Referência da API do Banger

Listar produtos do espaço de trabalho

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição

O contrato não especifica um corpo de requisição.

Resposta de sucesso 200

Resposta de sucesso.

application/json

• valueobject
• dataarrayobrigatório
• Cada itemobject
• idstringobrigatório

  format: "uuid"

• workspace_idstringobrigatório

  format: "uuid"

• namestringobrigatório
• slugstringobrigatório
• kindstringobrigatório

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

• website_urlstring | nullobrigatório
• domainsarrayobrigatório
• Cada itemstring
• descriptionstringobrigatório
• contextobjectobrigatório
• Propriedade adicionalQualquer valor
• brandobjectobrigatório
• company_namestring

  maxLength: 160

• logo_urlstring

  O ícone: o símbolo sozinho, usado em tamanho pequeno (rodapé de e-mail, formulários deslizantes) e como cabeçalho quando não há logotipo com o nome.

  maxLength: 2000

• wordmark_urlstring

  O logotipo com o nome: o nome da empresa como desenhado, exibido sozinho no topo de cada 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

• statusstringobrigatório

  deleting: excluído por uma pessoa; restaurável até delete_after, depois removido definitivamente.

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

• delete_afterstring | null

  Quando um produto em estado deleting é removido definitivamente.

  format: "date-time"

• is_defaultbooleanobrigatório
• route_readybooleanobrigatório
• setuparrayobrigatório
• Cada itemobject
• keystringobrigatório

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

• statusstringobrigatório

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

• completion_sourcestring | nullobrigatório

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

• notestringobrigatório
• updated_atstring | nullobrigatório

  format: "date-time"

• created_atstringobrigatório

  format: "date-time"

• updated_atstringobrigatório

  format: "date-time"

Exemplo de curl

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

Criar um produto

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição obrigatório

application/json

• valueobject
• namestringobrigatório

  minLength: 1 · maxLength: 160

• kindstring

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

• website_urlstring | null

  maxLength: 2000

• descriptionstring

  maxLength: 4000

• contextobject
• Propriedade adicionalQualquer valor
• domainsarray

  maxItems: 20

• Cada itemstring

  maxLength: 253

Resposta de sucesso 201

Resposta de sucesso.

application/json

• valueobject
• dataobjectobrigatório
• idstringobrigatório

  format: "uuid"

• workspace_idstringobrigatório

  format: "uuid"

• namestringobrigatório
• slugstringobrigatório
• kindstringobrigatório

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

• website_urlstring | nullobrigatório
• domainsarrayobrigatório
• Cada itemstring
• descriptionstringobrigatório
• contextobjectobrigatório
• Propriedade adicionalQualquer valor
• brandobjectobrigatório
• company_namestring

  maxLength: 160

• logo_urlstring

  O ícone: o símbolo sozinho, usado em tamanho pequeno (rodapé de e-mail, formulários deslizantes) e como cabeçalho quando não há logotipo com o nome.

  maxLength: 2000

• wordmark_urlstring

  O logotipo com o nome: o nome da empresa como desenhado, exibido sozinho no topo de cada 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

• statusstringobrigatório

  deleting: excluído por uma pessoa; restaurável até delete_after, depois removido definitivamente.

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

• delete_afterstring | null

  Quando um produto em estado deleting é removido definitivamente.

  format: "date-time"

• is_defaultbooleanobrigatório
• route_readybooleanobrigatório
• setuparrayobrigatório
• Cada itemobject
• keystringobrigatório

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

• statusstringobrigatório

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

• completion_sourcestring | nullobrigatório

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

• notestringobrigatório
• updated_atstring | nullobrigatório

  format: "date-time"

• created_atstringobrigatório

  format: "date-time"

• updated_atstringobrigatório

  format: "date-time"

Exemplo de curl

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/products' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "name": "example",
  "kind": "product",
  "website_url": "example",
  "description": "example",
  "context": {},
  "domains": [
    "example"
  ]
}'

Obter um produto

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição

O contrato não especifica um corpo de requisição.

Resposta de sucesso 200

Resposta de sucesso.

application/json

• valueobject
• dataobjectobrigatório
• idstringobrigatório

  format: "uuid"

• workspace_idstringobrigatório

  format: "uuid"

• namestringobrigatório
• slugstringobrigatório
• kindstringobrigatório

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

• website_urlstring | nullobrigatório
• domainsarrayobrigatório
• Cada itemstring
• descriptionstringobrigatório
• contextobjectobrigatório
• Propriedade adicionalQualquer valor
• brandobjectobrigatório
• company_namestring

  maxLength: 160

• logo_urlstring

  O ícone: o símbolo sozinho, usado em tamanho pequeno (rodapé de e-mail, formulários deslizantes) e como cabeçalho quando não há logotipo com o nome.

  maxLength: 2000

• wordmark_urlstring

  O logotipo com o nome: o nome da empresa como desenhado, exibido sozinho no topo de cada 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

• statusstringobrigatório

  deleting: excluído por uma pessoa; restaurável até delete_after, depois removido definitivamente.

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

• delete_afterstring | null

  Quando um produto em estado deleting é removido definitivamente.

  format: "date-time"

• is_defaultbooleanobrigatório
• route_readybooleanobrigatório
• setuparrayobrigatório
• Cada itemobject
• keystringobrigatório

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

• statusstringobrigatório

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

• completion_sourcestring | nullobrigatório

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

• notestringobrigatório
• updated_atstring | nullobrigatório

  format: "date-time"

• created_atstringobrigatório

  format: "date-time"

• updated_atstringobrigatório

  format: "date-time"

Exemplo de curl

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

Atualizar um produto

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição obrigatório

application/json

• valueobject
• namestring

  maxLength: 160

• kindstring

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

• website_urlstring | null

  maxLength: 2000

• descriptionstring

  maxLength: 4000

• contextobject
• Propriedade adicionalQualquer valor
• brandobject
• company_namestring

  maxLength: 160

• logo_urlstring

  O ícone: o símbolo sozinho, usado em tamanho pequeno (rodapé de e-mail, formulários deslizantes) e como cabeçalho quando não há logotipo com o nome.

  maxLength: 2000

• wordmark_urlstring

  O logotipo com o nome: o nome da empresa como desenhado, exibido sozinho no topo de cada 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"

Resposta de sucesso 200

Resposta de sucesso.

application/json

• valueobject
• dataobjectobrigatório
• idstringobrigatório

  format: "uuid"

• workspace_idstringobrigatório

  format: "uuid"

• namestringobrigatório
• slugstringobrigatório
• kindstringobrigatório

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

• website_urlstring | nullobrigatório
• domainsarrayobrigatório
• Cada itemstring
• descriptionstringobrigatório
• contextobjectobrigatório
• Propriedade adicionalQualquer valor
• brandobjectobrigatório
• company_namestring

  maxLength: 160

• logo_urlstring

  O ícone: o símbolo sozinho, usado em tamanho pequeno (rodapé de e-mail, formulários deslizantes) e como cabeçalho quando não há logotipo com o nome.

  maxLength: 2000

• wordmark_urlstring

  O logotipo com o nome: o nome da empresa como desenhado, exibido sozinho no topo de cada 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

• statusstringobrigatório

  deleting: excluído por uma pessoa; restaurável até delete_after, depois removido definitivamente.

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

• delete_afterstring | null

  Quando um produto em estado deleting é removido definitivamente.

  format: "date-time"

• is_defaultbooleanobrigatório
• route_readybooleanobrigatório
• setuparrayobrigatório
• Cada itemobject
• keystringobrigatório

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

• statusstringobrigatório

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

• completion_sourcestring | nullobrigatório

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

• notestringobrigatório
• updated_atstring | nullobrigatório

  format: "date-time"

• created_atstringobrigatório

  format: "date-time"

• updated_atstringobrigatório

  format: "date-time"

Exemplo de curl

curl --request PATCH --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/products/{productId}' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "name": "example",
  "kind": "product",
  "website_url": "example",
  "description": "example",
  "context": {},
  "brand": {
    "company_name": "example",
    "logo_url": "example",
    "wordmark_url": "example",
    "website_url": "example",
    "primary_color": "example",
    "accent_color": "example",
    "background_color": "example",
    "surface_color": "example",
    "text_color": "example",
    "muted_text_color": "example",
    "heading_font_family": "example",
    "body_font_family": "example",
    "tone": "example",
    "footer_address": "example",
    "email_style": "example"
  },
  "status": "active"
}'

Exclua um produto (um projeto no app) após revisar a prévia de exclusão. Ele sai de uso imediatamente (seu envio para) e pode ser restaurado por 24 horas; depois o Banger remove seus domínios de envio e todas as linhas que possui. O último produto ativo do espaço de trabalho não pode ser excluído. Exige administrador do espaço de trabalho e sessão iniciada; chaves de API e concessões OAuth são recusadas.

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição obrigatório

application/json

• valueobject

  Sem propriedades adicionais

• confirm_namestringobrigatório

  O nome exato do produto.

  minLength: 1 · maxLength: 160

• preview_tokenstringobrigatório

  minLength: 64 · maxLength: 64

Resposta de sucesso 202

O produto está fora de uso e é excluído definitivamente em delete_after, salvo se restaurado antes. Uma repetição idempotente retorna o mesmo resultado.

application/json

• valueobject
• dataobjectobrigatório
• idstringobrigatório

  format: "uuid"

• namestringobrigatório
• statusstringobrigatório

  enum: "deleting"

• delete_afterstringobrigatório

  Quando o produto é excluído definitivamente; até lá ele pode ser restaurado.

  format: "date-time"

• next_product_idstringobrigatório

  O produto padrão atual do espaço de trabalho.

  format: "uuid"

• replayedboolean

Exemplo de curl

curl --request DELETE --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/products/{productId}' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Idempotency-Key: examplexxxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "confirm_name": "example",
  "preview_token": "examplexxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}'

Veja a prévia da exclusão de um produto e de tudo que possui, sem excluir nada. Exige administrador do espaço de trabalho, com sessão iniciada ou OAuth autorizado pelo usuário.

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição

O contrato não especifica um corpo de requisição.

Resposta de sucesso 200

O que a exclusão do produto remove e interrompe.

application/json

• valueobject
• dataobjectobrigatório
• productobjectobrigatório
• idstringobrigatório

  format: "uuid"

• namestringobrigatório
• is_defaultbooleanobrigatório
• next_default_productnão especificadoobrigatório

  O produto que se torna padrão do espaço de trabalho quando o padrão é excluído.

• oneOf 1null
• oneOf 2object
• idstringobrigatório

  format: "uuid"

• namestringobrigatório
• last_productbooleanobrigatório

  O único produto ativo não pode ser excluído.

• mailboxesarrayobrigatório
• Cada itemobject
• idstringobrigatório

  format: "uuid"

• addressstringobrigatório
• domainsarrayobrigatório

  Domínios de envio que o Banger remove após o prazo de restauração.

• Cada itemobject
• idstringobrigatório

  format: "uuid"

• domainstringobrigatório
• journeysintegerobrigatório
• broadcastsintegerobrigatório
• signup_formsintegerobrigatório
• contactsintegerobrigatório
• api_keysintegerobrigatório
• webhooksintegerobrigatório
• pending_sendsintegerobrigatório
• impactarrayobrigatório
• Cada itemstring
• preview_tokenstringobrigatório

Exemplo de curl

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

Restaure um produto excluído antes de seu delete_after. Suas caixas de e-mail, Jornadas, formulários de inscrição, webhooks e integrações são reativados; os Disparos continuam pausados. Exige administrador do espaço de trabalho, com sessão iniciada ou OAuth autorizado pelo usuário.

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição

O contrato não especifica um corpo de requisição.

Resposta de sucesso 200

O produto está ativo novamente.

application/json

• valueobject
• dataobjectobrigatório
• idstringobrigatório

  format: "uuid"

• namestringobrigatório
• statusstringobrigatório

  enum: "active"

Exemplo de curl

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

Atualizar um item de configuração do produto

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição obrigatório

application/json

• valueobject
• statusstringobrigatório

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

• completion_sourcestring

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

• notestring

  maxLength: 1000

Resposta de sucesso 200

Resposta de sucesso.

application/json

• valueobject
• dataobjectobrigatório
• keystringobrigatório

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

• statusstringobrigatório

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

• completion_sourcestring | nullobrigatório

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

• notestringobrigatório
• updated_atstring | nullobrigatório

  format: "date-time"

Exemplo de curl

curl --request PUT --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/products/{productId}/setup/{key}' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "status": "todo",
  "completion_source": "person",
  "note": "example"
}'

Associar um domínio a um produto

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição obrigatório

application/json

• valueobject
• domainstringobrigatório

  minLength: 3 · maxLength: 253

Resposta de sucesso 201

Resposta de sucesso.

application/json

• valueobject
• dataobjectobrigatório
• idstringobrigatório

  format: "uuid"

• workspace_idstringobrigatório

  format: "uuid"

• namestringobrigatório
• slugstringobrigatório
• kindstringobrigatório

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

• website_urlstring | nullobrigatório
• domainsarrayobrigatório
• Cada itemstring
• descriptionstringobrigatório
• contextobjectobrigatório
• Propriedade adicionalQualquer valor
• brandobjectobrigatório
• company_namestring

  maxLength: 160

• logo_urlstring

  O ícone: o símbolo sozinho, usado em tamanho pequeno (rodapé de e-mail, formulários deslizantes) e como cabeçalho quando não há logotipo com o nome.

  maxLength: 2000

• wordmark_urlstring

  O logotipo com o nome: o nome da empresa como desenhado, exibido sozinho no topo de cada 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

• statusstringobrigatório

  deleting: excluído por uma pessoa; restaurável até delete_after, depois removido definitivamente.

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

• delete_afterstring | null

  Quando um produto em estado deleting é removido definitivamente.

  format: "date-time"

• is_defaultbooleanobrigatório
• route_readybooleanobrigatório
• setuparrayobrigatório
• Cada itemobject
• keystringobrigatório

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

• statusstringobrigatório

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

• completion_sourcestring | nullobrigatório

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

• notestringobrigatório
• updated_atstring | nullobrigatório

  format: "date-time"

• created_atstringobrigatório

  format: "date-time"

• updated_atstringobrigatório

  format: "date-time"

Exemplo de curl

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/products/{productId}/domains' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "domain": "example"
}'

listMailboxes

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição

O contrato não especifica um corpo de requisição.

Resposta de sucesso 200

Caixas de e-mail visíveis para o ator.

application/json

• valueobject
• dataarrayobrigatório
• Cada itemobject
• idstringobrigatório

  format: "uuid"

• workspace_idstringobrigatório

  format: "uuid"

• product_idstring | null

  O produto (projeto) ao qual a caixa de e-mail pertence. Clientes o usam para agrupar caixas de e-mail e criar links para o app web.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringobrigatório

  format: "email"

• display_namestringobrigatório
• providerstringobrigatório

  enum: "gmail", "smtp"

• statusstringobrigatório

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringobrigatório

  enum: "domain", "starter"

Exemplo de curl

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

Crie uma caixa de e-mail de trabalho nativa do Banger em um domínio de envio do espaço de trabalho.

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição obrigatório

application/json

• valueobject

  Sem propriedades adicionais

• domain_idstringobrigatório

  format: "uuid"

• local_partstringobrigatório

  minLength: 1 · maxLength: 64

• display_namestring

  maxLength: 200

Resposta de sucesso 200

Repetição idempotente da criação de uma caixa de e-mail nativa.

application/json

• valueobject
• dataobjectobrigatório
• idstringobrigatório

  format: "uuid"

• workspace_idstringobrigatório

  format: "uuid"

• product_idstring | null

  O produto (projeto) ao qual a caixa de e-mail pertence. Clientes o usam para agrupar caixas de e-mail e criar links para o app web.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringobrigatório

  format: "email"

• display_namestringobrigatório
• providerstringobrigatório

  enum: "gmail", "smtp"

• statusstringobrigatório

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringobrigatório

  enum: "domain", "starter"

Exemplo de curl

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/mailboxes' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Idempotency-Key: examplexxxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "domain_id": "00000000-0000-4000-8000-000000000001",
  "local_part": "example",
  "display_name": "example"
}'

Veja a prévia da exclusão permanente de uma caixa de e-mail e dos fluxos de envio dependentes. Exige administrador do espaço de trabalho e escopo do produto.

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição

O contrato não especifica um corpo de requisição.

Resposta de sucesso 200

Caixa de e-mail exata e impacto atual da exclusão, sem excluir nada.

application/json

• valueobject
• dataobjectobrigatório
• mailboxobjectobrigatório
• idstringobrigatório

  format: "uuid"

• addressstringobrigatório
• providerstringobrigatório
• domain_idstring | nullobrigatório

  format: "uuid"

• provider_connection_idstring | nullobrigatório

  format: "uuid"

• messagesintegerobrigatório
• draftsintegerobrigatório
• pending_sendsintegerobrigatório
• broadcastsarrayobrigatório
• Cada itemobject
• idstringobrigatório

  format: "uuid"

• namestringobrigatório
• statusstringobrigatório
• journeysarrayobrigatório
• Cada itemobject
• idstringobrigatório

  format: "uuid"

• namestringobrigatório
• statusstringobrigatório
• signup_formsarrayobrigatório
• Cada itemobject
• idstringobrigatório

  format: "uuid"

• namestringobrigatório
• statusstringobrigatório
• impactarrayobrigatório
• Cada itemstring
• preview_tokenstringobrigatório

Exemplo de curl

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

Defina o nome do remetente que os destinatários veem nos e-mails de uma caixa do Banger ("Name <address>"). Caixas de e-mail do Gmail mantêm o nome definido no Gmail. Exige administrador do espaço de trabalho.

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição obrigatório

application/json

• valueobject

  Sem propriedades adicionais

• display_namestringobrigatório

  Uma linha. Vazio envia apenas o endereço.

  maxLength: 200

Resposta de sucesso 200

A caixa de e-mail com seu nome de remetente.

application/json

• valueobject
• dataobjectobrigatório
• idstringobrigatório

  format: "uuid"

• workspace_idstringobrigatório

  format: "uuid"

• product_idstring | null

  O produto (projeto) ao qual a caixa de e-mail pertence. Clientes o usam para agrupar caixas de e-mail e criar links para o app web.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringobrigatório

  format: "email"

• display_namestringobrigatório
• providerstringobrigatório

  enum: "gmail", "smtp"

• statusstringobrigatório

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringobrigatório

  enum: "domain", "starter"

Exemplo de curl

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

Exclua permanentemente uma caixa de e-mail, mantendo seu domínio e as outras caixas. Exige administrador do espaço de trabalho e escopo do produto.

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição obrigatório

application/json

• valueobject

  Sem propriedades adicionais

• confirm_addressstringobrigatório

  minLength: 3 · maxLength: 320

• preview_tokenstringobrigatório

  minLength: 64 · maxLength: 64

Resposta de sucesso 200

Excluído ou repetição idempotente. Os arquivos armazenados entram na fila de limpeza permanente.

application/json

• valueobject
• dataobjectobrigatório
• idstringobrigatório

  format: "uuid"

• addressstringobrigatório
• deletedbooleanobrigatório
• replayedboolean

Exemplo de curl

curl --request DELETE --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/mailboxes/{mailboxId}' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Idempotency-Key: examplexxxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "confirm_address": "example",
  "preview_token": "examplexxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}'

Crie uma caixa de e-mail hospedada restrita às caixas de entrada hospedadas do mesmo produto e ao destinatário de inscrição do espaço de trabalho.

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição obrigatório

application/json

• valueobject

  Sem propriedades adicionais

• create_newboolean

  Crie uma caixa de e-mail hospedada adicional em vez de retomar a inicial.

• local_partstring

  Nome antes de @bangermail.com. Sem ele, a caixa de e-mail recebe um nome composto de palavras, como quiet-maple-harbor.

  minLength: 3 · maxLength: 40

• display_namestring

  maxLength: 200

Resposta de sucesso 200

Repetição idempotente da criação de uma identidade inicial.

application/json

• valueobject
• dataobjectobrigatório
• idstringobrigatório

  format: "uuid"

• workspace_idstringobrigatório

  format: "uuid"

• product_idstring | null

  O produto (projeto) ao qual a caixa de e-mail pertence. Clientes o usam para agrupar caixas de e-mail e criar links para o app web.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringobrigatório

  format: "email"

• display_namestringobrigatório
• providerstringobrigatório

  enum: "gmail", "smtp"

• statusstringobrigatório

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringobrigatório

  enum: "domain", "starter"

Exemplo de curl

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/mailboxes/starter' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Idempotency-Key: examplexxxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "create_new": true,
  "local_part": "example",
  "display_name": "example"
}'

Retome uma caixa de e-mail pausada por reputação do remetente, conforme as regras de retomada por autoatendimento de resumeSending.

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição obrigatório

application/json

• valueobject

  Sem propriedades adicionais

• acknowledge_recipient_complaintbooleanobrigatório

  const: true

• reasonstring

  Por que o envio está sendo restaurado; registrado no log de auditoria.

  maxLength: 500

Resposta de sucesso 200

Caixa de e-mail reativada ou já ativa após uma requisição anterior bem-sucedida.

application/json

• valueobject
• dataobjectobrigatório
• idstringobrigatório

  format: "uuid"

• workspace_idstringobrigatório

  format: "uuid"

• product_idstring | null

  O produto (projeto) ao qual a caixa de e-mail pertence. Clientes o usam para agrupar caixas de e-mail e criar links para o app web.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringobrigatório

  format: "email"

• display_namestringobrigatório
• providerstringobrigatório

  enum: "gmail", "smtp"

• statusstringobrigatório

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringobrigatório

  enum: "domain", "starter"

Exemplo de curl

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/mailboxes/{mailboxId}/reactivate' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "acknowledge_recipient_complaint": true,
  "reason": "example"
}'

listDrafts

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição

O contrato não especifica um corpo de requisição.

Resposta de sucesso 200

Resposta de sucesso.

application/json

• valueobject
• dataarrayobrigatório
• Cada itemobject
• idstringobrigatório

  format: "uuid"

• mailbox_idstringobrigatório

  format: "uuid"

• thread_idstring | nullobrigatório

  format: "uuid"

• versionintegerobrigatório
• toarrayobrigatório
• Cada itemobject
• emailstringobrigatório
• namestring
• ccarrayobrigatório
• Cada itemobject
• emailstringobrigatório
• namestring
• bccarrayobrigatório
• Cada itemobject
• emailstringobrigatório
• namestring
• subjectstringobrigatório
• body_textstringobrigatório
• statusstringobrigatório
• created_atstringobrigatório

  format: "date-time"

• updated_atstringobrigatório

  format: "date-time"

• attachmentsarrayobrigatório
• Cada itemobject
• idstringobrigatório

  format: "uuid"

• filenamestringobrigatório
• content_typestringobrigatório
• size_bytesintegerobrigatório
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

Exemplo de curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/drafts?mailbox_id=00000000-0000-4000-8000-000000000001' \
  --header "Authorization: Bearer $BANGER_API_KEY"

createDraft

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição obrigatório

application/json

• valueobject

  Sem propriedades adicionais

• mailbox_idstringobrigatório

  format: "uuid"

• thread_idstring

  format: "uuid"

• toarray

  maxItems: 500

• Cada itemobject
• namestring
• emailstringobrigatório

  format: "email"

• ccarray

  maxItems: 500

• Cada itemobject
• namestring
• emailstringobrigatório

  format: "email"

• bccarray

  maxItems: 500

• Cada itemobject
• namestring
• emailstringobrigatório

  format: "email"

• subjectstring

  maxLength: 10000

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

Resposta de sucesso 201

Resposta de sucesso.

application/json

• valueobject
• dataobjectobrigatório
• idstringobrigatório

  format: "uuid"

• mailbox_idstringobrigatório

  format: "uuid"

• thread_idstring | nullobrigatório

  format: "uuid"

• versionintegerobrigatório
• toarrayobrigatório
• Cada itemobject
• emailstringobrigatório
• namestring
• ccarrayobrigatório
• Cada itemobject
• emailstringobrigatório
• namestring
• bccarrayobrigatório
• Cada itemobject
• emailstringobrigatório
• namestring
• subjectstringobrigatório
• body_textstringobrigatório
• statusstringobrigatório
• created_atstringobrigatório

  format: "date-time"

• updated_atstringobrigatório

  format: "date-time"

• attachmentsarrayobrigatório
• Cada itemobject
• idstringobrigatório

  format: "uuid"

• filenamestringobrigatório
• content_typestringobrigatório
• size_bytesintegerobrigatório
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

Exemplo de curl

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/drafts' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "mailbox_id": "00000000-0000-4000-8000-000000000001",
  "thread_id": "00000000-0000-4000-8000-000000000001",
  "to": [
    {
      "name": "example",
      "email": "person@example.com"
    }
  ],
  "cc": [
    {
      "name": "example",
      "email": "person@example.com"
    }
  ],
  "bcc": [
    {
      "name": "example",
      "email": "person@example.com"
    }
  ],
  "subject": "example",
  "body_text": "example",
  "body_html": "example"
}'

getDraft

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição

O contrato não especifica um corpo de requisição.

Resposta de sucesso 200

Desempenho, saúde e incidentes canônicos de entregabilidade.

application/json

• valueobject
• dataobjectobrigatório
• idstringobrigatório

  format: "uuid"

• mailbox_idstringobrigatório

  format: "uuid"

• thread_idstring | nullobrigatório

  format: "uuid"

• versionintegerobrigatório
• toarrayobrigatório
• Cada itemobject
• emailstringobrigatório
• namestring
• ccarrayobrigatório
• Cada itemobject
• emailstringobrigatório
• namestring
• bccarrayobrigatório
• Cada itemobject
• emailstringobrigatório
• namestring
• subjectstringobrigatório
• body_textstringobrigatório
• statusstringobrigatório
• created_atstringobrigatório

  format: "date-time"

• updated_atstringobrigatório

  format: "date-time"

• attachmentsarrayobrigatório
• Cada itemobject
• idstringobrigatório

  format: "uuid"

• filenamestringobrigatório
• content_typestringobrigatório
• size_bytesintegerobrigatório
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

Exemplo de curl

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

updateDraft

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição obrigatório

application/json

• valuenão especificado
• allOf 1object

  Sem propriedades adicionais

• mailbox_idstringobrigatório

  format: "uuid"

• thread_idstring

  format: "uuid"

• toarray

  maxItems: 500

• Cada itemobject
• namestring
• emailstringobrigatório

  format: "email"

• ccarray

  maxItems: 500

• Cada itemobject
• namestring
• emailstringobrigatório

  format: "email"

• bccarray

  maxItems: 500

• Cada itemobject
• namestring
• emailstringobrigatório

  format: "email"

• subjectstring

  maxLength: 10000

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

• allOf 2object
• versionintegerobrigatório

  minimum: 1

Resposta de sucesso 200

Resposta de sucesso.

application/json

• valueobject
• dataobjectobrigatório
• idstringobrigatório

  format: "uuid"

• mailbox_idstringobrigatório

  format: "uuid"

• thread_idstring | nullobrigatório

  format: "uuid"

• versionintegerobrigatório
• toarrayobrigatório
• Cada itemobject
• emailstringobrigatório
• namestring
• ccarrayobrigatório
• Cada itemobject
• emailstringobrigatório
• namestring
• bccarrayobrigatório
• Cada itemobject
• emailstringobrigatório
• namestring
• subjectstringobrigatório
• body_textstringobrigatório
• statusstringobrigatório
• created_atstringobrigatório

  format: "date-time"

• updated_atstringobrigatório

  format: "date-time"

• attachmentsarrayobrigatório
• Cada itemobject
• idstringobrigatório

  format: "uuid"

• filenamestringobrigatório
• content_typestringobrigatório
• size_bytesintegerobrigatório
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

Exemplo de curl

curl --request PUT --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/drafts/{draftId}' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "mailbox_id": "00000000-0000-4000-8000-000000000001",
  "thread_id": "00000000-0000-4000-8000-000000000001",
  "to": [
    {
      "name": "example",
      "email": "person@example.com"
    }
  ],
  "cc": [
    {
      "name": "example",
      "email": "person@example.com"
    }
  ],
  "bcc": [
    {
      "name": "example",
      "email": "person@example.com"
    }
  ],
  "subject": "example",
  "body_text": "example",
  "body_html": "example",
  "version": 1
}'

deleteDraft

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição

O contrato não especifica um corpo de requisição.

Resposta de sucesso 204

Rascunho e objetos referenciados agendados para exclusão.

Sem corpo de resposta.

Exemplo de curl

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

sendDraft

Envia o rascunho pela sua caixa de e-mail, que deve ser acessível a quem chama. Se os envios exigem aprovação, recebe uma aprovação pendente; uma pessoa que poderia enviar o rascunho diretamente decide.

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição

O contrato não especifica um corpo de requisição.

Resposta de sucesso 202

O envio está na fila ou aguarda aprovação.

application/json

• valueobject
• datanão especificadoobrigatório
• oneOf 1object
• idstringobrigatório

  format: "uuid"

• typestringobrigatório
• statusstringobrigatório

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

• workspace_revisionintegerobrigatório

  format: "int64"

• created_atstringobrigatório

  format: "date-time"

• oneOf 2object

  Sem propriedades adicionais

• approvalobjectobrigatório
• idstringobrigatório

  format: "uuid"

• requested_by_actor_idstringobrigatório
• action_kindstringobrigatório
• summarystringobrigatório
• capability_scopesarrayobrigatório
• Cada itemstring
• resource_scopeobjectobrigatório
• Propriedade adicionalarray
• Cada itemstring

  Outros níveis de aninhamento omitidos

• payloadobjectobrigatório
• Propriedade adicionalQualquer valor
• payload_sha256stringobrigatório

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

• statusstringobrigatório

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

• missedbooleanobrigatório
• expires_atstringobrigatório

  format: "date-time"

• decided_by_actor_idstring | null
• decision_reasonstring | null
• created_atstringobrigatório

  format: "date-time"

• updated_atstringobrigatório

  format: "date-time"

• decided_atstring | null

  format: "date-time"

• execution_job_idstring

  format: "uuid"

• reviewobject

  Sem propriedades adicionais

• dispositionstringobrigatório

  enum: "automatic", "human_required"

• recipient_countinteger | nullobrigatório

  minimum: 0

• reasonsarrayobrigatório
• Cada itemstring

  Outros níveis de aninhamento omitidos

• checksarrayobrigatório
• Cada itemstring

  Outros níveis de aninhamento omitidos

Exemplo de curl

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

uploadDraftAttachment

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição obrigatório

application/octet-stream

• valuestring

  format: "binary" · maxLength: 26214400

Resposta de sucesso 201

Resposta de sucesso.

application/json

• valueobject
• dataobjectobrigatório
• idstringobrigatório

  format: "uuid"

• filenamestringobrigatório
• content_typestringobrigatório
• size_bytesintegerobrigatório
• sha256string
• created_atstring

  format: "date-time"

Exemplo de curl

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/drafts/{draftId}/attachments' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'X-Banger-Filename: example' \
  --header 'Content-Type: application/octet-stream' \
  --data-binary @request-body

deleteDraftAttachment

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição

O contrato não especifica um corpo de requisição.

Resposta de sucesso 204

Anexo agendado para exclusão no B2 considerando as versões.

Sem corpo de resposta.

Exemplo de curl

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

Ler o corpo HTML de um rascunho

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição

O contrato não especifica um corpo de requisição.

Resposta de sucesso 200

HTML do rascunho.

text/html

• valuestring

Exemplo de curl

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

listSendIntents

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição

O contrato não especifica um corpo de requisição.

Resposta de sucesso 200

Envios canônicos recentes e seu estado no provedor.

application/json

• valueobject
• dataarrayobrigatório
• Cada itemobject

  Sem propriedades adicionais

• idstringobrigatório

  format: "uuid"

• statusstringobrigatório

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

• traffic_classstringobrigatório

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

• recipient_countintegerobrigatório

  minimum: 1

• provider_keystringobrigatório
• provider_statestringobrigatório

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

• provider_message_idstring | null
• error_codestring | null
• created_atstringobrigatório

  format: "date-time"

• updated_atstringobrigatório

  format: "date-time"

• completed_atstring | null

  format: "date-time"

Exemplo de curl

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

getSendIntent

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição

O contrato não especifica um corpo de requisição.

Resposta de sucesso 200

Estado canônico do envio assíncrono.

application/json

• valueobject
• dataobjectobrigatório

  Sem propriedades adicionais

• idstringobrigatório

  format: "uuid"

• statusstringobrigatório

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

• traffic_classstringobrigatório

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

• recipient_countintegerobrigatório

  minimum: 1

• provider_keystringobrigatório
• provider_statestringobrigatório

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

• provider_message_idstring | null
• error_codestring | null
• created_atstringobrigatório

  format: "date-time"

• updated_atstringobrigatório

  format: "date-time"

• completed_atstring | null

  format: "date-time"

Exemplo de curl

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

listTransactionalSends

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição

O contrato não especifica um corpo de requisição.

Resposta de sucesso 200

Resposta de sucesso.

application/json

• valueobject
• dataarrayobrigatório
• Cada itemobject
• idstringobrigatório

  format: "uuid"

• mailbox_idstring | nullobrigatório

  format: "uuid"

• command_idstring | nullobrigatório

  format: "uuid"

• statusstringobrigatório
• command_statusstring | nullobrigatório
• subjectstring
• recipientsarray
• Cada itemobject
• emailstringobrigatório
• namestring
• recipient_countintegerobrigatório
• error_codestring | null
• send_intent_idstring

  format: "uuid"

• providerstring | null
• route_kindstring | null
• sourcestring
• from_addressstring
• recipient_statesobject
• Propriedade adicionalinteger
• provider_message_idstring | null
• languagenão especificado

  O idioma em que este e-mail foi enviado; null quando não foi traduzido.

• anyOf 1object

  O idioma em que uma pessoa recebeu um e-mail. Apenas e-mails traduzidos (conteúdo gerenciado) têm um.

• localestringobrigatório

  Tag BCP 47 do idioma em que o e-mail foi escrito.

• requested_localestring

  Presente apenas em um envio antigo que saiu em outro idioma: o idioma que a pessoa deveria ter recebido.

• fallback_reasonstring

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

• anyOf 2null
• journeyobject | null

  A etapa e a inscrição da Jornada que enviaram este e-mail; null para outros envios.

• journey_idstringobrigatório

  format: "uuid"

• step_idstringobrigatório

  format: "uuid"

• enrollment_idstringobrigatório

  format: "uuid"

• experimentobject | null

  A variante do experimento deste e-mail; null quando nenhuma se aplicou.

• experiment_idstringobrigatório

  format: "uuid"

• variant_keystringobrigatório
• created_atstringobrigatório

  format: "date-time"

• updated_atstringobrigatório

  format: "date-time"

• completed_atstring | nullobrigatório

  format: "date-time"

• template_idstring | null

  format: "uuid"

• template_versioninteger | null
• workspace_revisioninteger | null
• command_resultobject
• Propriedade adicionalQualquer valor
• command_started_atstring | null

  format: "date-time"

• command_completed_atstring | null

  format: "date-time"

• body_textstring
• body_htmlstring
• reply_toarray
• Cada itemobject
• emailstringobrigatório
• namestring
• headersobject
• Propriedade adicionalstring
• tagsarray
• Cada itemobject
• namestringobrigatório
• valuestringobrigatório

Exemplo de curl

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

createTransactionalSend

Um destinatário por envio de Jornada. To aceita um destinatário em qualquer formato RecipientInput ("a@example.com", "Pat <a@example.com>", { email, name } ou uma lista de um elemento); Cc e Bcc devem estar vazios. reply_to usa por padrão a caixa de e-mail da Jornada (uma lista vazia também indica o padrão); e-mail de Produto precisa de exatamente um. Uma nova Jornada de API usa conteúdo-fonte gerenciado por padrão; Jornadas de código legado mantêm envios de conteúdo completo. Uma recusa (4xx) não deixa nada congelado para o destinatário, então uma chamada corrigida com nova chave de idempotência envia.

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição obrigatório

application/json

• valueobject
• mailbox_idstringobrigatório

  format: "uuid"

• tonão especificadoobrigatório

  Destinatários de to, cc, bcc e reply_to: um endereço ("a@example.com" ou "Pat <a@example.com>"), um objeto { email, name } ou uma lista misturando ambos. O Banger os armazena como objetos { email, name } com o e-mail em minúsculas. O hash de idempotência abrange o corpo como enviado, então repita com o mesmo formato.

• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringobrigatório

  format: "email"

• oneOf 3array

  maxItems: 500

• Cada itemnão especificado
• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringobrigatório

  format: "email"

• ccarray

  maxItems: 0

• Cada itemobject
• namestring
• emailstringobrigatório

  format: "email"

• bccarray

  maxItems: 0

• Cada itemobject
• namestring
• emailstringobrigatório

  format: "email"

• subjectstring

  maxLength: 10000

• expires_atstring

  Descarte um envio adiado de Jornada após este instante; no máximo sete dias da requisição original.

  format: "date-time"

• expires_after_secondsinteger

  minimum: 1 · maximum: 604800

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

• reply_tonão especificado

  Destinatários de to, cc, bcc e reply_to: um endereço ("a@example.com" ou "Pat <a@example.com>"), um objeto { email, name } ou uma lista misturando ambos. O Banger os armazena como objetos { email, name } com o e-mail em minúsculas. O hash de idempotência abrange o corpo como enviado, então repita com o mesmo formato.

• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringobrigatório

  format: "email"

• oneOf 3array

  maxItems: 500

• Cada itemnão especificado
• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringobrigatório

  format: "email"

• headersobject
• Propriedade adicionalstring

  maxLength: 5000

• tagsarray

  maxItems: 49

• Cada itemobject

  Sem propriedades adicionais

• namestringobrigatório

  minLength: 1 · maxLength: 256

• valuestringobrigatório

  minLength: 1 · maxLength: 256

Resposta de sucesso 202

Resposta de sucesso.

application/json

• valueobject
• dataobjectobrigatório
• action_kindstringobrigatório

  enum: "transactional.send"

• idstring

  format: "uuid"

• send_intent_idstring

  format: "uuid"

• provider_attempt_idstring

  format: "uuid"

• statusstringobrigatório

  Estados sent/queued da entrega ou, para uma requisição congelada: deferred (agendada pela política ou aguardando tradução), processing (em envio), discarded.

• replayedboolean
• journeynão especificadoobrigatório
• anyOf 1object
• journey_idstringobrigatório

  format: "uuid"

• enrollment_idstringobrigatório

  format: "uuid"

• step_idstringobrigatório

  format: "uuid"

• step_positionintegerobrigatório
• originstring

  enum: "journey"

• journey_identitystring
• anyOf 2null
• ignored_variablesarrayobrigatório
• Cada itemstring
• scheduled_atstring

  format: "date-time"

• reasonstring
• communication_reservation_idstring

  format: "uuid"

Exemplo de curl

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/transactional-sends' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Idempotency-Key: examplexxxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "mailbox_id": "00000000-0000-4000-8000-000000000001",
  "to": "example",
  "cc": [
    {
      "name": "example",
      "email": "person@example.com"
    }
  ],
  "bcc": [
    {
      "name": "example",
      "email": "person@example.com"
    }
  ],
  "subject": "example",
  "expires_at": "2026-01-01T00:00:00Z",
  "expires_after_seconds": 1,
  "body_text": "example",
  "body_html": "example",
  "reply_to": "example",
  "headers": {},
  "tags": [
    {
      "name": "example",
      "value": "example"
    }
  ]
}'

getTransactionalSend

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição

O contrato não especifica um corpo de requisição.

Resposta de sucesso 200

Resposta de sucesso.

application/json

• valueobject
• dataobjectobrigatório
• idstringobrigatório

  format: "uuid"

• mailbox_idstring | nullobrigatório

  format: "uuid"

• command_idstring | nullobrigatório

  format: "uuid"

• statusstringobrigatório
• command_statusstring | nullobrigatório
• subjectstring
• recipientsarray
• Cada itemobject
• emailstringobrigatório
• namestring
• recipient_countintegerobrigatório
• error_codestring | null
• send_intent_idstring

  format: "uuid"

• providerstring | null
• route_kindstring | null
• sourcestring
• from_addressstring
• recipient_statesobject
• Propriedade adicionalinteger
• provider_message_idstring | null
• languagenão especificado

  O idioma em que este e-mail foi enviado; null quando não foi traduzido.

• anyOf 1object

  O idioma em que uma pessoa recebeu um e-mail. Apenas e-mails traduzidos (conteúdo gerenciado) têm um.

• localestringobrigatório

  Tag BCP 47 do idioma em que o e-mail foi escrito.

• requested_localestring

  Presente apenas em um envio antigo que saiu em outro idioma: o idioma que a pessoa deveria ter recebido.

• fallback_reasonstring

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

• anyOf 2null
• journeyobject | null

  A etapa e a inscrição da Jornada que enviaram este e-mail; null para outros envios.

• journey_idstringobrigatório

  format: "uuid"

• step_idstringobrigatório

  format: "uuid"

• enrollment_idstringobrigatório

  format: "uuid"

• experimentobject | null

  A variante do experimento deste e-mail; null quando nenhuma se aplicou.

• experiment_idstringobrigatório

  format: "uuid"

• variant_keystringobrigatório
• created_atstringobrigatório

  format: "date-time"

• updated_atstringobrigatório

  format: "date-time"

• completed_atstring | nullobrigatório

  format: "date-time"

• template_idstring | null

  format: "uuid"

• template_versioninteger | null
• workspace_revisioninteger | null
• command_resultobject
• Propriedade adicionalQualquer valor
• command_started_atstring | null

  format: "date-time"

• command_completed_atstring | null

  format: "date-time"

• body_textstring
• body_htmlstring
• reply_toarray
• Cada itemobject
• emailstringobrigatório
• namestring
• headersobject
• Propriedade adicionalstring
• tagsarray
• Cada itemobject
• namestringobrigatório
• valuestringobrigatório

Exemplo de curl

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

listTransactionalSendTimeline

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição

O contrato não especifica um corpo de requisição.

Resposta de sucesso 200

Linha do tempo ordenada de aceitação, tentativas do provedor e eventos do destinatário.

application/json

• valueobject
• dataarrayobrigatório
• Cada itemobject
• occurred_atstringobrigatório

  format: "date-time"

• event_typestringobrigatório
• labelstringobrigatório
• providerstring | null
• recipient_domainstring | null
• error_codestring | null

Exemplo de curl

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

retryTransactionalSend

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição

O contrato não especifica um corpo de requisição.

Resposta de sucesso 202

Resposta de sucesso.

application/json

• valueobject
• dataobjectobrigatório
• action_kindstringobrigatório

  enum: "transactional.send"

• idstringobrigatório

  format: "uuid"

• send_intent_idstringobrigatório

  format: "uuid"

• provider_attempt_idstringobrigatório

  format: "uuid"

• statusstringobrigatório
• replayedbooleanobrigatório

Exemplo de curl

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

listThreads

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição

O contrato não especifica um corpo de requisição.

Resposta de sucesso 200

Conversas do espaço de trabalho paginadas por chave.

application/json

• valueobject
• dataarrayobrigatório
• Cada itemobject
• idstringobrigatório

  format: "uuid"

• mailbox_idstringobrigatório

  format: "uuid"

• subjectstringobrigatório
• snippetstringobrigatório
• last_message_atstringobrigatório

  format: "date-time"

• message_countintegerobrigatório
• unread_countintegerobrigatório
• is_archivedbooleanobrigatório
• is_trashbooleanobrigatório
• is_spambooleanobrigatório
• is_starredbooleanobrigatório
• is_sentbooleanobrigatório
• has_attachmentsbooleanobrigatório
• labelsarrayobrigatório
• Cada itemstring
• participantsarray
• Cada itemobject
• namestring
• emailstringobrigatório

  format: "email"

• pageobjectobrigatório
• next_cursorstring
• has_morebooleanobrigatório

Exemplo de curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/threads?cursor=example&limit=50&mailbox_id=00000000-0000-4000-8000-000000000001&label_id=00000000-0000-4000-8000-000000000001&view=inbox' \
  --header "Authorization: Bearer $BANGER_API_KEY"

getThread

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição

O contrato não especifica um corpo de requisição.

Resposta de sucesso 200

Conversa e mensagens ordenadas.

application/json

• valueobject
• datanão especificadoobrigatório
• allOf 1object
• idstringobrigatório

  format: "uuid"

• mailbox_idstringobrigatório

  format: "uuid"

• subjectstringobrigatório
• snippetstringobrigatório
• last_message_atstringobrigatório

  format: "date-time"

• message_countintegerobrigatório
• unread_countintegerobrigatório
• is_archivedbooleanobrigatório
• is_trashbooleanobrigatório
• is_spambooleanobrigatório
• is_starredbooleanobrigatório
• is_sentbooleanobrigatório
• has_attachmentsbooleanobrigatório
• labelsarrayobrigatório
• Cada itemstring
• participantsarray
• Cada itemobject
• namestring
• emailstringobrigatório

  format: "email"

• allOf 2object
• messagesarrayobrigatório
• Cada itemobject
• idstringobrigatório

  format: "uuid"

• mailbox_idstringobrigatório

  format: "uuid"

• thread_idstringobrigatório

  format: "uuid"

• sent_atstringobrigatório

  format: "date-time"

• received_atstring

  format: "date-time"

• envelope_recipientsarray

  Destinatários originais do envelope SMTP, normalizados quanto a maiúsculas e minúsculas pela borda SMTP, antes do roteamento de aliases somente de recebimento. Vazio para mensagens antigas ou fontes não SMTP. Independente dos cabeçalhos visíveis To/Cc.

• Cada itemstring

  format: "email"

  Outros níveis de aninhamento omitidos

• fromobjectobrigatório
• namestring

  Outros níveis de aninhamento omitidos

• emailstringobrigatório

  format: "email"

  Outros níveis de aninhamento omitidos

• toarrayobrigatório
• Cada itemobject

  Outros níveis de aninhamento omitidos

• ccarray
• Cada itemobject

  Outros níveis de aninhamento omitidos

• reply_toarray
• Cada itemobject

  Outros níveis de aninhamento omitidos

• is_sentboolean

  Se esta mensagem foi enviada pela caixa de e-mail, inclusive por um alias.

• body_textstring
• body_html_urlstring

  format: "uri"

• reply_originobject
• send_intent_idstringobrigatório

  format: "uuid"

  Outros níveis de aninhamento omitidos

• sourcestringobrigatório

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

  Outros níveis de aninhamento omitidos

• source_idstring

  format: "uuid"

  Outros níveis de aninhamento omitidos

• traffic_classstringobrigatório

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

  Outros níveis de aninhamento omitidos

• kindstringobrigatório

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

  Outros níveis de aninhamento omitidos

• namestring

  Outros níveis de aninhamento omitidos

• has_attachmentsbooleanobrigatório
• attachmentsarray
• Cada itemobject

  Outros níveis de aninhamento omitidos

Exemplo de curl

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

getMessageHtml

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição

O contrato não especifica um corpo de requisição.

Resposta de sucesso 200

Corpo HTML da mensagem autenticado e restrito por sandbox.

text/html

• valuestring

Exemplo de curl

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

downloadAttachment

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição

O contrato não especifica um corpo de requisição.

Resposta de sucesso 200

Fluxo de anexo autenticado.

application/octet-stream

• valuestring

  format: "binary"

Exemplo de curl

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

searchMail

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição

O contrato não especifica um corpo de requisição.

Resposta de sucesso 200

Resultados de busca em todo o espaço de trabalho.

application/json

• valueobject
• dataarrayobrigatório
• Cada itemobject
• idstringobrigatório

  format: "uuid"

• mailbox_idstringobrigatório

  format: "uuid"

• subjectstringobrigatório
• snippetstringobrigatório
• last_message_atstringobrigatório

  format: "date-time"

• message_countintegerobrigatório
• unread_countintegerobrigatório
• is_archivedbooleanobrigatório
• is_trashbooleanobrigatório
• is_spambooleanobrigatório
• is_starredbooleanobrigatório
• is_sentbooleanobrigatório
• has_attachmentsbooleanobrigatório
• labelsarrayobrigatório
• Cada itemstring
• participantsarray
• Cada itemobject
• namestring
• emailstringobrigatório

  format: "email"

• pageobjectobrigatório
• next_cursorstring
• has_morebooleanobrigatório

Exemplo de curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/search?q=example&cursor=example&limit=50&mailbox_id=00000000-0000-4000-8000-000000000001' \
  --header "Authorization: Bearer $BANGER_API_KEY"

listContacts

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição

O contrato não especifica um corpo de requisição.

Resposta de sucesso 200

Resposta de sucesso.

application/json

• valueobject
• dataarrayobrigatório
• Cada itemobject
• idstringobrigatório

  format: "uuid"

• emailstringobrigatório

  format: "email"

• display_namestring | nullobrigatório
• attributesobjectobrigatório
• Propriedade adicionalQualquer valor
• statusstringobrigatório

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

• created_atstringobrigatório

  format: "date-time"

• updated_atstringobrigatório

  format: "date-time"

• pageobjectobrigatório
• next_cursorstring
• has_morebooleanobrigatório

Exemplo de curl

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

upsertContact

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição obrigatório

application/json

• valueobject

  Sem propriedades adicionais

• emailstringobrigatório

  format: "email"

• display_namestring

  maxLength: 1000

• statusstringobrigatório

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

• attributesobject
• Propriedade adicionalQualquer valor
• consent_confirmedboolean

  Obrigatório ao inscrever um novo endereço.

Resposta de sucesso 201

Resposta de sucesso.

application/json

• valueobject
• dataobjectobrigatório
• idstringobrigatório

  format: "uuid"

• emailstringobrigatório

  format: "email"

• display_namestring | nullobrigatório
• attributesobjectobrigatório
• Propriedade adicionalQualquer valor
• statusstringobrigatório

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

• created_atstringobrigatório

  format: "date-time"

• updated_atstringobrigatório

  format: "date-time"

Exemplo de curl

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/contacts' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "email": "person@example.com",
  "display_name": "example",
  "status": "subscribed",
  "attributes": {},
  "consent_confirmed": true
}'

getContact

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição

O contrato não especifica um corpo de requisição.

Resposta de sucesso 200

Resposta de sucesso.

application/json

• valueobject
• dataobjectobrigatório
• idstringobrigatório

  format: "uuid"

• emailstringobrigatório

  format: "email"

• display_namestring | nullobrigatório
• attributesobjectobrigatório
• Propriedade adicionalQualquer valor
• statusstringobrigatório

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

• created_atstringobrigatório

  format: "date-time"

• updated_atstringobrigatório

  format: "date-time"

• suppressedbooleanobrigatório
• suppression_reasonstring | nullobrigatório
• sourcesarrayobrigatório
• Cada itemobject
• kindstringobrigatório
• referencestringobrigatório
• connection_idstring | nullobrigatório

  format: "uuid"

• metadataobjectobrigatório
• Propriedade adicionalQualquer valor
• first_seen_atstringobrigatório

  format: "date-time"

• last_seen_atstringobrigatório

  format: "date-time"

• listsarrayobrigatório
• Cada itemobject
• idstringobrigatório

  format: "uuid"

• namestringobrigatório
• subscription_statusstringobrigatório
• consent_evidencearrayobrigatório
• Cada itemobject
• kindstringobrigatório
• referencestringobrigatório
• connection_idstring | nullobrigatório

  format: "uuid"

• metadataobjectobrigatório
• Propriedade adicionalQualquer valor
• first_seen_atstringobrigatório

  format: "date-time"

• last_seen_atstringobrigatório

  format: "date-time"

Exemplo de curl

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

deleteContact

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição

O contrato não especifica um corpo de requisição.

Resposta de sucesso 204

Contato excluído.

Sem corpo de resposta.

Exemplo de curl

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

listContactImports

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição

O contrato não especifica um corpo de requisição.

Resposta de sucesso 200

Resposta de sucesso.

application/json

• valueobject
• dataarrayobrigatório
• Cada itemobject
• idstring

  format: "uuid"

• filenamestring
• list_idstring | null

  format: "uuid"

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

Exemplo de curl

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

importContacts

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição obrigatório

application/json

• valueobject
• filenamestringobrigatório

  minLength: 1 · maxLength: 500

• list_idstring

  format: "uuid"

• consent_confirmedboolean

  Obrigatório quando alguma linha importada está inscrita.

• rowsarrayobrigatório

  minItems: 1 · maxItems: 5000

• Cada itemobject
• emailstringobrigatório

  format: "email"

• display_namestring

  maxLength: 1000

• statusstring

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

• attributesobject
• Propriedade adicionalQualquer valor

Resposta de sucesso 201

Resposta de sucesso.

application/json

• valueobject
• dataobjectobrigatório
• idstringobrigatório

  format: "uuid"

• statusstringobrigatório

  enum: "queued"

• total_rowsintegerobrigatório
• imported_rowsintegerobrigatório
• invalid_rowsintegerobrigatório
• list_idstring | nullobrigatório

  format: "uuid"

Exemplo de curl

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/contacts/imports' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "filename": "example",
  "list_id": "00000000-0000-4000-8000-000000000001",
  "consent_confirmed": true,
  "rows": [
    {
      "email": "person@example.com",
      "display_name": "example",
      "status": "subscribed",
      "attributes": {}
    }
  ]
}'

Mesclar atributos tipados sem alterar inscrição ou consentimento

Exige contacts:write e contacts:read. Atualiza apenas um contato existente. Atributos omitidos são preservados, false explícito é armazenado e null remove um campo. Forneça fatos verificados da fonte; dados ausentes não são false. Inscrição, supressão, identidade e histórico de fontes não mudam.

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição obrigatório

application/json

• valueobject

  Sem propriedades adicionais

• attributesobjectobrigatório
• Propriedade adicionalQualquer valor

Resposta de sucesso 200

Leitura atual do contato; replayed é true quando esta alteração já foi aplicada.

application/json

• valueobject
• dataobjectobrigatório
• idstringobrigatório

  format: "uuid"

• attributesobjectobrigatório
• Propriedade adicionalQualquer valor
• statusstringobrigatório

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

• replayedbooleanobrigatório
• Propriedade adicionalQualquer valor

Exemplo de curl

curl --request PATCH --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/contacts/{contactId}/attributes' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'X-Banger-Product-Id: 00000000-0000-4000-8000-000000000001' \
  --header 'Idempotency-Key: example' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "attributes": {}
}'

upsertProductContact

Autenticação: chave de API Bearer do espaço de trabalho.

Parâmetros

Corpo da requisição obrigatório

application/json

• valueobject

  Sem propriedades adicionais

• emailstringobrigatório

  format: "email" · maxLength: 320

• display_namestring

  minLength: 0 · maxLength: 1000

• attributesobject
• Propriedade adicionalQualquer valor
• statusstringobrigatório

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

• consent_evidenceobject

  Sem propriedades adicionais

• sourcestring

  minLength: 1 · maxLength: 2000

• referencestring

  minLength: 1 · maxLength: 2000

• observed_atstring

  format: "date-time"

• statementstring

  minLength: 1 · maxLength: 2000

• consent_confirmedboolean

Resposta de sucesso 200

Leitura canônica ou recibo idempotente. Aceitação pelo provedor é sent; delivered exige um evento de entrega e não comprova chegada à caixa de entrada.

application/json

• valueobject
• datanão especificadoobrigatório
• allOf 1object
• idstringobrigatório

  format: "uuid"

• emailstringobrigatório

  format: "email"

• display_namestring | nullobrigatório
• attributesobjectobrigatório
• Propriedade adicionalQualquer valor
• statusstringobrigatório

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

• created_atstringobrigatório

  format: "date-time"

• updated_atstringobrigatório

  format: "date-time"

• suppressedbooleanobrigatório
• suppression_reasonstring | nullobrigatório
• sourcesarrayobrigatório
• Cada itemobject
• kindstringobrigatório
• referencestringobrigatório
• connection_idstring | nullobrigatório

  format: "uuid"

• metadataobjectobrigatório
• Propriedade adicionalQualquer valor
• first_seen_atstringobrigatório

  format: "date-time"

• last_seen_atstringobrigatório

  format: "date-time"

• listsarrayobrigatório
• Cada itemobject
• idstringobrigatório

  format: "uuid"

• namestringobrigatório
• subscription_statusstringobrigatório
• consent_evidencearrayobrigatório
• Cada itemobject
• kindstringobrigatório
• referencestringobrigatório
• connection_idstring | nullobrigatório

  format: "uuid"

• metadataobjectobrigatório
• Propriedade adicionalQualquer valor
• first_seen_atstringobrigatório

  format: "date-time"

• last_seen_atstringobrigatório

  format: "date-time"

• allOf 2object
• replayedbooleanobrigatório