Référence de l’API Banger

Lister les produits de l’espace de travail

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête

Le contrat ne précise aucun corps de requête.

Réponse réussie 200

Réponse réussie.

application/json

• valueobject
• dataarrayobligatoire
• Chaque élémentobject
• idstringobligatoire

  format: "uuid"

• workspace_idstringobligatoire

  format: "uuid"

• namestringobligatoire
• slugstringobligatoire
• kindstringobligatoire

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

• website_urlstring | nullobligatoire
• domainsarrayobligatoire
• Chaque élémentstring
• descriptionstringobligatoire
• contextobjectobligatoire
• Propriété supplémentaireToute valeur
• brandobjectobligatoire
• company_namestring

  maxLength: 160

• logo_urlstring

  L’icône : le symbole seul, utilisé en petit format (pied d’e-mail, formulaires coulissants) et comme en-tête en l’absence de logotype.

  maxLength: 2000

• wordmark_urlstring

  Le logotype : le nom de l’entreprise tel qu’il est dessiné, affiché seul en haut de chaque 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

• statusstringobligatoire

  deleting : supprimé par une personne ; restaurable jusqu’à delete_after, puis supprimé définitivement.

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

• delete_afterstring | null

  Date de suppression définitive d’un produit en état deleting.

  format: "date-time"

• is_defaultbooleanobligatoire
• route_readybooleanobligatoire
• setuparrayobligatoire
• Chaque élémentobject
• keystringobligatoire

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

• statusstringobligatoire

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

• completion_sourcestring | nullobligatoire

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

• notestringobligatoire
• updated_atstring | nullobligatoire

  format: "date-time"

• created_atstringobligatoire

  format: "date-time"

• updated_atstringobligatoire

  format: "date-time"

Exemple curl

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

Créer un produit

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête obligatoire

application/json

• valueobject
• namestringobligatoire

  minLength: 1 · maxLength: 160

• kindstring

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

• website_urlstring | null

  maxLength: 2000

• descriptionstring

  maxLength: 4000

• contextobject
• Propriété supplémentaireToute valeur
• domainsarray

  maxItems: 20

• Chaque élémentstring

  maxLength: 253

Réponse réussie 201

Réponse réussie.

application/json

• valueobject
• dataobjectobligatoire
• idstringobligatoire

  format: "uuid"

• workspace_idstringobligatoire

  format: "uuid"

• namestringobligatoire
• slugstringobligatoire
• kindstringobligatoire

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

• website_urlstring | nullobligatoire
• domainsarrayobligatoire
• Chaque élémentstring
• descriptionstringobligatoire
• contextobjectobligatoire
• Propriété supplémentaireToute valeur
• brandobjectobligatoire
• company_namestring

  maxLength: 160

• logo_urlstring

  L’icône : le symbole seul, utilisé en petit format (pied d’e-mail, formulaires coulissants) et comme en-tête en l’absence de logotype.

  maxLength: 2000

• wordmark_urlstring

  Le logotype : le nom de l’entreprise tel qu’il est dessiné, affiché seul en haut de chaque 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

• statusstringobligatoire

  deleting : supprimé par une personne ; restaurable jusqu’à delete_after, puis supprimé définitivement.

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

• delete_afterstring | null

  Date de suppression définitive d’un produit en état deleting.

  format: "date-time"

• is_defaultbooleanobligatoire
• route_readybooleanobligatoire
• setuparrayobligatoire
• Chaque élémentobject
• keystringobligatoire

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

• statusstringobligatoire

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

• completion_sourcestring | nullobligatoire

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

• notestringobligatoire
• updated_atstring | nullobligatoire

  format: "date-time"

• created_atstringobligatoire

  format: "date-time"

• updated_atstringobligatoire

  format: "date-time"

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

Obtenir un produit

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête

Le contrat ne précise aucun corps de requête.

Réponse réussie 200

Réponse réussie.

application/json

• valueobject
• dataobjectobligatoire
• idstringobligatoire

  format: "uuid"

• workspace_idstringobligatoire

  format: "uuid"

• namestringobligatoire
• slugstringobligatoire
• kindstringobligatoire

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

• website_urlstring | nullobligatoire
• domainsarrayobligatoire
• Chaque élémentstring
• descriptionstringobligatoire
• contextobjectobligatoire
• Propriété supplémentaireToute valeur
• brandobjectobligatoire
• company_namestring

  maxLength: 160

• logo_urlstring

  L’icône : le symbole seul, utilisé en petit format (pied d’e-mail, formulaires coulissants) et comme en-tête en l’absence de logotype.

  maxLength: 2000

• wordmark_urlstring

  Le logotype : le nom de l’entreprise tel qu’il est dessiné, affiché seul en haut de chaque 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

• statusstringobligatoire

  deleting : supprimé par une personne ; restaurable jusqu’à delete_after, puis supprimé définitivement.

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

• delete_afterstring | null

  Date de suppression définitive d’un produit en état deleting.

  format: "date-time"

• is_defaultbooleanobligatoire
• route_readybooleanobligatoire
• setuparrayobligatoire
• Chaque élémentobject
• keystringobligatoire

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

• statusstringobligatoire

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

• completion_sourcestring | nullobligatoire

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

• notestringobligatoire
• updated_atstring | nullobligatoire

  format: "date-time"

• created_atstringobligatoire

  format: "date-time"

• updated_atstringobligatoire

  format: "date-time"

Exemple curl

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

Mettre à jour un produit

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête obligatoire

application/json

• valueobject
• namestring

  maxLength: 160

• kindstring

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

• website_urlstring | null

  maxLength: 2000

• descriptionstring

  maxLength: 4000

• contextobject
• Propriété supplémentaireToute valeur
• brandobject
• company_namestring

  maxLength: 160

• logo_urlstring

  L’icône : le symbole seul, utilisé en petit format (pied d’e-mail, formulaires coulissants) et comme en-tête en l’absence de logotype.

  maxLength: 2000

• wordmark_urlstring

  Le logotype : le nom de l’entreprise tel qu’il est dessiné, affiché seul en haut de chaque 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"

Réponse réussie 200

Réponse réussie.

application/json

• valueobject
• dataobjectobligatoire
• idstringobligatoire

  format: "uuid"

• workspace_idstringobligatoire

  format: "uuid"

• namestringobligatoire
• slugstringobligatoire
• kindstringobligatoire

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

• website_urlstring | nullobligatoire
• domainsarrayobligatoire
• Chaque élémentstring
• descriptionstringobligatoire
• contextobjectobligatoire
• Propriété supplémentaireToute valeur
• brandobjectobligatoire
• company_namestring

  maxLength: 160

• logo_urlstring

  L’icône : le symbole seul, utilisé en petit format (pied d’e-mail, formulaires coulissants) et comme en-tête en l’absence de logotype.

  maxLength: 2000

• wordmark_urlstring

  Le logotype : le nom de l’entreprise tel qu’il est dessiné, affiché seul en haut de chaque 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

• statusstringobligatoire

  deleting : supprimé par une personne ; restaurable jusqu’à delete_after, puis supprimé définitivement.

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

• delete_afterstring | null

  Date de suppression définitive d’un produit en état deleting.

  format: "date-time"

• is_defaultbooleanobligatoire
• route_readybooleanobligatoire
• setuparrayobligatoire
• Chaque élémentobject
• keystringobligatoire

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

• statusstringobligatoire

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

• completion_sourcestring | nullobligatoire

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

• notestringobligatoire
• updated_atstring | nullobligatoire

  format: "date-time"

• created_atstringobligatoire

  format: "date-time"

• updated_atstringobligatoire

  format: "date-time"

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

Supprimez un produit (un projet dans l’application) après examen de son aperçu de suppression. Il cesse immédiatement d’être utilisé (ses envois s’arrêtent) et reste restaurable pendant 24 heures ; Banger supprime ensuite ses domaines d’envoi et toutes ses lignes. Le dernier produit actif de l’espace de travail ne peut pas être supprimé. Nécessite un administrateur de l’espace de travail et une session connectée ; les clés API et autorisations OAuth sont refusées.

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête obligatoire

application/json

• valueobject

  Aucune propriété supplémentaire

• confirm_namestringobligatoire

  Le nom exact du produit.

  minLength: 1 · maxLength: 160

• preview_tokenstringobligatoire

  minLength: 64 · maxLength: 64

Réponse réussie 202

Le produit est hors service et sera supprimé définitivement à delete_after, sauf restauration préalable. Une répétition idempotente renvoie le même résultat.

application/json

• valueobject
• dataobjectobligatoire
• idstringobligatoire

  format: "uuid"

• namestringobligatoire
• statusstringobligatoire

  enum: "deleting"

• delete_afterstringobligatoire

  Date de suppression définitive du produit ; il peut être restauré jusque-là.

  format: "date-time"

• next_product_idstringobligatoire

  Le produit par défaut actuel de l’espace de travail.

  format: "uuid"

• replayedboolean

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

Prévisualisez la suppression d’un produit et de tout ce qui lui appartient, sans rien supprimer. Nécessite un administrateur de l’espace de travail, connecté ou via OAuth autorisé par l’utilisateur.

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête

Le contrat ne précise aucun corps de requête.

Réponse réussie 200

Ce que la suppression du produit retire et arrête.

application/json

• valueobject
• dataobjectobligatoire
• productobjectobligatoire
• idstringobligatoire

  format: "uuid"

• namestringobligatoire
• is_defaultbooleanobligatoire
• next_default_productnon préciséobligatoire

  Le produit qui devient celui par défaut de l’espace de travail lorsque le produit par défaut est supprimé.

• oneOf 1null
• oneOf 2object
• idstringobligatoire

  format: "uuid"

• namestringobligatoire
• last_productbooleanobligatoire

  Le seul produit actif ne peut pas être supprimé.

• mailboxesarrayobligatoire
• Chaque élémentobject
• idstringobligatoire

  format: "uuid"

• addressstringobligatoire
• domainsarrayobligatoire

  Domaines d’envoi supprimés par Banger après expiration du délai de restauration.

• Chaque élémentobject
• idstringobligatoire

  format: "uuid"

• domainstringobligatoire
• journeysintegerobligatoire
• broadcastsintegerobligatoire
• signup_formsintegerobligatoire
• contactsintegerobligatoire
• api_keysintegerobligatoire
• webhooksintegerobligatoire
• pending_sendsintegerobligatoire
• impactarrayobligatoire
• Chaque élémentstring
• preview_tokenstringobligatoire

Exemple curl

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

Restaurez un produit supprimé avant son delete_after. Ses boîtes mail, Parcours, formulaires d’inscription, webhooks et intégrations sont réactivés ; les Campagnes restent en pause. Nécessite un administrateur de l’espace de travail, connecté ou via OAuth autorisé par l’utilisateur.

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête

Le contrat ne précise aucun corps de requête.

Réponse réussie 200

Le produit est de nouveau actif.

application/json

• valueobject
• dataobjectobligatoire
• idstringobligatoire

  format: "uuid"

• namestringobligatoire
• statusstringobligatoire

  enum: "active"

Exemple curl

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

Mettre à jour un élément de configuration du produit

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête obligatoire

application/json

• valueobject
• statusstringobligatoire

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

• completion_sourcestring

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

• notestring

  maxLength: 1000

Réponse réussie 200

Réponse réussie.

application/json

• valueobject
• dataobjectobligatoire
• keystringobligatoire

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

• statusstringobligatoire

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

• completion_sourcestring | nullobligatoire

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

• notestringobligatoire
• updated_atstring | nullobligatoire

  format: "date-time"

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

Associer un domaine à un produit

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête obligatoire

application/json

• valueobject
• domainstringobligatoire

  minLength: 3 · maxLength: 253

Réponse réussie 201

Réponse réussie.

application/json

• valueobject
• dataobjectobligatoire
• idstringobligatoire

  format: "uuid"

• workspace_idstringobligatoire

  format: "uuid"

• namestringobligatoire
• slugstringobligatoire
• kindstringobligatoire

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

• website_urlstring | nullobligatoire
• domainsarrayobligatoire
• Chaque élémentstring
• descriptionstringobligatoire
• contextobjectobligatoire
• Propriété supplémentaireToute valeur
• brandobjectobligatoire
• company_namestring

  maxLength: 160

• logo_urlstring

  L’icône : le symbole seul, utilisé en petit format (pied d’e-mail, formulaires coulissants) et comme en-tête en l’absence de logotype.

  maxLength: 2000

• wordmark_urlstring

  Le logotype : le nom de l’entreprise tel qu’il est dessiné, affiché seul en haut de chaque 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

• statusstringobligatoire

  deleting : supprimé par une personne ; restaurable jusqu’à delete_after, puis supprimé définitivement.

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

• delete_afterstring | null

  Date de suppression définitive d’un produit en état deleting.

  format: "date-time"

• is_defaultbooleanobligatoire
• route_readybooleanobligatoire
• setuparrayobligatoire
• Chaque élémentobject
• keystringobligatoire

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

• statusstringobligatoire

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

• completion_sourcestring | nullobligatoire

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

• notestringobligatoire
• updated_atstring | nullobligatoire

  format: "date-time"

• created_atstringobligatoire

  format: "date-time"

• updated_atstringobligatoire

  format: "date-time"

Exemple 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

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête

Le contrat ne précise aucun corps de requête.

Réponse réussie 200

Boîtes mail visibles par l’acteur.

application/json

• valueobject
• dataarrayobligatoire
• Chaque élémentobject
• idstringobligatoire

  format: "uuid"

• workspace_idstringobligatoire

  format: "uuid"

• product_idstring | null

  Le produit (projet) auquel appartient la boîte mail. Les clients l’utilisent pour regrouper les boîtes mail et créer des liens vers l’application web.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringobligatoire

  format: "email"

• display_namestringobligatoire
• providerstringobligatoire

  enum: "gmail", "smtp"

• statusstringobligatoire

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringobligatoire

  enum: "domain", "starter"

Exemple curl

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

Créez une boîte mail professionnelle native Banger sur un domaine d’envoi de l’espace de travail.

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête obligatoire

application/json

• valueobject

  Aucune propriété supplémentaire

• domain_idstringobligatoire

  format: "uuid"

• local_partstringobligatoire

  minLength: 1 · maxLength: 64

• display_namestring

  maxLength: 200

Réponse réussie 200

Répétition idempotente de la création d’une boîte mail native.

application/json

• valueobject
• dataobjectobligatoire
• idstringobligatoire

  format: "uuid"

• workspace_idstringobligatoire

  format: "uuid"

• product_idstring | null

  Le produit (projet) auquel appartient la boîte mail. Les clients l’utilisent pour regrouper les boîtes mail et créer des liens vers l’application web.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringobligatoire

  format: "email"

• display_namestringobligatoire
• providerstringobligatoire

  enum: "gmail", "smtp"

• statusstringobligatoire

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringobligatoire

  enum: "domain", "starter"

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

Prévisualisez la suppression définitive d’une boîte mail et des flux d’envoi dépendants. Nécessite un administrateur de l’espace de travail et une portée produit.

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête

Le contrat ne précise aucun corps de requête.

Réponse réussie 200

Boîte mail exacte et impact actuel de la suppression, sans rien supprimer.

application/json

• valueobject
• dataobjectobligatoire
• mailboxobjectobligatoire
• idstringobligatoire

  format: "uuid"

• addressstringobligatoire
• providerstringobligatoire
• domain_idstring | nullobligatoire

  format: "uuid"

• provider_connection_idstring | nullobligatoire

  format: "uuid"

• messagesintegerobligatoire
• draftsintegerobligatoire
• pending_sendsintegerobligatoire
• broadcastsarrayobligatoire
• Chaque élémentobject
• idstringobligatoire

  format: "uuid"

• namestringobligatoire
• statusstringobligatoire
• journeysarrayobligatoire
• Chaque élémentobject
• idstringobligatoire

  format: "uuid"

• namestringobligatoire
• statusstringobligatoire
• signup_formsarrayobligatoire
• Chaque élémentobject
• idstringobligatoire

  format: "uuid"

• namestringobligatoire
• statusstringobligatoire
• impactarrayobligatoire
• Chaque élémentstring
• preview_tokenstringobligatoire

Exemple curl

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

Définissez le nom d’expéditeur affiché aux destinataires pour une boîte mail Banger ("Name <address>"). Les boîtes mail Gmail conservent le nom défini dans Gmail. Nécessite un administrateur de l’espace de travail.

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête obligatoire

application/json

• valueobject

  Aucune propriété supplémentaire

• display_namestringobligatoire

  Une ligne. Vide, envoie l’adresse seule.

  maxLength: 200

Réponse réussie 200

La boîte mail avec son nom d’expéditeur.

application/json

• valueobject
• dataobjectobligatoire
• idstringobligatoire

  format: "uuid"

• workspace_idstringobligatoire

  format: "uuid"

• product_idstring | null

  Le produit (projet) auquel appartient la boîte mail. Les clients l’utilisent pour regrouper les boîtes mail et créer des liens vers l’application web.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringobligatoire

  format: "email"

• display_namestringobligatoire
• providerstringobligatoire

  enum: "gmail", "smtp"

• statusstringobligatoire

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringobligatoire

  enum: "domain", "starter"

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

Supprimez définitivement une boîte mail en conservant son domaine et les autres boîtes mail. Nécessite un administrateur de l’espace de travail et une portée produit.

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête obligatoire

application/json

• valueobject

  Aucune propriété supplémentaire

• confirm_addressstringobligatoire

  minLength: 3 · maxLength: 320

• preview_tokenstringobligatoire

  minLength: 64 · maxLength: 64

Réponse réussie 200

Suppression ou répétition idempotente. Les fichiers stockés sont mis en file pour nettoyage définitif.

application/json

• valueobject
• dataobjectobligatoire
• idstringobligatoire

  format: "uuid"

• addressstringobligatoire
• deletedbooleanobligatoire
• replayedboolean

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

Créez une boîte mail hébergée limitée aux boîtes de réception hébergées du même produit et au destinataire d’inscription de l’espace de travail.

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête obligatoire

application/json

• valueobject

  Aucune propriété supplémentaire

• create_newboolean

  Créez une boîte mail hébergée supplémentaire au lieu de reprendre la première.

• local_partstring

  Nom avant @bangermail.com. Sans celui-ci, la boîte mail reçoit un nom composé de mots comme quiet-maple-harbor.

  minLength: 3 · maxLength: 40

• display_namestring

  maxLength: 200

Réponse réussie 200

Répétition idempotente de la création d’une identité initiale.

application/json

• valueobject
• dataobjectobligatoire
• idstringobligatoire

  format: "uuid"

• workspace_idstringobligatoire

  format: "uuid"

• product_idstring | null

  Le produit (projet) auquel appartient la boîte mail. Les clients l’utilisent pour regrouper les boîtes mail et créer des liens vers l’application web.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringobligatoire

  format: "email"

• display_namestringobligatoire
• providerstringobligatoire

  enum: "gmail", "smtp"

• statusstringobligatoire

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringobligatoire

  enum: "domain", "starter"

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

Levez la pause liée à la réputation de l’expéditeur d’une boîte mail, selon les règles de reprise en libre-service de resumeSending.

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête obligatoire

application/json

• valueobject

  Aucune propriété supplémentaire

• acknowledge_recipient_complaintbooleanobligatoire

  const: true

• reasonstring

  Motif du rétablissement de l’envoi ; consigné dans le journal d’audit.

  maxLength: 500

Réponse réussie 200

Boîte mail réactivée ou déjà active après une requête précédente réussie.

application/json

• valueobject
• dataobjectobligatoire
• idstringobligatoire

  format: "uuid"

• workspace_idstringobligatoire

  format: "uuid"

• product_idstring | null

  Le produit (projet) auquel appartient la boîte mail. Les clients l’utilisent pour regrouper les boîtes mail et créer des liens vers l’application web.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringobligatoire

  format: "email"

• display_namestringobligatoire
• providerstringobligatoire

  enum: "gmail", "smtp"

• statusstringobligatoire

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringobligatoire

  enum: "domain", "starter"

Exemple 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

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête

Le contrat ne précise aucun corps de requête.

Réponse réussie 200

Réponse réussie.

application/json

• valueobject
• dataarrayobligatoire
• Chaque élémentobject
• idstringobligatoire

  format: "uuid"

• mailbox_idstringobligatoire

  format: "uuid"

• thread_idstring | nullobligatoire

  format: "uuid"

• versionintegerobligatoire
• toarrayobligatoire
• Chaque élémentobject
• emailstringobligatoire
• namestring
• ccarrayobligatoire
• Chaque élémentobject
• emailstringobligatoire
• namestring
• bccarrayobligatoire
• Chaque élémentobject
• emailstringobligatoire
• namestring
• subjectstringobligatoire
• body_textstringobligatoire
• statusstringobligatoire
• created_atstringobligatoire

  format: "date-time"

• updated_atstringobligatoire

  format: "date-time"

• attachmentsarrayobligatoire
• Chaque élémentobject
• idstringobligatoire

  format: "uuid"

• filenamestringobligatoire
• content_typestringobligatoire
• size_bytesintegerobligatoire
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

Exemple 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

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête obligatoire

application/json

• valueobject

  Aucune propriété supplémentaire

• mailbox_idstringobligatoire

  format: "uuid"

• thread_idstring

  format: "uuid"

• toarray

  maxItems: 500

• Chaque élémentobject
• namestring
• emailstringobligatoire

  format: "email"

• ccarray

  maxItems: 500

• Chaque élémentobject
• namestring
• emailstringobligatoire

  format: "email"

• bccarray

  maxItems: 500

• Chaque élémentobject
• namestring
• emailstringobligatoire

  format: "email"

• subjectstring

  maxLength: 10000

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

Réponse réussie 201

Réponse réussie.

application/json

• valueobject
• dataobjectobligatoire
• idstringobligatoire

  format: "uuid"

• mailbox_idstringobligatoire

  format: "uuid"

• thread_idstring | nullobligatoire

  format: "uuid"

• versionintegerobligatoire
• toarrayobligatoire
• Chaque élémentobject
• emailstringobligatoire
• namestring
• ccarrayobligatoire
• Chaque élémentobject
• emailstringobligatoire
• namestring
• bccarrayobligatoire
• Chaque élémentobject
• emailstringobligatoire
• namestring
• subjectstringobligatoire
• body_textstringobligatoire
• statusstringobligatoire
• created_atstringobligatoire

  format: "date-time"

• updated_atstringobligatoire

  format: "date-time"

• attachmentsarrayobligatoire
• Chaque élémentobject
• idstringobligatoire

  format: "uuid"

• filenamestringobligatoire
• content_typestringobligatoire
• size_bytesintegerobligatoire
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

Exemple 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

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête

Le contrat ne précise aucun corps de requête.

Réponse réussie 200

Performances, état et incidents canoniques de délivrabilité.

application/json

• valueobject
• dataobjectobligatoire
• idstringobligatoire

  format: "uuid"

• mailbox_idstringobligatoire

  format: "uuid"

• thread_idstring | nullobligatoire

  format: "uuid"

• versionintegerobligatoire
• toarrayobligatoire
• Chaque élémentobject
• emailstringobligatoire
• namestring
• ccarrayobligatoire
• Chaque élémentobject
• emailstringobligatoire
• namestring
• bccarrayobligatoire
• Chaque élémentobject
• emailstringobligatoire
• namestring
• subjectstringobligatoire
• body_textstringobligatoire
• statusstringobligatoire
• created_atstringobligatoire

  format: "date-time"

• updated_atstringobligatoire

  format: "date-time"

• attachmentsarrayobligatoire
• Chaque élémentobject
• idstringobligatoire

  format: "uuid"

• filenamestringobligatoire
• content_typestringobligatoire
• size_bytesintegerobligatoire
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

Exemple curl

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

updateDraft

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête obligatoire

application/json

• valuenon précisé
• allOf 1object

  Aucune propriété supplémentaire

• mailbox_idstringobligatoire

  format: "uuid"

• thread_idstring

  format: "uuid"

• toarray

  maxItems: 500

• Chaque élémentobject
• namestring
• emailstringobligatoire

  format: "email"

• ccarray

  maxItems: 500

• Chaque élémentobject
• namestring
• emailstringobligatoire

  format: "email"

• bccarray

  maxItems: 500

• Chaque élémentobject
• namestring
• emailstringobligatoire

  format: "email"

• subjectstring

  maxLength: 10000

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

• allOf 2object
• versionintegerobligatoire

  minimum: 1

Réponse réussie 200

Réponse réussie.

application/json

• valueobject
• dataobjectobligatoire
• idstringobligatoire

  format: "uuid"

• mailbox_idstringobligatoire

  format: "uuid"

• thread_idstring | nullobligatoire

  format: "uuid"

• versionintegerobligatoire
• toarrayobligatoire
• Chaque élémentobject
• emailstringobligatoire
• namestring
• ccarrayobligatoire
• Chaque élémentobject
• emailstringobligatoire
• namestring
• bccarrayobligatoire
• Chaque élémentobject
• emailstringobligatoire
• namestring
• subjectstringobligatoire
• body_textstringobligatoire
• statusstringobligatoire
• created_atstringobligatoire

  format: "date-time"

• updated_atstringobligatoire

  format: "date-time"

• attachmentsarrayobligatoire
• Chaque élémentobject
• idstringobligatoire

  format: "uuid"

• filenamestringobligatoire
• content_typestringobligatoire
• size_bytesintegerobligatoire
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

Exemple 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

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête

Le contrat ne précise aucun corps de requête.

Réponse réussie 204

Brouillon et objets référencés programmés pour suppression.

Aucun corps de réponse.

Exemple curl

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

sendDraft

Envoie le brouillon depuis sa boîte mail, à laquelle l’appelant doit avoir accès. Si ses envois nécessitent une approbation, une approbation en attente est créée ; une personne autorisée à envoyer directement le brouillon décide.

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête

Le contrat ne précise aucun corps de requête.

Réponse réussie 202

L’envoi est en file ou attend une approbation.

application/json

• valueobject
• datanon préciséobligatoire
• oneOf 1object
• idstringobligatoire

  format: "uuid"

• typestringobligatoire
• statusstringobligatoire

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

• workspace_revisionintegerobligatoire

  format: "int64"

• created_atstringobligatoire

  format: "date-time"

• oneOf 2object

  Aucune propriété supplémentaire

• approvalobjectobligatoire
• idstringobligatoire

  format: "uuid"

• requested_by_actor_idstringobligatoire
• action_kindstringobligatoire
• summarystringobligatoire
• capability_scopesarrayobligatoire
• Chaque élémentstring
• resource_scopeobjectobligatoire
• Propriété supplémentairearray
• Chaque élémentstring

  Imbrications supplémentaires omises

• payloadobjectobligatoire
• Propriété supplémentaireToute valeur
• payload_sha256stringobligatoire

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

• statusstringobligatoire

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

• missedbooleanobligatoire
• expires_atstringobligatoire

  format: "date-time"

• decided_by_actor_idstring | null
• decision_reasonstring | null
• created_atstringobligatoire

  format: "date-time"

• updated_atstringobligatoire

  format: "date-time"

• decided_atstring | null

  format: "date-time"

• execution_job_idstring

  format: "uuid"

• reviewobject

  Aucune propriété supplémentaire

• dispositionstringobligatoire

  enum: "automatic", "human_required"

• recipient_countinteger | nullobligatoire

  minimum: 0

• reasonsarrayobligatoire
• Chaque élémentstring

  Imbrications supplémentaires omises

• checksarrayobligatoire
• Chaque élémentstring

  Imbrications supplémentaires omises

Exemple 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

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête obligatoire

application/octet-stream

• valuestring

  format: "binary" · maxLength: 26214400

Réponse réussie 201

Réponse réussie.

application/json

• valueobject
• dataobjectobligatoire
• idstringobligatoire

  format: "uuid"

• filenamestringobligatoire
• content_typestringobligatoire
• size_bytesintegerobligatoire
• sha256string
• created_atstring

  format: "date-time"

Exemple 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

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête

Le contrat ne précise aucun corps de requête.

Réponse réussie 204

Pièce jointe programmée pour suppression B2 tenant compte des versions.

Aucun corps de réponse.

Exemple curl

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

Lire le corps HTML d’un brouillon

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête

Le contrat ne précise aucun corps de requête.

Réponse réussie 200

HTML du brouillon.

text/html

• valuestring

Exemple curl

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

listSendIntents

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête

Le contrat ne précise aucun corps de requête.

Réponse réussie 200

Envois canoniques récents et leur état chez le fournisseur.

application/json

• valueobject
• dataarrayobligatoire
• Chaque élémentobject

  Aucune propriété supplémentaire

• idstringobligatoire

  format: "uuid"

• statusstringobligatoire

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

• traffic_classstringobligatoire

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

• recipient_countintegerobligatoire

  minimum: 1

• provider_keystringobligatoire
• provider_statestringobligatoire

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

• provider_message_idstring | null
• error_codestring | null
• created_atstringobligatoire

  format: "date-time"

• updated_atstringobligatoire

  format: "date-time"

• completed_atstring | null

  format: "date-time"

Exemple curl

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

getSendIntent

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête

Le contrat ne précise aucun corps de requête.

Réponse réussie 200

État canonique de l’envoi asynchrone.

application/json

• valueobject
• dataobjectobligatoire

  Aucune propriété supplémentaire

• idstringobligatoire

  format: "uuid"

• statusstringobligatoire

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

• traffic_classstringobligatoire

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

• recipient_countintegerobligatoire

  minimum: 1

• provider_keystringobligatoire
• provider_statestringobligatoire

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

• provider_message_idstring | null
• error_codestring | null
• created_atstringobligatoire

  format: "date-time"

• updated_atstringobligatoire

  format: "date-time"

• completed_atstring | null

  format: "date-time"

Exemple curl

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

listTransactionalSends

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête

Le contrat ne précise aucun corps de requête.

Réponse réussie 200

Réponse réussie.

application/json

• valueobject
• dataarrayobligatoire
• Chaque élémentobject
• idstringobligatoire

  format: "uuid"

• mailbox_idstring | nullobligatoire

  format: "uuid"

• command_idstring | nullobligatoire

  format: "uuid"

• statusstringobligatoire
• command_statusstring | nullobligatoire
• subjectstring
• recipientsarray
• Chaque élémentobject
• emailstringobligatoire
• namestring
• recipient_countintegerobligatoire
• error_codestring | null
• send_intent_idstring

  format: "uuid"

• providerstring | null
• route_kindstring | null
• sourcestring
• from_addressstring
• recipient_statesobject
• Propriété supplémentaireinteger
• provider_message_idstring | null
• languagenon précisé

  Langue dans laquelle cet e-mail a été envoyé ; null s’il n’a pas été traduit.

• anyOf 1object

  Langue dans laquelle une personne a reçu un e-mail. Seuls les e-mails traduits (contenu géré) en ont une.

• localestringobligatoire

  Étiquette BCP 47 de la langue de rédaction de l’e-mail.

• requested_localestring

  Présent uniquement sur un ancien envoi parti dans une autre langue : la langue que la personne aurait dû recevoir.

• fallback_reasonstring

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

• anyOf 2null
• journeyobject | null

  Étape et inscription du Parcours ayant envoyé cet e-mail ; null pour les autres envois.

• journey_idstringobligatoire

  format: "uuid"

• step_idstringobligatoire

  format: "uuid"

• enrollment_idstringobligatoire

  format: "uuid"

• experimentobject | null

  Variante d’expérience de cet e-mail ; null si aucune ne s’appliquait.

• experiment_idstringobligatoire

  format: "uuid"

• variant_keystringobligatoire
• created_atstringobligatoire

  format: "date-time"

• updated_atstringobligatoire

  format: "date-time"

• completed_atstring | nullobligatoire

  format: "date-time"

• template_idstring | null

  format: "uuid"

• template_versioninteger | null
• workspace_revisioninteger | null
• command_resultobject
• Propriété supplémentaireToute valeur
• command_started_atstring | null

  format: "date-time"

• command_completed_atstring | null

  format: "date-time"

• body_textstring
• body_htmlstring
• reply_toarray
• Chaque élémentobject
• emailstringobligatoire
• namestring
• headersobject
• Propriété supplémentairestring
• tagsarray
• Chaque élémentobject
• namestringobligatoire
• valuestringobligatoire

Exemple curl

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

createTransactionalSend

Un destinataire par envoi de Parcours. To accepte un destinataire dans tout format RecipientInput ("a@example.com", "Pat <a@example.com>", { email, name } ou une liste d’un élément) ; Cc et Bcc doivent être vides. reply_to utilise par défaut la boîte mail du Parcours (une liste vide signifie aussi la valeur par défaut) ; l’e-mail Produit en nécessite exactement un. Un nouveau Parcours API utilise par défaut un contenu source géré ; les Parcours de code hérités conservent les envois à contenu complet. Un refus (4xx) ne fige rien pour le destinataire : un appel corrigé avec une nouvelle clé d’idempotence envoie donc l’e-mail.

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête obligatoire

application/json

• valueobject
• mailbox_idstringobligatoire

  format: "uuid"

• tonon préciséobligatoire

  Destinataires de to, cc, bcc et reply_to : une adresse ("a@example.com" ou "Pat <a@example.com>"), un objet { email, name } ou une liste mélangeant les deux. Banger les stocke en objets { email, name } avec l’e-mail en minuscules. Le hash d’idempotence couvre le corps tel qu’envoyé : réessayez avec le même format.

• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringobligatoire

  format: "email"

• oneOf 3array

  maxItems: 500

• Chaque élémentnon précisé
• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringobligatoire

  format: "email"

• ccarray

  maxItems: 0

• Chaque élémentobject
• namestring
• emailstringobligatoire

  format: "email"

• bccarray

  maxItems: 0

• Chaque élémentobject
• namestring
• emailstringobligatoire

  format: "email"

• subjectstring

  maxLength: 10000

• expires_atstring

  Abandonnez un envoi différé de Parcours après cet instant ; au plus sept jours après la requête initiale.

  format: "date-time"

• expires_after_secondsinteger

  minimum: 1 · maximum: 604800

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

• reply_tonon précisé

  Destinataires de to, cc, bcc et reply_to : une adresse ("a@example.com" ou "Pat <a@example.com>"), un objet { email, name } ou une liste mélangeant les deux. Banger les stocke en objets { email, name } avec l’e-mail en minuscules. Le hash d’idempotence couvre le corps tel qu’envoyé : réessayez avec le même format.

• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringobligatoire

  format: "email"

• oneOf 3array

  maxItems: 500

• Chaque élémentnon précisé
• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringobligatoire

  format: "email"

• headersobject
• Propriété supplémentairestring

  maxLength: 5000

• tagsarray

  maxItems: 49

• Chaque élémentobject

  Aucune propriété supplémentaire

• namestringobligatoire

  minLength: 1 · maxLength: 256

• valuestringobligatoire

  minLength: 1 · maxLength: 256

Réponse réussie 202

Réponse réussie.

application/json

• valueobject
• dataobjectobligatoire
• action_kindstringobligatoire

  enum: "transactional.send"

• idstring

  format: "uuid"

• send_intent_idstring

  format: "uuid"

• provider_attempt_idstring

  format: "uuid"

• statusstringobligatoire

  États sent/queued de livraison ou, pour une requête figée : deferred (planifiée par la politique ou en attente de traduction), processing (en cours d’envoi), discarded.

• replayedboolean
• journeynon préciséobligatoire
• anyOf 1object
• journey_idstringobligatoire

  format: "uuid"

• enrollment_idstringobligatoire

  format: "uuid"

• step_idstringobligatoire

  format: "uuid"

• step_positionintegerobligatoire
• originstring

  enum: "journey"

• journey_identitystring
• anyOf 2null
• ignored_variablesarrayobligatoire
• Chaque élémentstring
• scheduled_atstring

  format: "date-time"

• reasonstring
• communication_reservation_idstring

  format: "uuid"

Exemple 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

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête

Le contrat ne précise aucun corps de requête.

Réponse réussie 200

Réponse réussie.

application/json

• valueobject
• dataobjectobligatoire
• idstringobligatoire

  format: "uuid"

• mailbox_idstring | nullobligatoire

  format: "uuid"

• command_idstring | nullobligatoire

  format: "uuid"

• statusstringobligatoire
• command_statusstring | nullobligatoire
• subjectstring
• recipientsarray
• Chaque élémentobject
• emailstringobligatoire
• namestring
• recipient_countintegerobligatoire
• error_codestring | null
• send_intent_idstring

  format: "uuid"

• providerstring | null
• route_kindstring | null
• sourcestring
• from_addressstring
• recipient_statesobject
• Propriété supplémentaireinteger
• provider_message_idstring | null
• languagenon précisé

  Langue dans laquelle cet e-mail a été envoyé ; null s’il n’a pas été traduit.

• anyOf 1object

  Langue dans laquelle une personne a reçu un e-mail. Seuls les e-mails traduits (contenu géré) en ont une.

• localestringobligatoire

  Étiquette BCP 47 de la langue de rédaction de l’e-mail.

• requested_localestring

  Présent uniquement sur un ancien envoi parti dans une autre langue : la langue que la personne aurait dû recevoir.

• fallback_reasonstring

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

• anyOf 2null
• journeyobject | null

  Étape et inscription du Parcours ayant envoyé cet e-mail ; null pour les autres envois.

• journey_idstringobligatoire

  format: "uuid"

• step_idstringobligatoire

  format: "uuid"

• enrollment_idstringobligatoire

  format: "uuid"

• experimentobject | null

  Variante d’expérience de cet e-mail ; null si aucune ne s’appliquait.

• experiment_idstringobligatoire

  format: "uuid"

• variant_keystringobligatoire
• created_atstringobligatoire

  format: "date-time"

• updated_atstringobligatoire

  format: "date-time"

• completed_atstring | nullobligatoire

  format: "date-time"

• template_idstring | null

  format: "uuid"

• template_versioninteger | null
• workspace_revisioninteger | null
• command_resultobject
• Propriété supplémentaireToute valeur
• command_started_atstring | null

  format: "date-time"

• command_completed_atstring | null

  format: "date-time"

• body_textstring
• body_htmlstring
• reply_toarray
• Chaque élémentobject
• emailstringobligatoire
• namestring
• headersobject
• Propriété supplémentairestring
• tagsarray
• Chaque élémentobject
• namestringobligatoire
• valuestringobligatoire

Exemple curl

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

listTransactionalSendTimeline

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête

Le contrat ne précise aucun corps de requête.

Réponse réussie 200

Chronologie ordonnée de l’acceptation, des tentatives fournisseur et des événements destinataire.

application/json

• valueobject
• dataarrayobligatoire
• Chaque élémentobject
• occurred_atstringobligatoire

  format: "date-time"

• event_typestringobligatoire
• labelstringobligatoire
• providerstring | null
• recipient_domainstring | null
• error_codestring | null

Exemple curl

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

retryTransactionalSend

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête

Le contrat ne précise aucun corps de requête.

Réponse réussie 202

Réponse réussie.

application/json

• valueobject
• dataobjectobligatoire
• action_kindstringobligatoire

  enum: "transactional.send"

• idstringobligatoire

  format: "uuid"

• send_intent_idstringobligatoire

  format: "uuid"

• provider_attempt_idstringobligatoire

  format: "uuid"

• statusstringobligatoire
• replayedbooleanobligatoire

Exemple 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

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête

Le contrat ne précise aucun corps de requête.

Réponse réussie 200

Conversations de l’espace de travail paginées par clé.

application/json

• valueobject
• dataarrayobligatoire
• Chaque élémentobject
• idstringobligatoire

  format: "uuid"

• mailbox_idstringobligatoire

  format: "uuid"

• subjectstringobligatoire
• snippetstringobligatoire
• last_message_atstringobligatoire

  format: "date-time"

• message_countintegerobligatoire
• unread_countintegerobligatoire
• is_archivedbooleanobligatoire
• is_trashbooleanobligatoire
• is_spambooleanobligatoire
• is_starredbooleanobligatoire
• is_sentbooleanobligatoire
• has_attachmentsbooleanobligatoire
• labelsarrayobligatoire
• Chaque élémentstring
• participantsarray
• Chaque élémentobject
• namestring
• emailstringobligatoire

  format: "email"

• pageobjectobligatoire
• next_cursorstring
• has_morebooleanobligatoire

Exemple 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

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête

Le contrat ne précise aucun corps de requête.

Réponse réussie 200

Conversation et messages ordonnés.

application/json

• valueobject
• datanon préciséobligatoire
• allOf 1object
• idstringobligatoire

  format: "uuid"

• mailbox_idstringobligatoire

  format: "uuid"

• subjectstringobligatoire
• snippetstringobligatoire
• last_message_atstringobligatoire

  format: "date-time"

• message_countintegerobligatoire
• unread_countintegerobligatoire
• is_archivedbooleanobligatoire
• is_trashbooleanobligatoire
• is_spambooleanobligatoire
• is_starredbooleanobligatoire
• is_sentbooleanobligatoire
• has_attachmentsbooleanobligatoire
• labelsarrayobligatoire
• Chaque élémentstring
• participantsarray
• Chaque élémentobject
• namestring
• emailstringobligatoire

  format: "email"

• allOf 2object
• messagesarrayobligatoire
• Chaque élémentobject
• idstringobligatoire

  format: "uuid"

• mailbox_idstringobligatoire

  format: "uuid"

• thread_idstringobligatoire

  format: "uuid"

• sent_atstringobligatoire

  format: "date-time"

• received_atstring

  format: "date-time"

• envelope_recipientsarray

  Destinataires originaux de l’enveloppe SMTP, normalisés en casse par la passerelle SMTP, avant le routage des alias de réception seule. Vide pour les anciens messages ou les sources non SMTP. Indépendant des en-têtes To/Cc visibles.

• Chaque élémentstring

  format: "email"

  Imbrications supplémentaires omises

• fromobjectobligatoire
• namestring

  Imbrications supplémentaires omises

• emailstringobligatoire

  format: "email"

  Imbrications supplémentaires omises

• toarrayobligatoire
• Chaque élémentobject

  Imbrications supplémentaires omises

• ccarray
• Chaque élémentobject

  Imbrications supplémentaires omises

• reply_toarray
• Chaque élémentobject

  Imbrications supplémentaires omises

• is_sentboolean

  Indique si ce message a été envoyé par la boîte mail, y compris depuis un alias.

• body_textstring
• body_html_urlstring

  format: "uri"

• reply_originobject
• send_intent_idstringobligatoire

  format: "uuid"

  Imbrications supplémentaires omises

• sourcestringobligatoire

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

  Imbrications supplémentaires omises

• source_idstring

  format: "uuid"

  Imbrications supplémentaires omises

• traffic_classstringobligatoire

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

  Imbrications supplémentaires omises

• kindstringobligatoire

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

  Imbrications supplémentaires omises

• namestring

  Imbrications supplémentaires omises

• has_attachmentsbooleanobligatoire
• attachmentsarray
• Chaque élémentobject

  Imbrications supplémentaires omises

Exemple curl

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

getMessageHtml

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête

Le contrat ne précise aucun corps de requête.

Réponse réussie 200

Corps HTML du message authentifié et limité par sandbox.

text/html

• valuestring

Exemple curl

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

downloadAttachment

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête

Le contrat ne précise aucun corps de requête.

Réponse réussie 200

Flux de pièce jointe authentifié.

application/octet-stream

• valuestring

  format: "binary"

Exemple curl

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

searchMail

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête

Le contrat ne précise aucun corps de requête.

Réponse réussie 200

Résultats de recherche dans tout l’espace de travail.

application/json

• valueobject
• dataarrayobligatoire
• Chaque élémentobject
• idstringobligatoire

  format: "uuid"

• mailbox_idstringobligatoire

  format: "uuid"

• subjectstringobligatoire
• snippetstringobligatoire
• last_message_atstringobligatoire

  format: "date-time"

• message_countintegerobligatoire
• unread_countintegerobligatoire
• is_archivedbooleanobligatoire
• is_trashbooleanobligatoire
• is_spambooleanobligatoire
• is_starredbooleanobligatoire
• is_sentbooleanobligatoire
• has_attachmentsbooleanobligatoire
• labelsarrayobligatoire
• Chaque élémentstring
• participantsarray
• Chaque élémentobject
• namestring
• emailstringobligatoire

  format: "email"

• pageobjectobligatoire
• next_cursorstring
• has_morebooleanobligatoire

Exemple 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

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête

Le contrat ne précise aucun corps de requête.

Réponse réussie 200

Réponse réussie.

application/json

• valueobject
• dataarrayobligatoire
• Chaque élémentobject
• idstringobligatoire

  format: "uuid"

• emailstringobligatoire

  format: "email"

• display_namestring | nullobligatoire
• attributesobjectobligatoire
• Propriété supplémentaireToute valeur
• statusstringobligatoire

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

• created_atstringobligatoire

  format: "date-time"

• updated_atstringobligatoire

  format: "date-time"

• pageobjectobligatoire
• next_cursorstring
• has_morebooleanobligatoire

Exemple 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

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête obligatoire

application/json

• valueobject

  Aucune propriété supplémentaire

• emailstringobligatoire

  format: "email"

• display_namestring

  maxLength: 1000

• statusstringobligatoire

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

• attributesobject
• Propriété supplémentaireToute valeur
• consent_confirmedboolean

  Requis lors d’un nouvel abonnement d’une adresse.

Réponse réussie 201

Réponse réussie.

application/json

• valueobject
• dataobjectobligatoire
• idstringobligatoire

  format: "uuid"

• emailstringobligatoire

  format: "email"

• display_namestring | nullobligatoire
• attributesobjectobligatoire
• Propriété supplémentaireToute valeur
• statusstringobligatoire

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

• created_atstringobligatoire

  format: "date-time"

• updated_atstringobligatoire

  format: "date-time"

Exemple 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

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête

Le contrat ne précise aucun corps de requête.

Réponse réussie 200

Réponse réussie.

application/json

• valueobject
• dataobjectobligatoire
• idstringobligatoire

  format: "uuid"

• emailstringobligatoire

  format: "email"

• display_namestring | nullobligatoire
• attributesobjectobligatoire
• Propriété supplémentaireToute valeur
• statusstringobligatoire

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

• created_atstringobligatoire

  format: "date-time"

• updated_atstringobligatoire

  format: "date-time"

• suppressedbooleanobligatoire
• suppression_reasonstring | nullobligatoire
• sourcesarrayobligatoire
• Chaque élémentobject
• kindstringobligatoire
• referencestringobligatoire
• connection_idstring | nullobligatoire

  format: "uuid"

• metadataobjectobligatoire
• Propriété supplémentaireToute valeur
• first_seen_atstringobligatoire

  format: "date-time"

• last_seen_atstringobligatoire

  format: "date-time"

• listsarrayobligatoire
• Chaque élémentobject
• idstringobligatoire

  format: "uuid"

• namestringobligatoire
• subscription_statusstringobligatoire
• consent_evidencearrayobligatoire
• Chaque élémentobject
• kindstringobligatoire
• referencestringobligatoire
• connection_idstring | nullobligatoire

  format: "uuid"

• metadataobjectobligatoire
• Propriété supplémentaireToute valeur
• first_seen_atstringobligatoire

  format: "date-time"

• last_seen_atstringobligatoire

  format: "date-time"

Exemple curl

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

deleteContact

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête

Le contrat ne précise aucun corps de requête.

Réponse réussie 204

Contact supprimé.

Aucun corps de réponse.

Exemple curl

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

listContactImports

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête

Le contrat ne précise aucun corps de requête.

Réponse réussie 200

Réponse réussie.

application/json

• valueobject
• dataarrayobligatoire
• Chaque élémentobject
• idstring

  format: "uuid"

• filenamestring
• list_idstring | null

  format: "uuid"

• list_namestring | null
• statusstring
• total_rowsinteger
• imported_rowsinteger
• invalid_rowsinteger
• error_summaryarray
• Chaque élémentstring
• 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"

Exemple curl

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

importContacts

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête obligatoire

application/json

• valueobject
• filenamestringobligatoire

  minLength: 1 · maxLength: 500

• list_idstring

  format: "uuid"

• consent_confirmedboolean

  Requis si une ligne importée est abonnée.

• rowsarrayobligatoire

  minItems: 1 · maxItems: 5000

• Chaque élémentobject
• emailstringobligatoire

  format: "email"

• display_namestring

  maxLength: 1000

• statusstring

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

• attributesobject
• Propriété supplémentaireToute valeur

Réponse réussie 201

Réponse réussie.

application/json

• valueobject
• dataobjectobligatoire
• idstringobligatoire

  format: "uuid"

• statusstringobligatoire

  enum: "queued"

• total_rowsintegerobligatoire
• imported_rowsintegerobligatoire
• invalid_rowsintegerobligatoire
• list_idstring | nullobligatoire

  format: "uuid"

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

Fusionner les attributs typés sans changer l’abonnement ni le consentement

Nécessite contacts:write et contacts:read. Met à jour uniquement un contact existant. Les attributs omis sont conservés, false explicite est stocké et null retire un champ. Fournissez des faits sources vérifiés ; une donnée absente n’est pas false. L’abonnement, l’exclusion, l’identité et l’historique des sources restent inchangés.

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête obligatoire

application/json

• valueobject

  Aucune propriété supplémentaire

• attributesobjectobligatoire
• Propriété supplémentaireToute valeur

Réponse réussie 200

Relecture actuelle du contact ; replayed vaut true si cette mutation a déjà été appliquée.

application/json

• valueobject
• dataobjectobligatoire
• idstringobligatoire

  format: "uuid"

• attributesobjectobligatoire
• Propriété supplémentaireToute valeur
• statusstringobligatoire

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

• replayedbooleanobligatoire
• Propriété supplémentaireToute valeur

Exemple 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

Authentification : clé API Bearer de l’espace de travail.

Paramètres

Corps de la requête obligatoire

application/json

• valueobject

  Aucune propriété supplémentaire

• emailstringobligatoire

  format: "email" · maxLength: 320

• display_namestring

  minLength: 0 · maxLength: 1000

• attributesobject
• Propriété supplémentaireToute valeur
• statusstringobligatoire

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

• consent_evidenceobject

  Aucune propriété supplémentaire

• sourcestring

  minLength: 1 · maxLength: 2000

• referencestring

  minLength: 1 · maxLength: 2000

• observed_atstring

  format: "date-time"

• statementstring

  minLength: 1 · maxLength: 2000

• consent_confirmedboolean

Réponse réussie 200

Relecture canonique ou reçu idempotent. L’acceptation fournisseur correspond à sent ; delivered nécessite un événement de livraison et ne prouve pas l’arrivée en boîte de réception.

application/json

• valueobject
• datanon préciséobligatoire
• allOf 1object
• idstringobligatoire

  format: "uuid"

• emailstringobligatoire

  format: "email"

• display_namestring | nullobligatoire
• attributesobjectobligatoire
• Propriété supplémentaireToute valeur
• statusstringobligatoire

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

• created_atstringobligatoire

  format: "date-time"

• updated_atstringobligatoire

  format: "date-time"

• suppressedbooleanobligatoire
• suppression_reasonstring | nullobligatoire
• sourcesarrayobligatoire
• Chaque élémentobject
• kindstringobligatoire
• referencestringobligatoire
• connection_idstring | nullobligatoire

  format: "uuid"

• metadataobjectobligatoire
• Propriété supplémentaireToute valeur
• first_seen_atstringobligatoire

  format: "date-time"

• last_seen_atstringobligatoire

  format: "date-time"

• listsarrayobligatoire
• Chaque élémentobject
• idstringobligatoire

  format: "uuid"

• namestringobligatoire
• subscription_statusstringobligatoire
• consent_evidencearrayobligatoire
• Chaque élémentobject
• kindstringobligatoire
• referencestringobligatoire
• connection_idstring | nullobligatoire

  format: "uuid"

• metadataobjectobligatoire
• Propriété supplémentaireToute valeur
• first_seen_atstringobligatoire

  format: "date-time"

• last_seen_atstringobligatoire

  format: "date-time"

• allOf 2object
• replayedbooleanobligatoire