مرجع API
عقد واحد للواجهة الكاملة المخصصة للعملاء.
نقاط نهاية العملاء متاحة ضمن /api/v1. وتبقى البادئة القديمة /api متاحة للوحة التحكم، بينما ينبغي للتكاملات الجديدة على الخادم استخدام عنوان URL الأساسي ذي الإصدار.
حدود المصادقة
تستخدم تكاملات المنتج مفتاح API لمساحة العمل، ويمكنه أيضًا قراءة استخدام الحساب والتحليلات وبيانات وصفية لمفاتيح API. أما تغييرات الفوترة وإنشاء مفاتيح API أو إلغاؤها فتتطلب جلسة المتصفح المقتصرة على HTTP وهي موسومة وفق ذلك.
الموارد
الرسائل والسلاسل
أرسل واسترجع وابحث وردّ وافحص أحداث التسليم.
8 عملياتالتصنيفات وقواعد الفرز
نظّم البريد المرسَل والمستلَم في مجلدات تلقائيًا أو يدويًا.
9 عملياتالمسودات والمرفقات
ابنِ تدفقات المحرر مع تخزين خاص للمرفقات.
10 عملياتالقوالب المستضافة
صُغ وأنشئ المعاينة واختبر وأصدر وانشر وأرسل محتوى قابلًا لإعادة الاستخدام.
7 عملياتالنطاقات
جهّز هويات الإرسال وافهم حالة توثيق DNS.
8 عملياتالبريد الوارد
أنشئ العناوين وتعامل مع المحادثات المستلَمة.
9 operationsقابلية التسليم
افحص الأحداث ونتائج السمعة والمستلِمين المحظورين.
10 operationsWebhooks
Receive signed, retried email events (sent, delivered, delayed, bounced, complained, failed, received) at your own endpoints.
47 operationsCampaigns
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 operationsAutomations
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"
}