Referensi Banger API

Daftar produk ruang kerja

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan

Kontrak tidak menentukan isi permintaan.

Respons berhasil 200

Respons berhasil.

application/json

• valueobject
• dataarraywajib
• Setiap itemobject
• idstringwajib

  format: "uuid"

• workspace_idstringwajib

  format: "uuid"

• namestringwajib
• slugstringwajib
• kindstringwajib

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

• website_urlstring | nullwajib
• domainsarraywajib
• Setiap itemstring
• descriptionstringwajib
• contextobjectwajib
• Properti tambahanNilai apa pun
• brandobjectwajib
• company_namestring

  maxLength: 160

• logo_urlstring

  Ikon: simbol tersendiri, digunakan dalam ukuran kecil (footer email, formulir slide-in) dan sebagai header saat tidak ada logo teks.

  maxLength: 2000

• wordmark_urlstring

  Logo teks: nama perusahaan dalam bentuk desainnya, ditampilkan sendiri di bagian atas setiap email.

  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

• statusstringwajib

  deleting: dihapus oleh seseorang; dapat dipulihkan hingga delete_after, lalu dihapus permanen.

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

• delete_afterstring | null

  Waktu produk berstatus deleting dihapus permanen.

  format: "date-time"

• is_defaultbooleanwajib
• route_readybooleanwajib
• setuparraywajib
• Setiap itemobject
• keystringwajib

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

• statusstringwajib

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

• completion_sourcestring | nullwajib

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

• notestringwajib
• updated_atstring | nullwajib

  format: "date-time"

• created_atstringwajib

  format: "date-time"

• updated_atstringwajib

  format: "date-time"

Contoh curl

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

Buat produk

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan wajib

application/json

• valueobject
• namestringwajib

  minLength: 1 · maxLength: 160

• kindstring

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

• website_urlstring | null

  maxLength: 2000

• descriptionstring

  maxLength: 4000

• contextobject
• Properti tambahanNilai apa pun
• domainsarray

  maxItems: 20

• Setiap itemstring

  maxLength: 253

Respons berhasil 201

Respons berhasil.

application/json

• valueobject
• dataobjectwajib
• idstringwajib

  format: "uuid"

• workspace_idstringwajib

  format: "uuid"

• namestringwajib
• slugstringwajib
• kindstringwajib

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

• website_urlstring | nullwajib
• domainsarraywajib
• Setiap itemstring
• descriptionstringwajib
• contextobjectwajib
• Properti tambahanNilai apa pun
• brandobjectwajib
• company_namestring

  maxLength: 160

• logo_urlstring

  Ikon: simbol tersendiri, digunakan dalam ukuran kecil (footer email, formulir slide-in) dan sebagai header saat tidak ada logo teks.

  maxLength: 2000

• wordmark_urlstring

  Logo teks: nama perusahaan dalam bentuk desainnya, ditampilkan sendiri di bagian atas setiap email.

  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

• statusstringwajib

  deleting: dihapus oleh seseorang; dapat dipulihkan hingga delete_after, lalu dihapus permanen.

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

• delete_afterstring | null

  Waktu produk berstatus deleting dihapus permanen.

  format: "date-time"

• is_defaultbooleanwajib
• route_readybooleanwajib
• setuparraywajib
• Setiap itemobject
• keystringwajib

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

• statusstringwajib

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

• completion_sourcestring | nullwajib

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

• notestringwajib
• updated_atstring | nullwajib

  format: "date-time"

• created_atstringwajib

  format: "date-time"

• updated_atstringwajib

  format: "date-time"

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

Ambil produk

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan

Kontrak tidak menentukan isi permintaan.

Respons berhasil 200

Respons berhasil.

application/json

• valueobject
• dataobjectwajib
• idstringwajib

  format: "uuid"

• workspace_idstringwajib

  format: "uuid"

• namestringwajib
• slugstringwajib
• kindstringwajib

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

• website_urlstring | nullwajib
• domainsarraywajib
• Setiap itemstring
• descriptionstringwajib
• contextobjectwajib
• Properti tambahanNilai apa pun
• brandobjectwajib
• company_namestring

  maxLength: 160

• logo_urlstring

  Ikon: simbol tersendiri, digunakan dalam ukuran kecil (footer email, formulir slide-in) dan sebagai header saat tidak ada logo teks.

  maxLength: 2000

• wordmark_urlstring

  Logo teks: nama perusahaan dalam bentuk desainnya, ditampilkan sendiri di bagian atas setiap email.

  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

• statusstringwajib

  deleting: dihapus oleh seseorang; dapat dipulihkan hingga delete_after, lalu dihapus permanen.

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

• delete_afterstring | null

  Waktu produk berstatus deleting dihapus permanen.

  format: "date-time"

• is_defaultbooleanwajib
• route_readybooleanwajib
• setuparraywajib
• Setiap itemobject
• keystringwajib

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

• statusstringwajib

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

• completion_sourcestring | nullwajib

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

• notestringwajib
• updated_atstring | nullwajib

  format: "date-time"

• created_atstringwajib

  format: "date-time"

• updated_atstringwajib

  format: "date-time"

Contoh curl

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

Perbarui produk

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan wajib

application/json

• valueobject
• namestring

  maxLength: 160

• kindstring

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

• website_urlstring | null

  maxLength: 2000

• descriptionstring

  maxLength: 4000

• contextobject
• Properti tambahanNilai apa pun
• brandobject
• company_namestring

  maxLength: 160

• logo_urlstring

  Ikon: simbol tersendiri, digunakan dalam ukuran kecil (footer email, formulir slide-in) dan sebagai header saat tidak ada logo teks.

  maxLength: 2000

• wordmark_urlstring

  Logo teks: nama perusahaan dalam bentuk desainnya, ditampilkan sendiri di bagian atas setiap email.

  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"

Respons berhasil 200

Respons berhasil.

application/json

• valueobject
• dataobjectwajib
• idstringwajib

  format: "uuid"

• workspace_idstringwajib

  format: "uuid"

• namestringwajib
• slugstringwajib
• kindstringwajib

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

• website_urlstring | nullwajib
• domainsarraywajib
• Setiap itemstring
• descriptionstringwajib
• contextobjectwajib
• Properti tambahanNilai apa pun
• brandobjectwajib
• company_namestring

  maxLength: 160

• logo_urlstring

  Ikon: simbol tersendiri, digunakan dalam ukuran kecil (footer email, formulir slide-in) dan sebagai header saat tidak ada logo teks.

  maxLength: 2000

• wordmark_urlstring

  Logo teks: nama perusahaan dalam bentuk desainnya, ditampilkan sendiri di bagian atas setiap email.

  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

• statusstringwajib

  deleting: dihapus oleh seseorang; dapat dipulihkan hingga delete_after, lalu dihapus permanen.

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

• delete_afterstring | null

  Waktu produk berstatus deleting dihapus permanen.

  format: "date-time"

• is_defaultbooleanwajib
• route_readybooleanwajib
• setuparraywajib
• Setiap itemobject
• keystringwajib

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

• statusstringwajib

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

• completion_sourcestring | nullwajib

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

• notestringwajib
• updated_atstring | nullwajib

  format: "date-time"

• created_atstringwajib

  format: "date-time"

• updated_atstringwajib

  format: "date-time"

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

Hapus satu produk (proyek di aplikasi) setelah meninjau pratinjau penghapusannya. Produk langsung berhenti digunakan (pengirimannya berhenti) dan dapat dipulihkan selama 24 jam; lalu Banger menghapus domain pengiriman dan setiap baris miliknya. Produk aktif terakhir di ruang kerja tidak dapat dihapus. Memerlukan admin ruang kerja dan sesi yang sudah masuk; kunci API dan izin OAuth ditolak.

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan wajib

application/json

• valueobject

  Tidak ada properti tambahan

• confirm_namestringwajib

  Nama produk yang persis.

  minLength: 1 · maxLength: 160

• preview_tokenstringwajib

  minLength: 64 · maxLength: 64

Respons berhasil 202

Produk tidak digunakan dan akan dihapus permanen pada delete_after kecuali dipulihkan lebih dulu. Pengulangan idempoten mengembalikan hasil yang sama.

application/json

• valueobject
• dataobjectwajib
• idstringwajib

  format: "uuid"

• namestringwajib
• statusstringwajib

  enum: "deleting"

• delete_afterstringwajib

  Waktu produk dihapus permanen; sebelum itu produk dapat dipulihkan.

  format: "date-time"

• next_product_idstringwajib

  Produk default ruang kerja saat ini.

  format: "uuid"

• replayedboolean

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

Pratinjau penghapusan satu produk dan semua miliknya tanpa menghapus apa pun. Memerlukan admin ruang kerja, sudah masuk atau melalui OAuth yang diizinkan pengguna.

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan

Kontrak tidak menentukan isi permintaan.

Respons berhasil 200

Hal yang dihapus dan dihentikan oleh penghapusan produk.

application/json

• valueobject
• dataobjectwajib
• productobjectwajib
• idstringwajib

  format: "uuid"

• namestringwajib
• is_defaultbooleanwajib
• next_default_producttidak ditentukanwajib

  Produk yang menjadi default ruang kerja saat produk default dihapus.

• oneOf 1null
• oneOf 2object
• idstringwajib

  format: "uuid"

• namestringwajib
• last_productbooleanwajib

  Satu-satunya produk aktif tidak dapat dihapus.

• mailboxesarraywajib
• Setiap itemobject
• idstringwajib

  format: "uuid"

• addressstringwajib
• domainsarraywajib

  Domain pengiriman yang dihapus Banger setelah masa pemulihan berlalu.

• Setiap itemobject
• idstringwajib

  format: "uuid"

• domainstringwajib
• journeysintegerwajib
• broadcastsintegerwajib
• signup_formsintegerwajib
• contactsintegerwajib
• api_keysintegerwajib
• webhooksintegerwajib
• pending_sendsintegerwajib
• impactarraywajib
• Setiap itemstring
• preview_tokenstringwajib

Contoh curl

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

Pulihkan produk yang dihapus sebelum delete_after. Kotak surat, Journey, formulir pendaftaran, webhook, dan integrasinya diaktifkan kembali; Kampanye tetap dijeda. Memerlukan admin ruang kerja, sudah masuk atau melalui OAuth yang diizinkan pengguna.

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan

Kontrak tidak menentukan isi permintaan.

Respons berhasil 200

Produk aktif kembali.

application/json

• valueobject
• dataobjectwajib
• idstringwajib

  format: "uuid"

• namestringwajib
• statusstringwajib

  enum: "active"

Contoh curl

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

Perbarui item penyiapan produk

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan wajib

application/json

• valueobject
• statusstringwajib

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

• completion_sourcestring

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

• notestring

  maxLength: 1000

Respons berhasil 200

Respons berhasil.

application/json

• valueobject
• dataobjectwajib
• keystringwajib

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

• statusstringwajib

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

• completion_sourcestring | nullwajib

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

• notestringwajib
• updated_atstring | nullwajib

  format: "date-time"

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

Kaitkan domain dengan produk

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan wajib

application/json

• valueobject
• domainstringwajib

  minLength: 3 · maxLength: 253

Respons berhasil 201

Respons berhasil.

application/json

• valueobject
• dataobjectwajib
• idstringwajib

  format: "uuid"

• workspace_idstringwajib

  format: "uuid"

• namestringwajib
• slugstringwajib
• kindstringwajib

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

• website_urlstring | nullwajib
• domainsarraywajib
• Setiap itemstring
• descriptionstringwajib
• contextobjectwajib
• Properti tambahanNilai apa pun
• brandobjectwajib
• company_namestring

  maxLength: 160

• logo_urlstring

  Ikon: simbol tersendiri, digunakan dalam ukuran kecil (footer email, formulir slide-in) dan sebagai header saat tidak ada logo teks.

  maxLength: 2000

• wordmark_urlstring

  Logo teks: nama perusahaan dalam bentuk desainnya, ditampilkan sendiri di bagian atas setiap email.

  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

• statusstringwajib

  deleting: dihapus oleh seseorang; dapat dipulihkan hingga delete_after, lalu dihapus permanen.

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

• delete_afterstring | null

  Waktu produk berstatus deleting dihapus permanen.

  format: "date-time"

• is_defaultbooleanwajib
• route_readybooleanwajib
• setuparraywajib
• Setiap itemobject
• keystringwajib

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

• statusstringwajib

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

• completion_sourcestring | nullwajib

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

• notestringwajib
• updated_atstring | nullwajib

  format: "date-time"

• created_atstringwajib

  format: "date-time"

• updated_atstringwajib

  format: "date-time"

Contoh 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

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan

Kontrak tidak menentukan isi permintaan.

Respons berhasil 200

Kotak surat yang terlihat oleh pelaku.

application/json

• valueobject
• dataarraywajib
• Setiap itemobject
• idstringwajib

  format: "uuid"

• workspace_idstringwajib

  format: "uuid"

• product_idstring | null

  Produk (proyek) pemilik kotak surat. Klien menggunakannya untuk mengelompokkan kotak surat dan membuat tautan aplikasi web.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringwajib

  format: "email"

• display_namestringwajib
• providerstringwajib

  enum: "gmail", "smtp"

• statusstringwajib

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringwajib

  enum: "domain", "starter"

Contoh curl

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

Buat kotak surat kerja bawaan Banger pada domain pengiriman ruang kerja.

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan wajib

application/json

• valueobject

  Tidak ada properti tambahan

• domain_idstringwajib

  format: "uuid"

• local_partstringwajib

  minLength: 1 · maxLength: 64

• display_namestring

  maxLength: 200

Respons berhasil 200

Pengulangan idempoten pembuatan kotak surat bawaan.

application/json

• valueobject
• dataobjectwajib
• idstringwajib

  format: "uuid"

• workspace_idstringwajib

  format: "uuid"

• product_idstring | null

  Produk (proyek) pemilik kotak surat. Klien menggunakannya untuk mengelompokkan kotak surat dan membuat tautan aplikasi web.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringwajib

  format: "email"

• display_namestringwajib
• providerstringwajib

  enum: "gmail", "smtp"

• statusstringwajib

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringwajib

  enum: "domain", "starter"

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

Pratinjau penghapusan permanen kotak surat dan alur pengiriman yang bergantung padanya. Memerlukan admin ruang kerja dan cakupan produk.

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan

Kontrak tidak menentukan isi permintaan.

Respons berhasil 200

Kotak surat yang persis dan dampak penghapusan saat ini, tanpa menghapus apa pun.

application/json

• valueobject
• dataobjectwajib
• mailboxobjectwajib
• idstringwajib

  format: "uuid"

• addressstringwajib
• providerstringwajib
• domain_idstring | nullwajib

  format: "uuid"

• provider_connection_idstring | nullwajib

  format: "uuid"

• messagesintegerwajib
• draftsintegerwajib
• pending_sendsintegerwajib
• broadcastsarraywajib
• Setiap itemobject
• idstringwajib

  format: "uuid"

• namestringwajib
• statusstringwajib
• journeysarraywajib
• Setiap itemobject
• idstringwajib

  format: "uuid"

• namestringwajib
• statusstringwajib
• signup_formsarraywajib
• Setiap itemobject
• idstringwajib

  format: "uuid"

• namestringwajib
• statusstringwajib
• impactarraywajib
• Setiap itemstring
• preview_tokenstringwajib

Contoh curl

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

Tetapkan nama pengirim yang dilihat penerima pada email dari satu kotak surat Banger ("Name <address>"). Kotak surat Gmail mempertahankan nama yang ditetapkan di Gmail. Memerlukan admin ruang kerja.

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan wajib

application/json

• valueobject

  Tidak ada properti tambahan

• display_namestringwajib

  Satu baris. Jika kosong, hanya alamat yang dikirim.

  maxLength: 200

Respons berhasil 200

Kotak surat beserta nama pengirimnya.

application/json

• valueobject
• dataobjectwajib
• idstringwajib

  format: "uuid"

• workspace_idstringwajib

  format: "uuid"

• product_idstring | null

  Produk (proyek) pemilik kotak surat. Klien menggunakannya untuk mengelompokkan kotak surat dan membuat tautan aplikasi web.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringwajib

  format: "email"

• display_namestringwajib
• providerstringwajib

  enum: "gmail", "smtp"

• statusstringwajib

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringwajib

  enum: "domain", "starter"

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

Hapus permanen satu kotak surat, dengan mempertahankan domain dan kotak surat lain. Memerlukan admin ruang kerja dan cakupan produk.

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan wajib

application/json

• valueobject

  Tidak ada properti tambahan

• confirm_addressstringwajib

  minLength: 3 · maxLength: 320

• preview_tokenstringwajib

  minLength: 64 · maxLength: 64

Respons berhasil 200

Dihapus atau pengulangan idempoten. File tersimpan masuk antrean pembersihan permanen.

application/json

• valueobject
• dataobjectwajib
• idstringwajib

  format: "uuid"

• addressstringwajib
• deletedbooleanwajib
• replayedboolean

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

Buat kotak surat yang dihosting dan dibatasi pada kotak masuk yang dihosting di produk yang sama serta penerima pendaftaran ruang kerja.

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan wajib

application/json

• valueobject

  Tidak ada properti tambahan

• create_newboolean

  Buat kotak surat tambahan yang dihosting alih-alih melanjutkan kotak surat awal.

• local_partstring

  Nama sebelum @bangermail.com. Tanpanya, kotak surat mendapat nama berupa kata seperti quiet-maple-harbor.

  minLength: 3 · maxLength: 40

• display_namestring

  maxLength: 200

Respons berhasil 200

Pengulangan idempoten pembuatan identitas awal.

application/json

• valueobject
• dataobjectwajib
• idstringwajib

  format: "uuid"

• workspace_idstringwajib

  format: "uuid"

• product_idstring | null

  Produk (proyek) pemilik kotak surat. Klien menggunakannya untuk mengelompokkan kotak surat dan membuat tautan aplikasi web.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringwajib

  format: "email"

• display_namestringwajib
• providerstringwajib

  enum: "gmail", "smtp"

• statusstringwajib

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringwajib

  enum: "domain", "starter"

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

Lanjutkan kotak surat yang dijeda karena reputasi pengirim, sesuai aturan pelanjutan mandiri resumeSending.

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan wajib

application/json

• valueobject

  Tidak ada properti tambahan

• acknowledge_recipient_complaintbooleanwajib

  const: true

• reasonstring

  Alasan pengiriman dipulihkan; dicatat dalam log audit.

  maxLength: 500

Respons berhasil 200

Kotak surat diaktifkan kembali, atau sudah aktif setelah permintaan sebelumnya berhasil.

application/json

• valueobject
• dataobjectwajib
• idstringwajib

  format: "uuid"

• workspace_idstringwajib

  format: "uuid"

• product_idstring | null

  Produk (proyek) pemilik kotak surat. Klien menggunakannya untuk mengelompokkan kotak surat dan membuat tautan aplikasi web.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringwajib

  format: "email"

• display_namestringwajib
• providerstringwajib

  enum: "gmail", "smtp"

• statusstringwajib

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringwajib

  enum: "domain", "starter"

Contoh 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

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan

Kontrak tidak menentukan isi permintaan.

Respons berhasil 200

Respons berhasil.

application/json

• valueobject
• dataarraywajib
• Setiap itemobject
• idstringwajib

  format: "uuid"

• mailbox_idstringwajib

  format: "uuid"

• thread_idstring | nullwajib

  format: "uuid"

• versionintegerwajib
• toarraywajib
• Setiap itemobject
• emailstringwajib
• namestring
• ccarraywajib
• Setiap itemobject
• emailstringwajib
• namestring
• bccarraywajib
• Setiap itemobject
• emailstringwajib
• namestring
• subjectstringwajib
• body_textstringwajib
• statusstringwajib
• created_atstringwajib

  format: "date-time"

• updated_atstringwajib

  format: "date-time"

• attachmentsarraywajib
• Setiap itemobject
• idstringwajib

  format: "uuid"

• filenamestringwajib
• content_typestringwajib
• size_bytesintegerwajib
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

Contoh 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

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan wajib

application/json

• valueobject

  Tidak ada properti tambahan

• mailbox_idstringwajib

  format: "uuid"

• thread_idstring

  format: "uuid"

• toarray

  maxItems: 500

• Setiap itemobject
• namestring
• emailstringwajib

  format: "email"

• ccarray

  maxItems: 500

• Setiap itemobject
• namestring
• emailstringwajib

  format: "email"

• bccarray

  maxItems: 500

• Setiap itemobject
• namestring
• emailstringwajib

  format: "email"

• subjectstring

  maxLength: 10000

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

Respons berhasil 201

Respons berhasil.

application/json

• valueobject
• dataobjectwajib
• idstringwajib

  format: "uuid"

• mailbox_idstringwajib

  format: "uuid"

• thread_idstring | nullwajib

  format: "uuid"

• versionintegerwajib
• toarraywajib
• Setiap itemobject
• emailstringwajib
• namestring
• ccarraywajib
• Setiap itemobject
• emailstringwajib
• namestring
• bccarraywajib
• Setiap itemobject
• emailstringwajib
• namestring
• subjectstringwajib
• body_textstringwajib
• statusstringwajib
• created_atstringwajib

  format: "date-time"

• updated_atstringwajib

  format: "date-time"

• attachmentsarraywajib
• Setiap itemobject
• idstringwajib

  format: "uuid"

• filenamestringwajib
• content_typestringwajib
• size_bytesintegerwajib
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

Contoh 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

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan

Kontrak tidak menentukan isi permintaan.

Respons berhasil 200

Performa keterkiriman, kondisi, dan insiden kanonis.

application/json

• valueobject
• dataobjectwajib
• idstringwajib

  format: "uuid"

• mailbox_idstringwajib

  format: "uuid"

• thread_idstring | nullwajib

  format: "uuid"

• versionintegerwajib
• toarraywajib
• Setiap itemobject
• emailstringwajib
• namestring
• ccarraywajib
• Setiap itemobject
• emailstringwajib
• namestring
• bccarraywajib
• Setiap itemobject
• emailstringwajib
• namestring
• subjectstringwajib
• body_textstringwajib
• statusstringwajib
• created_atstringwajib

  format: "date-time"

• updated_atstringwajib

  format: "date-time"

• attachmentsarraywajib
• Setiap itemobject
• idstringwajib

  format: "uuid"

• filenamestringwajib
• content_typestringwajib
• size_bytesintegerwajib
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

Contoh curl

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

updateDraft

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan wajib

application/json

• valuetidak ditentukan
• allOf 1object

  Tidak ada properti tambahan

• mailbox_idstringwajib

  format: "uuid"

• thread_idstring

  format: "uuid"

• toarray

  maxItems: 500

• Setiap itemobject
• namestring
• emailstringwajib

  format: "email"

• ccarray

  maxItems: 500

• Setiap itemobject
• namestring
• emailstringwajib

  format: "email"

• bccarray

  maxItems: 500

• Setiap itemobject
• namestring
• emailstringwajib

  format: "email"

• subjectstring

  maxLength: 10000

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

• allOf 2object
• versionintegerwajib

  minimum: 1

Respons berhasil 200

Respons berhasil.

application/json

• valueobject
• dataobjectwajib
• idstringwajib

  format: "uuid"

• mailbox_idstringwajib

  format: "uuid"

• thread_idstring | nullwajib

  format: "uuid"

• versionintegerwajib
• toarraywajib
• Setiap itemobject
• emailstringwajib
• namestring
• ccarraywajib
• Setiap itemobject
• emailstringwajib
• namestring
• bccarraywajib
• Setiap itemobject
• emailstringwajib
• namestring
• subjectstringwajib
• body_textstringwajib
• statusstringwajib
• created_atstringwajib

  format: "date-time"

• updated_atstringwajib

  format: "date-time"

• attachmentsarraywajib
• Setiap itemobject
• idstringwajib

  format: "uuid"

• filenamestringwajib
• content_typestringwajib
• size_bytesintegerwajib
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

Contoh 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

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan

Kontrak tidak menentukan isi permintaan.

Respons berhasil 204

Draf dan objek yang dirujuk dijadwalkan untuk dihapus.

Tanpa isi respons.

Contoh curl

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

sendDraft

Kirim draf dari kotak suratnya, yang harus dapat diakses pemanggil. Pemanggil yang pengirimannya perlu persetujuan mendapat persetujuan tertunda; seseorang yang dapat mengirim draf langsung akan memutuskannya.

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan

Kontrak tidak menentukan isi permintaan.

Respons berhasil 202

Pengiriman masuk antrean atau menunggu persetujuan.

application/json

• valueobject
• datatidak ditentukanwajib
• oneOf 1object
• idstringwajib

  format: "uuid"

• typestringwajib
• statusstringwajib

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

• workspace_revisionintegerwajib

  format: "int64"

• created_atstringwajib

  format: "date-time"

• oneOf 2object

  Tidak ada properti tambahan

• approvalobjectwajib
• idstringwajib

  format: "uuid"

• requested_by_actor_idstringwajib
• action_kindstringwajib
• summarystringwajib
• capability_scopesarraywajib
• Setiap itemstring
• resource_scopeobjectwajib
• Properti tambahanarray
• Setiap itemstring

  Penumpukan lebih lanjut dihilangkan

• payloadobjectwajib
• Properti tambahanNilai apa pun
• payload_sha256stringwajib

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

• statusstringwajib

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

• missedbooleanwajib
• expires_atstringwajib

  format: "date-time"

• decided_by_actor_idstring | null
• decision_reasonstring | null
• created_atstringwajib

  format: "date-time"

• updated_atstringwajib

  format: "date-time"

• decided_atstring | null

  format: "date-time"

• execution_job_idstring

  format: "uuid"

• reviewobject

  Tidak ada properti tambahan

• dispositionstringwajib

  enum: "automatic", "human_required"

• recipient_countinteger | nullwajib

  minimum: 0

• reasonsarraywajib
• Setiap itemstring

  Penumpukan lebih lanjut dihilangkan

• checksarraywajib
• Setiap itemstring

  Penumpukan lebih lanjut dihilangkan

Contoh 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

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan wajib

application/octet-stream

• valuestring

  format: "binary" · maxLength: 26214400

Respons berhasil 201

Respons berhasil.

application/json

• valueobject
• dataobjectwajib
• idstringwajib

  format: "uuid"

• filenamestringwajib
• content_typestringwajib
• size_bytesintegerwajib
• sha256string
• created_atstring

  format: "date-time"

Contoh 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

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan

Kontrak tidak menentukan isi permintaan.

Respons berhasil 204

Lampiran dijadwalkan untuk penghapusan B2 yang memperhitungkan versi.

Tanpa isi respons.

Contoh curl

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

Baca isi HTML draf

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan

Kontrak tidak menentukan isi permintaan.

Respons berhasil 200

HTML draf.

text/html

• valuestring

Contoh curl

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

listSendIntents

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan

Kontrak tidak menentukan isi permintaan.

Respons berhasil 200

Pengiriman kanonis terbaru dan status penyedianya.

application/json

• valueobject
• dataarraywajib
• Setiap itemobject

  Tidak ada properti tambahan

• idstringwajib

  format: "uuid"

• statusstringwajib

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

• traffic_classstringwajib

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

• recipient_countintegerwajib

  minimum: 1

• provider_keystringwajib
• provider_statestringwajib

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

• provider_message_idstring | null
• error_codestring | null
• created_atstringwajib

  format: "date-time"

• updated_atstringwajib

  format: "date-time"

• completed_atstring | null

  format: "date-time"

Contoh curl

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

getSendIntent

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan

Kontrak tidak menentukan isi permintaan.

Respons berhasil 200

Status pengiriman asinkron kanonis.

application/json

• valueobject
• dataobjectwajib

  Tidak ada properti tambahan

• idstringwajib

  format: "uuid"

• statusstringwajib

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

• traffic_classstringwajib

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

• recipient_countintegerwajib

  minimum: 1

• provider_keystringwajib
• provider_statestringwajib

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

• provider_message_idstring | null
• error_codestring | null
• created_atstringwajib

  format: "date-time"

• updated_atstringwajib

  format: "date-time"

• completed_atstring | null

  format: "date-time"

Contoh curl

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

listTransactionalSends

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan

Kontrak tidak menentukan isi permintaan.

Respons berhasil 200

Respons berhasil.

application/json

• valueobject
• dataarraywajib
• Setiap itemobject
• idstringwajib

  format: "uuid"

• mailbox_idstring | nullwajib

  format: "uuid"

• command_idstring | nullwajib

  format: "uuid"

• statusstringwajib
• command_statusstring | nullwajib
• subjectstring
• recipientsarray
• Setiap itemobject
• emailstringwajib
• namestring
• recipient_countintegerwajib
• error_codestring | null
• send_intent_idstring

  format: "uuid"

• providerstring | null
• route_kindstring | null
• sourcestring
• from_addressstring
• recipient_statesobject
• Properti tambahaninteger
• provider_message_idstring | null
• languagetidak ditentukan

  Bahasa pengiriman email ini; null jika tidak diterjemahkan.

• anyOf 1object

  Bahasa email yang diterima seseorang. Hanya email terjemahan (konten terkelola) yang memilikinya.

• localestringwajib

  Tag BCP 47 bahasa penulisan email.

• requested_localestring

  Hanya ada pada pengiriman lama dalam bahasa lain: bahasa yang seharusnya diterima orang tersebut.

• fallback_reasonstring

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

• anyOf 2null
• journeyobject | null

  Langkah dan pendaftaran Journey yang mengirim email ini; null untuk pengiriman lain.

• journey_idstringwajib

  format: "uuid"

• step_idstringwajib

  format: "uuid"

• enrollment_idstringwajib

  format: "uuid"

• experimentobject | null

  Varian eksperimen email ini; null jika tidak ada yang berlaku.

• experiment_idstringwajib

  format: "uuid"

• variant_keystringwajib
• created_atstringwajib

  format: "date-time"

• updated_atstringwajib

  format: "date-time"

• completed_atstring | nullwajib

  format: "date-time"

• template_idstring | null

  format: "uuid"

• template_versioninteger | null
• workspace_revisioninteger | null
• command_resultobject
• Properti tambahanNilai apa pun
• command_started_atstring | null

  format: "date-time"

• command_completed_atstring | null

  format: "date-time"

• body_textstring
• body_htmlstring
• reply_toarray
• Setiap itemobject
• emailstringwajib
• namestring
• headersobject
• Properti tambahanstring
• tagsarray
• Setiap itemobject
• namestringwajib
• valuestringwajib

Contoh curl

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

createTransactionalSend

Satu penerima per pengiriman Journey. To menerima satu penerima dalam bentuk RecipientInput apa pun ("a@example.com", "Pat <a@example.com>", { email, name }, atau daftar satu elemen); Cc dan Bcc harus kosong. reply_to default ke kotak surat Journey (daftar kosong juga berarti default); email Produk memerlukan tepat satu. Journey API baru default ke konten sumber terkelola; Journey kode lama tetap mengirim konten lengkap. Penolakan (4xx) tidak meninggalkan apa pun yang dibekukan untuk penerima, sehingga panggilan yang diperbaiki dengan kunci idempotensi baru akan mengirim.

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan wajib

application/json

• valueobject
• mailbox_idstringwajib

  format: "uuid"

• totidak ditentukanwajib

  Penerima untuk to, cc, bcc, dan reply_to: alamat ("a@example.com" atau "Pat <a@example.com>"), objek { email, name }, atau daftar yang mencampur keduanya. Banger menyimpannya sebagai objek { email, name } dengan email berhuruf kecil. Hash idempotensi mencakup isi sebagaimana dikirim, jadi ulangi dengan bentuk yang sama.

• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringwajib

  format: "email"

• oneOf 3array

  maxItems: 500

• Setiap itemtidak ditentukan
• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringwajib

  format: "email"

• ccarray

  maxItems: 0

• Setiap itemobject
• namestring
• emailstringwajib

  format: "email"

• bccarray

  maxItems: 0

• Setiap itemobject
• namestring
• emailstringwajib

  format: "email"

• subjectstring

  maxLength: 10000

• expires_atstring

  Buang pengiriman Journey yang ditunda setelah waktu ini; paling lama tujuh hari dari permintaan awal.

  format: "date-time"

• expires_after_secondsinteger

  minimum: 1 · maximum: 604800

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

• reply_totidak ditentukan

  Penerima untuk to, cc, bcc, dan reply_to: alamat ("a@example.com" atau "Pat <a@example.com>"), objek { email, name }, atau daftar yang mencampur keduanya. Banger menyimpannya sebagai objek { email, name } dengan email berhuruf kecil. Hash idempotensi mencakup isi sebagaimana dikirim, jadi ulangi dengan bentuk yang sama.

• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringwajib

  format: "email"

• oneOf 3array

  maxItems: 500

• Setiap itemtidak ditentukan
• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringwajib

  format: "email"

• headersobject
• Properti tambahanstring

  maxLength: 5000

• tagsarray

  maxItems: 49

• Setiap itemobject

  Tidak ada properti tambahan

• namestringwajib

  minLength: 1 · maxLength: 256

• valuestringwajib

  minLength: 1 · maxLength: 256

Respons berhasil 202

Respons berhasil.

application/json

• valueobject
• dataobjectwajib
• action_kindstringwajib

  enum: "transactional.send"

• idstring

  format: "uuid"

• send_intent_idstring

  format: "uuid"

• provider_attempt_idstring

  format: "uuid"

• statusstringwajib

  Status sent/queued dari pengiriman, atau untuk permintaan yang dibekukan: deferred (dijadwalkan oleh kebijakan atau menunggu terjemahan), processing (sedang dikirim), discarded.

• replayedboolean
• journeytidak ditentukanwajib
• anyOf 1object
• journey_idstringwajib

  format: "uuid"

• enrollment_idstringwajib

  format: "uuid"

• step_idstringwajib

  format: "uuid"

• step_positionintegerwajib
• originstring

  enum: "journey"

• journey_identitystring
• anyOf 2null
• ignored_variablesarraywajib
• Setiap itemstring
• scheduled_atstring

  format: "date-time"

• reasonstring
• communication_reservation_idstring

  format: "uuid"

Contoh 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

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan

Kontrak tidak menentukan isi permintaan.

Respons berhasil 200

Respons berhasil.

application/json

• valueobject
• dataobjectwajib
• idstringwajib

  format: "uuid"

• mailbox_idstring | nullwajib

  format: "uuid"

• command_idstring | nullwajib

  format: "uuid"

• statusstringwajib
• command_statusstring | nullwajib
• subjectstring
• recipientsarray
• Setiap itemobject
• emailstringwajib
• namestring
• recipient_countintegerwajib
• error_codestring | null
• send_intent_idstring

  format: "uuid"

• providerstring | null
• route_kindstring | null
• sourcestring
• from_addressstring
• recipient_statesobject
• Properti tambahaninteger
• provider_message_idstring | null
• languagetidak ditentukan

  Bahasa pengiriman email ini; null jika tidak diterjemahkan.

• anyOf 1object

  Bahasa email yang diterima seseorang. Hanya email terjemahan (konten terkelola) yang memilikinya.

• localestringwajib

  Tag BCP 47 bahasa penulisan email.

• requested_localestring

  Hanya ada pada pengiriman lama dalam bahasa lain: bahasa yang seharusnya diterima orang tersebut.

• fallback_reasonstring

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

• anyOf 2null
• journeyobject | null

  Langkah dan pendaftaran Journey yang mengirim email ini; null untuk pengiriman lain.

• journey_idstringwajib

  format: "uuid"

• step_idstringwajib

  format: "uuid"

• enrollment_idstringwajib

  format: "uuid"

• experimentobject | null

  Varian eksperimen email ini; null jika tidak ada yang berlaku.

• experiment_idstringwajib

  format: "uuid"

• variant_keystringwajib
• created_atstringwajib

  format: "date-time"

• updated_atstringwajib

  format: "date-time"

• completed_atstring | nullwajib

  format: "date-time"

• template_idstring | null

  format: "uuid"

• template_versioninteger | null
• workspace_revisioninteger | null
• command_resultobject
• Properti tambahanNilai apa pun
• command_started_atstring | null

  format: "date-time"

• command_completed_atstring | null

  format: "date-time"

• body_textstring
• body_htmlstring
• reply_toarray
• Setiap itemobject
• emailstringwajib
• namestring
• headersobject
• Properti tambahanstring
• tagsarray
• Setiap itemobject
• namestringwajib
• valuestringwajib

Contoh curl

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

listTransactionalSendTimeline

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan

Kontrak tidak menentukan isi permintaan.

Respons berhasil 200

Linimasa berurutan untuk penerimaan, percobaan penyedia, dan peristiwa penerima.

application/json

• valueobject
• dataarraywajib
• Setiap itemobject
• occurred_atstringwajib

  format: "date-time"

• event_typestringwajib
• labelstringwajib
• providerstring | null
• recipient_domainstring | null
• error_codestring | null

Contoh curl

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

retryTransactionalSend

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan

Kontrak tidak menentukan isi permintaan.

Respons berhasil 202

Respons berhasil.

application/json

• valueobject
• dataobjectwajib
• action_kindstringwajib

  enum: "transactional.send"

• idstringwajib

  format: "uuid"

• send_intent_idstringwajib

  format: "uuid"

• provider_attempt_idstringwajib

  format: "uuid"

• statusstringwajib
• replayedbooleanwajib

Contoh 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

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan

Kontrak tidak menentukan isi permintaan.

Respons berhasil 200

Utas ruang kerja dengan paginasi keyset.

application/json

• valueobject
• dataarraywajib
• Setiap itemobject
• idstringwajib

  format: "uuid"

• mailbox_idstringwajib

  format: "uuid"

• subjectstringwajib
• snippetstringwajib
• last_message_atstringwajib

  format: "date-time"

• message_countintegerwajib
• unread_countintegerwajib
• is_archivedbooleanwajib
• is_trashbooleanwajib
• is_spambooleanwajib
• is_starredbooleanwajib
• is_sentbooleanwajib
• has_attachmentsbooleanwajib
• labelsarraywajib
• Setiap itemstring
• participantsarray
• Setiap itemobject
• namestring
• emailstringwajib

  format: "email"

• pageobjectwajib
• next_cursorstring
• has_morebooleanwajib

Contoh 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

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan

Kontrak tidak menentukan isi permintaan.

Respons berhasil 200

Utas dan pesan berurutan.

application/json

• valueobject
• datatidak ditentukanwajib
• allOf 1object
• idstringwajib

  format: "uuid"

• mailbox_idstringwajib

  format: "uuid"

• subjectstringwajib
• snippetstringwajib
• last_message_atstringwajib

  format: "date-time"

• message_countintegerwajib
• unread_countintegerwajib
• is_archivedbooleanwajib
• is_trashbooleanwajib
• is_spambooleanwajib
• is_starredbooleanwajib
• is_sentbooleanwajib
• has_attachmentsbooleanwajib
• labelsarraywajib
• Setiap itemstring
• participantsarray
• Setiap itemobject
• namestring
• emailstringwajib

  format: "email"

• allOf 2object
• messagesarraywajib
• Setiap itemobject
• idstringwajib

  format: "uuid"

• mailbox_idstringwajib

  format: "uuid"

• thread_idstringwajib

  format: "uuid"

• sent_atstringwajib

  format: "date-time"

• received_atstring

  format: "date-time"

• envelope_recipientsarray

  Penerima amplop SMTP asli, dinormalisasi hurufnya oleh edge SMTP sebelum perutean alias khusus penerimaan. Kosong untuk pesan lama atau sumber non-SMTP. Terpisah dari header To/Cc yang terlihat.

• Setiap itemstring

  format: "email"

  Penumpukan lebih lanjut dihilangkan

• fromobjectwajib
• namestring

  Penumpukan lebih lanjut dihilangkan

• emailstringwajib

  format: "email"

  Penumpukan lebih lanjut dihilangkan

• toarraywajib
• Setiap itemobject

  Penumpukan lebih lanjut dihilangkan

• ccarray
• Setiap itemobject

  Penumpukan lebih lanjut dihilangkan

• reply_toarray
• Setiap itemobject

  Penumpukan lebih lanjut dihilangkan

• is_sentboolean

  Apakah pesan ini dikirim oleh kotak surat, termasuk dari alias.

• body_textstring
• body_html_urlstring

  format: "uri"

• reply_originobject
• send_intent_idstringwajib

  format: "uuid"

  Penumpukan lebih lanjut dihilangkan

• sourcestringwajib

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

  Penumpukan lebih lanjut dihilangkan

• source_idstring

  format: "uuid"

  Penumpukan lebih lanjut dihilangkan

• traffic_classstringwajib

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

  Penumpukan lebih lanjut dihilangkan

• kindstringwajib

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

  Penumpukan lebih lanjut dihilangkan

• namestring

  Penumpukan lebih lanjut dihilangkan

• has_attachmentsbooleanwajib
• attachmentsarray
• Setiap itemobject

  Penumpukan lebih lanjut dihilangkan

Contoh curl

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

getMessageHtml

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan

Kontrak tidak menentukan isi permintaan.

Respons berhasil 200

Isi pesan HTML terautentikasi dengan batasan sandbox.

text/html

• valuestring

Contoh curl

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

downloadAttachment

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan

Kontrak tidak menentukan isi permintaan.

Respons berhasil 200

Aliran lampiran terautentikasi.

application/octet-stream

• valuestring

  format: "binary"

Contoh curl

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

searchMail

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan

Kontrak tidak menentukan isi permintaan.

Respons berhasil 200

Hasil pencarian seluruh ruang kerja.

application/json

• valueobject
• dataarraywajib
• Setiap itemobject
• idstringwajib

  format: "uuid"

• mailbox_idstringwajib

  format: "uuid"

• subjectstringwajib
• snippetstringwajib
• last_message_atstringwajib

  format: "date-time"

• message_countintegerwajib
• unread_countintegerwajib
• is_archivedbooleanwajib
• is_trashbooleanwajib
• is_spambooleanwajib
• is_starredbooleanwajib
• is_sentbooleanwajib
• has_attachmentsbooleanwajib
• labelsarraywajib
• Setiap itemstring
• participantsarray
• Setiap itemobject
• namestring
• emailstringwajib

  format: "email"

• pageobjectwajib
• next_cursorstring
• has_morebooleanwajib

Contoh 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

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan

Kontrak tidak menentukan isi permintaan.

Respons berhasil 200

Respons berhasil.

application/json

• valueobject
• dataarraywajib
• Setiap itemobject
• idstringwajib

  format: "uuid"

• emailstringwajib

  format: "email"

• display_namestring | nullwajib
• attributesobjectwajib
• Properti tambahanNilai apa pun
• statusstringwajib

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

• created_atstringwajib

  format: "date-time"

• updated_atstringwajib

  format: "date-time"

• pageobjectwajib
• next_cursorstring
• has_morebooleanwajib

Contoh 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

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan wajib

application/json

• valueobject

  Tidak ada properti tambahan

• emailstringwajib

  format: "email"

• display_namestring

  maxLength: 1000

• statusstringwajib

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

• attributesobject
• Properti tambahanNilai apa pun
• consent_confirmedboolean

  Wajib saat baru mendaftarkan alamat sebagai pelanggan.

Respons berhasil 201

Respons berhasil.

application/json

• valueobject
• dataobjectwajib
• idstringwajib

  format: "uuid"

• emailstringwajib

  format: "email"

• display_namestring | nullwajib
• attributesobjectwajib
• Properti tambahanNilai apa pun
• statusstringwajib

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

• created_atstringwajib

  format: "date-time"

• updated_atstringwajib

  format: "date-time"

Contoh 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

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan

Kontrak tidak menentukan isi permintaan.

Respons berhasil 200

Respons berhasil.

application/json

• valueobject
• dataobjectwajib
• idstringwajib

  format: "uuid"

• emailstringwajib

  format: "email"

• display_namestring | nullwajib
• attributesobjectwajib
• Properti tambahanNilai apa pun
• statusstringwajib

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

• created_atstringwajib

  format: "date-time"

• updated_atstringwajib

  format: "date-time"

• suppressedbooleanwajib
• suppression_reasonstring | nullwajib
• sourcesarraywajib
• Setiap itemobject
• kindstringwajib
• referencestringwajib
• connection_idstring | nullwajib

  format: "uuid"

• metadataobjectwajib
• Properti tambahanNilai apa pun
• first_seen_atstringwajib

  format: "date-time"

• last_seen_atstringwajib

  format: "date-time"

• listsarraywajib
• Setiap itemobject
• idstringwajib

  format: "uuid"

• namestringwajib
• subscription_statusstringwajib
• consent_evidencearraywajib
• Setiap itemobject
• kindstringwajib
• referencestringwajib
• connection_idstring | nullwajib

  format: "uuid"

• metadataobjectwajib
• Properti tambahanNilai apa pun
• first_seen_atstringwajib

  format: "date-time"

• last_seen_atstringwajib

  format: "date-time"

Contoh curl

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

deleteContact

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan

Kontrak tidak menentukan isi permintaan.

Respons berhasil 204

Kontak dihapus.

Tanpa isi respons.

Contoh curl

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

listContactImports

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan

Kontrak tidak menentukan isi permintaan.

Respons berhasil 200

Respons berhasil.

application/json

• valueobject
• dataarraywajib
• Setiap itemobject
• idstring

  format: "uuid"

• filenamestring
• list_idstring | null

  format: "uuid"

• list_namestring | null
• statusstring
• total_rowsinteger
• imported_rowsinteger
• invalid_rowsinteger
• error_summaryarray
• Setiap itemstring
• 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"

Contoh curl

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

importContacts

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan wajib

application/json

• valueobject
• filenamestringwajib

  minLength: 1 · maxLength: 500

• list_idstring

  format: "uuid"

• consent_confirmedboolean

  Wajib jika ada baris impor yang berlangganan.

• rowsarraywajib

  minItems: 1 · maxItems: 5000

• Setiap itemobject
• emailstringwajib

  format: "email"

• display_namestring

  maxLength: 1000

• statusstring

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

• attributesobject
• Properti tambahanNilai apa pun

Respons berhasil 201

Respons berhasil.

application/json

• valueobject
• dataobjectwajib
• idstringwajib

  format: "uuid"

• statusstringwajib

  enum: "queued"

• total_rowsintegerwajib
• imported_rowsintegerwajib
• invalid_rowsintegerwajib
• list_idstring | nullwajib

  format: "uuid"

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

Gabungkan atribut bertipe tanpa mengubah langganan atau persetujuan

Memerlukan contacts:write dan contacts:read. Hanya memperbarui kontak yang ada. Atribut yang dihilangkan dipertahankan, false eksplisit disimpan, dan null menghapus field. Berikan fakta sumber terverifikasi; data yang tidak ada bukan false. Langganan, penekanan, identitas, dan riwayat sumber tidak berubah.

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan wajib

application/json

• valueobject

  Tidak ada properti tambahan

• attributesobjectwajib
• Properti tambahanNilai apa pun

Respons berhasil 200

Pembacaan kembali kontak saat ini; replayed bernilai true jika mutasi ini sudah diterapkan.

application/json

• valueobject
• dataobjectwajib
• idstringwajib

  format: "uuid"

• attributesobjectwajib
• Properti tambahanNilai apa pun
• statusstringwajib

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

• replayedbooleanwajib
• Properti tambahanNilai apa pun

Contoh 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

Autentikasi: kunci API ruang kerja Bearer.

Parameter

Isi permintaan wajib

application/json

• valueobject

  Tidak ada properti tambahan

• emailstringwajib

  format: "email" · maxLength: 320

• display_namestring

  minLength: 0 · maxLength: 1000

• attributesobject
• Properti tambahanNilai apa pun
• statusstringwajib

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

• consent_evidenceobject

  Tidak ada properti tambahan

• sourcestring

  minLength: 1 · maxLength: 2000

• referencestring

  minLength: 1 · maxLength: 2000

• observed_atstring

  format: "date-time"

• statementstring

  minLength: 1 · maxLength: 2000

• consent_confirmedboolean

Respons berhasil 200

Pembacaan kembali kanonis atau tanda terima idempoten. Penerimaan penyedia adalah sent; delivered memerlukan peristiwa pengiriman dan tidak membuktikan masuk ke kotak masuk.

application/json

• valueobject
• datatidak ditentukanwajib
• allOf 1object
• idstringwajib

  format: "uuid"

• emailstringwajib

  format: "email"

• display_namestring | nullwajib
• attributesobjectwajib
• Properti tambahanNilai apa pun
• statusstringwajib

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

• created_atstringwajib

  format: "date-time"

• updated_atstringwajib

  format: "date-time"

• suppressedbooleanwajib
• suppression_reasonstring | nullwajib
• sourcesarraywajib
• Setiap itemobject
• kindstringwajib
• referencestringwajib
• connection_idstring | nullwajib

  format: "uuid"

• metadataobjectwajib
• Properti tambahanNilai apa pun
• first_seen_atstringwajib

  format: "date-time"

• last_seen_atstringwajib

  format: "date-time"

• listsarraywajib
• Setiap itemobject
• idstringwajib

  format: "uuid"

• namestringwajib
• subscription_statusstringwajib
• consent_evidencearraywajib
• Setiap itemobject
• kindstringwajib
• referencestringwajib
• connection_idstring | nullwajib

  format: "uuid"

• metadataobjectwajib
• Properti tambahanNilai apa pun
• first_seen_atstringwajib

  format: "date-time"

• last_seen_atstringwajib

  format: "date-time"

• allOf 2object
• replayedbooleanwajib