مرجع Banger API

عرض منتجات مساحة العمل

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب

لا يحدد العقد متنًا للطلب.

استجابة النجاح 200

استجابة ناجحة.

application/json

• valueobject
• dataarrayمطلوب
• كل عنصرobject
• idstringمطلوب

  format: "uuid"

• workspace_idstringمطلوب

  format: "uuid"

• namestringمطلوب
• slugstringمطلوب
• kindstringمطلوب

  enum: "product", "store", "brand", "newsletter", "company", "other"

• website_urlstring | nullمطلوب
• domainsarrayمطلوب
• كل عنصرstring
• descriptionstringمطلوب
• contextobjectمطلوب
• خاصية إضافيةأي قيمة
• brandobjectمطلوب
• company_namestring

  maxLength: 160

• logo_urlstring

  الأيقونة: الرمز وحده، ويُستخدم بحجم صغير (تذييل البريد ونماذج الانزلاق) وكعنوان عند غياب الشعار النصي.

  maxLength: 2000

• wordmark_urlstring

  الشعار النصي: اسم الشركة كما صُمم، ويظهر وحده أعلى كل رسالة بريد.

  maxLength: 2000

• website_urlstring

  maxLength: 2000

• primary_colorstring

  maxLength: 7

• accent_colorstring

  maxLength: 7

• background_colorstring

  maxLength: 7

• surface_colorstring

  maxLength: 7

• text_colorstring

  maxLength: 7

• muted_text_colorstring

  maxLength: 7

• heading_font_familystring

  maxLength: 200

• body_font_familystring

  maxLength: 200

• tonestring

  maxLength: 1000

• footer_addressstring

  maxLength: 500

• email_stylestring

  maxLength: 20

• statusstringمطلوب

  deleting: حذفه شخص؛ يمكن استعادته حتى delete_after، ثم يُزال نهائيًا.

  enum: "active", "archived", "deleting"

• delete_afterstring | null

  وقت الإزالة النهائية لمنتج في حالة deleting.

  format: "date-time"

• is_defaultbooleanمطلوب
• route_readybooleanمطلوب
• setuparrayمطلوب
• كل عنصرobject
• keystringمطلوب

  enum: "context", "domain", "mailboxes", "journeys", "broadcasts", "compliance"

• statusstringمطلوب

  enum: "todo", "in_progress", "complete", "not_relevant"

• completion_sourcestring | nullمطلوب

  enum: "system", "person", "agent", null

• notestringمطلوب
• updated_atstring | nullمطلوب

  format: "date-time"

• created_atstringمطلوب

  format: "date-time"

• updated_atstringمطلوب

  format: "date-time"

مثال curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/products' \
  --header "Authorization: Bearer $BANGER_API_KEY"

إنشاء منتج

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب مطلوب

application/json

• valueobject
• namestringمطلوب

  minLength: 1 · maxLength: 160

• kindstring

  default: "product" · enum: "product", "store", "brand", "newsletter", "company", "other"

• website_urlstring | null

  maxLength: 2000

• descriptionstring

  maxLength: 4000

• contextobject
• خاصية إضافيةأي قيمة
• domainsarray

  maxItems: 20

• كل عنصرstring

  maxLength: 253

استجابة النجاح 201

استجابة ناجحة.

application/json

• valueobject
• dataobjectمطلوب
• idstringمطلوب

  format: "uuid"

• workspace_idstringمطلوب

  format: "uuid"

• namestringمطلوب
• slugstringمطلوب
• kindstringمطلوب

  enum: "product", "store", "brand", "newsletter", "company", "other"

• website_urlstring | nullمطلوب
• domainsarrayمطلوب
• كل عنصرstring
• descriptionstringمطلوب
• contextobjectمطلوب
• خاصية إضافيةأي قيمة
• brandobjectمطلوب
• company_namestring

  maxLength: 160

• logo_urlstring

  الأيقونة: الرمز وحده، ويُستخدم بحجم صغير (تذييل البريد ونماذج الانزلاق) وكعنوان عند غياب الشعار النصي.

  maxLength: 2000

• wordmark_urlstring

  الشعار النصي: اسم الشركة كما صُمم، ويظهر وحده أعلى كل رسالة بريد.

  maxLength: 2000

• website_urlstring

  maxLength: 2000

• primary_colorstring

  maxLength: 7

• accent_colorstring

  maxLength: 7

• background_colorstring

  maxLength: 7

• surface_colorstring

  maxLength: 7

• text_colorstring

  maxLength: 7

• muted_text_colorstring

  maxLength: 7

• heading_font_familystring

  maxLength: 200

• body_font_familystring

  maxLength: 200

• tonestring

  maxLength: 1000

• footer_addressstring

  maxLength: 500

• email_stylestring

  maxLength: 20

• statusstringمطلوب

  deleting: حذفه شخص؛ يمكن استعادته حتى delete_after، ثم يُزال نهائيًا.

  enum: "active", "archived", "deleting"

• delete_afterstring | null

  وقت الإزالة النهائية لمنتج في حالة deleting.

  format: "date-time"

• is_defaultbooleanمطلوب
• route_readybooleanمطلوب
• setuparrayمطلوب
• كل عنصرobject
• keystringمطلوب

  enum: "context", "domain", "mailboxes", "journeys", "broadcasts", "compliance"

• statusstringمطلوب

  enum: "todo", "in_progress", "complete", "not_relevant"

• completion_sourcestring | nullمطلوب

  enum: "system", "person", "agent", null

• notestringمطلوب
• updated_atstring | nullمطلوب

  format: "date-time"

• created_atstringمطلوب

  format: "date-time"

• updated_atstringمطلوب

  format: "date-time"

مثال curl

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/products' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "name": "example",
  "kind": "product",
  "website_url": "example",
  "description": "example",
  "context": {},
  "domains": [
    "example"
  ]
}'

جلب منتج

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب

لا يحدد العقد متنًا للطلب.

استجابة النجاح 200

استجابة ناجحة.

application/json

• valueobject
• dataobjectمطلوب
• idstringمطلوب

  format: "uuid"

• workspace_idstringمطلوب

  format: "uuid"

• namestringمطلوب
• slugstringمطلوب
• kindstringمطلوب

  enum: "product", "store", "brand", "newsletter", "company", "other"

• website_urlstring | nullمطلوب
• domainsarrayمطلوب
• كل عنصرstring
• descriptionstringمطلوب
• contextobjectمطلوب
• خاصية إضافيةأي قيمة
• brandobjectمطلوب
• company_namestring

  maxLength: 160

• logo_urlstring

  الأيقونة: الرمز وحده، ويُستخدم بحجم صغير (تذييل البريد ونماذج الانزلاق) وكعنوان عند غياب الشعار النصي.

  maxLength: 2000

• wordmark_urlstring

  الشعار النصي: اسم الشركة كما صُمم، ويظهر وحده أعلى كل رسالة بريد.

  maxLength: 2000

• website_urlstring

  maxLength: 2000

• primary_colorstring

  maxLength: 7

• accent_colorstring

  maxLength: 7

• background_colorstring

  maxLength: 7

• surface_colorstring

  maxLength: 7

• text_colorstring

  maxLength: 7

• muted_text_colorstring

  maxLength: 7

• heading_font_familystring

  maxLength: 200

• body_font_familystring

  maxLength: 200

• tonestring

  maxLength: 1000

• footer_addressstring

  maxLength: 500

• email_stylestring

  maxLength: 20

• statusstringمطلوب

  deleting: حذفه شخص؛ يمكن استعادته حتى delete_after، ثم يُزال نهائيًا.

  enum: "active", "archived", "deleting"

• delete_afterstring | null

  وقت الإزالة النهائية لمنتج في حالة deleting.

  format: "date-time"

• is_defaultbooleanمطلوب
• route_readybooleanمطلوب
• setuparrayمطلوب
• كل عنصرobject
• keystringمطلوب

  enum: "context", "domain", "mailboxes", "journeys", "broadcasts", "compliance"

• statusstringمطلوب

  enum: "todo", "in_progress", "complete", "not_relevant"

• completion_sourcestring | nullمطلوب

  enum: "system", "person", "agent", null

• notestringمطلوب
• updated_atstring | nullمطلوب

  format: "date-time"

• created_atstringمطلوب

  format: "date-time"

• updated_atstringمطلوب

  format: "date-time"

مثال curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/products/{productId}' \
  --header "Authorization: Bearer $BANGER_API_KEY"

تحديث منتج

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب مطلوب

application/json

• valueobject
• namestring

  maxLength: 160

• kindstring

  enum: "product", "store", "brand", "newsletter", "company", "other"

• website_urlstring | null

  maxLength: 2000

• descriptionstring

  maxLength: 4000

• contextobject
• خاصية إضافيةأي قيمة
• brandobject
• company_namestring

  maxLength: 160

• logo_urlstring

  الأيقونة: الرمز وحده، ويُستخدم بحجم صغير (تذييل البريد ونماذج الانزلاق) وكعنوان عند غياب الشعار النصي.

  maxLength: 2000

• wordmark_urlstring

  الشعار النصي: اسم الشركة كما صُمم، ويظهر وحده أعلى كل رسالة بريد.

  maxLength: 2000

• website_urlstring

  maxLength: 2000

• primary_colorstring

  maxLength: 7

• accent_colorstring

  maxLength: 7

• background_colorstring

  maxLength: 7

• surface_colorstring

  maxLength: 7

• text_colorstring

  maxLength: 7

• muted_text_colorstring

  maxLength: 7

• heading_font_familystring

  maxLength: 200

• body_font_familystring

  maxLength: 200

• tonestring

  maxLength: 1000

• footer_addressstring

  maxLength: 500

• email_stylestring

  maxLength: 20

• statusstring

  enum: "active", "archived"

استجابة النجاح 200

استجابة ناجحة.

application/json

• valueobject
• dataobjectمطلوب
• idstringمطلوب

  format: "uuid"

• workspace_idstringمطلوب

  format: "uuid"

• namestringمطلوب
• slugstringمطلوب
• kindstringمطلوب

  enum: "product", "store", "brand", "newsletter", "company", "other"

• website_urlstring | nullمطلوب
• domainsarrayمطلوب
• كل عنصرstring
• descriptionstringمطلوب
• contextobjectمطلوب
• خاصية إضافيةأي قيمة
• brandobjectمطلوب
• company_namestring

  maxLength: 160

• logo_urlstring

  الأيقونة: الرمز وحده، ويُستخدم بحجم صغير (تذييل البريد ونماذج الانزلاق) وكعنوان عند غياب الشعار النصي.

  maxLength: 2000

• wordmark_urlstring

  الشعار النصي: اسم الشركة كما صُمم، ويظهر وحده أعلى كل رسالة بريد.

  maxLength: 2000

• website_urlstring

  maxLength: 2000

• primary_colorstring

  maxLength: 7

• accent_colorstring

  maxLength: 7

• background_colorstring

  maxLength: 7

• surface_colorstring

  maxLength: 7

• text_colorstring

  maxLength: 7

• muted_text_colorstring

  maxLength: 7

• heading_font_familystring

  maxLength: 200

• body_font_familystring

  maxLength: 200

• tonestring

  maxLength: 1000

• footer_addressstring

  maxLength: 500

• email_stylestring

  maxLength: 20

• statusstringمطلوب

  deleting: حذفه شخص؛ يمكن استعادته حتى delete_after، ثم يُزال نهائيًا.

  enum: "active", "archived", "deleting"

• delete_afterstring | null

  وقت الإزالة النهائية لمنتج في حالة deleting.

  format: "date-time"

• is_defaultbooleanمطلوب
• route_readybooleanمطلوب
• setuparrayمطلوب
• كل عنصرobject
• keystringمطلوب

  enum: "context", "domain", "mailboxes", "journeys", "broadcasts", "compliance"

• statusstringمطلوب

  enum: "todo", "in_progress", "complete", "not_relevant"

• completion_sourcestring | nullمطلوب

  enum: "system", "person", "agent", null

• notestringمطلوب
• updated_atstring | nullمطلوب

  format: "date-time"

• created_atstringمطلوب

  format: "date-time"

• updated_atstringمطلوب

  format: "date-time"

مثال curl

curl --request PATCH --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/products/{productId}' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "name": "example",
  "kind": "product",
  "website_url": "example",
  "description": "example",
  "context": {},
  "brand": {
    "company_name": "example",
    "logo_url": "example",
    "wordmark_url": "example",
    "website_url": "example",
    "primary_color": "example",
    "accent_color": "example",
    "background_color": "example",
    "surface_color": "example",
    "text_color": "example",
    "muted_text_color": "example",
    "heading_font_family": "example",
    "body_font_family": "example",
    "tone": "example",
    "footer_address": "example",
    "email_style": "example"
  },
  "status": "active"
}'

احذف منتجًا واحدًا (مشروعًا في التطبيق) بعد مراجعة معاينة الحذف. يتوقف استخدامه فورًا (ويتوقف إرساله) ويبقى قابلًا للاستعادة لمدة 24 ساعة؛ ثم يزيل Banger نطاقات إرساله وكل صف يملكه. لا يمكن حذف آخر منتج نشط في مساحة العمل. يتطلب مسؤول مساحة العمل وجلسة مسجّلة الدخول؛ تُرفض مفاتيح API ومنح OAuth.

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب مطلوب

application/json

• valueobject

  لا خصائص إضافية

• confirm_namestringمطلوب

  اسم المنتج المطابق تمامًا.

  minLength: 1 · maxLength: 160

• preview_tokenstringمطلوب

  minLength: 64 · maxLength: 64

استجابة النجاح 202

المنتج خارج الاستخدام ويُحذف نهائيًا عند delete_after ما لم يُستعد قبل ذلك. تعيد الإعادة المتكررة الآمنة النتيجة نفسها.

application/json

• valueobject
• dataobjectمطلوب
• idstringمطلوب

  format: "uuid"

• namestringمطلوب
• statusstringمطلوب

  enum: "deleting"

• delete_afterstringمطلوب

  وقت حذف المنتج نهائيًا؛ يمكن استعادته حتى ذلك الحين.

  format: "date-time"

• next_product_idstringمطلوب

  المنتج الافتراضي الحالي لمساحة العمل.

  format: "uuid"

• replayedboolean

مثال curl

curl --request DELETE --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/products/{productId}' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Idempotency-Key: examplexxxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "confirm_name": "example",
  "preview_token": "examplexxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}'

عاين حذف منتج وكل ما يملكه دون حذف شيء. يتطلب مسؤول مساحة العمل، مسجّل الدخول أو عبر OAuth مخوّل من المستخدم.

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب

لا يحدد العقد متنًا للطلب.

استجابة النجاح 200

ما يزيله حذف المنتج وما يوقفه.

application/json

• valueobject
• dataobjectمطلوب
• productobjectمطلوب
• idstringمطلوب

  format: "uuid"

• namestringمطلوب
• is_defaultbooleanمطلوب
• next_default_productغير محددمطلوب

  المنتج الذي يصبح افتراضيًا لمساحة العمل عند حذف المنتج الافتراضي.

• oneOf 1null
• oneOf 2object
• idstringمطلوب

  format: "uuid"

• namestringمطلوب
• last_productbooleanمطلوب

  لا يمكن حذف المنتج النشط الوحيد.

• mailboxesarrayمطلوب
• كل عنصرobject
• idstringمطلوب

  format: "uuid"

• addressstringمطلوب
• domainsarrayمطلوب

  نطاقات الإرسال التي يزيلها Banger بعد انتهاء مهلة الاستعادة.

• كل عنصرobject
• idstringمطلوب

  format: "uuid"

• domainstringمطلوب
• journeysintegerمطلوب
• broadcastsintegerمطلوب
• signup_formsintegerمطلوب
• contactsintegerمطلوب
• api_keysintegerمطلوب
• webhooksintegerمطلوب
• pending_sendsintegerمطلوب
• impactarrayمطلوب
• كل عنصرstring
• preview_tokenstringمطلوب

مثال curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/products/{productId}/deletion-preview' \
  --header "Authorization: Bearer $BANGER_API_KEY"

استعد منتجًا محذوفًا قبل delete_after. تُعاد تفعيل صناديق بريده والرحلات ونماذج التسجيل وwebhooks والتكاملات؛ وتبقى الحملات متوقفة مؤقتًا. يتطلب مسؤول مساحة العمل، مسجّل الدخول أو عبر OAuth مخوّل من المستخدم.

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب

لا يحدد العقد متنًا للطلب.

استجابة النجاح 200

المنتج نشط مجددًا.

application/json

• valueobject
• dataobjectمطلوب
• idstringمطلوب

  format: "uuid"

• namestringمطلوب
• statusstringمطلوب

  enum: "active"

مثال curl

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/products/{productId}/restore' \
  --header "Authorization: Bearer $BANGER_API_KEY"

تحديث عنصر إعداد منتج

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب مطلوب

application/json

• valueobject
• statusstringمطلوب

  enum: "todo", "in_progress", "complete", "not_relevant"

• completion_sourcestring

  default: "person" · enum: "system", "person", "agent"

• notestring

  maxLength: 1000

استجابة النجاح 200

استجابة ناجحة.

application/json

• valueobject
• dataobjectمطلوب
• keystringمطلوب

  enum: "context", "domain", "mailboxes", "journeys", "broadcasts", "compliance"

• statusstringمطلوب

  enum: "todo", "in_progress", "complete", "not_relevant"

• completion_sourcestring | nullمطلوب

  enum: "system", "person", "agent", null

• notestringمطلوب
• updated_atstring | nullمطلوب

  format: "date-time"

مثال curl

curl --request PUT --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/products/{productId}/setup/{key}' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "status": "todo",
  "completion_source": "person",
  "note": "example"
}'

ربط نطاق بمنتج

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب مطلوب

application/json

• valueobject
• domainstringمطلوب

  minLength: 3 · maxLength: 253

استجابة النجاح 201

استجابة ناجحة.

application/json

• valueobject
• dataobjectمطلوب
• idstringمطلوب

  format: "uuid"

• workspace_idstringمطلوب

  format: "uuid"

• namestringمطلوب
• slugstringمطلوب
• kindstringمطلوب

  enum: "product", "store", "brand", "newsletter", "company", "other"

• website_urlstring | nullمطلوب
• domainsarrayمطلوب
• كل عنصرstring
• descriptionstringمطلوب
• contextobjectمطلوب
• خاصية إضافيةأي قيمة
• brandobjectمطلوب
• company_namestring

  maxLength: 160

• logo_urlstring

  الأيقونة: الرمز وحده، ويُستخدم بحجم صغير (تذييل البريد ونماذج الانزلاق) وكعنوان عند غياب الشعار النصي.

  maxLength: 2000

• wordmark_urlstring

  الشعار النصي: اسم الشركة كما صُمم، ويظهر وحده أعلى كل رسالة بريد.

  maxLength: 2000

• website_urlstring

  maxLength: 2000

• primary_colorstring

  maxLength: 7

• accent_colorstring

  maxLength: 7

• background_colorstring

  maxLength: 7

• surface_colorstring

  maxLength: 7

• text_colorstring

  maxLength: 7

• muted_text_colorstring

  maxLength: 7

• heading_font_familystring

  maxLength: 200

• body_font_familystring

  maxLength: 200

• tonestring

  maxLength: 1000

• footer_addressstring

  maxLength: 500

• email_stylestring

  maxLength: 20

• statusstringمطلوب

  deleting: حذفه شخص؛ يمكن استعادته حتى delete_after، ثم يُزال نهائيًا.

  enum: "active", "archived", "deleting"

• delete_afterstring | null

  وقت الإزالة النهائية لمنتج في حالة deleting.

  format: "date-time"

• is_defaultbooleanمطلوب
• route_readybooleanمطلوب
• setuparrayمطلوب
• كل عنصرobject
• keystringمطلوب

  enum: "context", "domain", "mailboxes", "journeys", "broadcasts", "compliance"

• statusstringمطلوب

  enum: "todo", "in_progress", "complete", "not_relevant"

• completion_sourcestring | nullمطلوب

  enum: "system", "person", "agent", null

• notestringمطلوب
• updated_atstring | nullمطلوب

  format: "date-time"

• created_atstringمطلوب

  format: "date-time"

• updated_atstringمطلوب

  format: "date-time"

مثال curl

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/products/{productId}/domains' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "domain": "example"
}'

listMailboxes

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب

لا يحدد العقد متنًا للطلب.

استجابة النجاح 200

صناديق البريد المرئية للجهة المنفّذة.

application/json

• valueobject
• dataarrayمطلوب
• كل عنصرobject
• idstringمطلوب

  format: "uuid"

• workspace_idstringمطلوب

  format: "uuid"

• product_idstring | null

  المنتج (المشروع) الذي ينتمي إليه صندوق البريد. يستخدمه العملاء لتجميع الصناديق وإنشاء روابط تطبيق الويب.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringمطلوب

  format: "email"

• display_namestringمطلوب
• providerstringمطلوب

  enum: "gmail", "smtp"

• statusstringمطلوب

  enum: "pending", "active", "suspended", "reconnect_required", "disabled"

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringمطلوب

  enum: "domain", "starter"

مثال curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/mailboxes' \
  --header "Authorization: Bearer $BANGER_API_KEY"

أنشئ صندوق بريد عمل أصليًا في Banger على نطاق إرسال لمساحة العمل.

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب مطلوب

application/json

• valueobject

  لا خصائص إضافية

• domain_idstringمطلوب

  format: "uuid"

• local_partstringمطلوب

  minLength: 1 · maxLength: 64

• display_namestring

  maxLength: 200

استجابة النجاح 200

إعادة آمنة لإنشاء صندوق بريد أصلي.

application/json

• valueobject
• dataobjectمطلوب
• idstringمطلوب

  format: "uuid"

• workspace_idstringمطلوب

  format: "uuid"

• product_idstring | null

  المنتج (المشروع) الذي ينتمي إليه صندوق البريد. يستخدمه العملاء لتجميع الصناديق وإنشاء روابط تطبيق الويب.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringمطلوب

  format: "email"

• display_namestringمطلوب
• providerstringمطلوب

  enum: "gmail", "smtp"

• statusstringمطلوب

  enum: "pending", "active", "suspended", "reconnect_required", "disabled"

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringمطلوب

  enum: "domain", "starter"

مثال curl

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/mailboxes' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Idempotency-Key: examplexxxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "domain_id": "00000000-0000-4000-8000-000000000001",
  "local_part": "example",
  "display_name": "example"
}'

عاين الحذف النهائي لصندوق بريد وتدفقات الإرسال التابعة له. يتطلب مسؤول مساحة العمل ونطاق المنتج.

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب

لا يحدد العقد متنًا للطلب.

استجابة النجاح 200

صندوق البريد المحدد والأثر الحالي للحذف، دون حذف شيء.

application/json

• valueobject
• dataobjectمطلوب
• mailboxobjectمطلوب
• idstringمطلوب

  format: "uuid"

• addressstringمطلوب
• providerstringمطلوب
• domain_idstring | nullمطلوب

  format: "uuid"

• provider_connection_idstring | nullمطلوب

  format: "uuid"

• messagesintegerمطلوب
• draftsintegerمطلوب
• pending_sendsintegerمطلوب
• broadcastsarrayمطلوب
• كل عنصرobject
• idstringمطلوب

  format: "uuid"

• namestringمطلوب
• statusstringمطلوب
• journeysarrayمطلوب
• كل عنصرobject
• idstringمطلوب

  format: "uuid"

• namestringمطلوب
• statusstringمطلوب
• signup_formsarrayمطلوب
• كل عنصرobject
• idstringمطلوب

  format: "uuid"

• namestringمطلوب
• statusstringمطلوب
• impactarrayمطلوب
• كل عنصرstring
• preview_tokenstringمطلوب

مثال curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/mailboxes/{mailboxId}/deletion-preview' \
  --header "Authorization: Bearer $BANGER_API_KEY"

عيّن اسم المرسِل الذي يراه المستلمون في بريد صندوق Banger واحد ("Name <address>"). تحتفظ صناديق Gmail بالاسم المعيّن في Gmail. يتطلب مسؤول مساحة العمل.

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب مطلوب

application/json

• valueobject

  لا خصائص إضافية

• display_namestringمطلوب

  سطر واحد. عند تركه فارغًا يُرسل العنوان وحده.

  maxLength: 200

استجابة النجاح 200

صندوق البريد مع اسم المرسِل.

application/json

• valueobject
• dataobjectمطلوب
• idstringمطلوب

  format: "uuid"

• workspace_idstringمطلوب

  format: "uuid"

• product_idstring | null

  المنتج (المشروع) الذي ينتمي إليه صندوق البريد. يستخدمه العملاء لتجميع الصناديق وإنشاء روابط تطبيق الويب.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringمطلوب

  format: "email"

• display_namestringمطلوب
• providerstringمطلوب

  enum: "gmail", "smtp"

• statusstringمطلوب

  enum: "pending", "active", "suspended", "reconnect_required", "disabled"

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringمطلوب

  enum: "domain", "starter"

مثال curl

curl --request PATCH --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/mailboxes/{mailboxId}' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "display_name": "example"
}'

احذف صندوق بريد واحدًا نهائيًا مع الاحتفاظ بنطاقه والصناديق الأخرى. يتطلب مسؤول مساحة العمل ونطاق المنتج.

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب مطلوب

application/json

• valueobject

  لا خصائص إضافية

• confirm_addressstringمطلوب

  minLength: 3 · maxLength: 320

• preview_tokenstringمطلوب

  minLength: 64 · maxLength: 64

استجابة النجاح 200

تم الحذف أو إعادة آمنة. تُدرج الملفات المخزنة في طابور التنظيف النهائي.

application/json

• valueobject
• dataobjectمطلوب
• idstringمطلوب

  format: "uuid"

• addressstringمطلوب
• deletedbooleanمطلوب
• replayedboolean

مثال curl

curl --request DELETE --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/mailboxes/{mailboxId}' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Idempotency-Key: examplexxxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "confirm_address": "example",
  "preview_token": "examplexxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}'

أنشئ صندوق بريد مستضافًا يقتصر على صناديق الوارد المستضافة للمنتج نفسه ومستلم التسجيل لمساحة العمل.

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب مطلوب

application/json

• valueobject

  لا خصائص إضافية

• create_newboolean

  أنشئ صندوق بريد مستضافًا إضافيًا بدلًا من استئناف الصندوق الأول.

• local_partstring

  الاسم قبل @bangermail.com. بدونه يحصل الصندوق على اسم من كلمات مثل quiet-maple-harbor.

  minLength: 3 · maxLength: 40

• display_namestring

  maxLength: 200

استجابة النجاح 200

إعادة آمنة لإنشاء هوية البداية.

application/json

• valueobject
• dataobjectمطلوب
• idstringمطلوب

  format: "uuid"

• workspace_idstringمطلوب

  format: "uuid"

• product_idstring | null

  المنتج (المشروع) الذي ينتمي إليه صندوق البريد. يستخدمه العملاء لتجميع الصناديق وإنشاء روابط تطبيق الويب.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringمطلوب

  format: "email"

• display_namestringمطلوب
• providerstringمطلوب

  enum: "gmail", "smtp"

• statusstringمطلوب

  enum: "pending", "active", "suspended", "reconnect_required", "disabled"

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringمطلوب

  enum: "domain", "starter"

مثال curl

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/mailboxes/starter' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Idempotency-Key: examplexxxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "create_new": true,
  "local_part": "example",
  "display_name": "example"
}'

استأنف صندوق بريد أوقفته سمعة المرسِل مؤقتًا، وفق قواعد الاستئناف الذاتي في resumeSending.

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب مطلوب

application/json

• valueobject

  لا خصائص إضافية

• acknowledge_recipient_complaintbooleanمطلوب

  const: true

• reasonstring

  سبب استعادة الإرسال؛ يُسجّل في سجل التدقيق.

  maxLength: 500

استجابة النجاح 200

أُعيد تفعيل الصندوق، أو كان نشطًا بعد طلب سابق ناجح.

application/json

• valueobject
• dataobjectمطلوب
• idstringمطلوب

  format: "uuid"

• workspace_idstringمطلوب

  format: "uuid"

• product_idstring | null

  المنتج (المشروع) الذي ينتمي إليه صندوق البريد. يستخدمه العملاء لتجميع الصناديق وإنشاء روابط تطبيق الويب.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringمطلوب

  format: "email"

• display_namestringمطلوب
• providerstringمطلوب

  enum: "gmail", "smtp"

• statusstringمطلوب

  enum: "pending", "active", "suspended", "reconnect_required", "disabled"

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringمطلوب

  enum: "domain", "starter"

مثال curl

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/mailboxes/{mailboxId}/reactivate' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "acknowledge_recipient_complaint": true,
  "reason": "example"
}'

listDrafts

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب

لا يحدد العقد متنًا للطلب.

استجابة النجاح 200

استجابة ناجحة.

application/json

• valueobject
• dataarrayمطلوب
• كل عنصرobject
• idstringمطلوب

  format: "uuid"

• mailbox_idstringمطلوب

  format: "uuid"

• thread_idstring | nullمطلوب

  format: "uuid"

• versionintegerمطلوب
• toarrayمطلوب
• كل عنصرobject
• emailstringمطلوب
• namestring
• ccarrayمطلوب
• كل عنصرobject
• emailstringمطلوب
• namestring
• bccarrayمطلوب
• كل عنصرobject
• emailstringمطلوب
• namestring
• subjectstringمطلوب
• body_textstringمطلوب
• statusstringمطلوب
• created_atstringمطلوب

  format: "date-time"

• updated_atstringمطلوب

  format: "date-time"

• attachmentsarrayمطلوب
• كل عنصرobject
• idstringمطلوب

  format: "uuid"

• filenamestringمطلوب
• content_typestringمطلوب
• size_bytesintegerمطلوب
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

مثال curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/drafts?mailbox_id=00000000-0000-4000-8000-000000000001' \
  --header "Authorization: Bearer $BANGER_API_KEY"

createDraft

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب مطلوب

application/json

• valueobject

  لا خصائص إضافية

• mailbox_idstringمطلوب

  format: "uuid"

• thread_idstring

  format: "uuid"

• toarray

  maxItems: 500

• كل عنصرobject
• namestring
• emailstringمطلوب

  format: "email"

• ccarray

  maxItems: 500

• كل عنصرobject
• namestring
• emailstringمطلوب

  format: "email"

• bccarray

  maxItems: 500

• كل عنصرobject
• namestring
• emailstringمطلوب

  format: "email"

• subjectstring

  maxLength: 10000

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

استجابة النجاح 201

استجابة ناجحة.

application/json

• valueobject
• dataobjectمطلوب
• idstringمطلوب

  format: "uuid"

• mailbox_idstringمطلوب

  format: "uuid"

• thread_idstring | nullمطلوب

  format: "uuid"

• versionintegerمطلوب
• toarrayمطلوب
• كل عنصرobject
• emailstringمطلوب
• namestring
• ccarrayمطلوب
• كل عنصرobject
• emailstringمطلوب
• namestring
• bccarrayمطلوب
• كل عنصرobject
• emailstringمطلوب
• namestring
• subjectstringمطلوب
• body_textstringمطلوب
• statusstringمطلوب
• created_atstringمطلوب

  format: "date-time"

• updated_atstringمطلوب

  format: "date-time"

• attachmentsarrayمطلوب
• كل عنصرobject
• idstringمطلوب

  format: "uuid"

• filenamestringمطلوب
• content_typestringمطلوب
• size_bytesintegerمطلوب
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

مثال curl

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/drafts' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "mailbox_id": "00000000-0000-4000-8000-000000000001",
  "thread_id": "00000000-0000-4000-8000-000000000001",
  "to": [
    {
      "name": "example",
      "email": "person@example.com"
    }
  ],
  "cc": [
    {
      "name": "example",
      "email": "person@example.com"
    }
  ],
  "bcc": [
    {
      "name": "example",
      "email": "person@example.com"
    }
  ],
  "subject": "example",
  "body_text": "example",
  "body_html": "example"
}'

getDraft

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب

لا يحدد العقد متنًا للطلب.

استجابة النجاح 200

الأداء والحالة والحوادث المرجعية لقابلية التسليم.

application/json

• valueobject
• dataobjectمطلوب
• idstringمطلوب

  format: "uuid"

• mailbox_idstringمطلوب

  format: "uuid"

• thread_idstring | nullمطلوب

  format: "uuid"

• versionintegerمطلوب
• toarrayمطلوب
• كل عنصرobject
• emailstringمطلوب
• namestring
• ccarrayمطلوب
• كل عنصرobject
• emailstringمطلوب
• namestring
• bccarrayمطلوب
• كل عنصرobject
• emailstringمطلوب
• namestring
• subjectstringمطلوب
• body_textstringمطلوب
• statusstringمطلوب
• created_atstringمطلوب

  format: "date-time"

• updated_atstringمطلوب

  format: "date-time"

• attachmentsarrayمطلوب
• كل عنصرobject
• idstringمطلوب

  format: "uuid"

• filenamestringمطلوب
• content_typestringمطلوب
• size_bytesintegerمطلوب
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

مثال curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/drafts/{draftId}' \
  --header "Authorization: Bearer $BANGER_API_KEY"

updateDraft

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب مطلوب

application/json

• valueغير محدد
• allOf 1object

  لا خصائص إضافية

• mailbox_idstringمطلوب

  format: "uuid"

• thread_idstring

  format: "uuid"

• toarray

  maxItems: 500

• كل عنصرobject
• namestring
• emailstringمطلوب

  format: "email"

• ccarray

  maxItems: 500

• كل عنصرobject
• namestring
• emailstringمطلوب

  format: "email"

• bccarray

  maxItems: 500

• كل عنصرobject
• namestring
• emailstringمطلوب

  format: "email"

• subjectstring

  maxLength: 10000

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

• allOf 2object
• versionintegerمطلوب

  minimum: 1

استجابة النجاح 200

استجابة ناجحة.

application/json

• valueobject
• dataobjectمطلوب
• idstringمطلوب

  format: "uuid"

• mailbox_idstringمطلوب

  format: "uuid"

• thread_idstring | nullمطلوب

  format: "uuid"

• versionintegerمطلوب
• toarrayمطلوب
• كل عنصرobject
• emailstringمطلوب
• namestring
• ccarrayمطلوب
• كل عنصرobject
• emailstringمطلوب
• namestring
• bccarrayمطلوب
• كل عنصرobject
• emailstringمطلوب
• namestring
• subjectstringمطلوب
• body_textstringمطلوب
• statusstringمطلوب
• created_atstringمطلوب

  format: "date-time"

• updated_atstringمطلوب

  format: "date-time"

• attachmentsarrayمطلوب
• كل عنصرobject
• idstringمطلوب

  format: "uuid"

• filenamestringمطلوب
• content_typestringمطلوب
• size_bytesintegerمطلوب
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

مثال curl

curl --request PUT --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/drafts/{draftId}' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "mailbox_id": "00000000-0000-4000-8000-000000000001",
  "thread_id": "00000000-0000-4000-8000-000000000001",
  "to": [
    {
      "name": "example",
      "email": "person@example.com"
    }
  ],
  "cc": [
    {
      "name": "example",
      "email": "person@example.com"
    }
  ],
  "bcc": [
    {
      "name": "example",
      "email": "person@example.com"
    }
  ],
  "subject": "example",
  "body_text": "example",
  "body_html": "example",
  "version": 1
}'

deleteDraft

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب

لا يحدد العقد متنًا للطلب.

استجابة النجاح 204

المسودة والكائنات المشار إليها مجدولة للحذف.

لا متن للاستجابة.

مثال curl

curl --request DELETE --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/drafts/{draftId}' \
  --header "Authorization: Bearer $BANGER_API_KEY"

sendDraft

يرسل المسودة من صندوقها الذي يجب أن يكون متاحًا للجهة المستدعية. إذا كانت إرسالياتها تحتاج موافقة، تُنشأ موافقة معلّقة بدلًا من الإرسال؛ ويقرر شخص يستطيع إرسال المسودة مباشرةً.

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب

لا يحدد العقد متنًا للطلب.

استجابة النجاح 202

الإرسال في الطابور أو ينتظر الموافقة.

application/json

• valueobject
• dataغير محددمطلوب
• oneOf 1object
• idstringمطلوب

  format: "uuid"

• typestringمطلوب
• statusstringمطلوب

  enum: "accepted", "executing", "succeeded", "failed"

• workspace_revisionintegerمطلوب

  format: "int64"

• created_atstringمطلوب

  format: "date-time"

• oneOf 2object

  لا خصائص إضافية

• approvalobjectمطلوب
• idstringمطلوب

  format: "uuid"

• requested_by_actor_idstringمطلوب
• action_kindstringمطلوب
• summarystringمطلوب
• capability_scopesarrayمطلوب
• كل عنصرstring
• resource_scopeobjectمطلوب
• خاصية إضافيةarray
• كل عنصرstring

  حُذفت مستويات التداخل الإضافية

• payloadobjectمطلوب
• خاصية إضافيةأي قيمة
• payload_sha256stringمطلوب

  pattern: "^[0-9a-f]{64}$"

• statusstringمطلوب

  enum: "pending", "approved", "rejected", "cancelled", "expired"

• missedbooleanمطلوب
• expires_atstringمطلوب

  format: "date-time"

• decided_by_actor_idstring | null
• decision_reasonstring | null
• created_atstringمطلوب

  format: "date-time"

• updated_atstringمطلوب

  format: "date-time"

• decided_atstring | null

  format: "date-time"

• execution_job_idstring

  format: "uuid"

• reviewobject

  لا خصائص إضافية

• dispositionstringمطلوب

  enum: "automatic", "human_required"

• recipient_countinteger | nullمطلوب

  minimum: 0

• reasonsarrayمطلوب
• كل عنصرstring

  حُذفت مستويات التداخل الإضافية

• checksarrayمطلوب
• كل عنصرstring

  حُذفت مستويات التداخل الإضافية

مثال curl

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/drafts/{draftId}/send' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Idempotency-Key: examplexxxxxxxxx'

uploadDraftAttachment

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب مطلوب

application/octet-stream

• valuestring

  format: "binary" · maxLength: 26214400

استجابة النجاح 201

استجابة ناجحة.

application/json

• valueobject
• dataobjectمطلوب
• idstringمطلوب

  format: "uuid"

• filenamestringمطلوب
• content_typestringمطلوب
• size_bytesintegerمطلوب
• sha256string
• created_atstring

  format: "date-time"

مثال curl

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/drafts/{draftId}/attachments' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'X-Banger-Filename: example' \
  --header 'Content-Type: application/octet-stream' \
  --data-binary @request-body

deleteDraftAttachment

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب

لا يحدد العقد متنًا للطلب.

استجابة النجاح 204

المرفق مجدول للحذف من B2 مع مراعاة الإصدارات.

لا متن للاستجابة.

مثال curl

curl --request DELETE --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/drafts/{draftId}/attachments/{attachmentId}' \
  --header "Authorization: Bearer $BANGER_API_KEY"

قراءة متن HTML لمسودة

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب

لا يحدد العقد متنًا للطلب.

استجابة النجاح 200

HTML المسودة.

text/html

• valuestring

مثال curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/drafts/{draftId}/html' \
  --header "Authorization: Bearer $BANGER_API_KEY"

listSendIntents

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب

لا يحدد العقد متنًا للطلب.

استجابة النجاح 200

الإرساليات المرجعية الأخيرة وحالتها لدى المزوّد.

application/json

• valueobject
• dataarrayمطلوب
• كل عنصرobject

  لا خصائص إضافية

• idstringمطلوب

  format: "uuid"

• statusstringمطلوب

  enum: "accepted", "scheduled", "queued", "executing", "partially_succeeded", "succeeded", "failed", "canceled"

• traffic_classstringمطلوب

  enum: "mailbox", "product", "broadcast"

• recipient_countintegerمطلوب

  minimum: 1

• provider_keystringمطلوب
• provider_statestringمطلوب

  enum: "pending", "leased", "submitted", "accepted", "ambiguous", "reconciling", "succeeded", "failed", "canceled"

• provider_message_idstring | null
• error_codestring | null
• created_atstringمطلوب

  format: "date-time"

• updated_atstringمطلوب

  format: "date-time"

• completed_atstring | null

  format: "date-time"

مثال curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/send-intents?limit=50' \
  --header "Authorization: Bearer $BANGER_API_KEY"

getSendIntent

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب

لا يحدد العقد متنًا للطلب.

استجابة النجاح 200

الحالة المرجعية للإرسال غير المتزامن.

application/json

• valueobject
• dataobjectمطلوب

  لا خصائص إضافية

• idstringمطلوب

  format: "uuid"

• statusstringمطلوب

  enum: "accepted", "scheduled", "queued", "executing", "partially_succeeded", "succeeded", "failed", "canceled"

• traffic_classstringمطلوب

  enum: "mailbox", "product", "broadcast"

• recipient_countintegerمطلوب

  minimum: 1

• provider_keystringمطلوب
• provider_statestringمطلوب

  enum: "pending", "leased", "submitted", "accepted", "ambiguous", "reconciling", "succeeded", "failed", "canceled"

• provider_message_idstring | null
• error_codestring | null
• created_atstringمطلوب

  format: "date-time"

• updated_atstringمطلوب

  format: "date-time"

• completed_atstring | null

  format: "date-time"

مثال curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/send-intents/{sendIntentId}' \
  --header "Authorization: Bearer $BANGER_API_KEY"

listTransactionalSends

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب

لا يحدد العقد متنًا للطلب.

استجابة النجاح 200

استجابة ناجحة.

application/json

• valueobject
• dataarrayمطلوب
• كل عنصرobject
• idstringمطلوب

  format: "uuid"

• mailbox_idstring | nullمطلوب

  format: "uuid"

• command_idstring | nullمطلوب

  format: "uuid"

• statusstringمطلوب
• command_statusstring | nullمطلوب
• subjectstring
• recipientsarray
• كل عنصرobject
• emailstringمطلوب
• namestring
• recipient_countintegerمطلوب
• error_codestring | null
• send_intent_idstring

  format: "uuid"

• providerstring | null
• route_kindstring | null
• sourcestring
• from_addressstring
• recipient_statesobject
• خاصية إضافيةinteger
• provider_message_idstring | null
• languageغير محدد

  اللغة التي أُرسلت بها هذه الرسالة؛ null إذا لم تُترجم.

• anyOf 1object

  اللغة التي تلقى بها الشخص الرسالة. توجد فقط في الرسائل المترجمة (managed-content).

• localestringمطلوب

  وسم BCP 47 للغة التي كُتبت بها الرسالة.

• requested_localestring

  يوجد فقط في إرسالية أقدم خرجت بلغة أخرى: اللغة التي كان ينبغي أن يتلقاها الشخص.

• fallback_reasonstring

  enum: "translation_missing", "translation_pending", "translation_review_required", "translation_failed", "translation_timeout"

• anyOf 2null
• journeyobject | null

  خطوة الرحلة والتسجيل اللذان أرسلا هذه الرسالة؛ null للإرساليات الأخرى.

• journey_idstringمطلوب

  format: "uuid"

• step_idstringمطلوب

  format: "uuid"

• enrollment_idstringمطلوب

  format: "uuid"

• experimentobject | null

  نسخة التجربة التي استخدمتها هذه الرسالة؛ null إذا لم تنطبق أي نسخة.

• experiment_idstringمطلوب

  format: "uuid"

• variant_keystringمطلوب
• created_atstringمطلوب

  format: "date-time"

• updated_atstringمطلوب

  format: "date-time"

• completed_atstring | nullمطلوب

  format: "date-time"

• template_idstring | null

  format: "uuid"

• template_versioninteger | null
• workspace_revisioninteger | null
• command_resultobject
• خاصية إضافيةأي قيمة
• command_started_atstring | null

  format: "date-time"

• command_completed_atstring | null

  format: "date-time"

• body_textstring
• body_htmlstring
• reply_toarray
• كل عنصرobject
• emailstringمطلوب
• namestring
• headersobject
• خاصية إضافيةstring
• tagsarray
• كل عنصرobject
• namestringمطلوب
• valuestringمطلوب

مثال curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/transactional-sends?limit=200' \
  --header "Authorization: Bearer $BANGER_API_KEY"

createTransactionalSend

مستلم واحد لكل إرسال في الرحلة. يقبل To مستلمًا واحدًا بأي صيغة RecipientInput ("a@example.com" أو "Pat <a@example.com>" أو { email, name } أو قائمة بعنصر واحد)؛ يجب أن يكون Cc وBcc فارغين. القيمة الافتراضية لـreply_to هي صندوق الرحلة (والقائمة الفارغة تعني الافتراضي أيضًا)؛ ويتطلب بريد المنتج واحدًا بالضبط. تستخدم رحلة API الجديدة محتوى مصدرًا مُدارًا افتراضيًا؛ وتحتفظ الرحلات البرمجية القديمة بالإرساليات ذات المحتوى الكامل. لا يثبّت الرفض (4xx) أي شيء للمستلم، لذا يُرسل الاستدعاء المصحح بمفتاح تكرار آمن جديد.

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب مطلوب

application/json

• valueobject
• mailbox_idstringمطلوب

  format: "uuid"

• toغير محددمطلوب

  مستلمو to وcc وbcc وreply_to: عنوان ("a@example.com" أو "Pat <a@example.com>") أو كائن { email, name } أو قائمة تجمع الصيغتين. يخزنهم Banger ككائنات { email, name } مع تحويل البريد إلى أحرف صغيرة. تشمل بصمة التكرار الآمن المتن كما أُرسل، لذا أعد المحاولة بالصيغة نفسها.

• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringمطلوب

  format: "email"

• oneOf 3array

  maxItems: 500

• كل عنصرغير محدد
• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringمطلوب

  format: "email"

• ccarray

  maxItems: 0

• كل عنصرobject
• namestring
• emailstringمطلوب

  format: "email"

• bccarray

  maxItems: 0

• كل عنصرobject
• namestring
• emailstringمطلوب

  format: "email"

• subjectstring

  maxLength: 10000

• expires_atstring

  استبعد إرسالية رحلة مؤجلة بعد هذه اللحظة؛ بحد أقصى سبعة أيام من الطلب الأصلي.

  format: "date-time"

• expires_after_secondsinteger

  minimum: 1 · maximum: 604800

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

• reply_toغير محدد

  مستلمو to وcc وbcc وreply_to: عنوان ("a@example.com" أو "Pat <a@example.com>") أو كائن { email, name } أو قائمة تجمع الصيغتين. يخزنهم Banger ككائنات { email, name } مع تحويل البريد إلى أحرف صغيرة. تشمل بصمة التكرار الآمن المتن كما أُرسل، لذا أعد المحاولة بالصيغة نفسها.

• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringمطلوب

  format: "email"

• oneOf 3array

  maxItems: 500

• كل عنصرغير محدد
• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringمطلوب

  format: "email"

• headersobject
• خاصية إضافيةstring

  maxLength: 5000

• tagsarray

  maxItems: 49

• كل عنصرobject

  لا خصائص إضافية

• namestringمطلوب

  minLength: 1 · maxLength: 256

• valuestringمطلوب

  minLength: 1 · maxLength: 256

استجابة النجاح 202

استجابة ناجحة.

application/json

• valueobject
• dataobjectمطلوب
• action_kindstringمطلوب

  enum: "transactional.send"

• idstring

  format: "uuid"

• send_intent_idstring

  format: "uuid"

• provider_attempt_idstring

  format: "uuid"

• statusstringمطلوب

  حالات sent/queued من التسليم، أو للطلب المثبّت: deferred (مجدول بسياسة أو انتظار ترجمة)، processing (جارٍ إرساله)، discarded.

• replayedboolean
• journeyغير محددمطلوب
• anyOf 1object
• journey_idstringمطلوب

  format: "uuid"

• enrollment_idstringمطلوب

  format: "uuid"

• step_idstringمطلوب

  format: "uuid"

• step_positionintegerمطلوب
• originstring

  enum: "journey"

• journey_identitystring
• anyOf 2null
• ignored_variablesarrayمطلوب
• كل عنصرstring
• scheduled_atstring

  format: "date-time"

• reasonstring
• communication_reservation_idstring

  format: "uuid"

مثال curl

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/transactional-sends' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Idempotency-Key: examplexxxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "mailbox_id": "00000000-0000-4000-8000-000000000001",
  "to": "example",
  "cc": [
    {
      "name": "example",
      "email": "person@example.com"
    }
  ],
  "bcc": [
    {
      "name": "example",
      "email": "person@example.com"
    }
  ],
  "subject": "example",
  "expires_at": "2026-01-01T00:00:00Z",
  "expires_after_seconds": 1,
  "body_text": "example",
  "body_html": "example",
  "reply_to": "example",
  "headers": {},
  "tags": [
    {
      "name": "example",
      "value": "example"
    }
  ]
}'

getTransactionalSend

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب

لا يحدد العقد متنًا للطلب.

استجابة النجاح 200

استجابة ناجحة.

application/json

• valueobject
• dataobjectمطلوب
• idstringمطلوب

  format: "uuid"

• mailbox_idstring | nullمطلوب

  format: "uuid"

• command_idstring | nullمطلوب

  format: "uuid"

• statusstringمطلوب
• command_statusstring | nullمطلوب
• subjectstring
• recipientsarray
• كل عنصرobject
• emailstringمطلوب
• namestring
• recipient_countintegerمطلوب
• error_codestring | null
• send_intent_idstring

  format: "uuid"

• providerstring | null
• route_kindstring | null
• sourcestring
• from_addressstring
• recipient_statesobject
• خاصية إضافيةinteger
• provider_message_idstring | null
• languageغير محدد

  اللغة التي أُرسلت بها هذه الرسالة؛ null إذا لم تُترجم.

• anyOf 1object

  اللغة التي تلقى بها الشخص الرسالة. توجد فقط في الرسائل المترجمة (managed-content).

• localestringمطلوب

  وسم BCP 47 للغة التي كُتبت بها الرسالة.

• requested_localestring

  يوجد فقط في إرسالية أقدم خرجت بلغة أخرى: اللغة التي كان ينبغي أن يتلقاها الشخص.

• fallback_reasonstring

  enum: "translation_missing", "translation_pending", "translation_review_required", "translation_failed", "translation_timeout"

• anyOf 2null
• journeyobject | null

  خطوة الرحلة والتسجيل اللذان أرسلا هذه الرسالة؛ null للإرساليات الأخرى.

• journey_idstringمطلوب

  format: "uuid"

• step_idstringمطلوب

  format: "uuid"

• enrollment_idstringمطلوب

  format: "uuid"

• experimentobject | null

  نسخة التجربة التي استخدمتها هذه الرسالة؛ null إذا لم تنطبق أي نسخة.

• experiment_idstringمطلوب

  format: "uuid"

• variant_keystringمطلوب
• created_atstringمطلوب

  format: "date-time"

• updated_atstringمطلوب

  format: "date-time"

• completed_atstring | nullمطلوب

  format: "date-time"

• template_idstring | null

  format: "uuid"

• template_versioninteger | null
• workspace_revisioninteger | null
• command_resultobject
• خاصية إضافيةأي قيمة
• command_started_atstring | null

  format: "date-time"

• command_completed_atstring | null

  format: "date-time"

• body_textstring
• body_htmlstring
• reply_toarray
• كل عنصرobject
• emailstringمطلوب
• namestring
• headersobject
• خاصية إضافيةstring
• tagsarray
• كل عنصرobject
• namestringمطلوب
• valuestringمطلوب

مثال curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/transactional-sends/{transactionalSendId}' \
  --header "Authorization: Bearer $BANGER_API_KEY"

listTransactionalSendTimeline

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب

لا يحدد العقد متنًا للطلب.

استجابة النجاح 200

تسلسل زمني مرتب للقبول ومحاولات المزوّد وأحداث المستلم.

application/json

• valueobject
• dataarrayمطلوب
• كل عنصرobject
• occurred_atstringمطلوب

  format: "date-time"

• event_typestringمطلوب
• labelstringمطلوب
• providerstring | null
• recipient_domainstring | null
• error_codestring | null

مثال curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/transactional-sends/{transactionalSendId}/timeline' \
  --header "Authorization: Bearer $BANGER_API_KEY"

retryTransactionalSend

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب

لا يحدد العقد متنًا للطلب.

استجابة النجاح 202

استجابة ناجحة.

application/json

• valueobject
• dataobjectمطلوب
• action_kindstringمطلوب

  enum: "transactional.send"

• idstringمطلوب

  format: "uuid"

• send_intent_idstringمطلوب

  format: "uuid"

• provider_attempt_idstringمطلوب

  format: "uuid"

• statusstringمطلوب
• replayedbooleanمطلوب

مثال curl

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/transactional-sends/{transactionalSendId}/retry' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Idempotency-Key: examplexxxxxxxxx'

listThreads

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب

لا يحدد العقد متنًا للطلب.

استجابة النجاح 200

محادثات مساحة العمل مقسّمة إلى صفحات بحسب المفتاح.

application/json

• valueobject
• dataarrayمطلوب
• كل عنصرobject
• idstringمطلوب

  format: "uuid"

• mailbox_idstringمطلوب

  format: "uuid"

• subjectstringمطلوب
• snippetstringمطلوب
• last_message_atstringمطلوب

  format: "date-time"

• message_countintegerمطلوب
• unread_countintegerمطلوب
• is_archivedbooleanمطلوب
• is_trashbooleanمطلوب
• is_spambooleanمطلوب
• is_starredbooleanمطلوب
• is_sentbooleanمطلوب
• has_attachmentsbooleanمطلوب
• labelsarrayمطلوب
• كل عنصرstring
• participantsarray
• كل عنصرobject
• namestring
• emailstringمطلوب

  format: "email"

• pageobjectمطلوب
• next_cursorstring
• has_morebooleanمطلوب

مثال curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/threads?cursor=example&limit=50&mailbox_id=00000000-0000-4000-8000-000000000001&label_id=00000000-0000-4000-8000-000000000001&view=inbox' \
  --header "Authorization: Bearer $BANGER_API_KEY"

getThread

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب

لا يحدد العقد متنًا للطلب.

استجابة النجاح 200

المحادثة والرسائل المرتبة.

application/json

• valueobject
• dataغير محددمطلوب
• allOf 1object
• idstringمطلوب

  format: "uuid"

• mailbox_idstringمطلوب

  format: "uuid"

• subjectstringمطلوب
• snippetstringمطلوب
• last_message_atstringمطلوب

  format: "date-time"

• message_countintegerمطلوب
• unread_countintegerمطلوب
• is_archivedbooleanمطلوب
• is_trashbooleanمطلوب
• is_spambooleanمطلوب
• is_starredbooleanمطلوب
• is_sentbooleanمطلوب
• has_attachmentsbooleanمطلوب
• labelsarrayمطلوب
• كل عنصرstring
• participantsarray
• كل عنصرobject
• namestring
• emailstringمطلوب

  format: "email"

• allOf 2object
• messagesarrayمطلوب
• كل عنصرobject
• idstringمطلوب

  format: "uuid"

• mailbox_idstringمطلوب

  format: "uuid"

• thread_idstringمطلوب

  format: "uuid"

• sent_atstringمطلوب

  format: "date-time"

• received_atstring

  format: "date-time"

• envelope_recipientsarray

  مستلمو ظرف SMTP الأصليون، بعد توحيد حالة الأحرف عند حافة SMTP وقبل توجيه الأسماء البديلة المخصصة للاستقبال فقط. فارغ للرسائل الأقدم أو المصادر غير SMTP. مستقل عن ترويستي To/Cc الظاهرتين.

• كل عنصرstring

  format: "email"

  حُذفت مستويات التداخل الإضافية

• fromobjectمطلوب
• namestring

  حُذفت مستويات التداخل الإضافية

• emailstringمطلوب

  format: "email"

  حُذفت مستويات التداخل الإضافية

• toarrayمطلوب
• كل عنصرobject

  حُذفت مستويات التداخل الإضافية

• ccarray
• كل عنصرobject

  حُذفت مستويات التداخل الإضافية

• reply_toarray
• كل عنصرobject

  حُذفت مستويات التداخل الإضافية

• is_sentboolean

  ما إذا كانت الرسالة أُرسلت من الصندوق، بما في ذلك من اسم بديل.

• body_textstring
• body_html_urlstring

  format: "uri"

• reply_originobject
• send_intent_idstringمطلوب

  format: "uuid"

  حُذفت مستويات التداخل الإضافية

• sourcestringمطلوب

  enum: "gateway", "transactional", "marketing", "mailbox", "agent"

  حُذفت مستويات التداخل الإضافية

• source_idstring

  format: "uuid"

  حُذفت مستويات التداخل الإضافية

• traffic_classstringمطلوب

  enum: "transactional", "marketing", "mailbox"

  حُذفت مستويات التداخل الإضافية

• kindstringمطلوب

  enum: "campaign", "sequence", "transactional", "mailbox", "agent"

  حُذفت مستويات التداخل الإضافية

• namestring

  حُذفت مستويات التداخل الإضافية

• has_attachmentsbooleanمطلوب
• attachmentsarray
• كل عنصرobject

  حُذفت مستويات التداخل الإضافية

مثال curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/threads/{threadId}' \
  --header "Authorization: Bearer $BANGER_API_KEY"

getMessageHtml

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب

لا يحدد العقد متنًا للطلب.

استجابة النجاح 200

متن HTML للرسالة، مع مصادقة وقيود بيئة معزولة.

text/html

• valuestring

مثال curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/messages/{messageId}/html' \
  --header "Authorization: Bearer $BANGER_API_KEY"

downloadAttachment

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب

لا يحدد العقد متنًا للطلب.

استجابة النجاح 200

تدفق المرفق مع مصادقة.

application/octet-stream

• valuestring

  format: "binary"

مثال curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/attachments/{attachmentId}/content' \
  --header "Authorization: Bearer $BANGER_API_KEY"

searchMail

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب

لا يحدد العقد متنًا للطلب.

استجابة النجاح 200

نتائج البحث في مساحة العمل بأكملها.

application/json

• valueobject
• dataarrayمطلوب
• كل عنصرobject
• idstringمطلوب

  format: "uuid"

• mailbox_idstringمطلوب

  format: "uuid"

• subjectstringمطلوب
• snippetstringمطلوب
• last_message_atstringمطلوب

  format: "date-time"

• message_countintegerمطلوب
• unread_countintegerمطلوب
• is_archivedbooleanمطلوب
• is_trashbooleanمطلوب
• is_spambooleanمطلوب
• is_starredbooleanمطلوب
• is_sentbooleanمطلوب
• has_attachmentsbooleanمطلوب
• labelsarrayمطلوب
• كل عنصرstring
• participantsarray
• كل عنصرobject
• namestring
• emailstringمطلوب

  format: "email"

• pageobjectمطلوب
• next_cursorstring
• has_morebooleanمطلوب

مثال curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/search?q=example&cursor=example&limit=50&mailbox_id=00000000-0000-4000-8000-000000000001' \
  --header "Authorization: Bearer $BANGER_API_KEY"

listContacts

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب

لا يحدد العقد متنًا للطلب.

استجابة النجاح 200

استجابة ناجحة.

application/json

• valueobject
• dataarrayمطلوب
• كل عنصرobject
• idstringمطلوب

  format: "uuid"

• emailstringمطلوب

  format: "email"

• display_namestring | nullمطلوب
• attributesobjectمطلوب
• خاصية إضافيةأي قيمة
• statusstringمطلوب

  enum: "subscribed", "unsubscribed", "bounced", "complained"

• created_atstringمطلوب

  format: "date-time"

• updated_atstringمطلوب

  format: "date-time"

• pageobjectمطلوب
• next_cursorstring
• has_morebooleanمطلوب

مثال curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/contacts?cursor=example&limit=50&q=example' \
  --header "Authorization: Bearer $BANGER_API_KEY"

upsertContact

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب مطلوب

application/json

• valueobject

  لا خصائص إضافية

• emailstringمطلوب

  format: "email"

• display_namestring

  maxLength: 1000

• statusstringمطلوب

  enum: "subscribed", "unsubscribed", "bounced", "complained"

• attributesobject
• خاصية إضافيةأي قيمة
• consent_confirmedboolean

  مطلوب عند اشتراك عنوان جديد.

استجابة النجاح 201

استجابة ناجحة.

application/json

• valueobject
• dataobjectمطلوب
• idstringمطلوب

  format: "uuid"

• emailstringمطلوب

  format: "email"

• display_namestring | nullمطلوب
• attributesobjectمطلوب
• خاصية إضافيةأي قيمة
• statusstringمطلوب

  enum: "subscribed", "unsubscribed", "bounced", "complained"

• created_atstringمطلوب

  format: "date-time"

• updated_atstringمطلوب

  format: "date-time"

مثال curl

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/contacts' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "email": "person@example.com",
  "display_name": "example",
  "status": "subscribed",
  "attributes": {},
  "consent_confirmed": true
}'

getContact

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب

لا يحدد العقد متنًا للطلب.

استجابة النجاح 200

استجابة ناجحة.

application/json

• valueobject
• dataobjectمطلوب
• idstringمطلوب

  format: "uuid"

• emailstringمطلوب

  format: "email"

• display_namestring | nullمطلوب
• attributesobjectمطلوب
• خاصية إضافيةأي قيمة
• statusstringمطلوب

  enum: "subscribed", "unsubscribed", "bounced", "complained"

• created_atstringمطلوب

  format: "date-time"

• updated_atstringمطلوب

  format: "date-time"

• suppressedbooleanمطلوب
• suppression_reasonstring | nullمطلوب
• sourcesarrayمطلوب
• كل عنصرobject
• kindstringمطلوب
• referencestringمطلوب
• connection_idstring | nullمطلوب

  format: "uuid"

• metadataobjectمطلوب
• خاصية إضافيةأي قيمة
• first_seen_atstringمطلوب

  format: "date-time"

• last_seen_atstringمطلوب

  format: "date-time"

• listsarrayمطلوب
• كل عنصرobject
• idstringمطلوب

  format: "uuid"

• namestringمطلوب
• subscription_statusstringمطلوب
• consent_evidencearrayمطلوب
• كل عنصرobject
• kindstringمطلوب
• referencestringمطلوب
• connection_idstring | nullمطلوب

  format: "uuid"

• metadataobjectمطلوب
• خاصية إضافيةأي قيمة
• first_seen_atstringمطلوب

  format: "date-time"

• last_seen_atstringمطلوب

  format: "date-time"

مثال curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/contacts/{contactId}' \
  --header "Authorization: Bearer $BANGER_API_KEY"

deleteContact

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب

لا يحدد العقد متنًا للطلب.

استجابة النجاح 204

حُذفت جهة الاتصال.

لا متن للاستجابة.

مثال curl

curl --request DELETE --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/contacts/{contactId}' \
  --header "Authorization: Bearer $BANGER_API_KEY"

listContactImports

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب

لا يحدد العقد متنًا للطلب.

استجابة النجاح 200

استجابة ناجحة.

application/json

• valueobject
• dataarrayمطلوب
• كل عنصرobject
• idstring

  format: "uuid"

• filenamestring
• list_idstring | null

  format: "uuid"

• list_namestring | null
• statusstring
• total_rowsinteger
• imported_rowsinteger
• invalid_rowsinteger
• error_summaryarray
• كل عنصرstring
• consent_confirmedboolean
• consent_confirmed_atstring | null

  format: "date-time"

• processed_rowsinteger
• attempt_countinteger
• last_error_codestring | null
• created_atstring

  format: "date-time"

• completed_atstring | null

  format: "date-time"

مثال curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/contacts/imports' \
  --header "Authorization: Bearer $BANGER_API_KEY"

importContacts

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب مطلوب

application/json

• valueobject
• filenamestringمطلوب

  minLength: 1 · maxLength: 500

• list_idstring

  format: "uuid"

• consent_confirmedboolean

  مطلوب إذا كان أي صف مستورد مشتركًا.

• rowsarrayمطلوب

  minItems: 1 · maxItems: 5000

• كل عنصرobject
• emailstringمطلوب

  format: "email"

• display_namestring

  maxLength: 1000

• statusstring

  enum: "subscribed", "unsubscribed", "bounced", "complained"

• attributesobject
• خاصية إضافيةأي قيمة

استجابة النجاح 201

استجابة ناجحة.

application/json

• valueobject
• dataobjectمطلوب
• idstringمطلوب

  format: "uuid"

• statusstringمطلوب

  enum: "queued"

• total_rowsintegerمطلوب
• imported_rowsintegerمطلوب
• invalid_rowsintegerمطلوب
• list_idstring | nullمطلوب

  format: "uuid"

مثال curl

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/contacts/imports' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "filename": "example",
  "list_id": "00000000-0000-4000-8000-000000000001",
  "consent_confirmed": true,
  "rows": [
    {
      "email": "person@example.com",
      "display_name": "example",
      "status": "subscribed",
      "attributes": {}
    }
  ]
}'

دمج سمات محددة النوع دون تغيير الاشتراك أو الموافقة

يتطلب contacts:write وcontacts:read. يحدّث جهة اتصال موجودة فقط. تُحفظ السمات المتروكة، وتُخزّن false الصريحة، وتحذف null الحقل. قدّم حقائق مصدر موثّقة؛ غياب البيانات لا يعني false. لا يتغير الاشتراك أو الاستبعاد أو الهوية أو سجل المصادر.

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب مطلوب

application/json

• valueobject

  لا خصائص إضافية

• attributesobjectمطلوب
• خاصية إضافيةأي قيمة

استجابة النجاح 200

قراءة جهة الاتصال الحالية؛ تكون replayed بقيمة true إذا كان هذا التعديل قد طُبّق بالفعل.

application/json

• valueobject
• dataobjectمطلوب
• idstringمطلوب

  format: "uuid"

• attributesobjectمطلوب
• خاصية إضافيةأي قيمة
• statusstringمطلوب

  enum: "subscribed", "unsubscribed", "bounced", "complained"

• replayedbooleanمطلوب
• خاصية إضافيةأي قيمة

مثال curl

curl --request PATCH --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/contacts/{contactId}/attributes' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'X-Banger-Product-Id: 00000000-0000-4000-8000-000000000001' \
  --header 'Idempotency-Key: example' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "attributes": {}
}'

upsertProductContact

المصادقة: مفتاح API لمساحة العمل بصيغة Bearer.

المعلمات

متن الطلب مطلوب

application/json

• valueobject

  لا خصائص إضافية

• emailstringمطلوب

  format: "email" · maxLength: 320

• display_namestring

  minLength: 0 · maxLength: 1000

• attributesobject
• خاصية إضافيةأي قيمة
• statusstringمطلوب

  enum: "subscribed", "unsubscribed", "bounced", "complained"

• consent_evidenceobject

  لا خصائص إضافية

• sourcestring

  minLength: 1 · maxLength: 2000

• referencestring

  minLength: 1 · maxLength: 2000

• observed_atstring

  format: "date-time"

• statementstring

  minLength: 1 · maxLength: 2000

• consent_confirmedboolean

استجابة النجاح 200

قراءة مرجعية أو إيصال تكرار آمن. قبول المزوّد هو sent؛ وتتطلب delivered حدث تسليم ولا تثبت الوصول إلى البريد الوارد.

application/json

• valueobject
• dataغير محددمطلوب
• allOf 1object
• idstringمطلوب

  format: "uuid"

• emailstringمطلوب

  format: "email"

• display_namestring | nullمطلوب
• attributesobjectمطلوب
• خاصية إضافيةأي قيمة
• statusstringمطلوب

  enum: "subscribed", "unsubscribed", "bounced", "complained"

• created_atstringمطلوب

  format: "date-time"

• updated_atstringمطلوب

  format: "date-time"

• suppressedbooleanمطلوب
• suppression_reasonstring | nullمطلوب
• sourcesarrayمطلوب
• كل عنصرobject
• kindstringمطلوب
• referencestringمطلوب
• connection_idstring | nullمطلوب

  format: "uuid"

• metadataobjectمطلوب
• خاصية إضافيةأي قيمة
• first_seen_atstringمطلوب

  format: "date-time"

• last_seen_atstringمطلوب

  format: "date-time"

• listsarrayمطلوب
• كل عنصرobject
• idstringمطلوب

  format: "uuid"

• namestringمطلوب
• subscription_statusstringمطلوب
• consent_evidencearrayمطلوب
• كل عنصرobject
• kindstringمطلوب
• referencestringمطلوب
• connection_idstring | nullمطلوب

  format: "uuid"

• metadataobjectمطلوب
• خاصية إضافيةأي قيمة
• first_seen_atstringمطلوب

  format: "date-time"

• last_seen_atstringمطلوب

  format: "date-time"

• allOf 2object
• replayedbooleanمطلوب