Riferimento API Banger

Elenca i prodotti del workspace

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta

Il contratto non specifica un corpo della richiesta.

Risposta di successo 200

Risposta riuscita.

application/json

• valueobject
• dataarrayobbligatorio
• Ogni elementoobject
• idstringobbligatorio

  format: "uuid"

• workspace_idstringobbligatorio

  format: "uuid"

• namestringobbligatorio
• slugstringobbligatorio
• kindstringobbligatorio

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

• website_urlstring | nullobbligatorio
• domainsarrayobbligatorio
• Ogni elementostring
• descriptionstringobbligatorio
• contextobjectobbligatorio
• Proprietà aggiuntivaQualsiasi valore
• brandobjectobbligatorio
• company_namestring

  maxLength: 160

• logo_urlstring

  L’icona: il simbolo da solo, usato in piccolo (piè di pagina delle email, moduli a comparsa laterale) e come intestazione quando manca il logo testuale.

  maxLength: 2000

• wordmark_urlstring

  Il logo testuale: il nome dell’azienda nella sua forma grafica, mostrato da solo in cima a ogni email.

  maxLength: 2000

• website_urlstring

  maxLength: 2000

• primary_colorstring

  maxLength: 7

• accent_colorstring

  maxLength: 7

• background_colorstring

  maxLength: 7

• surface_colorstring

  maxLength: 7

• text_colorstring

  maxLength: 7

• muted_text_colorstring

  maxLength: 7

• heading_font_familystring

  maxLength: 200

• body_font_familystring

  maxLength: 200

• tonestring

  maxLength: 1000

• footer_addressstring

  maxLength: 500

• email_stylestring

  maxLength: 20

• statusstringobbligatorio

  deleting: eliminato da una persona; ripristinabile fino a delete_after, poi rimosso definitivamente.

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

• delete_afterstring | null

  Quando un prodotto in stato deleting viene rimosso definitivamente.

  format: "date-time"

• is_defaultbooleanobbligatorio
• route_readybooleanobbligatorio
• setuparrayobbligatorio
• Ogni elementoobject
• keystringobbligatorio

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

• statusstringobbligatorio

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

• completion_sourcestring | nullobbligatorio

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

• notestringobbligatorio
• updated_atstring | nullobbligatorio

  format: "date-time"

• created_atstringobbligatorio

  format: "date-time"

• updated_atstringobbligatorio

  format: "date-time"

Esempio curl

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

Crea un prodotto

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta obbligatorio

application/json

• valueobject
• namestringobbligatorio

  minLength: 1 · maxLength: 160

• kindstring

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

• website_urlstring | null

  maxLength: 2000

• descriptionstring

  maxLength: 4000

• contextobject
• Proprietà aggiuntivaQualsiasi valore
• domainsarray

  maxItems: 20

• Ogni elementostring

  maxLength: 253

Risposta di successo 201

Risposta riuscita.

application/json

• valueobject
• dataobjectobbligatorio
• idstringobbligatorio

  format: "uuid"

• workspace_idstringobbligatorio

  format: "uuid"

• namestringobbligatorio
• slugstringobbligatorio
• kindstringobbligatorio

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

• website_urlstring | nullobbligatorio
• domainsarrayobbligatorio
• Ogni elementostring
• descriptionstringobbligatorio
• contextobjectobbligatorio
• Proprietà aggiuntivaQualsiasi valore
• brandobjectobbligatorio
• company_namestring

  maxLength: 160

• logo_urlstring

  L’icona: il simbolo da solo, usato in piccolo (piè di pagina delle email, moduli a comparsa laterale) e come intestazione quando manca il logo testuale.

  maxLength: 2000

• wordmark_urlstring

  Il logo testuale: il nome dell’azienda nella sua forma grafica, mostrato da solo in cima a ogni email.

  maxLength: 2000

• website_urlstring

  maxLength: 2000

• primary_colorstring

  maxLength: 7

• accent_colorstring

  maxLength: 7

• background_colorstring

  maxLength: 7

• surface_colorstring

  maxLength: 7

• text_colorstring

  maxLength: 7

• muted_text_colorstring

  maxLength: 7

• heading_font_familystring

  maxLength: 200

• body_font_familystring

  maxLength: 200

• tonestring

  maxLength: 1000

• footer_addressstring

  maxLength: 500

• email_stylestring

  maxLength: 20

• statusstringobbligatorio

  deleting: eliminato da una persona; ripristinabile fino a delete_after, poi rimosso definitivamente.

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

• delete_afterstring | null

  Quando un prodotto in stato deleting viene rimosso definitivamente.

  format: "date-time"

• is_defaultbooleanobbligatorio
• route_readybooleanobbligatorio
• setuparrayobbligatorio
• Ogni elementoobject
• keystringobbligatorio

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

• statusstringobbligatorio

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

• completion_sourcestring | nullobbligatorio

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

• notestringobbligatorio
• updated_atstring | nullobbligatorio

  format: "date-time"

• created_atstringobbligatorio

  format: "date-time"

• updated_atstringobbligatorio

  format: "date-time"

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

Ottieni un prodotto

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta

Il contratto non specifica un corpo della richiesta.

Risposta di successo 200

Risposta riuscita.

application/json

• valueobject
• dataobjectobbligatorio
• idstringobbligatorio

  format: "uuid"

• workspace_idstringobbligatorio

  format: "uuid"

• namestringobbligatorio
• slugstringobbligatorio
• kindstringobbligatorio

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

• website_urlstring | nullobbligatorio
• domainsarrayobbligatorio
• Ogni elementostring
• descriptionstringobbligatorio
• contextobjectobbligatorio
• Proprietà aggiuntivaQualsiasi valore
• brandobjectobbligatorio
• company_namestring

  maxLength: 160

• logo_urlstring

  L’icona: il simbolo da solo, usato in piccolo (piè di pagina delle email, moduli a comparsa laterale) e come intestazione quando manca il logo testuale.

  maxLength: 2000

• wordmark_urlstring

  Il logo testuale: il nome dell’azienda nella sua forma grafica, mostrato da solo in cima a ogni email.

  maxLength: 2000

• website_urlstring

  maxLength: 2000

• primary_colorstring

  maxLength: 7

• accent_colorstring

  maxLength: 7

• background_colorstring

  maxLength: 7

• surface_colorstring

  maxLength: 7

• text_colorstring

  maxLength: 7

• muted_text_colorstring

  maxLength: 7

• heading_font_familystring

  maxLength: 200

• body_font_familystring

  maxLength: 200

• tonestring

  maxLength: 1000

• footer_addressstring

  maxLength: 500

• email_stylestring

  maxLength: 20

• statusstringobbligatorio

  deleting: eliminato da una persona; ripristinabile fino a delete_after, poi rimosso definitivamente.

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

• delete_afterstring | null

  Quando un prodotto in stato deleting viene rimosso definitivamente.

  format: "date-time"

• is_defaultbooleanobbligatorio
• route_readybooleanobbligatorio
• setuparrayobbligatorio
• Ogni elementoobject
• keystringobbligatorio

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

• statusstringobbligatorio

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

• completion_sourcestring | nullobbligatorio

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

• notestringobbligatorio
• updated_atstring | nullobbligatorio

  format: "date-time"

• created_atstringobbligatorio

  format: "date-time"

• updated_atstringobbligatorio

  format: "date-time"

Esempio curl

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

Aggiorna un prodotto

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta obbligatorio

application/json

• valueobject
• namestring

  maxLength: 160

• kindstring

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

• website_urlstring | null

  maxLength: 2000

• descriptionstring

  maxLength: 4000

• contextobject
• Proprietà aggiuntivaQualsiasi valore
• brandobject
• company_namestring

  maxLength: 160

• logo_urlstring

  L’icona: il simbolo da solo, usato in piccolo (piè di pagina delle email, moduli a comparsa laterale) e come intestazione quando manca il logo testuale.

  maxLength: 2000

• wordmark_urlstring

  Il logo testuale: il nome dell’azienda nella sua forma grafica, mostrato da solo in cima a ogni email.

  maxLength: 2000

• website_urlstring

  maxLength: 2000

• primary_colorstring

  maxLength: 7

• accent_colorstring

  maxLength: 7

• background_colorstring

  maxLength: 7

• surface_colorstring

  maxLength: 7

• text_colorstring

  maxLength: 7

• muted_text_colorstring

  maxLength: 7

• heading_font_familystring

  maxLength: 200

• body_font_familystring

  maxLength: 200

• tonestring

  maxLength: 1000

• footer_addressstring

  maxLength: 500

• email_stylestring

  maxLength: 20

• statusstring

  enum: "active", "archived"

Risposta di successo 200

Risposta riuscita.

application/json

• valueobject
• dataobjectobbligatorio
• idstringobbligatorio

  format: "uuid"

• workspace_idstringobbligatorio

  format: "uuid"

• namestringobbligatorio
• slugstringobbligatorio
• kindstringobbligatorio

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

• website_urlstring | nullobbligatorio
• domainsarrayobbligatorio
• Ogni elementostring
• descriptionstringobbligatorio
• contextobjectobbligatorio
• Proprietà aggiuntivaQualsiasi valore
• brandobjectobbligatorio
• company_namestring

  maxLength: 160

• logo_urlstring

  L’icona: il simbolo da solo, usato in piccolo (piè di pagina delle email, moduli a comparsa laterale) e come intestazione quando manca il logo testuale.

  maxLength: 2000

• wordmark_urlstring

  Il logo testuale: il nome dell’azienda nella sua forma grafica, mostrato da solo in cima a ogni email.

  maxLength: 2000

• website_urlstring

  maxLength: 2000

• primary_colorstring

  maxLength: 7

• accent_colorstring

  maxLength: 7

• background_colorstring

  maxLength: 7

• surface_colorstring

  maxLength: 7

• text_colorstring

  maxLength: 7

• muted_text_colorstring

  maxLength: 7

• heading_font_familystring

  maxLength: 200

• body_font_familystring

  maxLength: 200

• tonestring

  maxLength: 1000

• footer_addressstring

  maxLength: 500

• email_stylestring

  maxLength: 20

• statusstringobbligatorio

  deleting: eliminato da una persona; ripristinabile fino a delete_after, poi rimosso definitivamente.

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

• delete_afterstring | null

  Quando un prodotto in stato deleting viene rimosso definitivamente.

  format: "date-time"

• is_defaultbooleanobbligatorio
• route_readybooleanobbligatorio
• setuparrayobbligatorio
• Ogni elementoobject
• keystringobbligatorio

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

• statusstringobbligatorio

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

• completion_sourcestring | nullobbligatorio

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

• notestringobbligatorio
• updated_atstring | nullobbligatorio

  format: "date-time"

• created_atstringobbligatorio

  format: "date-time"

• updated_atstringobbligatorio

  format: "date-time"

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

Elimina un prodotto (un progetto nell’app) dopo aver esaminato l’anteprima di eliminazione. Viene subito disattivato (l’invio si ferma) e resta ripristinabile per 24 ore; poi Banger rimuove i suoi domini di invio e tutte le righe che gli appartengono. L’ultimo prodotto attivo del workspace non può essere eliminato. Richiede un amministratore del workspace e una sessione autenticata; chiavi API e autorizzazioni OAuth sono rifiutate.

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta obbligatorio

application/json

• valueobject

  Nessuna proprietà aggiuntiva

• confirm_namestringobbligatorio

  Il nome esatto del prodotto.

  minLength: 1 · maxLength: 160

• preview_tokenstringobbligatorio

  minLength: 64 · maxLength: 64

Risposta di successo 202

Il prodotto è disattivato e viene eliminato definitivamente a delete_after se non viene prima ripristinato. Una ripetizione idempotente restituisce lo stesso risultato.

application/json

• valueobject
• dataobjectobbligatorio
• idstringobbligatorio

  format: "uuid"

• namestringobbligatorio
• statusstringobbligatorio

  enum: "deleting"

• delete_afterstringobbligatorio

  Quando il prodotto viene eliminato definitivamente; fino ad allora può essere ripristinato.

  format: "date-time"

• next_product_idstringobbligatorio

  Il prodotto predefinito attuale del workspace.

  format: "uuid"

• replayedboolean

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

Visualizza l’anteprima dell’eliminazione di un prodotto e di tutto ciò che gli appartiene, senza eliminare nulla. Richiede un amministratore del workspace, autenticato o tramite OAuth autorizzato dall’utente.

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta

Il contratto non specifica un corpo della richiesta.

Risposta di successo 200

Cosa rimuove e interrompe l’eliminazione del prodotto.

application/json

• valueobject
• dataobjectobbligatorio
• productobjectobbligatorio
• idstringobbligatorio

  format: "uuid"

• namestringobbligatorio
• is_defaultbooleanobbligatorio
• next_default_productnon specificatoobbligatorio

  Il prodotto che diventa predefinito nel workspace quando quello predefinito viene eliminato.

• oneOf 1null
• oneOf 2object
• idstringobbligatorio

  format: "uuid"

• namestringobbligatorio
• last_productbooleanobbligatorio

  L’unico prodotto attivo non può essere eliminato.

• mailboxesarrayobbligatorio
• Ogni elementoobject
• idstringobbligatorio

  format: "uuid"

• addressstringobbligatorio
• domainsarrayobbligatorio

  Domini di invio che Banger rimuove allo scadere del periodo di ripristino.

• Ogni elementoobject
• idstringobbligatorio

  format: "uuid"

• domainstringobbligatorio
• journeysintegerobbligatorio
• broadcastsintegerobbligatorio
• signup_formsintegerobbligatorio
• contactsintegerobbligatorio
• api_keysintegerobbligatorio
• webhooksintegerobbligatorio
• pending_sendsintegerobbligatorio
• impactarrayobbligatorio
• Ogni elementostring
• preview_tokenstringobbligatorio

Esempio curl

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

Ripristina un prodotto eliminato prima di delete_after. Caselle, Percorsi, moduli di iscrizione, webhook e integrazioni vengono riattivati; le Campagne restano in pausa. Richiede un amministratore del workspace, autenticato o tramite OAuth autorizzato dall’utente.

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta

Il contratto non specifica un corpo della richiesta.

Risposta di successo 200

Il prodotto è di nuovo attivo.

application/json

• valueobject
• dataobjectobbligatorio
• idstringobbligatorio

  format: "uuid"

• namestringobbligatorio
• statusstringobbligatorio

  enum: "active"

Esempio curl

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

Aggiorna un elemento della configurazione del prodotto

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta obbligatorio

application/json

• valueobject
• statusstringobbligatorio

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

• completion_sourcestring

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

• notestring

  maxLength: 1000

Risposta di successo 200

Risposta riuscita.

application/json

• valueobject
• dataobjectobbligatorio
• keystringobbligatorio

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

• statusstringobbligatorio

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

• completion_sourcestring | nullobbligatorio

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

• notestringobbligatorio
• updated_atstring | nullobbligatorio

  format: "date-time"

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

Associa un dominio a un prodotto

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta obbligatorio

application/json

• valueobject
• domainstringobbligatorio

  minLength: 3 · maxLength: 253

Risposta di successo 201

Risposta riuscita.

application/json

• valueobject
• dataobjectobbligatorio
• idstringobbligatorio

  format: "uuid"

• workspace_idstringobbligatorio

  format: "uuid"

• namestringobbligatorio
• slugstringobbligatorio
• kindstringobbligatorio

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

• website_urlstring | nullobbligatorio
• domainsarrayobbligatorio
• Ogni elementostring
• descriptionstringobbligatorio
• contextobjectobbligatorio
• Proprietà aggiuntivaQualsiasi valore
• brandobjectobbligatorio
• company_namestring

  maxLength: 160

• logo_urlstring

  L’icona: il simbolo da solo, usato in piccolo (piè di pagina delle email, moduli a comparsa laterale) e come intestazione quando manca il logo testuale.

  maxLength: 2000

• wordmark_urlstring

  Il logo testuale: il nome dell’azienda nella sua forma grafica, mostrato da solo in cima a ogni email.

  maxLength: 2000

• website_urlstring

  maxLength: 2000

• primary_colorstring

  maxLength: 7

• accent_colorstring

  maxLength: 7

• background_colorstring

  maxLength: 7

• surface_colorstring

  maxLength: 7

• text_colorstring

  maxLength: 7

• muted_text_colorstring

  maxLength: 7

• heading_font_familystring

  maxLength: 200

• body_font_familystring

  maxLength: 200

• tonestring

  maxLength: 1000

• footer_addressstring

  maxLength: 500

• email_stylestring

  maxLength: 20

• statusstringobbligatorio

  deleting: eliminato da una persona; ripristinabile fino a delete_after, poi rimosso definitivamente.

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

• delete_afterstring | null

  Quando un prodotto in stato deleting viene rimosso definitivamente.

  format: "date-time"

• is_defaultbooleanobbligatorio
• route_readybooleanobbligatorio
• setuparrayobbligatorio
• Ogni elementoobject
• keystringobbligatorio

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

• statusstringobbligatorio

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

• completion_sourcestring | nullobbligatorio

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

• notestringobbligatorio
• updated_atstring | nullobbligatorio

  format: "date-time"

• created_atstringobbligatorio

  format: "date-time"

• updated_atstringobbligatorio

  format: "date-time"

Esempio 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

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta

Il contratto non specifica un corpo della richiesta.

Risposta di successo 200

Caselle visibili all’attore.

application/json

• valueobject
• dataarrayobbligatorio
• Ogni elementoobject
• idstringobbligatorio

  format: "uuid"

• workspace_idstringobbligatorio

  format: "uuid"

• product_idstring | null

  Il prodotto (progetto) a cui appartiene la casella. I client lo usano per raggruppare le caselle e creare link all’app web.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringobbligatorio

  format: "email"

• display_namestringobbligatorio
• providerstringobbligatorio

  enum: "gmail", "smtp"

• statusstringobbligatorio

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringobbligatorio

  enum: "domain", "starter"

Esempio curl

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

Crea una casella di lavoro nativa Banger su un dominio di invio del workspace.

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta obbligatorio

application/json

• valueobject

  Nessuna proprietà aggiuntiva

• domain_idstringobbligatorio

  format: "uuid"

• local_partstringobbligatorio

  minLength: 1 · maxLength: 64

• display_namestring

  maxLength: 200

Risposta di successo 200

Ripetizione idempotente della creazione di una casella nativa.

application/json

• valueobject
• dataobjectobbligatorio
• idstringobbligatorio

  format: "uuid"

• workspace_idstringobbligatorio

  format: "uuid"

• product_idstring | null

  Il prodotto (progetto) a cui appartiene la casella. I client lo usano per raggruppare le caselle e creare link all’app web.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringobbligatorio

  format: "email"

• display_namestringobbligatorio
• providerstringobbligatorio

  enum: "gmail", "smtp"

• statusstringobbligatorio

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringobbligatorio

  enum: "domain", "starter"

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

Anteprima dell’eliminazione definitiva di una casella e dei flussi di invio dipendenti. Richiede un amministratore del workspace e l’ambito del prodotto.

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta

Il contratto non specifica un corpo della richiesta.

Risposta di successo 200

Casella esatta e impatto attuale dell’eliminazione, senza eliminare nulla.

application/json

• valueobject
• dataobjectobbligatorio
• mailboxobjectobbligatorio
• idstringobbligatorio

  format: "uuid"

• addressstringobbligatorio
• providerstringobbligatorio
• domain_idstring | nullobbligatorio

  format: "uuid"

• provider_connection_idstring | nullobbligatorio

  format: "uuid"

• messagesintegerobbligatorio
• draftsintegerobbligatorio
• pending_sendsintegerobbligatorio
• broadcastsarrayobbligatorio
• Ogni elementoobject
• idstringobbligatorio

  format: "uuid"

• namestringobbligatorio
• statusstringobbligatorio
• journeysarrayobbligatorio
• Ogni elementoobject
• idstringobbligatorio

  format: "uuid"

• namestringobbligatorio
• statusstringobbligatorio
• signup_formsarrayobbligatorio
• Ogni elementoobject
• idstringobbligatorio

  format: "uuid"

• namestringobbligatorio
• statusstringobbligatorio
• impactarrayobbligatorio
• Ogni elementostring
• preview_tokenstringobbligatorio

Esempio curl

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

Imposta il nome del mittente che i destinatari vedono nella posta di una casella Banger ("Name <address>"). Le caselle Gmail mantengono il nome impostato in Gmail. Richiede un amministratore del workspace.

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta obbligatorio

application/json

• valueobject

  Nessuna proprietà aggiuntiva

• display_namestringobbligatorio

  Una riga. Se vuota, invia il solo indirizzo.

  maxLength: 200

Risposta di successo 200

La casella con il suo nome del mittente.

application/json

• valueobject
• dataobjectobbligatorio
• idstringobbligatorio

  format: "uuid"

• workspace_idstringobbligatorio

  format: "uuid"

• product_idstring | null

  Il prodotto (progetto) a cui appartiene la casella. I client lo usano per raggruppare le caselle e creare link all’app web.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringobbligatorio

  format: "email"

• display_namestringobbligatorio
• providerstringobbligatorio

  enum: "gmail", "smtp"

• statusstringobbligatorio

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringobbligatorio

  enum: "domain", "starter"

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

Elimina definitivamente una casella, conservandone il dominio e le altre caselle. Richiede un amministratore del workspace e l’ambito del prodotto.

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta obbligatorio

application/json

• valueobject

  Nessuna proprietà aggiuntiva

• confirm_addressstringobbligatorio

  minLength: 3 · maxLength: 320

• preview_tokenstringobbligatorio

  minLength: 64 · maxLength: 64

Risposta di successo 200

Eliminato o ripetizione idempotente. I file archiviati vengono messi in coda per la pulizia definitiva.

application/json

• valueobject
• dataobjectobbligatorio
• idstringobbligatorio

  format: "uuid"

• addressstringobbligatorio
• deletedbooleanobbligatorio
• replayedboolean

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

Crea una casella ospitata limitata alle caselle ospitate dello stesso prodotto e al destinatario di iscrizione del workspace.

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta obbligatorio

application/json

• valueobject

  Nessuna proprietà aggiuntiva

• create_newboolean

  Crea un’ulteriore casella ospitata invece di riprendere quella iniziale.

• local_partstring

  Nome prima di @bangermail.com. Senza, la casella riceve un nome composto da parole come quiet-maple-harbor.

  minLength: 3 · maxLength: 40

• display_namestring

  maxLength: 200

Risposta di successo 200

Ripetizione idempotente della creazione dell’identità iniziale.

application/json

• valueobject
• dataobjectobbligatorio
• idstringobbligatorio

  format: "uuid"

• workspace_idstringobbligatorio

  format: "uuid"

• product_idstring | null

  Il prodotto (progetto) a cui appartiene la casella. I client lo usano per raggruppare le caselle e creare link all’app web.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringobbligatorio

  format: "email"

• display_namestringobbligatorio
• providerstringobbligatorio

  enum: "gmail", "smtp"

• statusstringobbligatorio

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringobbligatorio

  enum: "domain", "starter"

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

Rimuovi la pausa dovuta alla reputazione del mittente per una casella, secondo le regole di ripresa autonoma di resumeSending.

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta obbligatorio

application/json

• valueobject

  Nessuna proprietà aggiuntiva

• acknowledge_recipient_complaintbooleanobbligatorio

  const: true

• reasonstring

  Motivo del ripristino dell’invio; registrato nel log di controllo.

  maxLength: 500

Risposta di successo 200

Casella riattivata, o già attiva dopo una richiesta precedente riuscita.

application/json

• valueobject
• dataobjectobbligatorio
• idstringobbligatorio

  format: "uuid"

• workspace_idstringobbligatorio

  format: "uuid"

• product_idstring | null

  Il prodotto (progetto) a cui appartiene la casella. I client lo usano per raggruppare le caselle e creare link all’app web.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringobbligatorio

  format: "email"

• display_namestringobbligatorio
• providerstringobbligatorio

  enum: "gmail", "smtp"

• statusstringobbligatorio

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringobbligatorio

  enum: "domain", "starter"

Esempio 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

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta

Il contratto non specifica un corpo della richiesta.

Risposta di successo 200

Risposta riuscita.

application/json

• valueobject
• dataarrayobbligatorio
• Ogni elementoobject
• idstringobbligatorio

  format: "uuid"

• mailbox_idstringobbligatorio

  format: "uuid"

• thread_idstring | nullobbligatorio

  format: "uuid"

• versionintegerobbligatorio
• toarrayobbligatorio
• Ogni elementoobject
• emailstringobbligatorio
• namestring
• ccarrayobbligatorio
• Ogni elementoobject
• emailstringobbligatorio
• namestring
• bccarrayobbligatorio
• Ogni elementoobject
• emailstringobbligatorio
• namestring
• subjectstringobbligatorio
• body_textstringobbligatorio
• statusstringobbligatorio
• created_atstringobbligatorio

  format: "date-time"

• updated_atstringobbligatorio

  format: "date-time"

• attachmentsarrayobbligatorio
• Ogni elementoobject
• idstringobbligatorio

  format: "uuid"

• filenamestringobbligatorio
• content_typestringobbligatorio
• size_bytesintegerobbligatorio
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

Esempio 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

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta obbligatorio

application/json

• valueobject

  Nessuna proprietà aggiuntiva

• mailbox_idstringobbligatorio

  format: "uuid"

• thread_idstring

  format: "uuid"

• toarray

  maxItems: 500

• Ogni elementoobject
• namestring
• emailstringobbligatorio

  format: "email"

• ccarray

  maxItems: 500

• Ogni elementoobject
• namestring
• emailstringobbligatorio

  format: "email"

• bccarray

  maxItems: 500

• Ogni elementoobject
• namestring
• emailstringobbligatorio

  format: "email"

• subjectstring

  maxLength: 10000

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

Risposta di successo 201

Risposta riuscita.

application/json

• valueobject
• dataobjectobbligatorio
• idstringobbligatorio

  format: "uuid"

• mailbox_idstringobbligatorio

  format: "uuid"

• thread_idstring | nullobbligatorio

  format: "uuid"

• versionintegerobbligatorio
• toarrayobbligatorio
• Ogni elementoobject
• emailstringobbligatorio
• namestring
• ccarrayobbligatorio
• Ogni elementoobject
• emailstringobbligatorio
• namestring
• bccarrayobbligatorio
• Ogni elementoobject
• emailstringobbligatorio
• namestring
• subjectstringobbligatorio
• body_textstringobbligatorio
• statusstringobbligatorio
• created_atstringobbligatorio

  format: "date-time"

• updated_atstringobbligatorio

  format: "date-time"

• attachmentsarrayobbligatorio
• Ogni elementoobject
• idstringobbligatorio

  format: "uuid"

• filenamestringobbligatorio
• content_typestringobbligatorio
• size_bytesintegerobbligatorio
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

Esempio 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

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta

Il contratto non specifica un corpo della richiesta.

Risposta di successo 200

Prestazioni, stato e incidenti canonici di recapitabilità.

application/json

• valueobject
• dataobjectobbligatorio
• idstringobbligatorio

  format: "uuid"

• mailbox_idstringobbligatorio

  format: "uuid"

• thread_idstring | nullobbligatorio

  format: "uuid"

• versionintegerobbligatorio
• toarrayobbligatorio
• Ogni elementoobject
• emailstringobbligatorio
• namestring
• ccarrayobbligatorio
• Ogni elementoobject
• emailstringobbligatorio
• namestring
• bccarrayobbligatorio
• Ogni elementoobject
• emailstringobbligatorio
• namestring
• subjectstringobbligatorio
• body_textstringobbligatorio
• statusstringobbligatorio
• created_atstringobbligatorio

  format: "date-time"

• updated_atstringobbligatorio

  format: "date-time"

• attachmentsarrayobbligatorio
• Ogni elementoobject
• idstringobbligatorio

  format: "uuid"

• filenamestringobbligatorio
• content_typestringobbligatorio
• size_bytesintegerobbligatorio
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

Esempio curl

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

updateDraft

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta obbligatorio

application/json

• valuenon specificato
• allOf 1object

  Nessuna proprietà aggiuntiva

• mailbox_idstringobbligatorio

  format: "uuid"

• thread_idstring

  format: "uuid"

• toarray

  maxItems: 500

• Ogni elementoobject
• namestring
• emailstringobbligatorio

  format: "email"

• ccarray

  maxItems: 500

• Ogni elementoobject
• namestring
• emailstringobbligatorio

  format: "email"

• bccarray

  maxItems: 500

• Ogni elementoobject
• namestring
• emailstringobbligatorio

  format: "email"

• subjectstring

  maxLength: 10000

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

• allOf 2object
• versionintegerobbligatorio

  minimum: 1

Risposta di successo 200

Risposta riuscita.

application/json

• valueobject
• dataobjectobbligatorio
• idstringobbligatorio

  format: "uuid"

• mailbox_idstringobbligatorio

  format: "uuid"

• thread_idstring | nullobbligatorio

  format: "uuid"

• versionintegerobbligatorio
• toarrayobbligatorio
• Ogni elementoobject
• emailstringobbligatorio
• namestring
• ccarrayobbligatorio
• Ogni elementoobject
• emailstringobbligatorio
• namestring
• bccarrayobbligatorio
• Ogni elementoobject
• emailstringobbligatorio
• namestring
• subjectstringobbligatorio
• body_textstringobbligatorio
• statusstringobbligatorio
• created_atstringobbligatorio

  format: "date-time"

• updated_atstringobbligatorio

  format: "date-time"

• attachmentsarrayobbligatorio
• Ogni elementoobject
• idstringobbligatorio

  format: "uuid"

• filenamestringobbligatorio
• content_typestringobbligatorio
• size_bytesintegerobbligatorio
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

Esempio 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

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta

Il contratto non specifica un corpo della richiesta.

Risposta di successo 204

Bozza e oggetti referenziati programmati per l’eliminazione.

Nessun corpo della risposta.

Esempio curl

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

sendDraft

Invia la bozza dalla sua casella, che deve essere accessibile al chiamante. Se gli invii del chiamante richiedono approvazione, viene creata un’approvazione in attesa; decide una persona che potrebbe inviare direttamente la bozza.

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta

Il contratto non specifica un corpo della richiesta.

Risposta di successo 202

L’invio è in coda o attende approvazione.

application/json

• valueobject
• datanon specificatoobbligatorio
• oneOf 1object
• idstringobbligatorio

  format: "uuid"

• typestringobbligatorio
• statusstringobbligatorio

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

• workspace_revisionintegerobbligatorio

  format: "int64"

• created_atstringobbligatorio

  format: "date-time"

• oneOf 2object

  Nessuna proprietà aggiuntiva

• approvalobjectobbligatorio
• idstringobbligatorio

  format: "uuid"

• requested_by_actor_idstringobbligatorio
• action_kindstringobbligatorio
• summarystringobbligatorio
• capability_scopesarrayobbligatorio
• Ogni elementostring
• resource_scopeobjectobbligatorio
• Proprietà aggiuntivaarray
• Ogni elementostring

  Ulteriore annidamento omesso

• payloadobjectobbligatorio
• Proprietà aggiuntivaQualsiasi valore
• payload_sha256stringobbligatorio

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

• statusstringobbligatorio

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

• missedbooleanobbligatorio
• expires_atstringobbligatorio

  format: "date-time"

• decided_by_actor_idstring | null
• decision_reasonstring | null
• created_atstringobbligatorio

  format: "date-time"

• updated_atstringobbligatorio

  format: "date-time"

• decided_atstring | null

  format: "date-time"

• execution_job_idstring

  format: "uuid"

• reviewobject

  Nessuna proprietà aggiuntiva

• dispositionstringobbligatorio

  enum: "automatic", "human_required"

• recipient_countinteger | nullobbligatorio

  minimum: 0

• reasonsarrayobbligatorio
• Ogni elementostring

  Ulteriore annidamento omesso

• checksarrayobbligatorio
• Ogni elementostring

  Ulteriore annidamento omesso

Esempio 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

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta obbligatorio

application/octet-stream

• valuestring

  format: "binary" · maxLength: 26214400

Risposta di successo 201

Risposta riuscita.

application/json

• valueobject
• dataobjectobbligatorio
• idstringobbligatorio

  format: "uuid"

• filenamestringobbligatorio
• content_typestringobbligatorio
• size_bytesintegerobbligatorio
• sha256string
• created_atstring

  format: "date-time"

Esempio 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

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta

Il contratto non specifica un corpo della richiesta.

Risposta di successo 204

Allegato programmato per l’eliminazione in B2 tenendo conto delle versioni.

Nessun corpo della risposta.

Esempio curl

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

Leggi il corpo HTML di una bozza

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta

Il contratto non specifica un corpo della richiesta.

Risposta di successo 200

HTML della bozza.

text/html

• valuestring

Esempio curl

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

listSendIntents

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta

Il contratto non specifica un corpo della richiesta.

Risposta di successo 200

Invii canonici recenti e stato presso il provider.

application/json

• valueobject
• dataarrayobbligatorio
• Ogni elementoobject

  Nessuna proprietà aggiuntiva

• idstringobbligatorio

  format: "uuid"

• statusstringobbligatorio

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

• traffic_classstringobbligatorio

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

• recipient_countintegerobbligatorio

  minimum: 1

• provider_keystringobbligatorio
• provider_statestringobbligatorio

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

• provider_message_idstring | null
• error_codestring | null
• created_atstringobbligatorio

  format: "date-time"

• updated_atstringobbligatorio

  format: "date-time"

• completed_atstring | null

  format: "date-time"

Esempio curl

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

getSendIntent

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta

Il contratto non specifica un corpo della richiesta.

Risposta di successo 200

Stato canonico dell’invio asincrono.

application/json

• valueobject
• dataobjectobbligatorio

  Nessuna proprietà aggiuntiva

• idstringobbligatorio

  format: "uuid"

• statusstringobbligatorio

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

• traffic_classstringobbligatorio

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

• recipient_countintegerobbligatorio

  minimum: 1

• provider_keystringobbligatorio
• provider_statestringobbligatorio

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

• provider_message_idstring | null
• error_codestring | null
• created_atstringobbligatorio

  format: "date-time"

• updated_atstringobbligatorio

  format: "date-time"

• completed_atstring | null

  format: "date-time"

Esempio curl

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

listTransactionalSends

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta

Il contratto non specifica un corpo della richiesta.

Risposta di successo 200

Risposta riuscita.

application/json

• valueobject
• dataarrayobbligatorio
• Ogni elementoobject
• idstringobbligatorio

  format: "uuid"

• mailbox_idstring | nullobbligatorio

  format: "uuid"

• command_idstring | nullobbligatorio

  format: "uuid"

• statusstringobbligatorio
• command_statusstring | nullobbligatorio
• subjectstring
• recipientsarray
• Ogni elementoobject
• emailstringobbligatorio
• namestring
• recipient_countintegerobbligatorio
• error_codestring | null
• send_intent_idstring

  format: "uuid"

• providerstring | null
• route_kindstring | null
• sourcestring
• from_addressstring
• recipient_statesobject
• Proprietà aggiuntivainteger
• provider_message_idstring | null
• languagenon specificato

  La lingua in cui è stata inviata questa email; null se non è stata tradotta.

• anyOf 1object

  La lingua in cui una persona ha ricevuto un’email. Presente solo nelle email tradotte (managed-content).

• localestringobbligatorio

  Tag BCP 47 della lingua in cui è stata scritta l’email.

• requested_localestring

  Presente solo in un invio precedente in un’altra lingua: la lingua che la persona avrebbe dovuto ricevere.

• fallback_reasonstring

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

• anyOf 2null
• journeyobject | null

  Passaggio del Percorso e iscrizione che hanno inviato questa email; null per altri invii.

• journey_idstringobbligatorio

  format: "uuid"

• step_idstringobbligatorio

  format: "uuid"

• enrollment_idstringobbligatorio

  format: "uuid"

• experimentobject | null

  La variante dell’esperimento di questa email; null se non applicabile.

• experiment_idstringobbligatorio

  format: "uuid"

• variant_keystringobbligatorio
• created_atstringobbligatorio

  format: "date-time"

• updated_atstringobbligatorio

  format: "date-time"

• completed_atstring | nullobbligatorio

  format: "date-time"

• template_idstring | null

  format: "uuid"

• template_versioninteger | null
• workspace_revisioninteger | null
• command_resultobject
• Proprietà aggiuntivaQualsiasi valore
• command_started_atstring | null

  format: "date-time"

• command_completed_atstring | null

  format: "date-time"

• body_textstring
• body_htmlstring
• reply_toarray
• Ogni elementoobject
• emailstringobbligatorio
• namestring
• headersobject
• Proprietà aggiuntivastring
• tagsarray
• Ogni elementoobject
• namestringobbligatorio
• valuestringobbligatorio

Esempio curl

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

createTransactionalSend

Un destinatario per invio del Percorso. To accetta un destinatario in qualsiasi forma RecipientInput ("a@example.com", "Pat <a@example.com>", { email, name } o una lista di un elemento); Cc e Bcc devono essere vuoti. reply_to usa per default la casella del Percorso (anche una lista vuota indica il default); l’email di Prodotto ne richiede esattamente uno. Un nuovo Percorso API usa per default contenuti sorgente gestiti; i Percorsi legacy in codice mantengono invii con contenuto completo. Un rifiuto (4xx) non congela nulla per il destinatario, quindi una chiamata corretta con una nuova chiave di idempotenza invia.

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta obbligatorio

application/json

• valueobject
• mailbox_idstringobbligatorio

  format: "uuid"

• tonon specificatoobbligatorio

  Destinatari per to, cc, bcc e reply_to: un indirizzo ("a@example.com" o "Pat <a@example.com>"), un oggetto { email, name } o una lista che combina entrambi. Banger li archivia come oggetti { email, name } con l’email in minuscolo. L’hash di idempotenza copre il corpo così come inviato, quindi riprova con la stessa forma.

• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringobbligatorio

  format: "email"

• oneOf 3array

  maxItems: 500

• Ogni elementonon specificato
• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringobbligatorio

  format: "email"

• ccarray

  maxItems: 0

• Ogni elementoobject
• namestring
• emailstringobbligatorio

  format: "email"

• bccarray

  maxItems: 0

• Ogni elementoobject
• namestring
• emailstringobbligatorio

  format: "email"

• subjectstring

  maxLength: 10000

• expires_atstring

  Scarta un invio differito del Percorso dopo questo istante; al massimo sette giorni dalla richiesta originale.

  format: "date-time"

• expires_after_secondsinteger

  minimum: 1 · maximum: 604800

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

• reply_tonon specificato

  Destinatari per to, cc, bcc e reply_to: un indirizzo ("a@example.com" o "Pat <a@example.com>"), un oggetto { email, name } o una lista che combina entrambi. Banger li archivia come oggetti { email, name } con l’email in minuscolo. L’hash di idempotenza copre il corpo così come inviato, quindi riprova con la stessa forma.

• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringobbligatorio

  format: "email"

• oneOf 3array

  maxItems: 500

• Ogni elementonon specificato
• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringobbligatorio

  format: "email"

• headersobject
• Proprietà aggiuntivastring

  maxLength: 5000

• tagsarray

  maxItems: 49

• Ogni elementoobject

  Nessuna proprietà aggiuntiva

• namestringobbligatorio

  minLength: 1 · maxLength: 256

• valuestringobbligatorio

  minLength: 1 · maxLength: 256

Risposta di successo 202

Risposta riuscita.

application/json

• valueobject
• dataobjectobbligatorio
• action_kindstringobbligatorio

  enum: "transactional.send"

• idstring

  format: "uuid"

• send_intent_idstring

  format: "uuid"

• provider_attempt_idstring

  format: "uuid"

• statusstringobbligatorio

  Stati sent/queued dalla consegna oppure, per una richiesta congelata: deferred (programmata dalla politica o in attesa di traduzione), processing (in invio), discarded.

• replayedboolean
• journeynon specificatoobbligatorio
• anyOf 1object
• journey_idstringobbligatorio

  format: "uuid"

• enrollment_idstringobbligatorio

  format: "uuid"

• step_idstringobbligatorio

  format: "uuid"

• step_positionintegerobbligatorio
• originstring

  enum: "journey"

• journey_identitystring
• anyOf 2null
• ignored_variablesarrayobbligatorio
• Ogni elementostring
• scheduled_atstring

  format: "date-time"

• reasonstring
• communication_reservation_idstring

  format: "uuid"

Esempio 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

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta

Il contratto non specifica un corpo della richiesta.

Risposta di successo 200

Risposta riuscita.

application/json

• valueobject
• dataobjectobbligatorio
• idstringobbligatorio

  format: "uuid"

• mailbox_idstring | nullobbligatorio

  format: "uuid"

• command_idstring | nullobbligatorio

  format: "uuid"

• statusstringobbligatorio
• command_statusstring | nullobbligatorio
• subjectstring
• recipientsarray
• Ogni elementoobject
• emailstringobbligatorio
• namestring
• recipient_countintegerobbligatorio
• error_codestring | null
• send_intent_idstring

  format: "uuid"

• providerstring | null
• route_kindstring | null
• sourcestring
• from_addressstring
• recipient_statesobject
• Proprietà aggiuntivainteger
• provider_message_idstring | null
• languagenon specificato

  La lingua in cui è stata inviata questa email; null se non è stata tradotta.

• anyOf 1object

  La lingua in cui una persona ha ricevuto un’email. Presente solo nelle email tradotte (managed-content).

• localestringobbligatorio

  Tag BCP 47 della lingua in cui è stata scritta l’email.

• requested_localestring

  Presente solo in un invio precedente in un’altra lingua: la lingua che la persona avrebbe dovuto ricevere.

• fallback_reasonstring

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

• anyOf 2null
• journeyobject | null

  Passaggio del Percorso e iscrizione che hanno inviato questa email; null per altri invii.

• journey_idstringobbligatorio

  format: "uuid"

• step_idstringobbligatorio

  format: "uuid"

• enrollment_idstringobbligatorio

  format: "uuid"

• experimentobject | null

  La variante dell’esperimento di questa email; null se non applicabile.

• experiment_idstringobbligatorio

  format: "uuid"

• variant_keystringobbligatorio
• created_atstringobbligatorio

  format: "date-time"

• updated_atstringobbligatorio

  format: "date-time"

• completed_atstring | nullobbligatorio

  format: "date-time"

• template_idstring | null

  format: "uuid"

• template_versioninteger | null
• workspace_revisioninteger | null
• command_resultobject
• Proprietà aggiuntivaQualsiasi valore
• command_started_atstring | null

  format: "date-time"

• command_completed_atstring | null

  format: "date-time"

• body_textstring
• body_htmlstring
• reply_toarray
• Ogni elementoobject
• emailstringobbligatorio
• namestring
• headersobject
• Proprietà aggiuntivastring
• tagsarray
• Ogni elementoobject
• namestringobbligatorio
• valuestringobbligatorio

Esempio curl

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

listTransactionalSendTimeline

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta

Il contratto non specifica un corpo della richiesta.

Risposta di successo 200

Cronologia ordinata di accettazione, tentativi del provider ed eventi del destinatario.

application/json

• valueobject
• dataarrayobbligatorio
• Ogni elementoobject
• occurred_atstringobbligatorio

  format: "date-time"

• event_typestringobbligatorio
• labelstringobbligatorio
• providerstring | null
• recipient_domainstring | null
• error_codestring | null

Esempio curl

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

retryTransactionalSend

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta

Il contratto non specifica un corpo della richiesta.

Risposta di successo 202

Risposta riuscita.

application/json

• valueobject
• dataobjectobbligatorio
• action_kindstringobbligatorio

  enum: "transactional.send"

• idstringobbligatorio

  format: "uuid"

• send_intent_idstringobbligatorio

  format: "uuid"

• provider_attempt_idstringobbligatorio

  format: "uuid"

• statusstringobbligatorio
• replayedbooleanobbligatorio

Esempio 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

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta

Il contratto non specifica un corpo della richiesta.

Risposta di successo 200

Conversazioni del workspace paginate per chiave.

application/json

• valueobject
• dataarrayobbligatorio
• Ogni elementoobject
• idstringobbligatorio

  format: "uuid"

• mailbox_idstringobbligatorio

  format: "uuid"

• subjectstringobbligatorio
• snippetstringobbligatorio
• last_message_atstringobbligatorio

  format: "date-time"

• message_countintegerobbligatorio
• unread_countintegerobbligatorio
• is_archivedbooleanobbligatorio
• is_trashbooleanobbligatorio
• is_spambooleanobbligatorio
• is_starredbooleanobbligatorio
• is_sentbooleanobbligatorio
• has_attachmentsbooleanobbligatorio
• labelsarrayobbligatorio
• Ogni elementostring
• participantsarray
• Ogni elementoobject
• namestring
• emailstringobbligatorio

  format: "email"

• pageobjectobbligatorio
• next_cursorstring
• has_morebooleanobbligatorio

Esempio 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

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta

Il contratto non specifica un corpo della richiesta.

Risposta di successo 200

Conversazione e messaggi ordinati.

application/json

• valueobject
• datanon specificatoobbligatorio
• allOf 1object
• idstringobbligatorio

  format: "uuid"

• mailbox_idstringobbligatorio

  format: "uuid"

• subjectstringobbligatorio
• snippetstringobbligatorio
• last_message_atstringobbligatorio

  format: "date-time"

• message_countintegerobbligatorio
• unread_countintegerobbligatorio
• is_archivedbooleanobbligatorio
• is_trashbooleanobbligatorio
• is_spambooleanobbligatorio
• is_starredbooleanobbligatorio
• is_sentbooleanobbligatorio
• has_attachmentsbooleanobbligatorio
• labelsarrayobbligatorio
• Ogni elementostring
• participantsarray
• Ogni elementoobject
• namestring
• emailstringobbligatorio

  format: "email"

• allOf 2object
• messagesarrayobbligatorio
• Ogni elementoobject
• idstringobbligatorio

  format: "uuid"

• mailbox_idstringobbligatorio

  format: "uuid"

• thread_idstringobbligatorio

  format: "uuid"

• sent_atstringobbligatorio

  format: "date-time"

• received_atstring

  format: "date-time"

• envelope_recipientsarray

  Destinatari originali della busta SMTP, normalizzati per maiuscole e minuscole dal nodo SMTP prima dell’instradamento tramite alias di sola ricezione. Vuoto per messaggi precedenti o fonti non SMTP. Indipendente dagli header To/Cc visibili.

• Ogni elementostring

  format: "email"

  Ulteriore annidamento omesso

• fromobjectobbligatorio
• namestring

  Ulteriore annidamento omesso

• emailstringobbligatorio

  format: "email"

  Ulteriore annidamento omesso

• toarrayobbligatorio
• Ogni elementoobject

  Ulteriore annidamento omesso

• ccarray
• Ogni elementoobject

  Ulteriore annidamento omesso

• reply_toarray
• Ogni elementoobject

  Ulteriore annidamento omesso

• is_sentboolean

  Se questo messaggio è stato inviato dalla casella, anche da un alias.

• body_textstring
• body_html_urlstring

  format: "uri"

• reply_originobject
• send_intent_idstringobbligatorio

  format: "uuid"

  Ulteriore annidamento omesso

• sourcestringobbligatorio

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

  Ulteriore annidamento omesso

• source_idstring

  format: "uuid"

  Ulteriore annidamento omesso

• traffic_classstringobbligatorio

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

  Ulteriore annidamento omesso

• kindstringobbligatorio

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

  Ulteriore annidamento omesso

• namestring

  Ulteriore annidamento omesso

• has_attachmentsbooleanobbligatorio
• attachmentsarray
• Ogni elementoobject

  Ulteriore annidamento omesso

Esempio curl

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

getMessageHtml

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta

Il contratto non specifica un corpo della richiesta.

Risposta di successo 200

Corpo HTML del messaggio autenticato e limitato dalla sandbox.

text/html

• valuestring

Esempio curl

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

downloadAttachment

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta

Il contratto non specifica un corpo della richiesta.

Risposta di successo 200

Flusso dell’allegato autenticato.

application/octet-stream

• valuestring

  format: "binary"

Esempio curl

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

searchMail

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta

Il contratto non specifica un corpo della richiesta.

Risposta di successo 200

Risultati di ricerca nell’intero workspace.

application/json

• valueobject
• dataarrayobbligatorio
• Ogni elementoobject
• idstringobbligatorio

  format: "uuid"

• mailbox_idstringobbligatorio

  format: "uuid"

• subjectstringobbligatorio
• snippetstringobbligatorio
• last_message_atstringobbligatorio

  format: "date-time"

• message_countintegerobbligatorio
• unread_countintegerobbligatorio
• is_archivedbooleanobbligatorio
• is_trashbooleanobbligatorio
• is_spambooleanobbligatorio
• is_starredbooleanobbligatorio
• is_sentbooleanobbligatorio
• has_attachmentsbooleanobbligatorio
• labelsarrayobbligatorio
• Ogni elementostring
• participantsarray
• Ogni elementoobject
• namestring
• emailstringobbligatorio

  format: "email"

• pageobjectobbligatorio
• next_cursorstring
• has_morebooleanobbligatorio

Esempio 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

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta

Il contratto non specifica un corpo della richiesta.

Risposta di successo 200

Risposta riuscita.

application/json

• valueobject
• dataarrayobbligatorio
• Ogni elementoobject
• idstringobbligatorio

  format: "uuid"

• emailstringobbligatorio

  format: "email"

• display_namestring | nullobbligatorio
• attributesobjectobbligatorio
• Proprietà aggiuntivaQualsiasi valore
• statusstringobbligatorio

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

• created_atstringobbligatorio

  format: "date-time"

• updated_atstringobbligatorio

  format: "date-time"

• pageobjectobbligatorio
• next_cursorstring
• has_morebooleanobbligatorio

Esempio 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

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta obbligatorio

application/json

• valueobject

  Nessuna proprietà aggiuntiva

• emailstringobbligatorio

  format: "email"

• display_namestring

  maxLength: 1000

• statusstringobbligatorio

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

• attributesobject
• Proprietà aggiuntivaQualsiasi valore
• consent_confirmedboolean

  Obbligatorio quando si iscrive un nuovo indirizzo.

Risposta di successo 201

Risposta riuscita.

application/json

• valueobject
• dataobjectobbligatorio
• idstringobbligatorio

  format: "uuid"

• emailstringobbligatorio

  format: "email"

• display_namestring | nullobbligatorio
• attributesobjectobbligatorio
• Proprietà aggiuntivaQualsiasi valore
• statusstringobbligatorio

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

• created_atstringobbligatorio

  format: "date-time"

• updated_atstringobbligatorio

  format: "date-time"

Esempio 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

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta

Il contratto non specifica un corpo della richiesta.

Risposta di successo 200

Risposta riuscita.

application/json

• valueobject
• dataobjectobbligatorio
• idstringobbligatorio

  format: "uuid"

• emailstringobbligatorio

  format: "email"

• display_namestring | nullobbligatorio
• attributesobjectobbligatorio
• Proprietà aggiuntivaQualsiasi valore
• statusstringobbligatorio

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

• created_atstringobbligatorio

  format: "date-time"

• updated_atstringobbligatorio

  format: "date-time"

• suppressedbooleanobbligatorio
• suppression_reasonstring | nullobbligatorio
• sourcesarrayobbligatorio
• Ogni elementoobject
• kindstringobbligatorio
• referencestringobbligatorio
• connection_idstring | nullobbligatorio

  format: "uuid"

• metadataobjectobbligatorio
• Proprietà aggiuntivaQualsiasi valore
• first_seen_atstringobbligatorio

  format: "date-time"

• last_seen_atstringobbligatorio

  format: "date-time"

• listsarrayobbligatorio
• Ogni elementoobject
• idstringobbligatorio

  format: "uuid"

• namestringobbligatorio
• subscription_statusstringobbligatorio
• consent_evidencearrayobbligatorio
• Ogni elementoobject
• kindstringobbligatorio
• referencestringobbligatorio
• connection_idstring | nullobbligatorio

  format: "uuid"

• metadataobjectobbligatorio
• Proprietà aggiuntivaQualsiasi valore
• first_seen_atstringobbligatorio

  format: "date-time"

• last_seen_atstringobbligatorio

  format: "date-time"

Esempio curl

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

deleteContact

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta

Il contratto non specifica un corpo della richiesta.

Risposta di successo 204

Contatto eliminato.

Nessun corpo della risposta.

Esempio curl

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

listContactImports

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta

Il contratto non specifica un corpo della richiesta.

Risposta di successo 200

Risposta riuscita.

application/json

• valueobject
• dataarrayobbligatorio
• Ogni elementoobject
• idstring

  format: "uuid"

• filenamestring
• list_idstring | null

  format: "uuid"

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

Esempio curl

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

importContacts

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta obbligatorio

application/json

• valueobject
• filenamestringobbligatorio

  minLength: 1 · maxLength: 500

• list_idstring

  format: "uuid"

• consent_confirmedboolean

  Obbligatorio se una riga importata è iscritta.

• rowsarrayobbligatorio

  minItems: 1 · maxItems: 5000

• Ogni elementoobject
• emailstringobbligatorio

  format: "email"

• display_namestring

  maxLength: 1000

• statusstring

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

• attributesobject
• Proprietà aggiuntivaQualsiasi valore

Risposta di successo 201

Risposta riuscita.

application/json

• valueobject
• dataobjectobbligatorio
• idstringobbligatorio

  format: "uuid"

• statusstringobbligatorio

  enum: "queued"

• total_rowsintegerobbligatorio
• imported_rowsintegerobbligatorio
• invalid_rowsintegerobbligatorio
• list_idstring | nullobbligatorio

  format: "uuid"

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

Unisci attributi tipizzati senza modificare iscrizione o consenso

Richiede contacts:write e contacts:read. Aggiorna solo un contatto esistente. Gli attributi omessi restano invariati, false esplicito viene salvato e null rimuove un campo. Fornisci fatti verificati dalla fonte; un dato assente non è false. Iscrizione, esclusione, identità e cronologia delle fonti non cambiano.

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta obbligatorio

application/json

• valueobject

  Nessuna proprietà aggiuntiva

• attributesobjectobbligatorio
• Proprietà aggiuntivaQualsiasi valore

Risposta di successo 200

Rilettura attuale del contatto; replayed è true se questa modifica è già stata applicata.

application/json

• valueobject
• dataobjectobbligatorio
• idstringobbligatorio

  format: "uuid"

• attributesobjectobbligatorio
• Proprietà aggiuntivaQualsiasi valore
• statusstringobbligatorio

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

• replayedbooleanobbligatorio
• Proprietà aggiuntivaQualsiasi valore

Esempio 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

Autenticazione: chiave API del workspace come Bearer.

Parametri

Corpo della richiesta obbligatorio

application/json

• valueobject

  Nessuna proprietà aggiuntiva

• emailstringobbligatorio

  format: "email" · maxLength: 320

• display_namestring

  minLength: 0 · maxLength: 1000

• attributesobject
• Proprietà aggiuntivaQualsiasi valore
• statusstringobbligatorio

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

• consent_evidenceobject

  Nessuna proprietà aggiuntiva

• sourcestring

  minLength: 1 · maxLength: 2000

• referencestring

  minLength: 1 · maxLength: 2000

• observed_atstring

  format: "date-time"

• statementstring

  minLength: 1 · maxLength: 2000

• consent_confirmedboolean

Risposta di successo 200

Rilettura canonica o ricevuta idempotente. L’accettazione del provider è sent; delivered richiede un evento di consegna e non dimostra l’arrivo nella posta in arrivo.

application/json

• valueobject
• datanon specificatoobbligatorio
• allOf 1object
• idstringobbligatorio

  format: "uuid"

• emailstringobbligatorio

  format: "email"

• display_namestring | nullobbligatorio
• attributesobjectobbligatorio
• Proprietà aggiuntivaQualsiasi valore
• statusstringobbligatorio

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

• created_atstringobbligatorio

  format: "date-time"

• updated_atstringobbligatorio

  format: "date-time"

• suppressedbooleanobbligatorio
• suppression_reasonstring | nullobbligatorio
• sourcesarrayobbligatorio
• Ogni elementoobject
• kindstringobbligatorio
• referencestringobbligatorio
• connection_idstring | nullobbligatorio

  format: "uuid"

• metadataobjectobbligatorio
• Proprietà aggiuntivaQualsiasi valore
• first_seen_atstringobbligatorio

  format: "date-time"

• last_seen_atstringobbligatorio

  format: "date-time"

• listsarrayobbligatorio
• Ogni elementoobject
• idstringobbligatorio

  format: "uuid"

• namestringobbligatorio
• subscription_statusstringobbligatorio
• consent_evidencearrayobbligatorio
• Ogni elementoobject
• kindstringobbligatorio
• referencestringobbligatorio
• connection_idstring | nullobbligatorio

  format: "uuid"

• metadataobjectobbligatorio
• Proprietà aggiuntivaQualsiasi valore
• first_seen_atstringobbligatorio

  format: "date-time"

• last_seen_atstringobbligatorio

  format: "date-time"

• allOf 2object
• replayedbooleanobbligatorio