مرجع API

عقد واحد للواجهة الكاملة المخصصة للعملاء.

نقاط نهاية العملاء متاحة ضمن /api/v1. وتبقى البادئة القديمة /api متاحة للوحة التحكم، بينما ينبغي للتكاملات الجديدة على الخادم استخدام عنوان URL الأساسي ذي الإصدار.

163 documented operations11 resource groupsOpenAPI 3.1 machine-readable contract

حدود المصادقة

تستخدم تكاملات المنتج مفتاح API لمساحة العمل، ويمكنه أيضًا قراءة استخدام الحساب والتحليلات وبيانات وصفية لمفاتيح API. أما تغييرات الفوترة وإنشاء مفاتيح API أو إلغاؤها فتتطلب جلسة المتصفح المقتصرة على HTTP وهي موسومة وفق ذلك.

الموارد

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

الحساب والفوترة

اقرأ استخدام الحساب والتحليلات والبيانات الوصفية للمفاتيح باستخدام مفتاح 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"
}