מדריך 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

  השפה שבה אדם קיבל אימייל. קיימת רק באימיילים מתורגמים (תוכן מנוהל).

• 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

  השפה שבה אדם קיבל אימייל. קיימת רק באימיילים מתורגמים (תוכן מנוהל).

• 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חובה