مرجع API

یک قرارداد واحد برای کل سطح دسترسی مشتری.

endpointهای مشتری زیر /api/v1 در دسترس‌اند. پیشوند قدیمی /api همچنان برای داشبورد در دسترس است، اما یکپارچه‌سازی‌های سروری جدید باید از base URL نسخه‌دار استفاده کنند.

163 documented operations11 resource groupsOpenAPI 3.1 machine-readable contract

مرزهای احراز هویت

یکپارچه‌سازی‌های محصول از کلید API فضای کاری استفاده می‌کنند که می‌تواند میزان مصرف حساب، analytics و metadata کلیدهای API را نیز بخواند. تغییرات صورتحساب و ایجاد یا ابطال کلید API به نشست مرورگر HTTP-only نیاز دارند و بر همین اساس برچسب خورده‌اند.

منابع

10 operations

ایمیل‌ها و رشته‌های گفتگو

ارسال، بازیابی، جست‌وجو، پاسخ و بررسی رویدادهای تحویل.

8 عملیات

برچسب‌ها و قوانین دسته‌بندی

ایمیل‌های ارسالی و دریافتی را به‌طور خودکار یا دستی در پوشه‌ها سازمان‌دهی کنید.

9 عملیات

پیش‌نویس‌ها و پیوست‌ها

جریان‌های نوشتن ایمیل را با ذخیره‌سازی خصوصی پیوست‌ها بسازید.

10 عملیات

قالب‌های میزبانی‌شده

محتوای قابل‌استفاده مجدد را پیش‌نویس، رندر، آزمایش، نسخه‌بندی، منتشر و ارسال کنید.

7 عملیات

دامنه‌ها

هویت‌های فرستنده را راه‌اندازی کنید و وضعیت تأیید DNS را درک کنید.

8 عملیات

ایمیل ورودی

نشانی بسازید و با گفتگوهای دریافتی کار کنید.

9 operations

تحویل‌پذیری

رویدادها، نتایج اعتبار و گیرندگان مسدودشده را بررسی کنید.

10 operations

Webhooks

Receive signed, retried email events (sent, delivered, delayed, bounced, complained, failed, received) at your own endpoints.

47 operations

Campaigns

Store contacts with their consent basis, tags, and custom fields, organize them into lists with hosted double opt-in signup forms, welcome emails, and public newsletter sites, target segments, import and export CSV files, and send, test, and schedule broadcasts with merge tags, per-list one-click unsubscribe, pre-send checks, bot-filtered open and click reports, and per-recipient outcomes.

36 operations

Automations

Record what contacts do as events, and run timed sequences of emails that start on an event, stop when the contact converts, and share per-person sending limits. Create and edit automations, their emails and language versions, turn them on and off, and add or remove people. Available to enabled workspaces.

9 operations

حساب و صورتحساب

میزان مصرف حساب، analytics و metadata کلیدها را با کلید API بخوانید؛ تغییرات صورتحساب و ایجاد یا ابطال کلید به نشست داشبورد نیاز دارند.

پوشش خطا

خطاهای JSON از یک پوشش قابل‌پیش‌بینی استفاده می‌کنند. کدهای وضعیت، ورودی نامعتبر، احراز هویت، منابع ناموجود، تعارض‌ها، الزام پرداخت، مسدودسازی‌های ایمنی و محدودیت‌های مصرف را از هم متمایز می‌کنند.

پاسخ خطا
{
  "error": {
    "message": "The sender domain is not verified",
    "status": 403
  }
}

نسخه‌بندی

نسخه تاریخ‌محور API این قرارداد را مشخص می‌کند. فیلدهای سازگار با نسخه‌های قبلی می‌توانند در همان نسخه اضافه شوند. تغییرات ناسازگار به مسیر پایه نسخه‌دار جدید و یک دوره انتقال مستند نیاز دارند.

کشف
{
  "version": "2026-09-07",
  "baseUrl": "https://sendhq.cc/api/v1",
  "openapi": "https://sendhq.cc/openapi.json"
}