Banger API başvuru kaynağı

Çalışma alanı ürünlerini listele

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi

Sözleşmede istek gövdesi belirtilmemiştir.

Başarılı yanıt 200

Başarılı yanıt.

application/json

• valueobject
• dataarraygerekli
• Her öğeobject
• idstringgerekli

  format: "uuid"

• workspace_idstringgerekli

  format: "uuid"

• namestringgerekli
• slugstringgerekli
• kindstringgerekli

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

• website_urlstring | nullgerekli
• domainsarraygerekli
• Her öğestring
• descriptionstringgerekli
• contextobjectgerekli
• Ek özellikHerhangi bir değer
• brandobjectgerekli
• company_namestring

  maxLength: 160

• logo_urlstring

  Simge: küçük boyutta (e-posta altbilgisi, kayan formlar) kullanılan ve yazı logosu olmadığında başlık olarak gösterilen tek başına işaret.

  maxLength: 2000

• wordmark_urlstring

  Yazı logosu: şirket adının tasarlanmış biçimi; her e-postanın üstünde tek başına gösterilir.

  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

• statusstringgerekli

  deleting: bir kişi tarafından silinmiş; delete_after zamanına kadar geri yüklenebilir, sonra kalıcı olarak kaldırılır.

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

• delete_afterstring | null

  deleting durumundaki ürünün kalıcı olarak kaldırılacağı zaman.

  format: "date-time"

• is_defaultbooleangerekli
• route_readybooleangerekli
• setuparraygerekli
• Her öğeobject
• keystringgerekli

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

• statusstringgerekli

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

• completion_sourcestring | nullgerekli

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

• notestringgerekli
• updated_atstring | nullgerekli

  format: "date-time"

• created_atstringgerekli

  format: "date-time"

• updated_atstringgerekli

  format: "date-time"

curl örneği

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

Ürün oluştur

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi gerekli

application/json

• valueobject
• namestringgerekli

  minLength: 1 · maxLength: 160

• kindstring

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

• website_urlstring | null

  maxLength: 2000

• descriptionstring

  maxLength: 4000

• contextobject
• Ek özellikHerhangi bir değer
• domainsarray

  maxItems: 20

• Her öğestring

  maxLength: 253

Başarılı yanıt 201

Başarılı yanıt.

application/json

• valueobject
• dataobjectgerekli
• idstringgerekli

  format: "uuid"

• workspace_idstringgerekli

  format: "uuid"

• namestringgerekli
• slugstringgerekli
• kindstringgerekli

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

• website_urlstring | nullgerekli
• domainsarraygerekli
• Her öğestring
• descriptionstringgerekli
• contextobjectgerekli
• Ek özellikHerhangi bir değer
• brandobjectgerekli
• company_namestring

  maxLength: 160

• logo_urlstring

  Simge: küçük boyutta (e-posta altbilgisi, kayan formlar) kullanılan ve yazı logosu olmadığında başlık olarak gösterilen tek başına işaret.

  maxLength: 2000

• wordmark_urlstring

  Yazı logosu: şirket adının tasarlanmış biçimi; her e-postanın üstünde tek başına gösterilir.

  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

• statusstringgerekli

  deleting: bir kişi tarafından silinmiş; delete_after zamanına kadar geri yüklenebilir, sonra kalıcı olarak kaldırılır.

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

• delete_afterstring | null

  deleting durumundaki ürünün kalıcı olarak kaldırılacağı zaman.

  format: "date-time"

• is_defaultbooleangerekli
• route_readybooleangerekli
• setuparraygerekli
• Her öğeobject
• keystringgerekli

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

• statusstringgerekli

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

• completion_sourcestring | nullgerekli

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

• notestringgerekli
• updated_atstring | nullgerekli

  format: "date-time"

• created_atstringgerekli

  format: "date-time"

• updated_atstringgerekli

  format: "date-time"

curl örneği

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"
  ]
}'

Ürün getir

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi

Sözleşmede istek gövdesi belirtilmemiştir.

Başarılı yanıt 200

Başarılı yanıt.

application/json

• valueobject
• dataobjectgerekli
• idstringgerekli

  format: "uuid"

• workspace_idstringgerekli

  format: "uuid"

• namestringgerekli
• slugstringgerekli
• kindstringgerekli

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

• website_urlstring | nullgerekli
• domainsarraygerekli
• Her öğestring
• descriptionstringgerekli
• contextobjectgerekli
• Ek özellikHerhangi bir değer
• brandobjectgerekli
• company_namestring

  maxLength: 160

• logo_urlstring

  Simge: küçük boyutta (e-posta altbilgisi, kayan formlar) kullanılan ve yazı logosu olmadığında başlık olarak gösterilen tek başına işaret.

  maxLength: 2000

• wordmark_urlstring

  Yazı logosu: şirket adının tasarlanmış biçimi; her e-postanın üstünde tek başına gösterilir.

  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

• statusstringgerekli

  deleting: bir kişi tarafından silinmiş; delete_after zamanına kadar geri yüklenebilir, sonra kalıcı olarak kaldırılır.

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

• delete_afterstring | null

  deleting durumundaki ürünün kalıcı olarak kaldırılacağı zaman.

  format: "date-time"

• is_defaultbooleangerekli
• route_readybooleangerekli
• setuparraygerekli
• Her öğeobject
• keystringgerekli

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

• statusstringgerekli

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

• completion_sourcestring | nullgerekli

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

• notestringgerekli
• updated_atstring | nullgerekli

  format: "date-time"

• created_atstringgerekli

  format: "date-time"

• updated_atstringgerekli

  format: "date-time"

curl örneği

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

Ürün güncelle

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi gerekli

application/json

• valueobject
• namestring

  maxLength: 160

• kindstring

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

• website_urlstring | null

  maxLength: 2000

• descriptionstring

  maxLength: 4000

• contextobject
• Ek özellikHerhangi bir değer
• brandobject
• company_namestring

  maxLength: 160

• logo_urlstring

  Simge: küçük boyutta (e-posta altbilgisi, kayan formlar) kullanılan ve yazı logosu olmadığında başlık olarak gösterilen tek başına işaret.

  maxLength: 2000

• wordmark_urlstring

  Yazı logosu: şirket adının tasarlanmış biçimi; her e-postanın üstünde tek başına gösterilir.

  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"

Başarılı yanıt 200

Başarılı yanıt.

application/json

• valueobject
• dataobjectgerekli
• idstringgerekli

  format: "uuid"

• workspace_idstringgerekli

  format: "uuid"

• namestringgerekli
• slugstringgerekli
• kindstringgerekli

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

• website_urlstring | nullgerekli
• domainsarraygerekli
• Her öğestring
• descriptionstringgerekli
• contextobjectgerekli
• Ek özellikHerhangi bir değer
• brandobjectgerekli
• company_namestring

  maxLength: 160

• logo_urlstring

  Simge: küçük boyutta (e-posta altbilgisi, kayan formlar) kullanılan ve yazı logosu olmadığında başlık olarak gösterilen tek başına işaret.

  maxLength: 2000

• wordmark_urlstring

  Yazı logosu: şirket adının tasarlanmış biçimi; her e-postanın üstünde tek başına gösterilir.

  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

• statusstringgerekli

  deleting: bir kişi tarafından silinmiş; delete_after zamanına kadar geri yüklenebilir, sonra kalıcı olarak kaldırılır.

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

• delete_afterstring | null

  deleting durumundaki ürünün kalıcı olarak kaldırılacağı zaman.

  format: "date-time"

• is_defaultbooleangerekli
• route_readybooleangerekli
• setuparraygerekli
• Her öğeobject
• keystringgerekli

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

• statusstringgerekli

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

• completion_sourcestring | nullgerekli

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

• notestringgerekli
• updated_atstring | nullgerekli

  format: "date-time"

• created_atstringgerekli

  format: "date-time"

• updated_atstringgerekli

  format: "date-time"

curl örneği

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"
}'

Silme önizlemesini inceledikten sonra bir ürünü (uygulamadaki bir projeyi) sil. Hemen kullanım dışı kalır (gönderimi durur) ve 24 saat geri yüklenebilir; ardından Banger gönderim alan adlarını ve sahip olduğu tüm satırları kaldırır. Çalışma alanının son etkin ürünü silinemez. Çalışma alanı yöneticisi ve oturum açmış bir oturum gerekir; API anahtarları ve OAuth izinleri reddedilir.

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi gerekli

application/json

• valueobject

  Ek özellik yok

• confirm_namestringgerekli

  Ürünün tam adı.

  minLength: 1 · maxLength: 160

• preview_tokenstringgerekli

  minLength: 64 · maxLength: 64

Başarılı yanıt 202

Ürün kullanım dışıdır ve önce geri yüklenmezse delete_after zamanında kalıcı olarak silinir. İdempotent tekrar aynı sonucu döndürür.

application/json

• valueobject
• dataobjectgerekli
• idstringgerekli

  format: "uuid"

• namestringgerekli
• statusstringgerekli

  enum: "deleting"

• delete_afterstringgerekli

  Ürünün kalıcı olarak silineceği zaman; o zamana kadar geri yüklenebilir.

  format: "date-time"

• next_product_idstringgerekli

  Çalışma alanının şu anki varsayılan ürünü.

  format: "uuid"

• replayedboolean

curl örneği

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"
}'

Hiçbir şeyi silmeden bir ürünün ve sahip olduğu her şeyin silinmesini önizle. Oturum açmış veya kullanıcı tarafından yetkilendirilmiş OAuth kullanan çalışma alanı yöneticisi gerekir.

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi

Sözleşmede istek gövdesi belirtilmemiştir.

Başarılı yanıt 200

Ürünü silmenin kaldıracağı ve durduracağı öğeler.

application/json

• valueobject
• dataobjectgerekli
• productobjectgerekli
• idstringgerekli

  format: "uuid"

• namestringgerekli
• is_defaultbooleangerekli
• next_default_productbelirtilmemişgerekli

  Varsayılan ürün silindiğinde çalışma alanının varsayılanı olacak ürün.

• oneOf 1null
• oneOf 2object
• idstringgerekli

  format: "uuid"

• namestringgerekli
• last_productbooleangerekli

  Tek etkin ürün silinemez.

• mailboxesarraygerekli
• Her öğeobject
• idstringgerekli

  format: "uuid"

• addressstringgerekli
• domainsarraygerekli

  Geri yükleme süresi dolunca Banger’ın kaldıracağı gönderim alan adları.

• Her öğeobject
• idstringgerekli

  format: "uuid"

• domainstringgerekli
• journeysintegergerekli
• broadcastsintegergerekli
• signup_formsintegergerekli
• contactsintegergerekli
• api_keysintegergerekli
• webhooksintegergerekli
• pending_sendsintegergerekli
• impactarraygerekli
• Her öğestring
• preview_tokenstringgerekli

curl örneği

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

Silinen ürünü delete_after öncesinde geri yükle. Posta kutuları, Akışlar, kayıt formları, webhook’lar ve entegrasyonlar yeniden açılır; Kampanyalar duraklatılmış kalır. Oturum açmış veya kullanıcı tarafından yetkilendirilmiş OAuth kullanan çalışma alanı yöneticisi gerekir.

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi

Sözleşmede istek gövdesi belirtilmemiştir.

Başarılı yanıt 200

Ürün yeniden etkin.

application/json

• valueobject
• dataobjectgerekli
• idstringgerekli

  format: "uuid"

• namestringgerekli
• statusstringgerekli

  enum: "active"

curl örneği

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

Ürün kurulum öğesini güncelle

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi gerekli

application/json

• valueobject
• statusstringgerekli

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

• completion_sourcestring

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

• notestring

  maxLength: 1000

Başarılı yanıt 200

Başarılı yanıt.

application/json

• valueobject
• dataobjectgerekli
• keystringgerekli

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

• statusstringgerekli

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

• completion_sourcestring | nullgerekli

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

• notestringgerekli
• updated_atstring | nullgerekli

  format: "date-time"

curl örneği

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"
}'

Bir alan adını ürünle ilişkilendir

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi gerekli

application/json

• valueobject
• domainstringgerekli

  minLength: 3 · maxLength: 253

Başarılı yanıt 201

Başarılı yanıt.

application/json

• valueobject
• dataobjectgerekli
• idstringgerekli

  format: "uuid"

• workspace_idstringgerekli

  format: "uuid"

• namestringgerekli
• slugstringgerekli
• kindstringgerekli

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

• website_urlstring | nullgerekli
• domainsarraygerekli
• Her öğestring
• descriptionstringgerekli
• contextobjectgerekli
• Ek özellikHerhangi bir değer
• brandobjectgerekli
• company_namestring

  maxLength: 160

• logo_urlstring

  Simge: küçük boyutta (e-posta altbilgisi, kayan formlar) kullanılan ve yazı logosu olmadığında başlık olarak gösterilen tek başına işaret.

  maxLength: 2000

• wordmark_urlstring

  Yazı logosu: şirket adının tasarlanmış biçimi; her e-postanın üstünde tek başına gösterilir.

  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

• statusstringgerekli

  deleting: bir kişi tarafından silinmiş; delete_after zamanına kadar geri yüklenebilir, sonra kalıcı olarak kaldırılır.

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

• delete_afterstring | null

  deleting durumundaki ürünün kalıcı olarak kaldırılacağı zaman.

  format: "date-time"

• is_defaultbooleangerekli
• route_readybooleangerekli
• setuparraygerekli
• Her öğeobject
• keystringgerekli

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

• statusstringgerekli

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

• completion_sourcestring | nullgerekli

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

• notestringgerekli
• updated_atstring | nullgerekli

  format: "date-time"

• created_atstringgerekli

  format: "date-time"

• updated_atstringgerekli

  format: "date-time"

curl örneği

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

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi

Sözleşmede istek gövdesi belirtilmemiştir.

Başarılı yanıt 200

İşlemi yapanın görebildiği posta kutuları.

application/json

• valueobject
• dataarraygerekli
• Her öğeobject
• idstringgerekli

  format: "uuid"

• workspace_idstringgerekli

  format: "uuid"

• product_idstring | null

  Posta kutusunun ait olduğu ürün (proje). İstemciler bununla posta kutularını gruplar ve web uygulaması bağlantıları oluşturur.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringgerekli

  format: "email"

• display_namestringgerekli
• providerstringgerekli

  enum: "gmail", "smtp"

• statusstringgerekli

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringgerekli

  enum: "domain", "starter"

curl örneği

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

Çalışma alanı gönderim alan adında Banger’a özgü bir iş posta kutusu oluştur.

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi gerekli

application/json

• valueobject

  Ek özellik yok

• domain_idstringgerekli

  format: "uuid"

• local_partstringgerekli

  minLength: 1 · maxLength: 64

• display_namestring

  maxLength: 200

Başarılı yanıt 200

Yerel posta kutusu oluşturmanın idempotent tekrarı.

application/json

• valueobject
• dataobjectgerekli
• idstringgerekli

  format: "uuid"

• workspace_idstringgerekli

  format: "uuid"

• product_idstring | null

  Posta kutusunun ait olduğu ürün (proje). İstemciler bununla posta kutularını gruplar ve web uygulaması bağlantıları oluşturur.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringgerekli

  format: "email"

• display_namestringgerekli
• providerstringgerekli

  enum: "gmail", "smtp"

• statusstringgerekli

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringgerekli

  enum: "domain", "starter"

curl örneği

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"
}'

Posta kutusunun kalıcı silinmesini ve bağlı gönderim akışlarını önizle. Çalışma alanı yöneticisi ve ürün kapsamı gerekir.

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi

Sözleşmede istek gövdesi belirtilmemiştir.

Başarılı yanıt 200

Hiçbir şeyi silmeden tam posta kutusu ve silmenin mevcut etkisi.

application/json

• valueobject
• dataobjectgerekli
• mailboxobjectgerekli
• idstringgerekli

  format: "uuid"

• addressstringgerekli
• providerstringgerekli
• domain_idstring | nullgerekli

  format: "uuid"

• provider_connection_idstring | nullgerekli

  format: "uuid"

• messagesintegergerekli
• draftsintegergerekli
• pending_sendsintegergerekli
• broadcastsarraygerekli
• Her öğeobject
• idstringgerekli

  format: "uuid"

• namestringgerekli
• statusstringgerekli
• journeysarraygerekli
• Her öğeobject
• idstringgerekli

  format: "uuid"

• namestringgerekli
• statusstringgerekli
• signup_formsarraygerekli
• Her öğeobject
• idstringgerekli

  format: "uuid"

• namestringgerekli
• statusstringgerekli
• impactarraygerekli
• Her öğestring
• preview_tokenstringgerekli

curl örneği

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

Bir Banger posta kutusundan gelen iletilerde alıcıların gördüğü gönderen adını ayarla ("Name <address>"). Gmail posta kutuları Gmail’de ayarlanan adı korur. Çalışma alanı yöneticisi gerekir.

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi gerekli

application/json

• valueobject

  Ek özellik yok

• display_namestringgerekli

  Tek satır. Boşsa yalnızca adres gönderilir.

  maxLength: 200

Başarılı yanıt 200

Gönderen adıyla birlikte posta kutusu.

application/json

• valueobject
• dataobjectgerekli
• idstringgerekli

  format: "uuid"

• workspace_idstringgerekli

  format: "uuid"

• product_idstring | null

  Posta kutusunun ait olduğu ürün (proje). İstemciler bununla posta kutularını gruplar ve web uygulaması bağlantıları oluşturur.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringgerekli

  format: "email"

• display_namestringgerekli
• providerstringgerekli

  enum: "gmail", "smtp"

• statusstringgerekli

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringgerekli

  enum: "domain", "starter"

curl örneği

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"
}'

Alan adını ve diğer posta kutularını koruyarak bir posta kutusunu kalıcı olarak sil. Çalışma alanı yöneticisi ve ürün kapsamı gerekir.

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi gerekli

application/json

• valueobject

  Ek özellik yok

• confirm_addressstringgerekli

  minLength: 3 · maxLength: 320

• preview_tokenstringgerekli

  minLength: 64 · maxLength: 64

Başarılı yanıt 200

Silindi veya idempotent tekrar. Saklanan dosyalar kalıcı temizleme için kuyruğa alınır.

application/json

• valueobject
• dataobjectgerekli
• idstringgerekli

  format: "uuid"

• addressstringgerekli
• deletedbooleangerekli
• replayedboolean

curl örneği

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"
}'

Aynı ürünün barındırılan gelen kutuları ve çalışma alanının kayıt alıcısıyla sınırlı bir barındırılan posta kutusu oluştur.

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi gerekli

application/json

• valueobject

  Ek özellik yok

• create_newboolean

  İlk posta kutusunu sürdürmek yerine ek bir barındırılan posta kutusu oluştur.

• local_partstring

  @bangermail.com öncesindeki ad. Belirtilmezse posta kutusuna quiet-maple-harbor gibi sözcüklerden oluşan bir ad verilir.

  minLength: 3 · maxLength: 40

• display_namestring

  maxLength: 200

Başarılı yanıt 200

Başlangıç kimliği oluşturmanın idempotent tekrarı.

application/json

• valueobject
• dataobjectgerekli
• idstringgerekli

  format: "uuid"

• workspace_idstringgerekli

  format: "uuid"

• product_idstring | null

  Posta kutusunun ait olduğu ürün (proje). İstemciler bununla posta kutularını gruplar ve web uygulaması bağlantıları oluşturur.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringgerekli

  format: "email"

• display_namestringgerekli
• providerstringgerekli

  enum: "gmail", "smtp"

• statusstringgerekli

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringgerekli

  enum: "domain", "starter"

curl örneği

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’in kendi kendine sürdürme kuralları kapsamında bir posta kutusundaki gönderen itibarı duraklatmasını kaldır.

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi gerekli

application/json

• valueobject

  Ek özellik yok

• acknowledge_recipient_complaintbooleangerekli

  const: true

• reasonstring

  Gönderimin geri yüklenme nedeni; denetim kaydına yazılır.

  maxLength: 500

Başarılı yanıt 200

Posta kutusu yeniden etkinleştirildi veya önceki başarılı istekten sonra zaten etkin.

application/json

• valueobject
• dataobjectgerekli
• idstringgerekli

  format: "uuid"

• workspace_idstringgerekli

  format: "uuid"

• product_idstring | null

  Posta kutusunun ait olduğu ürün (proje). İstemciler bununla posta kutularını gruplar ve web uygulaması bağlantıları oluşturur.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringgerekli

  format: "email"

• display_namestringgerekli
• providerstringgerekli

  enum: "gmail", "smtp"

• statusstringgerekli

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringgerekli

  enum: "domain", "starter"

curl örneği

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

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi

Sözleşmede istek gövdesi belirtilmemiştir.

Başarılı yanıt 200

Başarılı yanıt.

application/json

• valueobject
• dataarraygerekli
• Her öğeobject
• idstringgerekli

  format: "uuid"

• mailbox_idstringgerekli

  format: "uuid"

• thread_idstring | nullgerekli

  format: "uuid"

• versionintegergerekli
• toarraygerekli
• Her öğeobject
• emailstringgerekli
• namestring
• ccarraygerekli
• Her öğeobject
• emailstringgerekli
• namestring
• bccarraygerekli
• Her öğeobject
• emailstringgerekli
• namestring
• subjectstringgerekli
• body_textstringgerekli
• statusstringgerekli
• created_atstringgerekli

  format: "date-time"

• updated_atstringgerekli

  format: "date-time"

• attachmentsarraygerekli
• Her öğeobject
• idstringgerekli

  format: "uuid"

• filenamestringgerekli
• content_typestringgerekli
• size_bytesintegergerekli
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

curl örneği

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

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi gerekli

application/json

• valueobject

  Ek özellik yok

• mailbox_idstringgerekli

  format: "uuid"

• thread_idstring

  format: "uuid"

• toarray

  maxItems: 500

• Her öğeobject
• namestring
• emailstringgerekli

  format: "email"

• ccarray

  maxItems: 500

• Her öğeobject
• namestring
• emailstringgerekli

  format: "email"

• bccarray

  maxItems: 500

• Her öğeobject
• namestring
• emailstringgerekli

  format: "email"

• subjectstring

  maxLength: 10000

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

Başarılı yanıt 201

Başarılı yanıt.

application/json

• valueobject
• dataobjectgerekli
• idstringgerekli

  format: "uuid"

• mailbox_idstringgerekli

  format: "uuid"

• thread_idstring | nullgerekli

  format: "uuid"

• versionintegergerekli
• toarraygerekli
• Her öğeobject
• emailstringgerekli
• namestring
• ccarraygerekli
• Her öğeobject
• emailstringgerekli
• namestring
• bccarraygerekli
• Her öğeobject
• emailstringgerekli
• namestring
• subjectstringgerekli
• body_textstringgerekli
• statusstringgerekli
• created_atstringgerekli

  format: "date-time"

• updated_atstringgerekli

  format: "date-time"

• attachmentsarraygerekli
• Her öğeobject
• idstringgerekli

  format: "uuid"

• filenamestringgerekli
• content_typestringgerekli
• size_bytesintegergerekli
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

curl örneği

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

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi

Sözleşmede istek gövdesi belirtilmemiştir.

Başarılı yanıt 200

Teslim edilebilirliğin esas performansı, sağlığı ve olayları.

application/json

• valueobject
• dataobjectgerekli
• idstringgerekli

  format: "uuid"

• mailbox_idstringgerekli

  format: "uuid"

• thread_idstring | nullgerekli

  format: "uuid"

• versionintegergerekli
• toarraygerekli
• Her öğeobject
• emailstringgerekli
• namestring
• ccarraygerekli
• Her öğeobject
• emailstringgerekli
• namestring
• bccarraygerekli
• Her öğeobject
• emailstringgerekli
• namestring
• subjectstringgerekli
• body_textstringgerekli
• statusstringgerekli
• created_atstringgerekli

  format: "date-time"

• updated_atstringgerekli

  format: "date-time"

• attachmentsarraygerekli
• Her öğeobject
• idstringgerekli

  format: "uuid"

• filenamestringgerekli
• content_typestringgerekli
• size_bytesintegergerekli
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

curl örneği

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

updateDraft

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi gerekli

application/json

• valuebelirtilmemiş
• allOf 1object

  Ek özellik yok

• mailbox_idstringgerekli

  format: "uuid"

• thread_idstring

  format: "uuid"

• toarray

  maxItems: 500

• Her öğeobject
• namestring
• emailstringgerekli

  format: "email"

• ccarray

  maxItems: 500

• Her öğeobject
• namestring
• emailstringgerekli

  format: "email"

• bccarray

  maxItems: 500

• Her öğeobject
• namestring
• emailstringgerekli

  format: "email"

• subjectstring

  maxLength: 10000

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

• allOf 2object
• versionintegergerekli

  minimum: 1

Başarılı yanıt 200

Başarılı yanıt.

application/json

• valueobject
• dataobjectgerekli
• idstringgerekli

  format: "uuid"

• mailbox_idstringgerekli

  format: "uuid"

• thread_idstring | nullgerekli

  format: "uuid"

• versionintegergerekli
• toarraygerekli
• Her öğeobject
• emailstringgerekli
• namestring
• ccarraygerekli
• Her öğeobject
• emailstringgerekli
• namestring
• bccarraygerekli
• Her öğeobject
• emailstringgerekli
• namestring
• subjectstringgerekli
• body_textstringgerekli
• statusstringgerekli
• created_atstringgerekli

  format: "date-time"

• updated_atstringgerekli

  format: "date-time"

• attachmentsarraygerekli
• Her öğeobject
• idstringgerekli

  format: "uuid"

• filenamestringgerekli
• content_typestringgerekli
• size_bytesintegergerekli
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

curl örneği

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

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi

Sözleşmede istek gövdesi belirtilmemiştir.

Başarılı yanıt 204

Taslak ve başvurulan nesneler silinmek üzere planlandı.

Yanıt gövdesi yok.

curl örneği

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

sendDraft

Taslağı, çağıranın erişebildiği kendi posta kutusundan gönderir. Gönderimleri onay gerektiren çağıran bunun yerine bekleyen bir onay alır; taslağı doğrudan gönderebilecek bir kişi karar verir.

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi

Sözleşmede istek gövdesi belirtilmemiştir.

Başarılı yanıt 202

Gönderim kuyrukta veya onay bekliyor.

application/json

• valueobject
• databelirtilmemişgerekli
• oneOf 1object
• idstringgerekli

  format: "uuid"

• typestringgerekli
• statusstringgerekli

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

• workspace_revisionintegergerekli

  format: "int64"

• created_atstringgerekli

  format: "date-time"

• oneOf 2object

  Ek özellik yok

• approvalobjectgerekli
• idstringgerekli

  format: "uuid"

• requested_by_actor_idstringgerekli
• action_kindstringgerekli
• summarystringgerekli
• capability_scopesarraygerekli
• Her öğestring
• resource_scopeobjectgerekli
• Ek özellikarray
• Her öğestring

  Daha fazla iç içe yapı atlandı

• payloadobjectgerekli
• Ek özellikHerhangi bir değer
• payload_sha256stringgerekli

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

• statusstringgerekli

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

• missedbooleangerekli
• expires_atstringgerekli

  format: "date-time"

• decided_by_actor_idstring | null
• decision_reasonstring | null
• created_atstringgerekli

  format: "date-time"

• updated_atstringgerekli

  format: "date-time"

• decided_atstring | null

  format: "date-time"

• execution_job_idstring

  format: "uuid"

• reviewobject

  Ek özellik yok

• dispositionstringgerekli

  enum: "automatic", "human_required"

• recipient_countinteger | nullgerekli

  minimum: 0

• reasonsarraygerekli
• Her öğestring

  Daha fazla iç içe yapı atlandı

• checksarraygerekli
• Her öğestring

  Daha fazla iç içe yapı atlandı

curl örneği

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

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi gerekli

application/octet-stream

• valuestring

  format: "binary" · maxLength: 26214400

Başarılı yanıt 201

Başarılı yanıt.

application/json

• valueobject
• dataobjectgerekli
• idstringgerekli

  format: "uuid"

• filenamestringgerekli
• content_typestringgerekli
• size_bytesintegergerekli
• sha256string
• created_atstring

  format: "date-time"

curl örneği

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

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi

Sözleşmede istek gövdesi belirtilmemiştir.

Başarılı yanıt 204

Ek, sürümleri dikkate alan B2 silmesi için planlandı.

Yanıt gövdesi yok.

curl örneği

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

Taslağın HTML gövdesini oku

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi

Sözleşmede istek gövdesi belirtilmemiştir.

Başarılı yanıt 200

Taslak HTML’i.

text/html

• valuestring

curl örneği

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

listSendIntents

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi

Sözleşmede istek gövdesi belirtilmemiştir.

Başarılı yanıt 200

Son esas gönderimler ve sağlayıcı durumları.

application/json

• valueobject
• dataarraygerekli
• Her öğeobject

  Ek özellik yok

• idstringgerekli

  format: "uuid"

• statusstringgerekli

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

• traffic_classstringgerekli

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

• recipient_countintegergerekli

  minimum: 1

• provider_keystringgerekli
• provider_statestringgerekli

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

• provider_message_idstring | null
• error_codestring | null
• created_atstringgerekli

  format: "date-time"

• updated_atstringgerekli

  format: "date-time"

• completed_atstring | null

  format: "date-time"

curl örneği

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

getSendIntent

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi

Sözleşmede istek gövdesi belirtilmemiştir.

Başarılı yanıt 200

Asenkron gönderimin esas durumu.

application/json

• valueobject
• dataobjectgerekli

  Ek özellik yok

• idstringgerekli

  format: "uuid"

• statusstringgerekli

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

• traffic_classstringgerekli

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

• recipient_countintegergerekli

  minimum: 1

• provider_keystringgerekli
• provider_statestringgerekli

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

• provider_message_idstring | null
• error_codestring | null
• created_atstringgerekli

  format: "date-time"

• updated_atstringgerekli

  format: "date-time"

• completed_atstring | null

  format: "date-time"

curl örneği

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

listTransactionalSends

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi

Sözleşmede istek gövdesi belirtilmemiştir.

Başarılı yanıt 200

Başarılı yanıt.

application/json

• valueobject
• dataarraygerekli
• Her öğeobject
• idstringgerekli

  format: "uuid"

• mailbox_idstring | nullgerekli

  format: "uuid"

• command_idstring | nullgerekli

  format: "uuid"

• statusstringgerekli
• command_statusstring | nullgerekli
• subjectstring
• recipientsarray
• Her öğeobject
• emailstringgerekli
• namestring
• recipient_countintegergerekli
• error_codestring | null
• send_intent_idstring

  format: "uuid"

• providerstring | null
• route_kindstring | null
• sourcestring
• from_addressstring
• recipient_statesobject
• Ek özellikinteger
• provider_message_idstring | null
• languagebelirtilmemiş

  Bu e-postanın gönderildiği dil; çevrilmediyse null.

• anyOf 1object

  Bir kişinin e-postayı aldığı dil. Yalnızca çevrilmiş (managed-content) e-postalarda bulunur.

• localestringgerekli

  E-postanın yazıldığı dilin BCP 47 etiketi.

• requested_localestring

  Yalnızca başka dilde gönderilmiş eski bir gönderimde bulunur: kişinin alması gereken dil.

• fallback_reasonstring

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

• anyOf 2null
• journeyobject | null

  Bu e-postayı gönderen Akış adımı ve kaydı; diğer gönderimlerde null.

• journey_idstringgerekli

  format: "uuid"

• step_idstringgerekli

  format: "uuid"

• enrollment_idstringgerekli

  format: "uuid"

• experimentobject | null

  Bu e-postanın deney varyantı; uygulanmadıysa null.

• experiment_idstringgerekli

  format: "uuid"

• variant_keystringgerekli
• created_atstringgerekli

  format: "date-time"

• updated_atstringgerekli

  format: "date-time"

• completed_atstring | nullgerekli

  format: "date-time"

• template_idstring | null

  format: "uuid"

• template_versioninteger | null
• workspace_revisioninteger | null
• command_resultobject
• Ek özellikHerhangi bir değer
• command_started_atstring | null

  format: "date-time"

• command_completed_atstring | null

  format: "date-time"

• body_textstring
• body_htmlstring
• reply_toarray
• Her öğeobject
• emailstringgerekli
• namestring
• headersobject
• Ek özellikstring
• tagsarray
• Her öğeobject
• namestringgerekli
• valuestringgerekli

curl örneği

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

createTransactionalSend

Her Akış gönderiminde bir alıcı. To, herhangi bir RecipientInput biçiminde bir alıcı alır ("a@example.com", "Pat <a@example.com>", { email, name } veya tek öğeli liste); Cc ve Bcc boş olmalıdır. reply_to varsayılan olarak Akışın posta kutusudur (boş liste de varsayılan demektir); Ürün e-postası tam bir tane gerektirir. Yeni bir API Akışı varsayılan olarak yönetilen kaynak içerik kullanır; eski kod Akışları tam içerikli gönderimleri korur. Ret (4xx) alıcı için hiçbir şeyi sabitlemez, dolayısıyla yeni idempotency anahtarıyla düzeltilmiş çağrı gönderir.

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi gerekli

application/json

• valueobject
• mailbox_idstringgerekli

  format: "uuid"

• tobelirtilmemişgerekli

  to, cc, bcc ve reply_to alıcıları: bir adres ("a@example.com" veya "Pat <a@example.com>"), { email, name } nesnesi veya ikisini karıştıran liste. Banger bunları e-postası küçük harfe çevrilmiş { email, name } nesneleri olarak saklar. İdempotency karması gövdenin gönderilen biçimini kapsar; aynı biçimle yeniden dene.

• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringgerekli

  format: "email"

• oneOf 3array

  maxItems: 500

• Her öğebelirtilmemiş
• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringgerekli

  format: "email"

• ccarray

  maxItems: 0

• Her öğeobject
• namestring
• emailstringgerekli

  format: "email"

• bccarray

  maxItems: 0

• Her öğeobject
• namestring
• emailstringgerekli

  format: "email"

• subjectstring

  maxLength: 10000

• expires_atstring

  Ertelenmiş Akış gönderimini bu andan sonra iptal et; ilk istekten itibaren en fazla yedi gün.

  format: "date-time"

• expires_after_secondsinteger

  minimum: 1 · maximum: 604800

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

• reply_tobelirtilmemiş

  to, cc, bcc ve reply_to alıcıları: bir adres ("a@example.com" veya "Pat <a@example.com>"), { email, name } nesnesi veya ikisini karıştıran liste. Banger bunları e-postası küçük harfe çevrilmiş { email, name } nesneleri olarak saklar. İdempotency karması gövdenin gönderilen biçimini kapsar; aynı biçimle yeniden dene.

• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringgerekli

  format: "email"

• oneOf 3array

  maxItems: 500

• Her öğebelirtilmemiş
• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringgerekli

  format: "email"

• headersobject
• Ek özellikstring

  maxLength: 5000

• tagsarray

  maxItems: 49

• Her öğeobject

  Ek özellik yok

• namestringgerekli

  minLength: 1 · maxLength: 256

• valuestringgerekli

  minLength: 1 · maxLength: 256

Başarılı yanıt 202

Başarılı yanıt.

application/json

• valueobject
• dataobjectgerekli
• action_kindstringgerekli

  enum: "transactional.send"

• idstring

  format: "uuid"

• send_intent_idstring

  format: "uuid"

• provider_attempt_idstring

  format: "uuid"

• statusstringgerekli

  Teslimattan sent/queued durumları veya sabitlenmiş istek için: deferred (politikayla ya da çeviri beklemesiyle planlanmış), processing (gönderiliyor), discarded.

• replayedboolean
• journeybelirtilmemişgerekli
• anyOf 1object
• journey_idstringgerekli

  format: "uuid"

• enrollment_idstringgerekli

  format: "uuid"

• step_idstringgerekli

  format: "uuid"

• step_positionintegergerekli
• originstring

  enum: "journey"

• journey_identitystring
• anyOf 2null
• ignored_variablesarraygerekli
• Her öğestring
• scheduled_atstring

  format: "date-time"

• reasonstring
• communication_reservation_idstring

  format: "uuid"

curl örneği

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

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi

Sözleşmede istek gövdesi belirtilmemiştir.

Başarılı yanıt 200

Başarılı yanıt.

application/json

• valueobject
• dataobjectgerekli
• idstringgerekli

  format: "uuid"

• mailbox_idstring | nullgerekli

  format: "uuid"

• command_idstring | nullgerekli

  format: "uuid"

• statusstringgerekli
• command_statusstring | nullgerekli
• subjectstring
• recipientsarray
• Her öğeobject
• emailstringgerekli
• namestring
• recipient_countintegergerekli
• error_codestring | null
• send_intent_idstring

  format: "uuid"

• providerstring | null
• route_kindstring | null
• sourcestring
• from_addressstring
• recipient_statesobject
• Ek özellikinteger
• provider_message_idstring | null
• languagebelirtilmemiş

  Bu e-postanın gönderildiği dil; çevrilmediyse null.

• anyOf 1object

  Bir kişinin e-postayı aldığı dil. Yalnızca çevrilmiş (managed-content) e-postalarda bulunur.

• localestringgerekli

  E-postanın yazıldığı dilin BCP 47 etiketi.

• requested_localestring

  Yalnızca başka dilde gönderilmiş eski bir gönderimde bulunur: kişinin alması gereken dil.

• fallback_reasonstring

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

• anyOf 2null
• journeyobject | null

  Bu e-postayı gönderen Akış adımı ve kaydı; diğer gönderimlerde null.

• journey_idstringgerekli

  format: "uuid"

• step_idstringgerekli

  format: "uuid"

• enrollment_idstringgerekli

  format: "uuid"

• experimentobject | null

  Bu e-postanın deney varyantı; uygulanmadıysa null.

• experiment_idstringgerekli

  format: "uuid"

• variant_keystringgerekli
• created_atstringgerekli

  format: "date-time"

• updated_atstringgerekli

  format: "date-time"

• completed_atstring | nullgerekli

  format: "date-time"

• template_idstring | null

  format: "uuid"

• template_versioninteger | null
• workspace_revisioninteger | null
• command_resultobject
• Ek özellikHerhangi bir değer
• command_started_atstring | null

  format: "date-time"

• command_completed_atstring | null

  format: "date-time"

• body_textstring
• body_htmlstring
• reply_toarray
• Her öğeobject
• emailstringgerekli
• namestring
• headersobject
• Ek özellikstring
• tagsarray
• Her öğeobject
• namestringgerekli
• valuestringgerekli

curl örneği

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

listTransactionalSendTimeline

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi

Sözleşmede istek gövdesi belirtilmemiştir.

Başarılı yanıt 200

Kabul, sağlayıcı denemesi ve alıcı olaylarının sıralı zaman çizelgesi.

application/json

• valueobject
• dataarraygerekli
• Her öğeobject
• occurred_atstringgerekli

  format: "date-time"

• event_typestringgerekli
• labelstringgerekli
• providerstring | null
• recipient_domainstring | null
• error_codestring | null

curl örneği

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

retryTransactionalSend

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi

Sözleşmede istek gövdesi belirtilmemiştir.

Başarılı yanıt 202

Başarılı yanıt.

application/json

• valueobject
• dataobjectgerekli
• action_kindstringgerekli

  enum: "transactional.send"

• idstringgerekli

  format: "uuid"

• send_intent_idstringgerekli

  format: "uuid"

• provider_attempt_idstringgerekli

  format: "uuid"

• statusstringgerekli
• replayedbooleangerekli

curl örneği

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

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi

Sözleşmede istek gövdesi belirtilmemiştir.

Başarılı yanıt 200

Anahtar tabanlı sayfalanmış çalışma alanı konuşmaları.

application/json

• valueobject
• dataarraygerekli
• Her öğeobject
• idstringgerekli

  format: "uuid"

• mailbox_idstringgerekli

  format: "uuid"

• subjectstringgerekli
• snippetstringgerekli
• last_message_atstringgerekli

  format: "date-time"

• message_countintegergerekli
• unread_countintegergerekli
• is_archivedbooleangerekli
• is_trashbooleangerekli
• is_spambooleangerekli
• is_starredbooleangerekli
• is_sentbooleangerekli
• has_attachmentsbooleangerekli
• labelsarraygerekli
• Her öğestring
• participantsarray
• Her öğeobject
• namestring
• emailstringgerekli

  format: "email"

• pageobjectgerekli
• next_cursorstring
• has_morebooleangerekli

curl örneği

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

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi

Sözleşmede istek gövdesi belirtilmemiştir.

Başarılı yanıt 200

Konuşma ve sıralı iletiler.

application/json

• valueobject
• databelirtilmemişgerekli
• allOf 1object
• idstringgerekli

  format: "uuid"

• mailbox_idstringgerekli

  format: "uuid"

• subjectstringgerekli
• snippetstringgerekli
• last_message_atstringgerekli

  format: "date-time"

• message_countintegergerekli
• unread_countintegergerekli
• is_archivedbooleangerekli
• is_trashbooleangerekli
• is_spambooleangerekli
• is_starredbooleangerekli
• is_sentbooleangerekli
• has_attachmentsbooleangerekli
• labelsarraygerekli
• Her öğestring
• participantsarray
• Her öğeobject
• namestring
• emailstringgerekli

  format: "email"

• allOf 2object
• messagesarraygerekli
• Her öğeobject
• idstringgerekli

  format: "uuid"

• mailbox_idstringgerekli

  format: "uuid"

• thread_idstringgerekli

  format: "uuid"

• sent_atstringgerekli

  format: "date-time"

• received_atstring

  format: "date-time"

• envelope_recipientsarray

  Yalnızca alma amaçlı takma ad yönlendirmesinden önce SMTP kenarında harf büyüklüğü normalleştirilmiş özgün SMTP zarf alıcıları. Eski iletilerde veya SMTP dışı kaynaklarda boş. Görünür To/Cc üstbilgilerinden bağımsızdır.

• Her öğestring

  format: "email"

  Daha fazla iç içe yapı atlandı

• fromobjectgerekli
• namestring

  Daha fazla iç içe yapı atlandı

• emailstringgerekli

  format: "email"

  Daha fazla iç içe yapı atlandı

• toarraygerekli
• Her öğeobject

  Daha fazla iç içe yapı atlandı

• ccarray
• Her öğeobject

  Daha fazla iç içe yapı atlandı

• reply_toarray
• Her öğeobject

  Daha fazla iç içe yapı atlandı

• is_sentboolean

  Bu iletinin, takma ad dahil, posta kutusundan gönderilip gönderilmediği.

• body_textstring
• body_html_urlstring

  format: "uri"

• reply_originobject
• send_intent_idstringgerekli

  format: "uuid"

  Daha fazla iç içe yapı atlandı

• sourcestringgerekli

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

  Daha fazla iç içe yapı atlandı

• source_idstring

  format: "uuid"

  Daha fazla iç içe yapı atlandı

• traffic_classstringgerekli

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

  Daha fazla iç içe yapı atlandı

• kindstringgerekli

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

  Daha fazla iç içe yapı atlandı

• namestring

  Daha fazla iç içe yapı atlandı

• has_attachmentsbooleangerekli
• attachmentsarray
• Her öğeobject

  Daha fazla iç içe yapı atlandı

curl örneği

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

getMessageHtml

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi

Sözleşmede istek gövdesi belirtilmemiştir.

Başarılı yanıt 200

Kimliği doğrulanmış, sandbox ile sınırlandırılmış HTML ileti gövdesi.

text/html

• valuestring

curl örneği

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

downloadAttachment

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi

Sözleşmede istek gövdesi belirtilmemiştir.

Başarılı yanıt 200

Kimliği doğrulanmış ek akışı.

application/octet-stream

• valuestring

  format: "binary"

curl örneği

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

searchMail

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi

Sözleşmede istek gövdesi belirtilmemiştir.

Başarılı yanıt 200

Çalışma alanı genelindeki arama sonuçları.

application/json

• valueobject
• dataarraygerekli
• Her öğeobject
• idstringgerekli

  format: "uuid"

• mailbox_idstringgerekli

  format: "uuid"

• subjectstringgerekli
• snippetstringgerekli
• last_message_atstringgerekli

  format: "date-time"

• message_countintegergerekli
• unread_countintegergerekli
• is_archivedbooleangerekli
• is_trashbooleangerekli
• is_spambooleangerekli
• is_starredbooleangerekli
• is_sentbooleangerekli
• has_attachmentsbooleangerekli
• labelsarraygerekli
• Her öğestring
• participantsarray
• Her öğeobject
• namestring
• emailstringgerekli

  format: "email"

• pageobjectgerekli
• next_cursorstring
• has_morebooleangerekli

curl örneği

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

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi

Sözleşmede istek gövdesi belirtilmemiştir.

Başarılı yanıt 200

Başarılı yanıt.

application/json

• valueobject
• dataarraygerekli
• Her öğeobject
• idstringgerekli

  format: "uuid"

• emailstringgerekli

  format: "email"

• display_namestring | nullgerekli
• attributesobjectgerekli
• Ek özellikHerhangi bir değer
• statusstringgerekli

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

• created_atstringgerekli

  format: "date-time"

• updated_atstringgerekli

  format: "date-time"

• pageobjectgerekli
• next_cursorstring
• has_morebooleangerekli

curl örneği

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

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi gerekli

application/json

• valueobject

  Ek özellik yok

• emailstringgerekli

  format: "email"

• display_namestring

  maxLength: 1000

• statusstringgerekli

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

• attributesobject
• Ek özellikHerhangi bir değer
• consent_confirmedboolean

  Bir adres yeni abone yapılırken gereklidir.

Başarılı yanıt 201

Başarılı yanıt.

application/json

• valueobject
• dataobjectgerekli
• idstringgerekli

  format: "uuid"

• emailstringgerekli

  format: "email"

• display_namestring | nullgerekli
• attributesobjectgerekli
• Ek özellikHerhangi bir değer
• statusstringgerekli

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

• created_atstringgerekli

  format: "date-time"

• updated_atstringgerekli

  format: "date-time"

curl örneği

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

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi

Sözleşmede istek gövdesi belirtilmemiştir.

Başarılı yanıt 200

Başarılı yanıt.

application/json

• valueobject
• dataobjectgerekli
• idstringgerekli

  format: "uuid"

• emailstringgerekli

  format: "email"

• display_namestring | nullgerekli
• attributesobjectgerekli
• Ek özellikHerhangi bir değer
• statusstringgerekli

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

• created_atstringgerekli

  format: "date-time"

• updated_atstringgerekli

  format: "date-time"

• suppressedbooleangerekli
• suppression_reasonstring | nullgerekli
• sourcesarraygerekli
• Her öğeobject
• kindstringgerekli
• referencestringgerekli
• connection_idstring | nullgerekli

  format: "uuid"

• metadataobjectgerekli
• Ek özellikHerhangi bir değer
• first_seen_atstringgerekli

  format: "date-time"

• last_seen_atstringgerekli

  format: "date-time"

• listsarraygerekli
• Her öğeobject
• idstringgerekli

  format: "uuid"

• namestringgerekli
• subscription_statusstringgerekli
• consent_evidencearraygerekli
• Her öğeobject
• kindstringgerekli
• referencestringgerekli
• connection_idstring | nullgerekli

  format: "uuid"

• metadataobjectgerekli
• Ek özellikHerhangi bir değer
• first_seen_atstringgerekli

  format: "date-time"

• last_seen_atstringgerekli

  format: "date-time"

curl örneği

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

deleteContact

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi

Sözleşmede istek gövdesi belirtilmemiştir.

Başarılı yanıt 204

Kişi silindi.

Yanıt gövdesi yok.

curl örneği

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

listContactImports

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi

Sözleşmede istek gövdesi belirtilmemiştir.

Başarılı yanıt 200

Başarılı yanıt.

application/json

• valueobject
• dataarraygerekli
• Her öğeobject
• idstring

  format: "uuid"

• filenamestring
• list_idstring | null

  format: "uuid"

• list_namestring | null
• statusstring
• total_rowsinteger
• imported_rowsinteger
• invalid_rowsinteger
• error_summaryarray
• Her öğestring
• 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 örneği

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

importContacts

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi gerekli

application/json

• valueobject
• filenamestringgerekli

  minLength: 1 · maxLength: 500

• list_idstring

  format: "uuid"

• consent_confirmedboolean

  İçe aktarılan herhangi bir satır aboneyse gereklidir.

• rowsarraygerekli

  minItems: 1 · maxItems: 5000

• Her öğeobject
• emailstringgerekli

  format: "email"

• display_namestring

  maxLength: 1000

• statusstring

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

• attributesobject
• Ek özellikHerhangi bir değer

Başarılı yanıt 201

Başarılı yanıt.

application/json

• valueobject
• dataobjectgerekli
• idstringgerekli

  format: "uuid"

• statusstringgerekli

  enum: "queued"

• total_rowsintegergerekli
• imported_rowsintegergerekli
• invalid_rowsintegergerekli
• list_idstring | nullgerekli

  format: "uuid"

curl örneği

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": {}
    }
  ]
}'

Aboneliği veya onayı değiştirmeden türlenmiş öznitelikleri birleştir

contacts:write ve contacts:read gerekir. Yalnızca mevcut kişiyi günceller. Atlanan öznitelikler korunur, açık false saklanır ve null alanı kaldırır. Doğrulanmış kaynak bilgileri sağla; eksik veri false değildir. Abonelik, engelleme, kimlik ve kaynak geçmişi değişmez.

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi gerekli

application/json

• valueobject

  Ek özellik yok

• attributesobjectgerekli
• Ek özellikHerhangi bir değer

Başarılı yanıt 200

Kişinin güncel geri okuması; bu değişiklik önceden uygulandıysa replayed true olur.

application/json

• valueobject
• dataobjectgerekli
• idstringgerekli

  format: "uuid"

• attributesobjectgerekli
• Ek özellikHerhangi bir değer
• statusstringgerekli

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

• replayedbooleangerekli
• Ek özellikHerhangi bir değer

curl örneği

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

Kimlik doğrulama: Bearer çalışma alanı API anahtarı.

Parametreler

İstek gövdesi gerekli

application/json

• valueobject

  Ek özellik yok

• emailstringgerekli

  format: "email" · maxLength: 320

• display_namestring

  minLength: 0 · maxLength: 1000

• attributesobject
• Ek özellikHerhangi bir değer
• statusstringgerekli

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

• consent_evidenceobject

  Ek özellik yok

• sourcestring

  minLength: 1 · maxLength: 2000

• referencestring

  minLength: 1 · maxLength: 2000

• observed_atstring

  format: "date-time"

• statementstring

  minLength: 1 · maxLength: 2000

• consent_confirmedboolean

Başarılı yanıt 200

Esas geri okuma veya idempotent alındı. Sağlayıcı kabulü sent durumudur; delivered bir teslimat olayı gerektirir ve gelen kutusuna yerleştiğini kanıtlamaz.

application/json

• valueobject
• databelirtilmemişgerekli
• allOf 1object
• idstringgerekli

  format: "uuid"

• emailstringgerekli

  format: "email"

• display_namestring | nullgerekli
• attributesobjectgerekli
• Ek özellikHerhangi bir değer
• statusstringgerekli

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

• created_atstringgerekli

  format: "date-time"

• updated_atstringgerekli

  format: "date-time"

• suppressedbooleangerekli
• suppression_reasonstring | nullgerekli
• sourcesarraygerekli
• Her öğeobject
• kindstringgerekli
• referencestringgerekli
• connection_idstring | nullgerekli

  format: "uuid"

• metadataobjectgerekli
• Ek özellikHerhangi bir değer
• first_seen_atstringgerekli

  format: "date-time"

• last_seen_atstringgerekli

  format: "date-time"

• listsarraygerekli
• Her öğeobject
• idstringgerekli

  format: "uuid"

• namestringgerekli
• subscription_statusstringgerekli
• consent_evidencearraygerekli
• Her öğeobject
• kindstringgerekli
• referencestringgerekli
• connection_idstring | nullgerekli

  format: "uuid"

• metadataobjectgerekli
• Ek özellikHerhangi bir değer
• first_seen_atstringgerekli

  format: "date-time"

• last_seen_atstringgerekli

  format: "date-time"

• allOf 2object
• replayedbooleangerekli