Banger API reference

List workspace products

Authentication: Bearer workspace API key.

Parameters

Request body

No request body is specified in the contract.

Success response 200

Successful response.

application/json

• valueobject
• dataarrayrequired
• Each itemobject
• idstringrequired

  format: "uuid"

• workspace_idstringrequired

  format: "uuid"

• namestringrequired
• slugstringrequired
• kindstringrequired

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

• website_urlstring | nullrequired
• domainsarrayrequired
• Each itemstring
• descriptionstringrequired
• contextobjectrequired
• Additional propertyAny value
• brandobjectrequired
• company_namestring

  maxLength: 160

• logo_urlstring

  The icon: the mark on its own, used small (email footer, slide-in forms) and as the header when there is no wordmark.

  maxLength: 2000

• wordmark_urlstring

  The wordmark: the company name as drawn, shown alone at the top of every email.

  maxLength: 2000

• wordmark_inkstring

  The color the wordmark is drawn in, measured from the image on save. A header the mark wouldn't read on gets a plate behind it. Absent for opaque images.

  maxLength: 7

• logo_inkstring

  The color the icon is drawn in, measured from the image on save.

  maxLength: 7

• 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

• statusstringrequired

  deleting: deleted by a person; restorable until delete_after, then removed for good.

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

• delete_afterstring | null

  When a deleting product is removed for good.

  format: "date-time"

• is_defaultbooleanrequired
• route_readybooleanrequired
• setuparrayrequired
• Each itemobject
• keystringrequired

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

• statusstringrequired

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

• completion_sourcestring | nullrequired

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

• notestringrequired
• updated_atstring | nullrequired

  format: "date-time"

• created_atstringrequired

  format: "date-time"

• updated_atstringrequired

  format: "date-time"

curl example

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

Create a product

Authentication: Bearer workspace API key.

Parameters

Request body required

application/json

• valueobject
• namestringrequired

  minLength: 1 · maxLength: 160

• kindstring

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

• website_urlstring | null

  maxLength: 2000

• descriptionstring

  maxLength: 4000

• contextobject
• Additional propertyAny value
• domainsarray

  maxItems: 20

• Each itemstring

  maxLength: 253

Success response 201

Successful response.

application/json

• valueobject
• dataobjectrequired
• idstringrequired

  format: "uuid"

• workspace_idstringrequired

  format: "uuid"

• namestringrequired
• slugstringrequired
• kindstringrequired

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

• website_urlstring | nullrequired
• domainsarrayrequired
• Each itemstring
• descriptionstringrequired
• contextobjectrequired
• Additional propertyAny value
• brandobjectrequired
• company_namestring

  maxLength: 160

• logo_urlstring

  The icon: the mark on its own, used small (email footer, slide-in forms) and as the header when there is no wordmark.

  maxLength: 2000

• wordmark_urlstring

  The wordmark: the company name as drawn, shown alone at the top of every email.

  maxLength: 2000

• wordmark_inkstring

  The color the wordmark is drawn in, measured from the image on save. A header the mark wouldn't read on gets a plate behind it. Absent for opaque images.

  maxLength: 7

• logo_inkstring

  The color the icon is drawn in, measured from the image on save.

  maxLength: 7

• 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

• statusstringrequired

  deleting: deleted by a person; restorable until delete_after, then removed for good.

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

• delete_afterstring | null

  When a deleting product is removed for good.

  format: "date-time"

• is_defaultbooleanrequired
• route_readybooleanrequired
• setuparrayrequired
• Each itemobject
• keystringrequired

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

• statusstringrequired

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

• completion_sourcestring | nullrequired

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

• notestringrequired
• updated_atstring | nullrequired

  format: "date-time"

• created_atstringrequired

  format: "date-time"

• updated_atstringrequired

  format: "date-time"

curl example

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

Get a product

Authentication: Bearer workspace API key.

Parameters

Request body

No request body is specified in the contract.

Success response 200

Successful response.

application/json

• valueobject
• dataobjectrequired
• idstringrequired

  format: "uuid"

• workspace_idstringrequired

  format: "uuid"

• namestringrequired
• slugstringrequired
• kindstringrequired

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

• website_urlstring | nullrequired
• domainsarrayrequired
• Each itemstring
• descriptionstringrequired
• contextobjectrequired
• Additional propertyAny value
• brandobjectrequired
• company_namestring

  maxLength: 160

• logo_urlstring

  The icon: the mark on its own, used small (email footer, slide-in forms) and as the header when there is no wordmark.

  maxLength: 2000

• wordmark_urlstring

  The wordmark: the company name as drawn, shown alone at the top of every email.

  maxLength: 2000

• wordmark_inkstring

  The color the wordmark is drawn in, measured from the image on save. A header the mark wouldn't read on gets a plate behind it. Absent for opaque images.

  maxLength: 7

• logo_inkstring

  The color the icon is drawn in, measured from the image on save.

  maxLength: 7

• 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

• statusstringrequired

  deleting: deleted by a person; restorable until delete_after, then removed for good.

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

• delete_afterstring | null

  When a deleting product is removed for good.

  format: "date-time"

• is_defaultbooleanrequired
• route_readybooleanrequired
• setuparrayrequired
• Each itemobject
• keystringrequired

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

• statusstringrequired

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

• completion_sourcestring | nullrequired

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

• notestringrequired
• updated_atstring | nullrequired

  format: "date-time"

• created_atstringrequired

  format: "date-time"

• updated_atstringrequired

  format: "date-time"

curl example

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

Update a product

Authentication: Bearer workspace API key.

Parameters

Request body required

application/json

• valueobject
• namestring

  maxLength: 160

• kindstring

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

• website_urlstring | null

  maxLength: 2000

• descriptionstring

  maxLength: 4000

• contextobject
• Additional propertyAny value
• brandobject
• company_namestring

  maxLength: 160

• logo_urlstring

  The icon: the mark on its own, used small (email footer, slide-in forms) and as the header when there is no wordmark.

  maxLength: 2000

• wordmark_urlstring

  The wordmark: the company name as drawn, shown alone at the top of every email.

  maxLength: 2000

• wordmark_inkstring

  The color the wordmark is drawn in, measured from the image on save. A header the mark wouldn't read on gets a plate behind it. Absent for opaque images.

  maxLength: 7

• logo_inkstring

  The color the icon is drawn in, measured from the image on save.

  maxLength: 7

• 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"

Success response 200

Successful response.

application/json

• valueobject
• dataobjectrequired
• idstringrequired

  format: "uuid"

• workspace_idstringrequired

  format: "uuid"

• namestringrequired
• slugstringrequired
• kindstringrequired

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

• website_urlstring | nullrequired
• domainsarrayrequired
• Each itemstring
• descriptionstringrequired
• contextobjectrequired
• Additional propertyAny value
• brandobjectrequired
• company_namestring

  maxLength: 160

• logo_urlstring

  The icon: the mark on its own, used small (email footer, slide-in forms) and as the header when there is no wordmark.

  maxLength: 2000

• wordmark_urlstring

  The wordmark: the company name as drawn, shown alone at the top of every email.

  maxLength: 2000

• wordmark_inkstring

  The color the wordmark is drawn in, measured from the image on save. A header the mark wouldn't read on gets a plate behind it. Absent for opaque images.

  maxLength: 7

• logo_inkstring

  The color the icon is drawn in, measured from the image on save.

  maxLength: 7

• 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

• statusstringrequired

  deleting: deleted by a person; restorable until delete_after, then removed for good.

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

• delete_afterstring | null

  When a deleting product is removed for good.

  format: "date-time"

• is_defaultbooleanrequired
• route_readybooleanrequired
• setuparrayrequired
• Each itemobject
• keystringrequired

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

• statusstringrequired

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

• completion_sourcestring | nullrequired

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

• notestringrequired
• updated_atstring | nullrequired

  format: "date-time"

• created_atstringrequired

  format: "date-time"

• updated_atstringrequired

  format: "date-time"

curl example

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

Delete one product (a project in the app) after reviewing its deletion preview. It leaves use at once (its sending stops) and stays restorable for 24 hours; then Banger removes its sending domains and every row it owns. The workspace's last active product cannot be deleted. Requires workspace admin and a signed-in session; API keys and OAuth grants are refused.

Authentication: Bearer workspace API key.

Parameters

Request body required

application/json

• valueobject

  No additional properties

• confirm_namestringrequired

  The exact product name.

  minLength: 1 · maxLength: 160

• preview_tokenstringrequired

  minLength: 64 · maxLength: 64

Success response 202

The product is out of use and is deleted for good at delete_after unless restored first. An idempotent replay returns the same result.

application/json

• valueobject
• dataobjectrequired
• idstringrequired

  format: "uuid"

• namestringrequired
• statusstringrequired

  enum: "deleting"

• delete_afterstringrequired

  When the product is deleted for good; until then it can be restored.

  format: "date-time"

• next_product_idstringrequired

  The workspace's default product now.

  format: "uuid"

• replayedboolean

curl example

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

Preview deleting one product and everything it owns, without deleting anything. Requires workspace admin, signed in or through user-authorized OAuth.

Authentication: Bearer workspace API key.

Parameters

Request body

No request body is specified in the contract.

Success response 200

What deleting the product removes and stops.

application/json

• valueobject
• dataobjectrequired
• productobjectrequired
• idstringrequired

  format: "uuid"

• namestringrequired
• is_defaultbooleanrequired
• next_default_productunspecifiedrequired

  The product that becomes the workspace default when the default is deleted.

• oneOf 1null
• oneOf 2object
• idstringrequired

  format: "uuid"

• namestringrequired
• last_productbooleanrequired

  The only active product cannot be deleted.

• mailboxesarrayrequired
• Each itemobject
• idstringrequired

  format: "uuid"

• addressstringrequired
• domainsarrayrequired

  Sending domains Banger removes once the restore window has passed.

• Each itemobject
• idstringrequired

  format: "uuid"

• domainstringrequired
• journeysintegerrequired
• broadcastsintegerrequired
• signup_formsintegerrequired
• contactsintegerrequired
• api_keysintegerrequired
• webhooksintegerrequired
• pending_sendsintegerrequired
• impactarrayrequired
• Each itemstring
• preview_tokenstringrequired

curl example

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

Restore a deleted product before its delete_after. Its mailboxes, Journeys, signup forms, webhooks and integrations are switched back on; Broadcasts stay paused. Requires workspace admin, signed in or through user-authorized OAuth.

Authentication: Bearer workspace API key.

Parameters

Request body

No request body is specified in the contract.

Success response 200

The product is active again.

application/json

• valueobject
• dataobjectrequired
• idstringrequired

  format: "uuid"

• namestringrequired
• statusstringrequired

  enum: "active"

curl example

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

Update a product setup item

Authentication: Bearer workspace API key.

Parameters

Request body required

application/json

• valueobject
• statusstringrequired

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

• completion_sourcestring

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

• notestring

  maxLength: 1000

Success response 200

Successful response.

application/json

• valueobject
• dataobjectrequired
• keystringrequired

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

• statusstringrequired

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

• completion_sourcestring | nullrequired

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

• notestringrequired
• updated_atstring | nullrequired

  format: "date-time"

curl example

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

Associate a domain with a product

Authentication: Bearer workspace API key.

Parameters

Request body required

application/json

• valueobject
• domainstringrequired

  minLength: 3 · maxLength: 253

Success response 201

Successful response.

application/json

• valueobject
• dataobjectrequired
• idstringrequired

  format: "uuid"

• workspace_idstringrequired

  format: "uuid"

• namestringrequired
• slugstringrequired
• kindstringrequired

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

• website_urlstring | nullrequired
• domainsarrayrequired
• Each itemstring
• descriptionstringrequired
• contextobjectrequired
• Additional propertyAny value
• brandobjectrequired
• company_namestring

  maxLength: 160

• logo_urlstring

  The icon: the mark on its own, used small (email footer, slide-in forms) and as the header when there is no wordmark.

  maxLength: 2000

• wordmark_urlstring

  The wordmark: the company name as drawn, shown alone at the top of every email.

  maxLength: 2000

• wordmark_inkstring

  The color the wordmark is drawn in, measured from the image on save. A header the mark wouldn't read on gets a plate behind it. Absent for opaque images.

  maxLength: 7

• logo_inkstring

  The color the icon is drawn in, measured from the image on save.

  maxLength: 7

• 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

• statusstringrequired

  deleting: deleted by a person; restorable until delete_after, then removed for good.

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

• delete_afterstring | null

  When a deleting product is removed for good.

  format: "date-time"

• is_defaultbooleanrequired
• route_readybooleanrequired
• setuparrayrequired
• Each itemobject
• keystringrequired

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

• statusstringrequired

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

• completion_sourcestring | nullrequired

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

• notestringrequired
• updated_atstring | nullrequired

  format: "date-time"

• created_atstringrequired

  format: "date-time"

• updated_atstringrequired

  format: "date-time"

curl example

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

Authentication: Bearer workspace API key.

Parameters

Request body

No request body is specified in the contract.

Success response 200

Mailboxes visible to the actor.

application/json

• valueobject
• dataarrayrequired
• Each itemobject
• idstringrequired

  format: "uuid"

• workspace_idstringrequired

  format: "uuid"

• product_idstring | null

  The product (project) the mailbox belongs to. Clients group mailboxes and build web-app links with it.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringrequired

  The email address, or for an SMS inbox its phone number in E.164 (+15551234567).

• display_namestringrequired
• providerstringrequired

  enum: "gmail", "smtp", "twilio"

• channelstring

  email; sms for an SMS inbox on Twilio; whatsapp for a WhatsApp inbox, a WhatsApp sender on Twilio for the business's WhatsApp Business account.

  enum: "email", "sms", "whatsapp"

• sms_verificationobject | null

  A number from Banger, carriers' answer on its toll-free verification. It sends once approved; null for every other mailbox.

• statusstring

  enum: "pending_review", "in_review", "approved", "rejected"

• reasonstring | null

  Carriers' reason when rejected.

• statusstringrequired

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringrequired

  enum: "domain", "starter"

curl example

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

Create a Banger-native work mailbox on a workspace sending domain.

Authentication: Bearer workspace API key.

Parameters

Request body required

application/json

• valueobject

  No additional properties

• domain_idstringrequired

  format: "uuid"

• local_partstringrequired

  minLength: 1 · maxLength: 64

• display_namestring

  maxLength: 200

Success response 200

Idempotent replay of a native mailbox creation.

application/json

• valueobject
• dataobjectrequired
• idstringrequired

  format: "uuid"

• workspace_idstringrequired

  format: "uuid"

• product_idstring | null

  The product (project) the mailbox belongs to. Clients group mailboxes and build web-app links with it.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringrequired

  The email address, or for an SMS inbox its phone number in E.164 (+15551234567).

• display_namestringrequired
• providerstringrequired

  enum: "gmail", "smtp", "twilio"

• channelstring

  email; sms for an SMS inbox on Twilio; whatsapp for a WhatsApp inbox, a WhatsApp sender on Twilio for the business's WhatsApp Business account.

  enum: "email", "sms", "whatsapp"

• sms_verificationobject | null

  A number from Banger, carriers' answer on its toll-free verification. It sends once approved; null for every other mailbox.

• statusstring

  enum: "pending_review", "in_review", "approved", "rejected"

• reasonstring | null

  Carriers' reason when rejected.

• statusstringrequired

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringrequired

  enum: "domain", "starter"

curl example

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

Add an SMS inbox for a number on the company's own Twilio account. Banger checks the account owns the number, points its incoming texts at the inbox, and keeps the Auth Token encrypted. A workspace admin signed in to the web app does this; it needs the customers workspace feature.

Authentication: Bearer workspace API key.

Parameters

Request body required

application/json

• valueobject

  No additional properties

• account_sidstringrequired

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

• auth_tokenstringrequired

  minLength: 16 · maxLength: 128

• phone_numberstringrequired

  The Twilio number in E.164.

• display_namestring

  maxLength: 200

Success response 201

The SMS inbox.

application/json

• valueobject
• dataobjectrequired
• idstringrequired

  format: "uuid"

• workspace_idstringrequired

  format: "uuid"

• product_idstring | null

  The product (project) the mailbox belongs to. Clients group mailboxes and build web-app links with it.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringrequired

  The email address, or for an SMS inbox its phone number in E.164 (+15551234567).

• display_namestringrequired
• providerstringrequired

  enum: "gmail", "smtp", "twilio"

• channelstring

  email; sms for an SMS inbox on Twilio; whatsapp for a WhatsApp inbox, a WhatsApp sender on Twilio for the business's WhatsApp Business account.

  enum: "email", "sms", "whatsapp"

• sms_verificationobject | null

  A number from Banger, carriers' answer on its toll-free verification. It sends once approved; null for every other mailbox.

• statusstring

  enum: "pending_review", "in_review", "approved", "rejected"

• reasonstring | null

  Carriers' reason when rejected.

• statusstringrequired

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringrequired

  enum: "domain", "starter"

curl example

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/mailboxes/sms' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "account_sid": "example",
  "auth_token": "examplexxxxxxxxx",
  "phone_number": "example",
  "display_name": "example"
}'

What the web app needs to open Meta's Embedded Signup for a WhatsApp inbox (Banger is a Tech Provider under Twilio). A workspace admin in the web app; needs the customers workspace feature and a paid plan.

Authentication: Bearer workspace API key.

Parameters

Request body

No request body is specified in the contract.

Success response 200

Banger's Meta app and its Embedded Signup configuration.

application/json

• valueobject
• dataobjectrequired
• app_idstringrequired
• config_idstringrequired
• solution_idstringrequired

  Twilio's Partner Solution id for Banger's Meta app.

• graph_versionstringrequired

curl example

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

Finish connecting a WhatsApp number as an inbox, with the WhatsApp Business account Meta's Embedded Signup returned. Banger registers the number as a WhatsApp sender in the workspace's Twilio sub-account; the inbox is pending until the sender is ONLINE.

Authentication: Bearer workspace API key.

Parameters

Request body required

application/json

• valueobject

  No additional properties

• waba_idstringrequired
• phone_numberstringrequired

  The number the business chose in the signup

• display_namestring

  The name WhatsApp shows; required for a number from Banger.

  maxLength: 200

Success response 201

The WhatsApp inbox.

application/json

• valueobject
• dataobjectrequired
• idstringrequired

  format: "uuid"

• workspace_idstringrequired

  format: "uuid"

• product_idstring | null

  The product (project) the mailbox belongs to. Clients group mailboxes and build web-app links with it.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringrequired

  The email address, or for an SMS inbox its phone number in E.164 (+15551234567).

• display_namestringrequired
• providerstringrequired

  enum: "gmail", "smtp", "twilio"

• channelstring

  email; sms for an SMS inbox on Twilio; whatsapp for a WhatsApp inbox, a WhatsApp sender on Twilio for the business's WhatsApp Business account.

  enum: "email", "sms", "whatsapp"

• sms_verificationobject | null

  A number from Banger, carriers' answer on its toll-free verification. It sends once approved; null for every other mailbox.

• statusstring

  enum: "pending_review", "in_review", "approved", "rejected"

• reasonstring | null

  Carriers' reason when rejected.

• statusstringrequired

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringrequired

  enum: "domain", "starter"

curl example

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

Toll-free numbers Banger can buy for this workspace, which text phones in the US and Canada. Needs the customers workspace feature and a paid plan.

Authentication: Bearer workspace API key.

Parameters

Request body

No request body is specified in the contract.

Success response 200

Numbers to pick from.

application/json

• valueobject
• dataarrayrequired
• Each itemobject
• phone_numberstringrequired
• kindstringrequired

  enum: "toll_free"

• reachesarrayrequired
• Each itemstring

curl example

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

Buy a toll-free number as an SMS inbox and ask carriers to approve it with the business's details. It receives texts at once and sends once carriers approve, usually within a few days. It texts the US and Canada only.

Authentication: Bearer workspace API key.

Parameters

Request body required

application/json

• valueobject

  No additional properties

• phone_numberstringrequired
• display_namestring

  maxLength: 200

• businessobjectrequired
• legal_namestringrequired

  maxLength: 200

• websitestringrequired

  maxLength: 500

• typestringrequired

  enum: "private_profit", "public_profit", "sole_proprietor", "non_profit", "government"

• registration_numberstring

  EIN in the US

  maxLength: 64

• countrystringrequired

  enum: "US", "CA"

• streetstringrequired

  maxLength: 200

• street2string

  maxLength: 200

• citystringrequired

  maxLength: 100

• regionstringrequired

  maxLength: 100

• postal_codestringrequired

  maxLength: 20

• contact_first_namestringrequired

  maxLength: 100

• contact_last_namestringrequired

  maxLength: 100

• contact_emailstringrequired

  maxLength: 320

• contact_phonestringrequired

  maxLength: 32

• opt_in_urlstringrequired

  The page where customers find this number.

  maxLength: 500

• use_case_summarystring

  maxLength: 1000

• message_samplestring

  maxLength: 1000

Success response 201

The SMS inbox, pending until carriers approve the number.

application/json

• valueobject
• dataobjectrequired
• idstringrequired

  format: "uuid"

• workspace_idstringrequired

  format: "uuid"

• product_idstring | null

  The product (project) the mailbox belongs to. Clients group mailboxes and build web-app links with it.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringrequired

  The email address, or for an SMS inbox its phone number in E.164 (+15551234567).

• display_namestringrequired
• providerstringrequired

  enum: "gmail", "smtp", "twilio"

• channelstring

  email; sms for an SMS inbox on Twilio; whatsapp for a WhatsApp inbox, a WhatsApp sender on Twilio for the business's WhatsApp Business account.

  enum: "email", "sms", "whatsapp"

• sms_verificationobject | null

  A number from Banger, carriers' answer on its toll-free verification. It sends once approved; null for every other mailbox.

• statusstring

  enum: "pending_review", "in_review", "approved", "rejected"

• reasonstring | null

  Carriers' reason when rejected.

• statusstringrequired

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringrequired

  enum: "domain", "starter"

curl example

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/mailboxes/sms/numbers' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "phone_number": "example",
  "display_name": "example",
  "business": {
    "legal_name": "example",
    "website": "example",
    "type": "private_profit",
    "registration_number": "example",
    "country": "US",
    "street": "example",
    "street2": "example",
    "city": "example",
    "region": "example",
    "postal_code": "example",
    "contact_first_name": "example",
    "contact_last_name": "example",
    "contact_email": "example",
    "contact_phone": "example",
    "opt_in_url": "example",
    "use_case_summary": "example",
    "message_sample": "example"
  }
}'

Preview permanent mailbox deletion and dependent sending flows. Requires workspace admin and product scope.

Authentication: Bearer workspace API key.

Parameters

Request body

No request body is specified in the contract.

Success response 200

Exact mailbox and current deletion impact, without deleting anything.

application/json

• valueobject
• dataobjectrequired
• mailboxobjectrequired
• idstringrequired

  format: "uuid"

• addressstringrequired
• providerstringrequired
• domain_idstring | nullrequired

  format: "uuid"

• provider_connection_idstring | nullrequired

  format: "uuid"

• messagesintegerrequired
• draftsintegerrequired
• pending_sendsintegerrequired
• broadcastsarrayrequired
• Each itemobject
• idstringrequired

  format: "uuid"

• namestringrequired
• statusstringrequired
• journeysarrayrequired
• Each itemobject
• idstringrequired

  format: "uuid"

• namestringrequired
• statusstringrequired
• signup_formsarrayrequired
• Each itemobject
• idstringrequired

  format: "uuid"

• namestringrequired
• statusstringrequired
• impactarrayrequired
• Each itemstring
• preview_tokenstringrequired

curl example

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

Set the sender name recipients see on mail from one Banger mailbox ("Name <address>"). Gmail mailboxes keep the name set in Gmail. Requires workspace admin.

Authentication: Bearer workspace API key.

Parameters

Request body required

application/json

• valueobject

  No additional properties

• display_namestringrequired

  One line. Empty sends the bare address.

  maxLength: 200

Success response 200

The mailbox with its sender name.

application/json

• valueobject
• dataobjectrequired
• idstringrequired

  format: "uuid"

• workspace_idstringrequired

  format: "uuid"

• product_idstring | null

  The product (project) the mailbox belongs to. Clients group mailboxes and build web-app links with it.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringrequired

  The email address, or for an SMS inbox its phone number in E.164 (+15551234567).

• display_namestringrequired
• providerstringrequired

  enum: "gmail", "smtp", "twilio"

• channelstring

  email; sms for an SMS inbox on Twilio; whatsapp for a WhatsApp inbox, a WhatsApp sender on Twilio for the business's WhatsApp Business account.

  enum: "email", "sms", "whatsapp"

• sms_verificationobject | null

  A number from Banger, carriers' answer on its toll-free verification. It sends once approved; null for every other mailbox.

• statusstring

  enum: "pending_review", "in_review", "approved", "rejected"

• reasonstring | null

  Carriers' reason when rejected.

• statusstringrequired

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringrequired

  enum: "domain", "starter"

curl example

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

Permanently delete one mailbox, keeping its domain and other mailboxes. Requires workspace admin and product scope.

Authentication: Bearer workspace API key.

Parameters

Request body required

application/json

• valueobject

  No additional properties

• confirm_addressstringrequired

  minLength: 3 · maxLength: 320

• preview_tokenstringrequired

  minLength: 64 · maxLength: 64

Success response 200

Deleted or idempotent replay. Stored files are queued for permanent cleanup.

application/json

• valueobject
• dataobjectrequired
• idstringrequired

  format: "uuid"

• addressstringrequired
• deletedbooleanrequired
• replayedboolean

curl example

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

Create a hosted mailbox restricted to same-product hosted inboxes and the workspace signup recipient.

Authentication: Bearer workspace API key.

Parameters

Request body required

application/json

• valueobject

  No additional properties

• create_newboolean

  Create an additional hosted mailbox instead of resuming the initial one.

• local_partstring

  Name before @bangermail.com. Without it the mailbox gets a word name such as quiet-maple-harbor.

  minLength: 3 · maxLength: 40

• display_namestring

  maxLength: 200

Success response 200

Idempotent replay of starter identity creation.

application/json

• valueobject
• dataobjectrequired
• idstringrequired

  format: "uuid"

• workspace_idstringrequired

  format: "uuid"

• product_idstring | null

  The product (project) the mailbox belongs to. Clients group mailboxes and build web-app links with it.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringrequired

  The email address, or for an SMS inbox its phone number in E.164 (+15551234567).

• display_namestringrequired
• providerstringrequired

  enum: "gmail", "smtp", "twilio"

• channelstring

  email; sms for an SMS inbox on Twilio; whatsapp for a WhatsApp inbox, a WhatsApp sender on Twilio for the business's WhatsApp Business account.

  enum: "email", "sms", "whatsapp"

• sms_verificationobject | null

  A number from Banger, carriers' answer on its toll-free verification. It sends once approved; null for every other mailbox.

• statusstring

  enum: "pending_review", "in_review", "approved", "rejected"

• reasonstring | null

  Carriers' reason when rejected.

• statusstringrequired

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringrequired

  enum: "domain", "starter"

curl example

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

Resume the sender-reputation pause holding one mailbox, under the self-serve resume rules of resumeSending.

Authentication: Bearer workspace API key.

Parameters

Request body required

application/json

• valueobject

  No additional properties

• acknowledge_recipient_complaintbooleanrequired

  const: true

• reasonstring

  Why sending is being restored; recorded in the audit log.

  maxLength: 500

Success response 200

Mailbox reactivated, or already active after a prior successful request.

application/json

• valueobject
• dataobjectrequired
• idstringrequired

  format: "uuid"

• workspace_idstringrequired

  format: "uuid"

• product_idstring | null

  The product (project) the mailbox belongs to. Clients group mailboxes and build web-app links with it.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringrequired

  The email address, or for an SMS inbox its phone number in E.164 (+15551234567).

• display_namestringrequired
• providerstringrequired

  enum: "gmail", "smtp", "twilio"

• channelstring

  email; sms for an SMS inbox on Twilio; whatsapp for a WhatsApp inbox, a WhatsApp sender on Twilio for the business's WhatsApp Business account.

  enum: "email", "sms", "whatsapp"

• sms_verificationobject | null

  A number from Banger, carriers' answer on its toll-free verification. It sends once approved; null for every other mailbox.

• statusstring

  enum: "pending_review", "in_review", "approved", "rejected"

• reasonstring | null

  Carriers' reason when rejected.

• statusstringrequired

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringrequired

  enum: "domain", "starter"

curl example

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

Authentication: Bearer workspace API key.

Parameters

Request body

No request body is specified in the contract.

Success response 200

Successful response.

application/json

• valueobject
• dataarrayrequired
• Each itemobject
• idstringrequired

  format: "uuid"

• mailbox_idstringrequired

  format: "uuid"

• thread_idstring | nullrequired

  format: "uuid"

• versionintegerrequired
• toarrayrequired
• Each itemobject
• emailstringrequired
• namestring
• ccarrayrequired
• Each itemobject
• emailstringrequired
• namestring
• bccarrayrequired
• Each itemobject
• emailstringrequired
• namestring
• subjectstringrequired
• body_textstringrequired
• statusstringrequired
• created_atstringrequired

  format: "date-time"

• updated_atstringrequired

  format: "date-time"

• attachmentsarrayrequired
• Each itemobject
• idstringrequired

  format: "uuid"

• filenamestringrequired
• content_typestringrequired
• size_bytesintegerrequired
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

curl example

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

Authentication: Bearer workspace API key.

Parameters

Request body required

application/json

• valueobject

  No additional properties

• mailbox_idstringrequired

  format: "uuid"

• thread_idstring

  format: "uuid"

• toarray

  maxItems: 500

• Each itemobject
• namestring
• emailstringrequired

  format: "email"

• ccarray

  maxItems: 500

• Each itemobject
• namestring
• emailstringrequired

  format: "email"

• bccarray

  maxItems: 500

• Each itemobject
• namestring
• emailstringrequired

  format: "email"

• subjectstring

  maxLength: 10000

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

Success response 201

Successful response.

application/json

• valueobject
• dataobjectrequired
• idstringrequired

  format: "uuid"

• mailbox_idstringrequired

  format: "uuid"

• thread_idstring | nullrequired

  format: "uuid"

• versionintegerrequired
• toarrayrequired
• Each itemobject
• emailstringrequired
• namestring
• ccarrayrequired
• Each itemobject
• emailstringrequired
• namestring
• bccarrayrequired
• Each itemobject
• emailstringrequired
• namestring
• subjectstringrequired
• body_textstringrequired
• statusstringrequired
• created_atstringrequired

  format: "date-time"

• updated_atstringrequired

  format: "date-time"

• attachmentsarrayrequired
• Each itemobject
• idstringrequired

  format: "uuid"

• filenamestringrequired
• content_typestringrequired
• size_bytesintegerrequired
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

curl example

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

Authentication: Bearer workspace API key.

Parameters

Request body

No request body is specified in the contract.

Success response 200

Canonical deliverability performance, health, and incidents.

application/json

• valueobject
• dataobjectrequired
• idstringrequired

  format: "uuid"

• mailbox_idstringrequired

  format: "uuid"

• thread_idstring | nullrequired

  format: "uuid"

• versionintegerrequired
• toarrayrequired
• Each itemobject
• emailstringrequired
• namestring
• ccarrayrequired
• Each itemobject
• emailstringrequired
• namestring
• bccarrayrequired
• Each itemobject
• emailstringrequired
• namestring
• subjectstringrequired
• body_textstringrequired
• statusstringrequired
• created_atstringrequired

  format: "date-time"

• updated_atstringrequired

  format: "date-time"

• attachmentsarrayrequired
• Each itemobject
• idstringrequired

  format: "uuid"

• filenamestringrequired
• content_typestringrequired
• size_bytesintegerrequired
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

curl example

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

updateDraft

Authentication: Bearer workspace API key.

Parameters

Request body required

application/json

• valueunspecified
• allOf 1object

  No additional properties

• mailbox_idstringrequired

  format: "uuid"

• thread_idstring

  format: "uuid"

• toarray

  maxItems: 500

• Each itemobject
• namestring
• emailstringrequired

  format: "email"

• ccarray

  maxItems: 500

• Each itemobject
• namestring
• emailstringrequired

  format: "email"

• bccarray

  maxItems: 500

• Each itemobject
• namestring
• emailstringrequired

  format: "email"

• subjectstring

  maxLength: 10000

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

• allOf 2object
• versionintegerrequired

  minimum: 1

Success response 200

Successful response.

application/json

• valueobject
• dataobjectrequired
• idstringrequired

  format: "uuid"

• mailbox_idstringrequired

  format: "uuid"

• thread_idstring | nullrequired

  format: "uuid"

• versionintegerrequired
• toarrayrequired
• Each itemobject
• emailstringrequired
• namestring
• ccarrayrequired
• Each itemobject
• emailstringrequired
• namestring
• bccarrayrequired
• Each itemobject
• emailstringrequired
• namestring
• subjectstringrequired
• body_textstringrequired
• statusstringrequired
• created_atstringrequired

  format: "date-time"

• updated_atstringrequired

  format: "date-time"

• attachmentsarrayrequired
• Each itemobject
• idstringrequired

  format: "uuid"

• filenamestringrequired
• content_typestringrequired
• size_bytesintegerrequired
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

curl example

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

Authentication: Bearer workspace API key.

Parameters

Request body

No request body is specified in the contract.

Success response 204

Draft and referenced objects scheduled for deletion.

No response body.

curl example

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

sendDraft

Sends the draft from its mailbox, which must be one the caller reaches. A caller whose sends need approval gets a pending approval instead; a person who could send the draft directly decides it.

Authentication: Bearer workspace API key.

Parameters

Request body

No request body is specified in the contract.

Success response 202

The send is queued, or waits for approval.

application/json

• valueobject
• dataunspecifiedrequired
• oneOf 1object
• idstringrequired

  format: "uuid"

• typestringrequired
• statusstringrequired

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

• workspace_revisionintegerrequired

  format: "int64"

• created_atstringrequired

  format: "date-time"

• oneOf 2object

  No additional properties

• approvalobjectrequired
• idstringrequired

  format: "uuid"

• requested_by_actor_idstringrequired
• action_kindstringrequired
• summarystringrequired
• capability_scopesarrayrequired
• Each itemstring
• resource_scopeobjectrequired
• Additional propertyarray
• Each itemstring

  Further nesting omitted

• payloadobjectrequired
• Additional propertyAny value
• payload_sha256stringrequired

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

• statusstringrequired

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

• missedbooleanrequired
• expires_atstringrequired

  format: "date-time"

• qa_automationobject | null

  Server-recorded dedicated QA automation provenance; never evidence of a human payload review. The run and global authorization are rechecked at execution.

• kindstring

  enum: "dedicated_qa_automation"

• authorization_referencestring
• run_idstring
• operation_keystring
• recipientsarray
• Each itemstring

  format: "email"

  Further nesting omitted

• approval_sha256string
• resource_sha256string
• decided_by_actor_idstring | null
• decision_reasonstring | null
• created_atstringrequired

  format: "date-time"

• updated_atstringrequired

  format: "date-time"

• decided_atstring | null

  format: "date-time"

• execution_job_idstring

  format: "uuid"

• reviewobject

  No additional properties

• dispositionstringrequired

  enum: "automatic", "human_required"

• recipient_countinteger | nullrequired

  minimum: 0

• reasonsarrayrequired
• Each itemstring

  Further nesting omitted

• checksarrayrequired
• Each itemstring

  Further nesting omitted

curl example

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

Authentication: Bearer workspace API key.

Parameters

Request body required

application/octet-stream

• valuestring

  format: "binary" · maxLength: 26214400

Success response 201

Successful response.

application/json

• valueobject
• dataobjectrequired
• idstringrequired

  format: "uuid"

• filenamestringrequired
• content_typestringrequired
• size_bytesintegerrequired
• sha256string
• created_atstring

  format: "date-time"

curl example

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

Authentication: Bearer workspace API key.

Parameters

Request body

No request body is specified in the contract.

Success response 204

Attachment scheduled for version-aware B2 deletion.

No response body.

curl example

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

Read a draft HTML body

Authentication: Bearer workspace API key.

Parameters

Request body

No request body is specified in the contract.

Success response 200

Draft HTML.

text/html

• valuestring

curl example

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

listSendIntents

Authentication: Bearer workspace API key.

Parameters

Request body

No request body is specified in the contract.

Success response 200

Recent canonical sends and their provider state.

application/json

• valueobject
• dataarrayrequired
• Each itemobject

  No additional properties

• idstringrequired

  format: "uuid"

• statusstringrequired

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

• traffic_classstringrequired

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

• recipient_countintegerrequired

  minimum: 1

• provider_keystringrequired
• provider_statestringrequired

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

• provider_message_idstring | null
• error_codestring | null
• created_atstringrequired

  format: "date-time"

• updated_atstringrequired

  format: "date-time"

• completed_atstring | null

  format: "date-time"

curl example

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

getSendIntent

Authentication: Bearer workspace API key.

Parameters

Request body

No request body is specified in the contract.

Success response 200

Canonical asynchronous send status.

application/json

• valueobject
• dataobjectrequired

  No additional properties

• idstringrequired

  format: "uuid"

• statusstringrequired

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

• traffic_classstringrequired

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

• recipient_countintegerrequired

  minimum: 1

• provider_keystringrequired
• provider_statestringrequired

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

• provider_message_idstring | null
• error_codestring | null
• created_atstringrequired

  format: "date-time"

• updated_atstringrequired

  format: "date-time"

• completed_atstring | null

  format: "date-time"

curl example

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

listTransactionalSends

Authentication: Bearer workspace API key.

Parameters

Request body

No request body is specified in the contract.

Success response 200

Successful response.

application/json

• valueobject
• dataarrayrequired
• Each itemobject
• idstringrequired

  format: "uuid"

• mailbox_idstring | nullrequired

  format: "uuid"

• command_idstring | nullrequired

  format: "uuid"

• statusstringrequired
• command_statusstring | nullrequired
• subjectstring
• recipientsarray
• Each itemobject
• emailstringrequired
• namestring
• recipient_countintegerrequired
• error_codestring | null
• send_intent_idstring

  format: "uuid"

• providerstring | null
• route_kindstring | null
• sourcestring
• from_addressstring
• recipient_statesobject
• Additional propertyinteger
• provider_message_idstring | null
• languageunspecified

  The language this email went out in; null when it was not translated.

• anyOf 1object

  The language a person got an email in. Only translated (managed-content) emails have one.

• localestringrequired

  BCP 47 tag of the language the email was written in.

• requested_localestring

  Present only on an older send that went out in another language: the language the person should have got.

• fallback_reasonstring

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

• anyOf 2null
• journeyobject | null

  The Journey step and enrollment that sent this email; null for other sends.

• journey_idstringrequired

  format: "uuid"

• step_idstringrequired

  format: "uuid"

• enrollment_idstringrequired

  format: "uuid"

• experimentobject | null

  The experiment variant this email was; null when none applied.

• experiment_idstringrequired

  format: "uuid"

• variant_keystringrequired
• created_atstringrequired

  format: "date-time"

• updated_atstringrequired

  format: "date-time"

• completed_atstring | nullrequired

  format: "date-time"

• template_idstring | null

  format: "uuid"

• template_versioninteger | null
• workspace_revisioninteger | null
• command_resultobject
• Additional propertyAny value
• command_started_atstring | null

  format: "date-time"

• command_completed_atstring | null

  format: "date-time"

• body_textstring
• body_htmlstring
• reply_toarray
• Each itemobject
• emailstringrequired
• namestring
• headersobject
• Additional propertystring
• tagsarray
• Each itemobject
• namestringrequired
• valuestringrequired

curl example

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

createTransactionalSend

One recipient per Journey send. To takes one recipient in any RecipientInput shape ("a@example.com", "Pat <a@example.com>", { email, name }, or a one-element list); Cc and Bcc must be empty. reply_to defaults to the Journey's mailbox (an empty list also means the default); Product email needs exactly one. A new API Journey defaults to managed source content; legacy code Journeys retain complete-content sends. A refusal (4xx) leaves nothing frozen for the recipient, so a corrected call with a new idempotency key sends.

Authentication: Bearer workspace API key.

Parameters

Request body required

application/json

• valueobject
• journeystring

  Key of the Journey this email belongs to, such as welcome. A key Banger has not seen yet records a new Journey from this email and sends it; claim that Journey later to manage its content. The key of a Journey you created sends once that Journey is approved and on. Without a key the send is refused with 422 journey_key_required, unless the workspace accepts sends without one. POST /journeys/{journeyKey}/send is the same send with the key in the path.

  minLength: 1 · maxLength: 100

• mailbox_idstring

  Sender mailbox. Optional when the named Journey has one, which then sends.

  format: "uuid"

• tounspecifiedrequired

  Recipients for to, cc, bcc and reply_to: an address ("a@example.com" or "Pat <a@example.com>"), an { email, name } object, or a list mixing both. Banger stores them as { email, name } objects with the email lowercased. The idempotency hash covers the body as sent, so retry with the same shape.

• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringrequired

  format: "email"

• oneOf 3array

  maxItems: 500

• Each itemunspecified
• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringrequired

  format: "email"

• ccarray

  maxItems: 0

• Each itemobject
• namestring
• emailstringrequired

  format: "email"

• bccarray

  maxItems: 0

• Each itemobject
• namestring
• emailstringrequired

  format: "email"

• subjectstring

  maxLength: 10000

• expires_atstring

  Discard a deferred Journey send after this instant; at most seven days from the original request.

  format: "date-time"

• expires_after_secondsinteger

  minimum: 1 · maximum: 604800

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

• reply_tounspecified

  Recipients for to, cc, bcc and reply_to: an address ("a@example.com" or "Pat <a@example.com>"), an { email, name } object, or a list mixing both. Banger stores them as { email, name } objects with the email lowercased. The idempotency hash covers the body as sent, so retry with the same shape.

• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringrequired

  format: "email"

• oneOf 3array

  maxItems: 500

• Each itemunspecified
• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringrequired

  format: "email"

• headersobject
• Additional propertystring

  maxLength: 5000

• tagsarray

  maxItems: 49

• Each itemobject

  No additional properties

• namestringrequired

  minLength: 1 · maxLength: 256

• valuestringrequired

  minLength: 1 · maxLength: 256

• attachmentsarray

  Files sent with the email, in managed and code Journeys alike. Their base64 content may total 10 MiB (about 7.5 MiB of files).

  maxItems: 20

• Each itemobject

  No additional properties

• filenamestringrequired

  Name the recipient sees, on one line.

  minLength: 1 · maxLength: 500

• contentstringrequired

  The file encoded as base64; whitespace is ignored.

  minLength: 4

• content_typestring

  Media type such as application/pdf, without parameters. Defaults to application/octet-stream.

  maxLength: 255

• content_idstring

  Content-ID an HTML body can reference as cid:<content_id>.

  minLength: 1 · maxLength: 500

Success response 202

Successful response.

application/json

• valueobject
• dataobjectrequired
• action_kindstringrequired

  enum: "transactional.send"

• idstring

  format: "uuid"

• send_intent_idstring

  format: "uuid"

• provider_attempt_idstring

  format: "uuid"

• statusstringrequired

  sent/queued states from delivery, or for a frozen request: deferred (scheduled by policy or a translation wait), processing (being sent), discarded.

• replayedboolean
• journeyunspecifiedrequired
• anyOf 1object
• journey_idstringrequired

  format: "uuid"

• enrollment_idstringrequired

  format: "uuid"

• step_idstringrequired

  format: "uuid"

• step_positionintegerrequired
• originstring

  enum: "journey"

• journey_identitystring
• anyOf 2null
• ignored_variablesarrayrequired
• Each itemstring
• scheduled_atstring

  format: "date-time"

• reasonstring
• communication_reservation_idstring

  format: "uuid"

curl example

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 '{
  "journey": "example",
  "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"
    }
  ],
  "attachments": [
    {
      "filename": "example",
      "content": "example",
      "content_type": "example",
      "content_id": "example"
    }
  ]
}'

getTransactionalSend

Authentication: Bearer workspace API key.

Parameters

Request body

No request body is specified in the contract.

Success response 200

Successful response.

application/json

• valueobject
• dataobjectrequired
• idstringrequired

  format: "uuid"

• mailbox_idstring | nullrequired

  format: "uuid"

• command_idstring | nullrequired

  format: "uuid"

• statusstringrequired
• command_statusstring | nullrequired
• subjectstring
• recipientsarray
• Each itemobject
• emailstringrequired
• namestring
• recipient_countintegerrequired
• error_codestring | null
• send_intent_idstring

  format: "uuid"

• providerstring | null
• route_kindstring | null
• sourcestring
• from_addressstring
• recipient_statesobject
• Additional propertyinteger
• provider_message_idstring | null
• languageunspecified

  The language this email went out in; null when it was not translated.

• anyOf 1object

  The language a person got an email in. Only translated (managed-content) emails have one.

• localestringrequired

  BCP 47 tag of the language the email was written in.

• requested_localestring

  Present only on an older send that went out in another language: the language the person should have got.

• fallback_reasonstring

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

• anyOf 2null
• journeyobject | null

  The Journey step and enrollment that sent this email; null for other sends.

• journey_idstringrequired

  format: "uuid"

• step_idstringrequired

  format: "uuid"

• enrollment_idstringrequired

  format: "uuid"

• experimentobject | null

  The experiment variant this email was; null when none applied.

• experiment_idstringrequired

  format: "uuid"

• variant_keystringrequired
• created_atstringrequired

  format: "date-time"

• updated_atstringrequired

  format: "date-time"

• completed_atstring | nullrequired

  format: "date-time"

• template_idstring | null

  format: "uuid"

• template_versioninteger | null
• workspace_revisioninteger | null
• command_resultobject
• Additional propertyAny value
• command_started_atstring | null

  format: "date-time"

• command_completed_atstring | null

  format: "date-time"

• body_textstring
• body_htmlstring
• reply_toarray
• Each itemobject
• emailstringrequired
• namestring
• headersobject
• Additional propertystring
• tagsarray
• Each itemobject
• namestringrequired
• valuestringrequired

curl example

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

listTransactionalSendTimeline

Authentication: Bearer workspace API key.

Parameters

Request body

No request body is specified in the contract.

Success response 200

Ordered acceptance, provider-attempt, and recipient-event timeline.

application/json

• valueobject
• dataarrayrequired
• Each itemobject
• occurred_atstringrequired

  format: "date-time"

• event_typestringrequired
• labelstringrequired
• providerstring | null
• recipient_domainstring | null
• error_codestring | null

curl example

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

retryTransactionalSend

Authentication: Bearer workspace API key.

Parameters

Request body

No request body is specified in the contract.

Success response 202

Successful response.

application/json

• valueobject
• dataobjectrequired
• action_kindstringrequired

  enum: "transactional.send"

• idstringrequired

  format: "uuid"

• send_intent_idstringrequired

  format: "uuid"

• provider_attempt_idstringrequired

  format: "uuid"

• statusstringrequired
• replayedbooleanrequired

curl example

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

Authentication: Bearer workspace API key.

Parameters

Request body

No request body is specified in the contract.

Success response 200

Keyset-paginated workspace threads.

application/json

• valueobject
• dataarrayrequired
• Each itemobject
• idstringrequired

  format: "uuid"

• mailbox_idstringrequired

  format: "uuid"

• subjectstringrequired
• snippetstringrequired
• last_message_atstringrequired

  format: "date-time"

• message_countintegerrequired
• unread_countintegerrequired
• is_archivedbooleanrequired
• is_trashbooleanrequired
• is_spambooleanrequired
• is_starredbooleanrequired
• is_sentbooleanrequired
• has_attachmentsbooleanrequired
• sender_unverifiedboolean

  True when the latest message's sender passed neither SPF nor DKIM for its From domain, so its From address may be forged.

• labelsarrayrequired
• Each itemstring
• participantsarray
• Each itemobject
• namestring
• emailstringrequired

  format: "email"

• recipientsarray

  The To list of the mailbox's latest sent message in this thread; empty when the mailbox sent none. Sent views show these instead of the sender.

• Each itemobject
• namestring
• emailstringrequired

  format: "email"

• pageobjectrequired
• next_cursorstring
• has_morebooleanrequired

curl example

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

Authentication: Bearer workspace API key.

Parameters

Request body

No request body is specified in the contract.

Success response 200

Thread and ordered messages.

application/json

• valueobject
• dataunspecifiedrequired
• allOf 1object
• idstringrequired

  format: "uuid"

• mailbox_idstringrequired

  format: "uuid"

• subjectstringrequired
• snippetstringrequired
• last_message_atstringrequired

  format: "date-time"

• message_countintegerrequired
• unread_countintegerrequired
• is_archivedbooleanrequired
• is_trashbooleanrequired
• is_spambooleanrequired
• is_starredbooleanrequired
• is_sentbooleanrequired
• has_attachmentsbooleanrequired
• sender_unverifiedboolean

  True when the latest message's sender passed neither SPF nor DKIM for its From domain, so its From address may be forged.

• labelsarrayrequired
• Each itemstring
• participantsarray
• Each itemobject
• namestring
• emailstringrequired

  format: "email"

• recipientsarray

  The To list of the mailbox's latest sent message in this thread; empty when the mailbox sent none. Sent views show these instead of the sender.

• Each itemobject
• namestring
• emailstringrequired

  format: "email"

• allOf 2object
• messagesarrayrequired
• Each itemobject
• idstringrequired

  format: "uuid"

• mailbox_idstringrequired

  format: "uuid"

• thread_idstringrequired

  format: "uuid"

• sent_atstringrequired

  format: "date-time"

• received_atstring

  format: "date-time"

• envelope_recipientsarray

  Original SMTP envelope recipients, case-folded by the SMTP edge, before receive-only alias routing. Empty for older messages or non-SMTP sources. Independent of visible To/Cc headers.

• Each itemstring

  format: "email"

  Further nesting omitted

• fromobjectrequired
• namestring

  Further nesting omitted

• emailstringrequired

  format: "email"

  Further nesting omitted

• toarrayrequired
• Each itemobject

  Further nesting omitted

• ccarray
• Each itemobject

  Further nesting omitted

• reply_toarray
• Each itemobject

  Further nesting omitted

• is_sentboolean

  Whether this message was sent by the mailbox, including from an alias.

• provider_statusstring | null

  An SMS or WhatsApp reply's delivery as the provider last reported it (read is WhatsApp only). Null for email.

  enum: "queued", "sent", "delivered", "read", "undelivered", "failed", null

• body_textstring
• body_html_urlstring

  format: "uri"

• reply_originobject
• send_intent_idstringrequired

  format: "uuid"

  Further nesting omitted

• sourcestringrequired

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

  Further nesting omitted

• source_idstring

  format: "uuid"

  Further nesting omitted

• traffic_classstringrequired

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

  Further nesting omitted

• kindstringrequired

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

  Further nesting omitted

• namestring

  Further nesting omitted

• sender_verifiedboolean

  Present and false when the sender passed neither SPF nor DKIM for its From domain. Banger accepted it because that domain's DMARC policy is not reject, so the From address may be forged. Absent when the sender was verified or not checked.

• has_attachmentsbooleanrequired
• attachmentsarray
• Each itemobject

  Further nesting omitted

curl example

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

getMessageHtml

Authentication: Bearer workspace API key.

Parameters

Request body

No request body is specified in the contract.

Success response 200

Authenticated, sandbox-constrained HTML message body.

text/html

• valuestring

curl example

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

downloadAttachment

Authentication: Bearer workspace API key.

Parameters

Request body

No request body is specified in the contract.

Success response 200

Authenticated attachment stream.

application/octet-stream

• valuestring

  format: "binary"

curl example

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

searchMail

Authentication: Bearer workspace API key.

Parameters

Request body

No request body is specified in the contract.

Success response 200

Workspace-wide search results.

application/json

• valueobject
• dataarrayrequired
• Each itemobject
• idstringrequired

  format: "uuid"

• mailbox_idstringrequired

  format: "uuid"

• subjectstringrequired
• snippetstringrequired
• last_message_atstringrequired

  format: "date-time"

• message_countintegerrequired
• unread_countintegerrequired
• is_archivedbooleanrequired
• is_trashbooleanrequired
• is_spambooleanrequired
• is_starredbooleanrequired
• is_sentbooleanrequired
• has_attachmentsbooleanrequired
• sender_unverifiedboolean

  True when the latest message's sender passed neither SPF nor DKIM for its From domain, so its From address may be forged.

• labelsarrayrequired
• Each itemstring
• participantsarray
• Each itemobject
• namestring
• emailstringrequired

  format: "email"

• recipientsarray

  The To list of the mailbox's latest sent message in this thread; empty when the mailbox sent none. Sent views show these instead of the sender.

• Each itemobject
• namestring
• emailstringrequired

  format: "email"

• pageobjectrequired
• next_cursorstring
• has_morebooleanrequired

curl example

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

Authentication: Bearer workspace API key.

Parameters

Request body

No request body is specified in the contract.

Success response 200

Successful response.

application/json

• valueobject
• dataarrayrequired
• Each itemobject
• idstringrequired

  format: "uuid"

• emailstringrequired

  format: "email"

• display_namestring | nullrequired
• attributesobjectrequired
• Additional propertyAny value
• statusstringrequired

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

• created_atstringrequired

  format: "date-time"

• updated_atstringrequired

  format: "date-time"

• pageobjectrequired
• next_cursorstring
• has_morebooleanrequired