Banger API-referentie

Werkruimteproducten weergeven

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody

Het contract specificeert geen requestbody.

Succesresponse 200

Succesvolle response.

application/json

• valueobject
• dataarrayvereist
• Elk itemobject
• idstringvereist

  format: "uuid"

• workspace_idstringvereist

  format: "uuid"

• namestringvereist
• slugstringvereist
• kindstringvereist

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

• website_urlstring | nullvereist
• domainsarrayvereist
• Elk itemstring
• descriptionstringvereist
• contextobjectvereist
• Aanvullende eigenschapElke waarde
• brandobjectvereist
• company_namestring

  maxLength: 160

• logo_urlstring

  Het pictogram: het beeldmerk op zichzelf, klein gebruikt (e-mailfooter, inschuifformulieren) en als kop wanneer er geen woordmerk is.

  maxLength: 2000

• wordmark_urlstring

  Het woordmerk: de bedrijfsnaam zoals vormgegeven, afzonderlijk bovenaan elke e-mail.

  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

• statusstringvereist

  deleting: verwijderd door een persoon; herstelbaar tot delete_after, daarna definitief verwijderd.

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

• delete_afterstring | null

  Wanneer een product met status deleting definitief wordt verwijderd.

  format: "date-time"

• is_defaultbooleanvereist
• route_readybooleanvereist
• setuparrayvereist
• Elk itemobject
• keystringvereist

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

• statusstringvereist

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

• completion_sourcestring | nullvereist

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

• notestringvereist
• updated_atstring | nullvereist

  format: "date-time"

• created_atstringvereist

  format: "date-time"

• updated_atstringvereist

  format: "date-time"

curl-voorbeeld

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

Product maken

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody vereist

application/json

• valueobject
• namestringvereist

  minLength: 1 · maxLength: 160

• kindstring

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

• website_urlstring | null

  maxLength: 2000

• descriptionstring

  maxLength: 4000

• contextobject
• Aanvullende eigenschapElke waarde
• domainsarray

  maxItems: 20

• Elk itemstring

  maxLength: 253

Succesresponse 201

Succesvolle response.

application/json

• valueobject
• dataobjectvereist
• idstringvereist

  format: "uuid"

• workspace_idstringvereist

  format: "uuid"

• namestringvereist
• slugstringvereist
• kindstringvereist

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

• website_urlstring | nullvereist
• domainsarrayvereist
• Elk itemstring
• descriptionstringvereist
• contextobjectvereist
• Aanvullende eigenschapElke waarde
• brandobjectvereist
• company_namestring

  maxLength: 160

• logo_urlstring

  Het pictogram: het beeldmerk op zichzelf, klein gebruikt (e-mailfooter, inschuifformulieren) en als kop wanneer er geen woordmerk is.

  maxLength: 2000

• wordmark_urlstring

  Het woordmerk: de bedrijfsnaam zoals vormgegeven, afzonderlijk bovenaan elke e-mail.

  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

• statusstringvereist

  deleting: verwijderd door een persoon; herstelbaar tot delete_after, daarna definitief verwijderd.

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

• delete_afterstring | null

  Wanneer een product met status deleting definitief wordt verwijderd.

  format: "date-time"

• is_defaultbooleanvereist
• route_readybooleanvereist
• setuparrayvereist
• Elk itemobject
• keystringvereist

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

• statusstringvereist

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

• completion_sourcestring | nullvereist

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

• notestringvereist
• updated_atstring | nullvereist

  format: "date-time"

• created_atstringvereist

  format: "date-time"

• updated_atstringvereist

  format: "date-time"

curl-voorbeeld

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

Product ophalen

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody

Het contract specificeert geen requestbody.

Succesresponse 200

Succesvolle response.

application/json

• valueobject
• dataobjectvereist
• idstringvereist

  format: "uuid"

• workspace_idstringvereist

  format: "uuid"

• namestringvereist
• slugstringvereist
• kindstringvereist

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

• website_urlstring | nullvereist
• domainsarrayvereist
• Elk itemstring
• descriptionstringvereist
• contextobjectvereist
• Aanvullende eigenschapElke waarde
• brandobjectvereist
• company_namestring

  maxLength: 160

• logo_urlstring

  Het pictogram: het beeldmerk op zichzelf, klein gebruikt (e-mailfooter, inschuifformulieren) en als kop wanneer er geen woordmerk is.

  maxLength: 2000

• wordmark_urlstring

  Het woordmerk: de bedrijfsnaam zoals vormgegeven, afzonderlijk bovenaan elke e-mail.

  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

• statusstringvereist

  deleting: verwijderd door een persoon; herstelbaar tot delete_after, daarna definitief verwijderd.

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

• delete_afterstring | null

  Wanneer een product met status deleting definitief wordt verwijderd.

  format: "date-time"

• is_defaultbooleanvereist
• route_readybooleanvereist
• setuparrayvereist
• Elk itemobject
• keystringvereist

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

• statusstringvereist

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

• completion_sourcestring | nullvereist

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

• notestringvereist
• updated_atstring | nullvereist

  format: "date-time"

• created_atstringvereist

  format: "date-time"

• updated_atstringvereist

  format: "date-time"

curl-voorbeeld

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

Product bijwerken

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody vereist

application/json

• valueobject
• namestring

  maxLength: 160

• kindstring

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

• website_urlstring | null

  maxLength: 2000

• descriptionstring

  maxLength: 4000

• contextobject
• Aanvullende eigenschapElke waarde
• brandobject
• company_namestring

  maxLength: 160

• logo_urlstring

  Het pictogram: het beeldmerk op zichzelf, klein gebruikt (e-mailfooter, inschuifformulieren) en als kop wanneer er geen woordmerk is.

  maxLength: 2000

• wordmark_urlstring

  Het woordmerk: de bedrijfsnaam zoals vormgegeven, afzonderlijk bovenaan elke e-mail.

  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"

Succesresponse 200

Succesvolle response.

application/json

• valueobject
• dataobjectvereist
• idstringvereist

  format: "uuid"

• workspace_idstringvereist

  format: "uuid"

• namestringvereist
• slugstringvereist
• kindstringvereist

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

• website_urlstring | nullvereist
• domainsarrayvereist
• Elk itemstring
• descriptionstringvereist
• contextobjectvereist
• Aanvullende eigenschapElke waarde
• brandobjectvereist
• company_namestring

  maxLength: 160

• logo_urlstring

  Het pictogram: het beeldmerk op zichzelf, klein gebruikt (e-mailfooter, inschuifformulieren) en als kop wanneer er geen woordmerk is.

  maxLength: 2000

• wordmark_urlstring

  Het woordmerk: de bedrijfsnaam zoals vormgegeven, afzonderlijk bovenaan elke e-mail.

  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

• statusstringvereist

  deleting: verwijderd door een persoon; herstelbaar tot delete_after, daarna definitief verwijderd.

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

• delete_afterstring | null

  Wanneer een product met status deleting definitief wordt verwijderd.

  format: "date-time"

• is_defaultbooleanvereist
• route_readybooleanvereist
• setuparrayvereist
• Elk itemobject
• keystringvereist

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

• statusstringvereist

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

• completion_sourcestring | nullvereist

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

• notestringvereist
• updated_atstring | nullvereist

  format: "date-time"

• created_atstringvereist

  format: "date-time"

• updated_atstringvereist

  format: "date-time"

curl-voorbeeld

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

Verwijder één product (een project in de app) nadat je het verwijdervoorbeeld hebt bekeken. Het wordt onmiddellijk buiten gebruik gesteld (versturen stopt) en blijft 24 uur herstelbaar; daarna verwijdert Banger de verzenddomeinen en alle bijbehorende rijen. Het laatste actieve product van de werkruimte kan niet worden verwijderd. Vereist een werkruimtebeheerder en een ingelogde sessie; API-sleutels en OAuth-toestemmingen worden geweigerd.

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody vereist

application/json

• valueobject

  Geen aanvullende eigenschappen

• confirm_namestringvereist

  De exacte productnaam.

  minLength: 1 · maxLength: 160

• preview_tokenstringvereist

  minLength: 64 · maxLength: 64

Succesresponse 202

Het product is buiten gebruik en wordt definitief verwijderd op delete_after, tenzij het eerder wordt hersteld. Een idempotente herhaling geeft hetzelfde resultaat.

application/json

• valueobject
• dataobjectvereist
• idstringvereist

  format: "uuid"

• namestringvereist
• statusstringvereist

  enum: "deleting"

• delete_afterstringvereist

  Wanneer het product definitief wordt verwijderd; tot dan kan het worden hersteld.

  format: "date-time"

• next_product_idstringvereist

  Het huidige standaardproduct van de werkruimte.

  format: "uuid"

• replayedboolean

curl-voorbeeld

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

Bekijk vooraf het verwijderen van één product en alles wat erbij hoort, zonder iets te verwijderen. Vereist een werkruimtebeheerder, ingelogd of via door de gebruiker geautoriseerde OAuth.

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody

Het contract specificeert geen requestbody.

Succesresponse 200

Wat het verwijderen van het product verwijdert en stopt.

application/json

• valueobject
• dataobjectvereist
• productobjectvereist
• idstringvereist

  format: "uuid"

• namestringvereist
• is_defaultbooleanvereist
• next_default_productniet gespecificeerdvereist

  Het product dat de standaard wordt wanneer het standaardproduct wordt verwijderd.

• oneOf 1null
• oneOf 2object
• idstringvereist

  format: "uuid"

• namestringvereist
• last_productbooleanvereist

  Het enige actieve product kan niet worden verwijderd.

• mailboxesarrayvereist
• Elk itemobject
• idstringvereist

  format: "uuid"

• addressstringvereist
• domainsarrayvereist

  Verzenddomeinen die Banger verwijdert nadat de herstelperiode is verstreken.

• Elk itemobject
• idstringvereist

  format: "uuid"

• domainstringvereist
• journeysintegervereist
• broadcastsintegervereist
• signup_formsintegervereist
• contactsintegervereist
• api_keysintegervereist
• webhooksintegervereist
• pending_sendsintegervereist
• impactarrayvereist
• Elk itemstring
• preview_tokenstringvereist

curl-voorbeeld

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

Herstel een verwijderd product vóór delete_after. De mailboxen, Journeys, aanmeldformulieren, webhooks en integraties worden opnieuw ingeschakeld; campagnes blijven gepauzeerd. Vereist een werkruimtebeheerder, ingelogd of via door de gebruiker geautoriseerde OAuth.

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody

Het contract specificeert geen requestbody.

Succesresponse 200

Het product is weer actief.

application/json

• valueobject
• dataobjectvereist
• idstringvereist

  format: "uuid"

• namestringvereist
• statusstringvereist

  enum: "active"

curl-voorbeeld

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

Een productinstellingsitem bijwerken

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody vereist

application/json

• valueobject
• statusstringvereist

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

• completion_sourcestring

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

• notestring

  maxLength: 1000

Succesresponse 200

Succesvolle response.

application/json

• valueobject
• dataobjectvereist
• keystringvereist

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

• statusstringvereist

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

• completion_sourcestring | nullvereist

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

• notestringvereist
• updated_atstring | nullvereist

  format: "date-time"

curl-voorbeeld

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

Domein koppelen aan een product

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody vereist

application/json

• valueobject
• domainstringvereist

  minLength: 3 · maxLength: 253

Succesresponse 201

Succesvolle response.

application/json

• valueobject
• dataobjectvereist
• idstringvereist

  format: "uuid"

• workspace_idstringvereist

  format: "uuid"

• namestringvereist
• slugstringvereist
• kindstringvereist

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

• website_urlstring | nullvereist
• domainsarrayvereist
• Elk itemstring
• descriptionstringvereist
• contextobjectvereist
• Aanvullende eigenschapElke waarde
• brandobjectvereist
• company_namestring

  maxLength: 160

• logo_urlstring

  Het pictogram: het beeldmerk op zichzelf, klein gebruikt (e-mailfooter, inschuifformulieren) en als kop wanneer er geen woordmerk is.

  maxLength: 2000

• wordmark_urlstring

  Het woordmerk: de bedrijfsnaam zoals vormgegeven, afzonderlijk bovenaan elke e-mail.

  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

• statusstringvereist

  deleting: verwijderd door een persoon; herstelbaar tot delete_after, daarna definitief verwijderd.

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

• delete_afterstring | null

  Wanneer een product met status deleting definitief wordt verwijderd.

  format: "date-time"

• is_defaultbooleanvereist
• route_readybooleanvereist
• setuparrayvereist
• Elk itemobject
• keystringvereist

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

• statusstringvereist

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

• completion_sourcestring | nullvereist

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

• notestringvereist
• updated_atstring | nullvereist

  format: "date-time"

• created_atstringvereist

  format: "date-time"

• updated_atstringvereist

  format: "date-time"

curl-voorbeeld

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

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody

Het contract specificeert geen requestbody.

Succesresponse 200

Mailboxen die de actor kan zien.

application/json

• valueobject
• dataarrayvereist
• Elk itemobject
• idstringvereist

  format: "uuid"

• workspace_idstringvereist

  format: "uuid"

• product_idstring | null

  Het product (project) waartoe de mailbox behoort. Clients groeperen er mailboxen mee en maken er webapplinks mee.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringvereist

  format: "email"

• display_namestringvereist
• providerstringvereist

  enum: "gmail", "smtp"

• statusstringvereist

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringvereist

  enum: "domain", "starter"

curl-voorbeeld

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

Maak een Banger-werkmailbox op een verzenddomein van de werkruimte.

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody vereist

application/json

• valueobject

  Geen aanvullende eigenschappen

• domain_idstringvereist

  format: "uuid"

• local_partstringvereist

  minLength: 1 · maxLength: 64

• display_namestring

  maxLength: 200

Succesresponse 200

Idempotente herhaling van het maken van een native mailbox.

application/json

• valueobject
• dataobjectvereist
• idstringvereist

  format: "uuid"

• workspace_idstringvereist

  format: "uuid"

• product_idstring | null

  Het product (project) waartoe de mailbox behoort. Clients groeperen er mailboxen mee en maken er webapplinks mee.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringvereist

  format: "email"

• display_namestringvereist
• providerstringvereist

  enum: "gmail", "smtp"

• statusstringvereist

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringvereist

  enum: "domain", "starter"

curl-voorbeeld

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

Bekijk vooraf permanente mailboxverwijdering en afhankelijke verzendstromen. Vereist een werkruimtebeheerder en productscope.

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody

Het contract specificeert geen requestbody.

Succesresponse 200

Exacte mailbox en huidige verwijderimpact, zonder iets te verwijderen.

application/json

• valueobject
• dataobjectvereist
• mailboxobjectvereist
• idstringvereist

  format: "uuid"

• addressstringvereist
• providerstringvereist
• domain_idstring | nullvereist

  format: "uuid"

• provider_connection_idstring | nullvereist

  format: "uuid"

• messagesintegervereist
• draftsintegervereist
• pending_sendsintegervereist
• broadcastsarrayvereist
• Elk itemobject
• idstringvereist

  format: "uuid"

• namestringvereist
• statusstringvereist
• journeysarrayvereist
• Elk itemobject
• idstringvereist

  format: "uuid"

• namestringvereist
• statusstringvereist
• signup_formsarrayvereist
• Elk itemobject
• idstringvereist

  format: "uuid"

• namestringvereist
• statusstringvereist
• impactarrayvereist
• Elk itemstring
• preview_tokenstringvereist

curl-voorbeeld

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

Stel de afzendernaam in die ontvangers zien bij e-mail uit één Banger-mailbox ("Name <address>"). Gmail-mailboxen behouden de naam uit Gmail. Vereist een werkruimtebeheerder.

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody vereist

application/json

• valueobject

  Geen aanvullende eigenschappen

• display_namestringvereist

  Eén regel. Leeg verstuurt alleen het adres.

  maxLength: 200

Succesresponse 200

De mailbox met de afzendernaam.

application/json

• valueobject
• dataobjectvereist
• idstringvereist

  format: "uuid"

• workspace_idstringvereist

  format: "uuid"

• product_idstring | null

  Het product (project) waartoe de mailbox behoort. Clients groeperen er mailboxen mee en maken er webapplinks mee.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringvereist

  format: "email"

• display_namestringvereist
• providerstringvereist

  enum: "gmail", "smtp"

• statusstringvereist

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringvereist

  enum: "domain", "starter"

curl-voorbeeld

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

Verwijder één mailbox permanent, met behoud van het domein en andere mailboxen. Vereist een werkruimtebeheerder en productscope.

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody vereist

application/json

• valueobject

  Geen aanvullende eigenschappen

• confirm_addressstringvereist

  minLength: 3 · maxLength: 320

• preview_tokenstringvereist

  minLength: 64 · maxLength: 64

Succesresponse 200

Verwijderd of idempotente herhaling. Opgeslagen bestanden staan in de wachtrij voor permanente opschoning.

application/json

• valueobject
• dataobjectvereist
• idstringvereist

  format: "uuid"

• addressstringvereist
• deletedbooleanvereist
• replayedboolean

curl-voorbeeld

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

Maak een gehoste mailbox, beperkt tot gehoste inboxen van hetzelfde product en de aanmeldontvanger van de werkruimte.

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody vereist

application/json

• valueobject

  Geen aanvullende eigenschappen

• create_newboolean

  Maak een extra gehoste mailbox in plaats van de oorspronkelijke te hervatten.

• local_partstring

  Naam vóór @bangermail.com. Zonder naam krijgt de mailbox een woordnaam zoals quiet-maple-harbor.

  minLength: 3 · maxLength: 40

• display_namestring

  maxLength: 200

Succesresponse 200

Idempotente herhaling van het maken van een startidentiteit.

application/json

• valueobject
• dataobjectvereist
• idstringvereist

  format: "uuid"

• workspace_idstringvereist

  format: "uuid"

• product_idstring | null

  Het product (project) waartoe de mailbox behoort. Clients groeperen er mailboxen mee en maken er webapplinks mee.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringvereist

  format: "email"

• display_namestringvereist
• providerstringvereist

  enum: "gmail", "smtp"

• statusstringvereist

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringvereist

  enum: "domain", "starter"

curl-voorbeeld

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

Hef de afzenderreputatiepauze van één mailbox op, volgens de zelfbedieningsregels van resumeSending.

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody vereist

application/json

• valueobject

  Geen aanvullende eigenschappen

• acknowledge_recipient_complaintbooleanvereist

  const: true

• reasonstring

  Waarom het versturen wordt hersteld; vastgelegd in het auditlog.

  maxLength: 500

Succesresponse 200

Mailbox opnieuw geactiveerd, of al actief na een eerder geslaagd verzoek.

application/json

• valueobject
• dataobjectvereist
• idstringvereist

  format: "uuid"

• workspace_idstringvereist

  format: "uuid"

• product_idstring | null

  Het product (project) waartoe de mailbox behoort. Clients groeperen er mailboxen mee en maken er webapplinks mee.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringvereist

  format: "email"

• display_namestringvereist
• providerstringvereist

  enum: "gmail", "smtp"

• statusstringvereist

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringvereist

  enum: "domain", "starter"

curl-voorbeeld

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

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody

Het contract specificeert geen requestbody.

Succesresponse 200

Succesvolle response.

application/json

• valueobject
• dataarrayvereist
• Elk itemobject
• idstringvereist

  format: "uuid"

• mailbox_idstringvereist

  format: "uuid"

• thread_idstring | nullvereist

  format: "uuid"

• versionintegervereist
• toarrayvereist
• Elk itemobject
• emailstringvereist
• namestring
• ccarrayvereist
• Elk itemobject
• emailstringvereist
• namestring
• bccarrayvereist
• Elk itemobject
• emailstringvereist
• namestring
• subjectstringvereist
• body_textstringvereist
• statusstringvereist
• created_atstringvereist

  format: "date-time"

• updated_atstringvereist

  format: "date-time"

• attachmentsarrayvereist
• Elk itemobject
• idstringvereist

  format: "uuid"

• filenamestringvereist
• content_typestringvereist
• size_bytesintegervereist
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

curl-voorbeeld

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

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody vereist

application/json

• valueobject

  Geen aanvullende eigenschappen

• mailbox_idstringvereist

  format: "uuid"

• thread_idstring

  format: "uuid"

• toarray

  maxItems: 500

• Elk itemobject
• namestring
• emailstringvereist

  format: "email"

• ccarray

  maxItems: 500

• Elk itemobject
• namestring
• emailstringvereist

  format: "email"

• bccarray

  maxItems: 500

• Elk itemobject
• namestring
• emailstringvereist

  format: "email"

• subjectstring

  maxLength: 10000

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

Succesresponse 201

Succesvolle response.

application/json

• valueobject
• dataobjectvereist
• idstringvereist

  format: "uuid"

• mailbox_idstringvereist

  format: "uuid"

• thread_idstring | nullvereist

  format: "uuid"

• versionintegervereist
• toarrayvereist
• Elk itemobject
• emailstringvereist
• namestring
• ccarrayvereist
• Elk itemobject
• emailstringvereist
• namestring
• bccarrayvereist
• Elk itemobject
• emailstringvereist
• namestring
• subjectstringvereist
• body_textstringvereist
• statusstringvereist
• created_atstringvereist

  format: "date-time"

• updated_atstringvereist

  format: "date-time"

• attachmentsarrayvereist
• Elk itemobject
• idstringvereist

  format: "uuid"

• filenamestringvereist
• content_typestringvereist
• size_bytesintegervereist
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

curl-voorbeeld

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

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody

Het contract specificeert geen requestbody.

Succesresponse 200

Gezaghebbende bezorgprestaties, status en incidenten.

application/json

• valueobject
• dataobjectvereist
• idstringvereist

  format: "uuid"

• mailbox_idstringvereist

  format: "uuid"

• thread_idstring | nullvereist

  format: "uuid"

• versionintegervereist
• toarrayvereist
• Elk itemobject
• emailstringvereist
• namestring
• ccarrayvereist
• Elk itemobject
• emailstringvereist
• namestring
• bccarrayvereist
• Elk itemobject
• emailstringvereist
• namestring
• subjectstringvereist
• body_textstringvereist
• statusstringvereist
• created_atstringvereist

  format: "date-time"

• updated_atstringvereist

  format: "date-time"

• attachmentsarrayvereist
• Elk itemobject
• idstringvereist

  format: "uuid"

• filenamestringvereist
• content_typestringvereist
• size_bytesintegervereist
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

curl-voorbeeld

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

updateDraft

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody vereist

application/json

• valueniet gespecificeerd
• allOf 1object

  Geen aanvullende eigenschappen

• mailbox_idstringvereist

  format: "uuid"

• thread_idstring

  format: "uuid"

• toarray

  maxItems: 500

• Elk itemobject
• namestring
• emailstringvereist

  format: "email"

• ccarray

  maxItems: 500

• Elk itemobject
• namestring
• emailstringvereist

  format: "email"

• bccarray

  maxItems: 500

• Elk itemobject
• namestring
• emailstringvereist

  format: "email"

• subjectstring

  maxLength: 10000

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

• allOf 2object
• versionintegervereist

  minimum: 1

Succesresponse 200

Succesvolle response.

application/json

• valueobject
• dataobjectvereist
• idstringvereist

  format: "uuid"

• mailbox_idstringvereist

  format: "uuid"

• thread_idstring | nullvereist

  format: "uuid"

• versionintegervereist
• toarrayvereist
• Elk itemobject
• emailstringvereist
• namestring
• ccarrayvereist
• Elk itemobject
• emailstringvereist
• namestring
• bccarrayvereist
• Elk itemobject
• emailstringvereist
• namestring
• subjectstringvereist
• body_textstringvereist
• statusstringvereist
• created_atstringvereist

  format: "date-time"

• updated_atstringvereist

  format: "date-time"

• attachmentsarrayvereist
• Elk itemobject
• idstringvereist

  format: "uuid"

• filenamestringvereist
• content_typestringvereist
• size_bytesintegervereist
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

curl-voorbeeld

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

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody

Het contract specificeert geen requestbody.

Succesresponse 204

Concept en bijbehorende objecten ingepland voor verwijdering.

Geen responsebody.

curl-voorbeeld

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

sendDraft

Verstuurt het concept vanuit de mailbox, waartoe de aanroeper toegang moet hebben. Een aanroeper wiens verzendingen goedkeuring vereisen krijgt een openstaande goedkeuring; iemand die het concept rechtstreeks mag versturen beslist.

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody

Het contract specificeert geen requestbody.

Succesresponse 202

Verzending staat in de wachtrij of wacht op goedkeuring.

application/json

• valueobject
• dataniet gespecificeerdvereist
• oneOf 1object
• idstringvereist

  format: "uuid"

• typestringvereist
• statusstringvereist

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

• workspace_revisionintegervereist

  format: "int64"

• created_atstringvereist

  format: "date-time"

• oneOf 2object

  Geen aanvullende eigenschappen

• approvalobjectvereist
• idstringvereist

  format: "uuid"

• requested_by_actor_idstringvereist
• action_kindstringvereist
• summarystringvereist
• capability_scopesarrayvereist
• Elk itemstring
• resource_scopeobjectvereist
• Aanvullende eigenschaparray
• Elk itemstring

  Verdere nesting weggelaten

• payloadobjectvereist
• Aanvullende eigenschapElke waarde
• payload_sha256stringvereist

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

• statusstringvereist

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

• missedbooleanvereist
• expires_atstringvereist

  format: "date-time"

• decided_by_actor_idstring | null
• decision_reasonstring | null
• created_atstringvereist

  format: "date-time"

• updated_atstringvereist

  format: "date-time"

• decided_atstring | null

  format: "date-time"

• execution_job_idstring

  format: "uuid"

• reviewobject

  Geen aanvullende eigenschappen

• dispositionstringvereist

  enum: "automatic", "human_required"

• recipient_countinteger | nullvereist

  minimum: 0

• reasonsarrayvereist
• Elk itemstring

  Verdere nesting weggelaten

• checksarrayvereist
• Elk itemstring

  Verdere nesting weggelaten

curl-voorbeeld

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

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody vereist

application/octet-stream

• valuestring

  format: "binary" · maxLength: 26214400

Succesresponse 201

Succesvolle response.

application/json

• valueobject
• dataobjectvereist
• idstringvereist

  format: "uuid"

• filenamestringvereist
• content_typestringvereist
• size_bytesintegervereist
• sha256string
• created_atstring

  format: "date-time"

curl-voorbeeld

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

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody

Het contract specificeert geen requestbody.

Succesresponse 204

Bijlage ingepland voor versiebewuste B2-verwijdering.

Geen responsebody.

curl-voorbeeld

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

HTML-body van een concept lezen

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody

Het contract specificeert geen requestbody.

Succesresponse 200

Concept-HTML.

text/html

• valuestring

curl-voorbeeld

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

listSendIntents

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody

Het contract specificeert geen requestbody.

Succesresponse 200

Recente gezaghebbende verzendingen en hun providerstatus.

application/json

• valueobject
• dataarrayvereist
• Elk itemobject

  Geen aanvullende eigenschappen

• idstringvereist

  format: "uuid"

• statusstringvereist

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

• traffic_classstringvereist

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

• recipient_countintegervereist

  minimum: 1

• provider_keystringvereist
• provider_statestringvereist

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

• provider_message_idstring | null
• error_codestring | null
• created_atstringvereist

  format: "date-time"

• updated_atstringvereist

  format: "date-time"

• completed_atstring | null

  format: "date-time"

curl-voorbeeld

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

getSendIntent

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody

Het contract specificeert geen requestbody.

Succesresponse 200

Gezaghebbende asynchrone verzendstatus.

application/json

• valueobject
• dataobjectvereist

  Geen aanvullende eigenschappen

• idstringvereist

  format: "uuid"

• statusstringvereist

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

• traffic_classstringvereist

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

• recipient_countintegervereist

  minimum: 1

• provider_keystringvereist
• provider_statestringvereist

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

• provider_message_idstring | null
• error_codestring | null
• created_atstringvereist

  format: "date-time"

• updated_atstringvereist

  format: "date-time"

• completed_atstring | null

  format: "date-time"

curl-voorbeeld

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

listTransactionalSends

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody

Het contract specificeert geen requestbody.

Succesresponse 200

Succesvolle response.

application/json

• valueobject
• dataarrayvereist
• Elk itemobject
• idstringvereist

  format: "uuid"

• mailbox_idstring | nullvereist

  format: "uuid"

• command_idstring | nullvereist

  format: "uuid"

• statusstringvereist
• command_statusstring | nullvereist
• subjectstring
• recipientsarray
• Elk itemobject
• emailstringvereist
• namestring
• recipient_countintegervereist
• error_codestring | null
• send_intent_idstring

  format: "uuid"

• providerstring | null
• route_kindstring | null
• sourcestring
• from_addressstring
• recipient_statesobject
• Aanvullende eigenschapinteger
• provider_message_idstring | null
• languageniet gespecificeerd

  De taal waarin deze e-mail is verstuurd; null als hij niet is vertaald.

• anyOf 1object

  De taal waarin iemand een e-mail kreeg. Alleen vertaalde e-mails (beheerde inhoud) hebben die.

• localestringvereist

  BCP 47-tag van de taal waarin de e-mail is geschreven.

• requested_localestring

  Alleen aanwezig bij een oudere verzending in een andere taal: de taal waarin de persoon die had moeten krijgen.

• fallback_reasonstring

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

• anyOf 2null
• journeyobject | null

  De Journey-stap en inschrijving die deze e-mail verstuurden; null voor andere verzendingen.

• journey_idstringvereist

  format: "uuid"

• step_idstringvereist

  format: "uuid"

• enrollment_idstringvereist

  format: "uuid"

• experimentobject | null

  De experimentvariant van deze e-mail; null als geen variant van toepassing was.

• experiment_idstringvereist

  format: "uuid"

• variant_keystringvereist
• created_atstringvereist

  format: "date-time"

• updated_atstringvereist

  format: "date-time"

• completed_atstring | nullvereist

  format: "date-time"

• template_idstring | null

  format: "uuid"

• template_versioninteger | null
• workspace_revisioninteger | null
• command_resultobject
• Aanvullende eigenschapElke waarde
• command_started_atstring | null

  format: "date-time"

• command_completed_atstring | null

  format: "date-time"

• body_textstring
• body_htmlstring
• reply_toarray
• Elk itemobject
• emailstringvereist
• namestring
• headersobject
• Aanvullende eigenschapstring
• tagsarray
• Elk itemobject
• namestringvereist
• valuestringvereist

curl-voorbeeld

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

createTransactionalSend

Eén ontvanger per Journey-verzending. To accepteert één ontvanger in elke RecipientInput-vorm ("a@example.com", "Pat <a@example.com>", { email, name }, of een lijst met één element); Cc en Bcc moeten leeg zijn. reply_to gebruikt standaard de Journey-mailbox (een lege lijst betekent ook de standaard); Product-e-mail vereist precies één. Een nieuwe API-Journey gebruikt standaard beheerde broninhoud; oude code-Journeys blijven volledige inhoud versturen. Bij weigering (4xx) wordt niets voor de ontvanger bevroren, dus een gecorrigeerde aanroep met een nieuwe idempotentiesleutel verstuurt.

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody vereist

application/json

• valueobject
• mailbox_idstringvereist

  format: "uuid"

• toniet gespecificeerdvereist

  Ontvangers voor to, cc, bcc en reply_to: een adres ("a@example.com" of "Pat <a@example.com>"), een { email, name }-object of een lijst met beide vormen. Banger bewaart ze als { email, name }-objecten met het e-mailadres in kleine letters. De idempotentiehash omvat de body zoals verstuurd; herhaal dus met dezelfde vorm.

• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringvereist

  format: "email"

• oneOf 3array

  maxItems: 500

• Elk itemniet gespecificeerd
• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringvereist

  format: "email"

• ccarray

  maxItems: 0

• Elk itemobject
• namestring
• emailstringvereist

  format: "email"

• bccarray

  maxItems: 0

• Elk itemobject
• namestring
• emailstringvereist

  format: "email"

• subjectstring

  maxLength: 10000

• expires_atstring

  Verwerp een uitgestelde Journey-verzending na dit tijdstip; maximaal zeven dagen na het oorspronkelijke verzoek.

  format: "date-time"

• expires_after_secondsinteger

  minimum: 1 · maximum: 604800

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

• reply_toniet gespecificeerd

  Ontvangers voor to, cc, bcc en reply_to: een adres ("a@example.com" of "Pat <a@example.com>"), een { email, name }-object of een lijst met beide vormen. Banger bewaart ze als { email, name }-objecten met het e-mailadres in kleine letters. De idempotentiehash omvat de body zoals verstuurd; herhaal dus met dezelfde vorm.

• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringvereist

  format: "email"

• oneOf 3array

  maxItems: 500

• Elk itemniet gespecificeerd
• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringvereist

  format: "email"

• headersobject
• Aanvullende eigenschapstring

  maxLength: 5000

• tagsarray

  maxItems: 49

• Elk itemobject

  Geen aanvullende eigenschappen

• namestringvereist

  minLength: 1 · maxLength: 256

• valuestringvereist

  minLength: 1 · maxLength: 256

Succesresponse 202

Succesvolle response.

application/json

• valueobject
• dataobjectvereist
• action_kindstringvereist

  enum: "transactional.send"

• idstring

  format: "uuid"

• send_intent_idstring

  format: "uuid"

• provider_attempt_idstring

  format: "uuid"

• statusstringvereist

  sent/queued-statussen uit de bezorging, of voor een bevroren verzoek: deferred (ingepland door beleid of wachtend op vertaling), processing (wordt verstuurd), discarded.

• replayedboolean
• journeyniet gespecificeerdvereist
• anyOf 1object
• journey_idstringvereist

  format: "uuid"

• enrollment_idstringvereist

  format: "uuid"

• step_idstringvereist

  format: "uuid"

• step_positionintegervereist
• originstring

  enum: "journey"

• journey_identitystring
• anyOf 2null
• ignored_variablesarrayvereist
• Elk itemstring
• scheduled_atstring

  format: "date-time"

• reasonstring
• communication_reservation_idstring

  format: "uuid"

curl-voorbeeld

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

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody

Het contract specificeert geen requestbody.

Succesresponse 200

Succesvolle response.

application/json

• valueobject
• dataobjectvereist
• idstringvereist

  format: "uuid"

• mailbox_idstring | nullvereist

  format: "uuid"

• command_idstring | nullvereist

  format: "uuid"

• statusstringvereist
• command_statusstring | nullvereist
• subjectstring
• recipientsarray
• Elk itemobject
• emailstringvereist
• namestring
• recipient_countintegervereist
• error_codestring | null
• send_intent_idstring

  format: "uuid"

• providerstring | null
• route_kindstring | null
• sourcestring
• from_addressstring
• recipient_statesobject
• Aanvullende eigenschapinteger
• provider_message_idstring | null
• languageniet gespecificeerd

  De taal waarin deze e-mail is verstuurd; null als hij niet is vertaald.

• anyOf 1object

  De taal waarin iemand een e-mail kreeg. Alleen vertaalde e-mails (beheerde inhoud) hebben die.

• localestringvereist

  BCP 47-tag van de taal waarin de e-mail is geschreven.

• requested_localestring

  Alleen aanwezig bij een oudere verzending in een andere taal: de taal waarin de persoon die had moeten krijgen.

• fallback_reasonstring

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

• anyOf 2null
• journeyobject | null

  De Journey-stap en inschrijving die deze e-mail verstuurden; null voor andere verzendingen.

• journey_idstringvereist

  format: "uuid"

• step_idstringvereist

  format: "uuid"

• enrollment_idstringvereist

  format: "uuid"

• experimentobject | null

  De experimentvariant van deze e-mail; null als geen variant van toepassing was.

• experiment_idstringvereist

  format: "uuid"

• variant_keystringvereist
• created_atstringvereist

  format: "date-time"

• updated_atstringvereist

  format: "date-time"

• completed_atstring | nullvereist

  format: "date-time"

• template_idstring | null

  format: "uuid"

• template_versioninteger | null
• workspace_revisioninteger | null
• command_resultobject
• Aanvullende eigenschapElke waarde
• command_started_atstring | null

  format: "date-time"

• command_completed_atstring | null

  format: "date-time"

• body_textstring
• body_htmlstring
• reply_toarray
• Elk itemobject
• emailstringvereist
• namestring
• headersobject
• Aanvullende eigenschapstring
• tagsarray
• Elk itemobject
• namestringvereist
• valuestringvereist

curl-voorbeeld

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

listTransactionalSendTimeline

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody

Het contract specificeert geen requestbody.

Succesresponse 200

Geordende tijdlijn van acceptatie, providerpogingen en ontvangergebeurtenissen.

application/json

• valueobject
• dataarrayvereist
• Elk itemobject
• occurred_atstringvereist

  format: "date-time"

• event_typestringvereist
• labelstringvereist
• providerstring | null
• recipient_domainstring | null
• error_codestring | null

curl-voorbeeld

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

retryTransactionalSend

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody

Het contract specificeert geen requestbody.

Succesresponse 202

Succesvolle response.

application/json

• valueobject
• dataobjectvereist
• action_kindstringvereist

  enum: "transactional.send"

• idstringvereist

  format: "uuid"

• send_intent_idstringvereist

  format: "uuid"

• provider_attempt_idstringvereist

  format: "uuid"

• statusstringvereist
• replayedbooleanvereist

curl-voorbeeld

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

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody

Het contract specificeert geen requestbody.

Succesresponse 200

Werkruimtegesprekken met keyset-paginering.

application/json

• valueobject
• dataarrayvereist
• Elk itemobject
• idstringvereist

  format: "uuid"

• mailbox_idstringvereist

  format: "uuid"

• subjectstringvereist
• snippetstringvereist
• last_message_atstringvereist

  format: "date-time"

• message_countintegervereist
• unread_countintegervereist
• is_archivedbooleanvereist
• is_trashbooleanvereist
• is_spambooleanvereist
• is_starredbooleanvereist
• is_sentbooleanvereist
• has_attachmentsbooleanvereist
• labelsarrayvereist
• Elk itemstring
• participantsarray
• Elk itemobject
• namestring
• emailstringvereist

  format: "email"

• pageobjectvereist
• next_cursorstring
• has_morebooleanvereist

curl-voorbeeld

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

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody

Het contract specificeert geen requestbody.

Succesresponse 200

Gesprek en geordende berichten.

application/json

• valueobject
• dataniet gespecificeerdvereist
• allOf 1object
• idstringvereist

  format: "uuid"

• mailbox_idstringvereist

  format: "uuid"

• subjectstringvereist
• snippetstringvereist
• last_message_atstringvereist

  format: "date-time"

• message_countintegervereist
• unread_countintegervereist
• is_archivedbooleanvereist
• is_trashbooleanvereist
• is_spambooleanvereist
• is_starredbooleanvereist
• is_sentbooleanvereist
• has_attachmentsbooleanvereist
• labelsarrayvereist
• Elk itemstring
• participantsarray
• Elk itemobject
• namestring
• emailstringvereist

  format: "email"

• allOf 2object
• messagesarrayvereist
• Elk itemobject
• idstringvereist

  format: "uuid"

• mailbox_idstringvereist

  format: "uuid"

• thread_idstringvereist

  format: "uuid"

• sent_atstringvereist

  format: "date-time"

• received_atstring

  format: "date-time"

• envelope_recipientsarray

  Oorspronkelijke SMTP-envelopontvangers, door de SMTP-edge omgezet naar één letterkast, vóór routering van aliassen voor alleen ontvangen. Leeg bij oudere berichten of niet-SMTP-bronnen. Onafhankelijk van zichtbare To/Cc-headers.

• Elk itemstring

  format: "email"

  Verdere nesting weggelaten

• fromobjectvereist
• namestring

  Verdere nesting weggelaten

• emailstringvereist

  format: "email"

  Verdere nesting weggelaten

• toarrayvereist
• Elk itemobject

  Verdere nesting weggelaten

• ccarray
• Elk itemobject

  Verdere nesting weggelaten

• reply_toarray
• Elk itemobject

  Verdere nesting weggelaten

• is_sentboolean

  Of dit bericht door de mailbox is verstuurd, ook via een alias.

• body_textstring
• body_html_urlstring

  format: "uri"

• reply_originobject
• send_intent_idstringvereist

  format: "uuid"

  Verdere nesting weggelaten

• sourcestringvereist

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

  Verdere nesting weggelaten

• source_idstring

  format: "uuid"

  Verdere nesting weggelaten

• traffic_classstringvereist

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

  Verdere nesting weggelaten

• kindstringvereist

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

  Verdere nesting weggelaten

• namestring

  Verdere nesting weggelaten

• has_attachmentsbooleanvereist
• attachmentsarray
• Elk itemobject

  Verdere nesting weggelaten

curl-voorbeeld

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

getMessageHtml

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody

Het contract specificeert geen requestbody.

Succesresponse 200

Geauthenticeerde HTML-berichtbody met sandboxbeperkingen.

text/html

• valuestring

curl-voorbeeld

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

downloadAttachment

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody

Het contract specificeert geen requestbody.

Succesresponse 200

Geauthenticeerde bijlagestream.

application/octet-stream

• valuestring

  format: "binary"

curl-voorbeeld

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

searchMail

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody

Het contract specificeert geen requestbody.

Succesresponse 200

Zoekresultaten voor de hele werkruimte.

application/json

• valueobject
• dataarrayvereist
• Elk itemobject
• idstringvereist

  format: "uuid"

• mailbox_idstringvereist

  format: "uuid"

• subjectstringvereist
• snippetstringvereist
• last_message_atstringvereist

  format: "date-time"

• message_countintegervereist
• unread_countintegervereist
• is_archivedbooleanvereist
• is_trashbooleanvereist
• is_spambooleanvereist
• is_starredbooleanvereist
• is_sentbooleanvereist
• has_attachmentsbooleanvereist
• labelsarrayvereist
• Elk itemstring
• participantsarray
• Elk itemobject
• namestring
• emailstringvereist

  format: "email"

• pageobjectvereist
• next_cursorstring
• has_morebooleanvereist

curl-voorbeeld

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

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody

Het contract specificeert geen requestbody.

Succesresponse 200

Succesvolle response.

application/json

• valueobject
• dataarrayvereist
• Elk itemobject
• idstringvereist

  format: "uuid"

• emailstringvereist

  format: "email"

• display_namestring | nullvereist
• attributesobjectvereist
• Aanvullende eigenschapElke waarde
• statusstringvereist

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

• created_atstringvereist

  format: "date-time"

• updated_atstringvereist

  format: "date-time"

• pageobjectvereist
• next_cursorstring
• has_morebooleanvereist

curl-voorbeeld

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

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody vereist

application/json

• valueobject

  Geen aanvullende eigenschappen

• emailstringvereist

  format: "email"

• display_namestring

  maxLength: 1000

• statusstringvereist

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

• attributesobject
• Aanvullende eigenschapElke waarde
• consent_confirmedboolean

  Vereist bij een nieuwe inschrijving van een adres.

Succesresponse 201

Succesvolle response.

application/json

• valueobject
• dataobjectvereist
• idstringvereist

  format: "uuid"

• emailstringvereist

  format: "email"

• display_namestring | nullvereist
• attributesobjectvereist
• Aanvullende eigenschapElke waarde
• statusstringvereist

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

• created_atstringvereist

  format: "date-time"

• updated_atstringvereist

  format: "date-time"

curl-voorbeeld

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

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody

Het contract specificeert geen requestbody.

Succesresponse 200

Succesvolle response.

application/json

• valueobject
• dataobjectvereist
• idstringvereist

  format: "uuid"

• emailstringvereist

  format: "email"

• display_namestring | nullvereist
• attributesobjectvereist
• Aanvullende eigenschapElke waarde
• statusstringvereist

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

• created_atstringvereist

  format: "date-time"

• updated_atstringvereist

  format: "date-time"

• suppressedbooleanvereist
• suppression_reasonstring | nullvereist
• sourcesarrayvereist
• Elk itemobject
• kindstringvereist
• referencestringvereist
• connection_idstring | nullvereist

  format: "uuid"

• metadataobjectvereist
• Aanvullende eigenschapElke waarde
• first_seen_atstringvereist

  format: "date-time"

• last_seen_atstringvereist

  format: "date-time"

• listsarrayvereist
• Elk itemobject
• idstringvereist

  format: "uuid"

• namestringvereist
• subscription_statusstringvereist
• consent_evidencearrayvereist
• Elk itemobject
• kindstringvereist
• referencestringvereist
• connection_idstring | nullvereist

  format: "uuid"

• metadataobjectvereist
• Aanvullende eigenschapElke waarde
• first_seen_atstringvereist

  format: "date-time"

• last_seen_atstringvereist

  format: "date-time"

curl-voorbeeld

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

deleteContact

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody

Het contract specificeert geen requestbody.

Succesresponse 204

Contact verwijderd.

Geen responsebody.

curl-voorbeeld

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

listContactImports

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody

Het contract specificeert geen requestbody.

Succesresponse 200

Succesvolle response.

application/json

• valueobject
• dataarrayvereist
• Elk itemobject
• idstring

  format: "uuid"

• filenamestring
• list_idstring | null

  format: "uuid"

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

curl-voorbeeld

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

importContacts

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody vereist

application/json

• valueobject
• filenamestringvereist

  minLength: 1 · maxLength: 500

• list_idstring

  format: "uuid"

• consent_confirmedboolean

  Vereist wanneer een geïmporteerde rij is ingeschreven.

• rowsarrayvereist

  minItems: 1 · maxItems: 5000

• Elk itemobject
• emailstringvereist

  format: "email"

• display_namestring

  maxLength: 1000

• statusstring

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

• attributesobject
• Aanvullende eigenschapElke waarde

Succesresponse 201

Succesvolle response.

application/json

• valueobject
• dataobjectvereist
• idstringvereist

  format: "uuid"

• statusstringvereist

  enum: "queued"

• total_rowsintegervereist
• imported_rowsintegervereist
• invalid_rowsintegervereist
• list_idstring | nullvereist

  format: "uuid"

curl-voorbeeld

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

Getypeerde attributen samenvoegen zonder inschrijving of toestemming te wijzigen

Vereist contacts:write en contacts:read. Werkt alleen een bestaand contact bij. Weggelaten attributen blijven behouden, expliciete false wordt opgeslagen en null verwijdert een veld. Geef geverifieerde bronfeiten op; ontbrekende gegevens zijn niet false. Inschrijving, blokkering, identiteit en brongeschiedenis blijven ongewijzigd.

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody vereist

application/json

• valueobject

  Geen aanvullende eigenschappen

• attributesobjectvereist
• Aanvullende eigenschapElke waarde

Succesresponse 200

Huidige teruggelezen contactgegevens; replayed is true als deze wijziging al is toegepast.

application/json

• valueobject
• dataobjectvereist
• idstringvereist

  format: "uuid"

• attributesobjectvereist
• Aanvullende eigenschapElke waarde
• statusstringvereist

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

• replayedbooleanvereist
• Aanvullende eigenschapElke waarde

curl-voorbeeld

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

Authenticatie: Bearer-API-sleutel van de werkruimte.

Parameters

Requestbody vereist

application/json

• valueobject

  Geen aanvullende eigenschappen

• emailstringvereist

  format: "email" · maxLength: 320

• display_namestring

  minLength: 0 · maxLength: 1000

• attributesobject
• Aanvullende eigenschapElke waarde
• statusstringvereist

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

• consent_evidenceobject

  Geen aanvullende eigenschappen

• sourcestring

  minLength: 1 · maxLength: 2000

• referencestring

  minLength: 1 · maxLength: 2000

• observed_atstring

  format: "date-time"

• statementstring

  minLength: 1 · maxLength: 2000

• consent_confirmedboolean

Succesresponse 200

Gezaghebbende teruglezing of idempotent ontvangstbewijs. Acceptatie door de provider is sent; delivered vereist een bezorggebeurtenis en bewijst geen plaatsing in de inbox.

application/json

• valueobject
• dataniet gespecificeerdvereist
• allOf 1object
• idstringvereist

  format: "uuid"

• emailstringvereist

  format: "email"

• display_namestring | nullvereist
• attributesobjectvereist
• Aanvullende eigenschapElke waarde
• statusstringvereist

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

• created_atstringvereist

  format: "date-time"

• updated_atstringvereist

  format: "date-time"

• suppressedbooleanvereist
• suppression_reasonstring | nullvereist
• sourcesarrayvereist
• Elk itemobject
• kindstringvereist
• referencestringvereist
• connection_idstring | nullvereist

  format: "uuid"

• metadataobjectvereist
• Aanvullende eigenschapElke waarde
• first_seen_atstringvereist

  format: "date-time"

• last_seen_atstringvereist

  format: "date-time"

• listsarrayvereist
• Elk itemobject
• idstringvereist

  format: "uuid"

• namestringvereist
• subscription_statusstringvereist
• consent_evidencearrayvereist
• Elk itemobject
• kindstringvereist
• referencestringvereist
• connection_idstring | nullvereist

  format: "uuid"

• metadataobjectvereist
• Aanvullende eigenschapElke waarde
• first_seen_atstringvereist

  format: "date-time"

• last_seen_atstringvereist

  format: "date-time"

• allOf 2object
• replayedbooleanvereist