Banger-API-Referenz

Workspace-Produkte auflisten

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body

Im Vertrag ist kein Anfrage-Body angegeben.

Erfolgsantwort 200

Erfolgreiche Antwort.

application/json

• valueobject
• dataarrayerforderlich
• Jedes Elementobject
• idstringerforderlich

  format: "uuid"

• workspace_idstringerforderlich

  format: "uuid"

• namestringerforderlich
• slugstringerforderlich
• kindstringerforderlich

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

• website_urlstring | nullerforderlich
• domainsarrayerforderlich
• Jedes Elementstring
• descriptionstringerforderlich
• contextobjecterforderlich
• Zusätzliche EigenschaftBeliebiger Wert
• brandobjecterforderlich
• company_namestring

  maxLength: 160

• logo_urlstring

  Das Symbol: die Bildmarke allein, klein verwendet (E-Mail-Fußzeile, eingeblendete Formulare) und als Kopfzeile, wenn keine Wortmarke vorhanden ist.

  maxLength: 2000

• wordmark_urlstring

  Die Wortmarke: der gestaltete Firmenname, allein oben in jeder E-Mail angezeigt.

  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

• statusstringerforderlich

  deleting: von einer Person gelöscht; bis delete_after wiederherstellbar, danach endgültig entfernt.

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

• delete_afterstring | null

  Zeitpunkt der endgültigen Entfernung eines Produkts im Zustand deleting.

  format: "date-time"

• is_defaultbooleanerforderlich
• route_readybooleanerforderlich
• setuparrayerforderlich
• Jedes Elementobject
• keystringerforderlich

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

• statusstringerforderlich

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

• completion_sourcestring | nullerforderlich

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

• notestringerforderlich
• updated_atstring | nullerforderlich

  format: "date-time"

• created_atstringerforderlich

  format: "date-time"

• updated_atstringerforderlich

  format: "date-time"

curl-Beispiel

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

Produkt erstellen

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body erforderlich

application/json

• valueobject
• namestringerforderlich

  minLength: 1 · maxLength: 160

• kindstring

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

• website_urlstring | null

  maxLength: 2000

• descriptionstring

  maxLength: 4000

• contextobject
• Zusätzliche EigenschaftBeliebiger Wert
• domainsarray

  maxItems: 20

• Jedes Elementstring

  maxLength: 253

Erfolgsantwort 201

Erfolgreiche Antwort.

application/json

• valueobject
• dataobjecterforderlich
• idstringerforderlich

  format: "uuid"

• workspace_idstringerforderlich

  format: "uuid"

• namestringerforderlich
• slugstringerforderlich
• kindstringerforderlich

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

• website_urlstring | nullerforderlich
• domainsarrayerforderlich
• Jedes Elementstring
• descriptionstringerforderlich
• contextobjecterforderlich
• Zusätzliche EigenschaftBeliebiger Wert
• brandobjecterforderlich
• company_namestring

  maxLength: 160

• logo_urlstring

  Das Symbol: die Bildmarke allein, klein verwendet (E-Mail-Fußzeile, eingeblendete Formulare) und als Kopfzeile, wenn keine Wortmarke vorhanden ist.

  maxLength: 2000

• wordmark_urlstring

  Die Wortmarke: der gestaltete Firmenname, allein oben in jeder E-Mail angezeigt.

  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

• statusstringerforderlich

  deleting: von einer Person gelöscht; bis delete_after wiederherstellbar, danach endgültig entfernt.

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

• delete_afterstring | null

  Zeitpunkt der endgültigen Entfernung eines Produkts im Zustand deleting.

  format: "date-time"

• is_defaultbooleanerforderlich
• route_readybooleanerforderlich
• setuparrayerforderlich
• Jedes Elementobject
• keystringerforderlich

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

• statusstringerforderlich

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

• completion_sourcestring | nullerforderlich

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

• notestringerforderlich
• updated_atstring | nullerforderlich

  format: "date-time"

• created_atstringerforderlich

  format: "date-time"

• updated_atstringerforderlich

  format: "date-time"

curl-Beispiel

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

Produkt abrufen

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body

Im Vertrag ist kein Anfrage-Body angegeben.

Erfolgsantwort 200

Erfolgreiche Antwort.

application/json

• valueobject
• dataobjecterforderlich
• idstringerforderlich

  format: "uuid"

• workspace_idstringerforderlich

  format: "uuid"

• namestringerforderlich
• slugstringerforderlich
• kindstringerforderlich

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

• website_urlstring | nullerforderlich
• domainsarrayerforderlich
• Jedes Elementstring
• descriptionstringerforderlich
• contextobjecterforderlich
• Zusätzliche EigenschaftBeliebiger Wert
• brandobjecterforderlich
• company_namestring

  maxLength: 160

• logo_urlstring

  Das Symbol: die Bildmarke allein, klein verwendet (E-Mail-Fußzeile, eingeblendete Formulare) und als Kopfzeile, wenn keine Wortmarke vorhanden ist.

  maxLength: 2000

• wordmark_urlstring

  Die Wortmarke: der gestaltete Firmenname, allein oben in jeder E-Mail angezeigt.

  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

• statusstringerforderlich

  deleting: von einer Person gelöscht; bis delete_after wiederherstellbar, danach endgültig entfernt.

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

• delete_afterstring | null

  Zeitpunkt der endgültigen Entfernung eines Produkts im Zustand deleting.

  format: "date-time"

• is_defaultbooleanerforderlich
• route_readybooleanerforderlich
• setuparrayerforderlich
• Jedes Elementobject
• keystringerforderlich

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

• statusstringerforderlich

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

• completion_sourcestring | nullerforderlich

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

• notestringerforderlich
• updated_atstring | nullerforderlich

  format: "date-time"

• created_atstringerforderlich

  format: "date-time"

• updated_atstringerforderlich

  format: "date-time"

curl-Beispiel

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

Produkt aktualisieren

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body erforderlich

application/json

• valueobject
• namestring

  maxLength: 160

• kindstring

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

• website_urlstring | null

  maxLength: 2000

• descriptionstring

  maxLength: 4000

• contextobject
• Zusätzliche EigenschaftBeliebiger Wert
• brandobject
• company_namestring

  maxLength: 160

• logo_urlstring

  Das Symbol: die Bildmarke allein, klein verwendet (E-Mail-Fußzeile, eingeblendete Formulare) und als Kopfzeile, wenn keine Wortmarke vorhanden ist.

  maxLength: 2000

• wordmark_urlstring

  Die Wortmarke: der gestaltete Firmenname, allein oben in jeder E-Mail angezeigt.

  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"

Erfolgsantwort 200

Erfolgreiche Antwort.

application/json

• valueobject
• dataobjecterforderlich
• idstringerforderlich

  format: "uuid"

• workspace_idstringerforderlich

  format: "uuid"

• namestringerforderlich
• slugstringerforderlich
• kindstringerforderlich

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

• website_urlstring | nullerforderlich
• domainsarrayerforderlich
• Jedes Elementstring
• descriptionstringerforderlich
• contextobjecterforderlich
• Zusätzliche EigenschaftBeliebiger Wert
• brandobjecterforderlich
• company_namestring

  maxLength: 160

• logo_urlstring

  Das Symbol: die Bildmarke allein, klein verwendet (E-Mail-Fußzeile, eingeblendete Formulare) und als Kopfzeile, wenn keine Wortmarke vorhanden ist.

  maxLength: 2000

• wordmark_urlstring

  Die Wortmarke: der gestaltete Firmenname, allein oben in jeder E-Mail angezeigt.

  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

• statusstringerforderlich

  deleting: von einer Person gelöscht; bis delete_after wiederherstellbar, danach endgültig entfernt.

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

• delete_afterstring | null

  Zeitpunkt der endgültigen Entfernung eines Produkts im Zustand deleting.

  format: "date-time"

• is_defaultbooleanerforderlich
• route_readybooleanerforderlich
• setuparrayerforderlich
• Jedes Elementobject
• keystringerforderlich

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

• statusstringerforderlich

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

• completion_sourcestring | nullerforderlich

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

• notestringerforderlich
• updated_atstring | nullerforderlich

  format: "date-time"

• created_atstringerforderlich

  format: "date-time"

• updated_atstringerforderlich

  format: "date-time"

curl-Beispiel

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

Lösche ein Produkt (ein Projekt in der App) nach Prüfung der Löschvorschau. Es wird sofort außer Betrieb genommen (sein Versand stoppt) und bleibt 24 Stunden wiederherstellbar; danach entfernt Banger seine Versanddomains und alle zugehörigen Zeilen. Das letzte aktive Produkt des Workspace kann nicht gelöscht werden. Erfordert einen Workspace-Administrator und eine angemeldete Sitzung; API-Schlüssel und OAuth-Berechtigungen werden abgelehnt.

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body erforderlich

application/json

• valueobject

  Keine zusätzlichen Eigenschaften

• confirm_namestringerforderlich

  Der genaue Produktname.

  minLength: 1 · maxLength: 160

• preview_tokenstringerforderlich

  minLength: 64 · maxLength: 64

Erfolgsantwort 202

Das Produkt ist außer Betrieb und wird bei delete_after endgültig gelöscht, sofern es nicht vorher wiederhergestellt wird. Eine idempotente Wiederholung liefert dasselbe Ergebnis.

application/json

• valueobject
• dataobjecterforderlich
• idstringerforderlich

  format: "uuid"

• namestringerforderlich
• statusstringerforderlich

  enum: "deleting"

• delete_afterstringerforderlich

  Zeitpunkt der endgültigen Löschung; bis dahin kann das Produkt wiederhergestellt werden.

  format: "date-time"

• next_product_idstringerforderlich

  Das aktuelle Standardprodukt des Workspace.

  format: "uuid"

• replayedboolean

curl-Beispiel

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

Zeige die Löschung eines Produkts und aller zugehörigen Daten in der Vorschau an, ohne etwas zu löschen. Erfordert einen Workspace-Administrator, angemeldet oder über vom Nutzer autorisiertes OAuth.

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body

Im Vertrag ist kein Anfrage-Body angegeben.

Erfolgsantwort 200

Was die Produktlöschung entfernt und stoppt.

application/json

• valueobject
• dataobjecterforderlich
• productobjecterforderlich
• idstringerforderlich

  format: "uuid"

• namestringerforderlich
• is_defaultbooleanerforderlich
• next_default_productnicht angegebenerforderlich

  Das Produkt, das beim Löschen des Standardprodukts zum Workspace-Standard wird.

• oneOf 1null
• oneOf 2object
• idstringerforderlich

  format: "uuid"

• namestringerforderlich
• last_productbooleanerforderlich

  Das einzige aktive Produkt kann nicht gelöscht werden.

• mailboxesarrayerforderlich
• Jedes Elementobject
• idstringerforderlich

  format: "uuid"

• addressstringerforderlich
• domainsarrayerforderlich

  Versanddomains, die Banger nach Ablauf des Wiederherstellungszeitraums entfernt.

• Jedes Elementobject
• idstringerforderlich

  format: "uuid"

• domainstringerforderlich
• journeysintegererforderlich
• broadcastsintegererforderlich
• signup_formsintegererforderlich
• contactsintegererforderlich
• api_keysintegererforderlich
• webhooksintegererforderlich
• pending_sendsintegererforderlich
• impactarrayerforderlich
• Jedes Elementstring
• preview_tokenstringerforderlich

curl-Beispiel

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

Stelle ein gelöschtes Produkt vor seinem delete_after wieder her. Seine Postfächer, Journeys, Anmeldeformulare, Webhooks und Integrationen werden wieder aktiviert; Kampagnen bleiben pausiert. Erfordert einen Workspace-Administrator, angemeldet oder über vom Nutzer autorisiertes OAuth.

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body

Im Vertrag ist kein Anfrage-Body angegeben.

Erfolgsantwort 200

Das Produkt ist wieder aktiv.

application/json

• valueobject
• dataobjecterforderlich
• idstringerforderlich

  format: "uuid"

• namestringerforderlich
• statusstringerforderlich

  enum: "active"

curl-Beispiel

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

Ein Einrichtungselement des Produkts aktualisieren

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body erforderlich

application/json

• valueobject
• statusstringerforderlich

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

• completion_sourcestring

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

• notestring

  maxLength: 1000

Erfolgsantwort 200

Erfolgreiche Antwort.

application/json

• valueobject
• dataobjecterforderlich
• keystringerforderlich

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

• statusstringerforderlich

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

• completion_sourcestring | nullerforderlich

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

• notestringerforderlich
• updated_atstring | nullerforderlich

  format: "date-time"

curl-Beispiel

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

Eine Domain einem Produkt zuordnen

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body erforderlich

application/json

• valueobject
• domainstringerforderlich

  minLength: 3 · maxLength: 253

Erfolgsantwort 201

Erfolgreiche Antwort.

application/json

• valueobject
• dataobjecterforderlich
• idstringerforderlich

  format: "uuid"

• workspace_idstringerforderlich

  format: "uuid"

• namestringerforderlich
• slugstringerforderlich
• kindstringerforderlich

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

• website_urlstring | nullerforderlich
• domainsarrayerforderlich
• Jedes Elementstring
• descriptionstringerforderlich
• contextobjecterforderlich
• Zusätzliche EigenschaftBeliebiger Wert
• brandobjecterforderlich
• company_namestring

  maxLength: 160

• logo_urlstring

  Das Symbol: die Bildmarke allein, klein verwendet (E-Mail-Fußzeile, eingeblendete Formulare) und als Kopfzeile, wenn keine Wortmarke vorhanden ist.

  maxLength: 2000

• wordmark_urlstring

  Die Wortmarke: der gestaltete Firmenname, allein oben in jeder E-Mail angezeigt.

  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

• statusstringerforderlich

  deleting: von einer Person gelöscht; bis delete_after wiederherstellbar, danach endgültig entfernt.

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

• delete_afterstring | null

  Zeitpunkt der endgültigen Entfernung eines Produkts im Zustand deleting.

  format: "date-time"

• is_defaultbooleanerforderlich
• route_readybooleanerforderlich
• setuparrayerforderlich
• Jedes Elementobject
• keystringerforderlich

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

• statusstringerforderlich

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

• completion_sourcestring | nullerforderlich

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

• notestringerforderlich
• updated_atstring | nullerforderlich

  format: "date-time"

• created_atstringerforderlich

  format: "date-time"

• updated_atstringerforderlich

  format: "date-time"

curl-Beispiel

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

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body

Im Vertrag ist kein Anfrage-Body angegeben.

Erfolgsantwort 200

Für den Akteur sichtbare Postfächer.

application/json

• valueobject
• dataarrayerforderlich
• Jedes Elementobject
• idstringerforderlich

  format: "uuid"

• workspace_idstringerforderlich

  format: "uuid"

• product_idstring | null

  Das Produkt (Projekt), zu dem das Postfach gehört. Clients gruppieren damit Postfächer und erstellen Web-App-Links.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringerforderlich

  format: "email"

• display_namestringerforderlich
• providerstringerforderlich

  enum: "gmail", "smtp"

• statusstringerforderlich

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringerforderlich

  enum: "domain", "starter"

curl-Beispiel

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

Erstelle ein Banger-eigenes Arbeitspostfach auf einer Versanddomain des Workspace.

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body erforderlich

application/json

• valueobject

  Keine zusätzlichen Eigenschaften

• domain_idstringerforderlich

  format: "uuid"

• local_partstringerforderlich

  minLength: 1 · maxLength: 64

• display_namestring

  maxLength: 200

Erfolgsantwort 200

Idempotente Wiederholung einer nativen Postfacherstellung.

application/json

• valueobject
• dataobjecterforderlich
• idstringerforderlich

  format: "uuid"

• workspace_idstringerforderlich

  format: "uuid"

• product_idstring | null

  Das Produkt (Projekt), zu dem das Postfach gehört. Clients gruppieren damit Postfächer und erstellen Web-App-Links.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringerforderlich

  format: "email"

• display_namestringerforderlich
• providerstringerforderlich

  enum: "gmail", "smtp"

• statusstringerforderlich

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringerforderlich

  enum: "domain", "starter"

curl-Beispiel

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

Zeige die endgültige Postfachlöschung und abhängige Versandabläufe in der Vorschau an. Erfordert einen Workspace-Administrator und Produktzugriff.

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body

Im Vertrag ist kein Anfrage-Body angegeben.

Erfolgsantwort 200

Genaues Postfach und aktuelle Löschfolgen, ohne etwas zu löschen.

application/json

• valueobject
• dataobjecterforderlich
• mailboxobjecterforderlich
• idstringerforderlich

  format: "uuid"

• addressstringerforderlich
• providerstringerforderlich
• domain_idstring | nullerforderlich

  format: "uuid"

• provider_connection_idstring | nullerforderlich

  format: "uuid"

• messagesintegererforderlich
• draftsintegererforderlich
• pending_sendsintegererforderlich
• broadcastsarrayerforderlich
• Jedes Elementobject
• idstringerforderlich

  format: "uuid"

• namestringerforderlich
• statusstringerforderlich
• journeysarrayerforderlich
• Jedes Elementobject
• idstringerforderlich

  format: "uuid"

• namestringerforderlich
• statusstringerforderlich
• signup_formsarrayerforderlich
• Jedes Elementobject
• idstringerforderlich

  format: "uuid"

• namestringerforderlich
• statusstringerforderlich
• impactarrayerforderlich
• Jedes Elementstring
• preview_tokenstringerforderlich

curl-Beispiel

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

Lege den Absendernamen fest, den Empfänger bei E-Mails eines Banger-Postfachs sehen ("Name <address>"). Gmail-Postfächer behalten den in Gmail festgelegten Namen. Erfordert einen Workspace-Administrator.

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body erforderlich

application/json

• valueobject

  Keine zusätzlichen Eigenschaften

• display_namestringerforderlich

  Eine Zeile. Leer wird nur die Adresse gesendet.

  maxLength: 200

Erfolgsantwort 200

Das Postfach mit seinem Absendernamen.

application/json

• valueobject
• dataobjecterforderlich
• idstringerforderlich

  format: "uuid"

• workspace_idstringerforderlich

  format: "uuid"

• product_idstring | null

  Das Produkt (Projekt), zu dem das Postfach gehört. Clients gruppieren damit Postfächer und erstellen Web-App-Links.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringerforderlich

  format: "email"

• display_namestringerforderlich
• providerstringerforderlich

  enum: "gmail", "smtp"

• statusstringerforderlich

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringerforderlich

  enum: "domain", "starter"

curl-Beispiel

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

Lösche ein Postfach endgültig; seine Domain und andere Postfächer bleiben erhalten. Erfordert einen Workspace-Administrator und Produktzugriff.

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body erforderlich

application/json

• valueobject

  Keine zusätzlichen Eigenschaften

• confirm_addressstringerforderlich

  minLength: 3 · maxLength: 320

• preview_tokenstringerforderlich

  minLength: 64 · maxLength: 64

Erfolgsantwort 200

Gelöscht oder idempotente Wiederholung. Gespeicherte Dateien werden zur endgültigen Bereinigung eingereiht.

application/json

• valueobject
• dataobjecterforderlich
• idstringerforderlich

  format: "uuid"

• addressstringerforderlich
• deletedbooleanerforderlich
• replayedboolean

curl-Beispiel

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

Erstelle ein gehostetes Postfach, beschränkt auf gehostete Posteingänge desselben Produkts und den Registrierungsempfänger des Workspace.

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body erforderlich

application/json

• valueobject

  Keine zusätzlichen Eigenschaften

• create_newboolean

  Erstelle ein zusätzliches gehostetes Postfach, statt das erste fortzusetzen.

• local_partstring

  Name vor @bangermail.com. Ohne ihn erhält das Postfach einen Wortnamen wie quiet-maple-harbor.

  minLength: 3 · maxLength: 40

• display_namestring

  maxLength: 200

Erfolgsantwort 200

Idempotente Wiederholung der Erstellung einer Startidentität.

application/json

• valueobject
• dataobjecterforderlich
• idstringerforderlich

  format: "uuid"

• workspace_idstringerforderlich

  format: "uuid"

• product_idstring | null

  Das Produkt (Projekt), zu dem das Postfach gehört. Clients gruppieren damit Postfächer und erstellen Web-App-Links.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringerforderlich

  format: "email"

• display_namestringerforderlich
• providerstringerforderlich

  enum: "gmail", "smtp"

• statusstringerforderlich

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringerforderlich

  enum: "domain", "starter"

curl-Beispiel

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

Hebe die durch Absenderreputation bedingte Pause eines Postfachs gemäß den Selbstbedienungsregeln von resumeSending auf.

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body erforderlich

application/json

• valueobject

  Keine zusätzlichen Eigenschaften

• acknowledge_recipient_complaintbooleanerforderlich

  const: true

• reasonstring

  Grund für die Wiederherstellung des Versands; im Auditprotokoll erfasst.

  maxLength: 500

Erfolgsantwort 200

Postfach reaktiviert oder nach einer früheren erfolgreichen Anfrage bereits aktiv.

application/json

• valueobject
• dataobjecterforderlich
• idstringerforderlich

  format: "uuid"

• workspace_idstringerforderlich

  format: "uuid"

• product_idstring | null

  Das Produkt (Projekt), zu dem das Postfach gehört. Clients gruppieren damit Postfächer und erstellen Web-App-Links.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringerforderlich

  format: "email"

• display_namestringerforderlich
• providerstringerforderlich

  enum: "gmail", "smtp"

• statusstringerforderlich

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringerforderlich

  enum: "domain", "starter"

curl-Beispiel

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

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body

Im Vertrag ist kein Anfrage-Body angegeben.

Erfolgsantwort 200

Erfolgreiche Antwort.

application/json

• valueobject
• dataarrayerforderlich
• Jedes Elementobject
• idstringerforderlich

  format: "uuid"

• mailbox_idstringerforderlich

  format: "uuid"

• thread_idstring | nullerforderlich

  format: "uuid"

• versionintegererforderlich
• toarrayerforderlich
• Jedes Elementobject
• emailstringerforderlich
• namestring
• ccarrayerforderlich
• Jedes Elementobject
• emailstringerforderlich
• namestring
• bccarrayerforderlich
• Jedes Elementobject
• emailstringerforderlich
• namestring
• subjectstringerforderlich
• body_textstringerforderlich
• statusstringerforderlich
• created_atstringerforderlich

  format: "date-time"

• updated_atstringerforderlich

  format: "date-time"

• attachmentsarrayerforderlich
• Jedes Elementobject
• idstringerforderlich

  format: "uuid"

• filenamestringerforderlich
• content_typestringerforderlich
• size_bytesintegererforderlich
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

curl-Beispiel

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

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body erforderlich

application/json

• valueobject

  Keine zusätzlichen Eigenschaften

• mailbox_idstringerforderlich

  format: "uuid"

• thread_idstring

  format: "uuid"

• toarray

  maxItems: 500

• Jedes Elementobject
• namestring
• emailstringerforderlich

  format: "email"

• ccarray

  maxItems: 500

• Jedes Elementobject
• namestring
• emailstringerforderlich

  format: "email"

• bccarray

  maxItems: 500

• Jedes Elementobject
• namestring
• emailstringerforderlich

  format: "email"

• subjectstring

  maxLength: 10000

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

Erfolgsantwort 201

Erfolgreiche Antwort.

application/json

• valueobject
• dataobjecterforderlich
• idstringerforderlich

  format: "uuid"

• mailbox_idstringerforderlich

  format: "uuid"

• thread_idstring | nullerforderlich

  format: "uuid"

• versionintegererforderlich
• toarrayerforderlich
• Jedes Elementobject
• emailstringerforderlich
• namestring
• ccarrayerforderlich
• Jedes Elementobject
• emailstringerforderlich
• namestring
• bccarrayerforderlich
• Jedes Elementobject
• emailstringerforderlich
• namestring
• subjectstringerforderlich
• body_textstringerforderlich
• statusstringerforderlich
• created_atstringerforderlich

  format: "date-time"

• updated_atstringerforderlich

  format: "date-time"

• attachmentsarrayerforderlich
• Jedes Elementobject
• idstringerforderlich

  format: "uuid"

• filenamestringerforderlich
• content_typestringerforderlich
• size_bytesintegererforderlich
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

curl-Beispiel

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

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body

Im Vertrag ist kein Anfrage-Body angegeben.

Erfolgsantwort 200

Kanonische Zustellleistung, Status und Vorfälle.

application/json

• valueobject
• dataobjecterforderlich
• idstringerforderlich

  format: "uuid"

• mailbox_idstringerforderlich

  format: "uuid"

• thread_idstring | nullerforderlich

  format: "uuid"

• versionintegererforderlich
• toarrayerforderlich
• Jedes Elementobject
• emailstringerforderlich
• namestring
• ccarrayerforderlich
• Jedes Elementobject
• emailstringerforderlich
• namestring
• bccarrayerforderlich
• Jedes Elementobject
• emailstringerforderlich
• namestring
• subjectstringerforderlich
• body_textstringerforderlich
• statusstringerforderlich
• created_atstringerforderlich

  format: "date-time"

• updated_atstringerforderlich

  format: "date-time"

• attachmentsarrayerforderlich
• Jedes Elementobject
• idstringerforderlich

  format: "uuid"

• filenamestringerforderlich
• content_typestringerforderlich
• size_bytesintegererforderlich
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

curl-Beispiel

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

updateDraft

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body erforderlich

application/json

• valuenicht angegeben
• allOf 1object

  Keine zusätzlichen Eigenschaften

• mailbox_idstringerforderlich

  format: "uuid"

• thread_idstring

  format: "uuid"

• toarray

  maxItems: 500

• Jedes Elementobject
• namestring
• emailstringerforderlich

  format: "email"

• ccarray

  maxItems: 500

• Jedes Elementobject
• namestring
• emailstringerforderlich

  format: "email"

• bccarray

  maxItems: 500

• Jedes Elementobject
• namestring
• emailstringerforderlich

  format: "email"

• subjectstring

  maxLength: 10000

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

• allOf 2object
• versionintegererforderlich

  minimum: 1

Erfolgsantwort 200

Erfolgreiche Antwort.

application/json

• valueobject
• dataobjecterforderlich
• idstringerforderlich

  format: "uuid"

• mailbox_idstringerforderlich

  format: "uuid"

• thread_idstring | nullerforderlich

  format: "uuid"

• versionintegererforderlich
• toarrayerforderlich
• Jedes Elementobject
• emailstringerforderlich
• namestring
• ccarrayerforderlich
• Jedes Elementobject
• emailstringerforderlich
• namestring
• bccarrayerforderlich
• Jedes Elementobject
• emailstringerforderlich
• namestring
• subjectstringerforderlich
• body_textstringerforderlich
• statusstringerforderlich
• created_atstringerforderlich

  format: "date-time"

• updated_atstringerforderlich

  format: "date-time"

• attachmentsarrayerforderlich
• Jedes Elementobject
• idstringerforderlich

  format: "uuid"

• filenamestringerforderlich
• content_typestringerforderlich
• size_bytesintegererforderlich
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

curl-Beispiel

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

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body

Im Vertrag ist kein Anfrage-Body angegeben.

Erfolgsantwort 204

Entwurf und referenzierte Objekte zur Löschung vorgesehen.

Kein Antwort-Body.

curl-Beispiel

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

sendDraft

Sendet den Entwurf aus seinem Postfach, auf das der Aufrufer Zugriff haben muss. Benötigen seine Sendungen eine Freigabe, erhält er eine ausstehende Freigabe; eine Person, die den Entwurf direkt senden könnte, entscheidet.

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body

Im Vertrag ist kein Anfrage-Body angegeben.

Erfolgsantwort 202

Der Versand ist eingereiht oder wartet auf Freigabe.

application/json

• valueobject
• datanicht angegebenerforderlich
• oneOf 1object
• idstringerforderlich

  format: "uuid"

• typestringerforderlich
• statusstringerforderlich

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

• workspace_revisionintegererforderlich

  format: "int64"

• created_atstringerforderlich

  format: "date-time"

• oneOf 2object

  Keine zusätzlichen Eigenschaften

• approvalobjecterforderlich
• idstringerforderlich

  format: "uuid"

• requested_by_actor_idstringerforderlich
• action_kindstringerforderlich
• summarystringerforderlich
• capability_scopesarrayerforderlich
• Jedes Elementstring
• resource_scopeobjecterforderlich
• Zusätzliche Eigenschaftarray
• Jedes Elementstring

  Weitere Verschachtelung ausgelassen

• payloadobjecterforderlich
• Zusätzliche EigenschaftBeliebiger Wert
• payload_sha256stringerforderlich

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

• statusstringerforderlich

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

• missedbooleanerforderlich
• expires_atstringerforderlich

  format: "date-time"

• decided_by_actor_idstring | null
• decision_reasonstring | null
• created_atstringerforderlich

  format: "date-time"

• updated_atstringerforderlich

  format: "date-time"

• decided_atstring | null

  format: "date-time"

• execution_job_idstring

  format: "uuid"

• reviewobject

  Keine zusätzlichen Eigenschaften

• dispositionstringerforderlich

  enum: "automatic", "human_required"

• recipient_countinteger | nullerforderlich

  minimum: 0

• reasonsarrayerforderlich
• Jedes Elementstring

  Weitere Verschachtelung ausgelassen

• checksarrayerforderlich
• Jedes Elementstring

  Weitere Verschachtelung ausgelassen

curl-Beispiel

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

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body erforderlich

application/octet-stream

• valuestring

  format: "binary" · maxLength: 26214400

Erfolgsantwort 201

Erfolgreiche Antwort.

application/json

• valueobject
• dataobjecterforderlich
• idstringerforderlich

  format: "uuid"

• filenamestringerforderlich
• content_typestringerforderlich
• size_bytesintegererforderlich
• sha256string
• created_atstring

  format: "date-time"

curl-Beispiel

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

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body

Im Vertrag ist kein Anfrage-Body angegeben.

Erfolgsantwort 204

Anhang zur versionsbewussten B2-Löschung vorgesehen.

Kein Antwort-Body.

curl-Beispiel

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

HTML-Body eines Entwurfs lesen

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body

Im Vertrag ist kein Anfrage-Body angegeben.

Erfolgsantwort 200

Entwurfs-HTML.

text/html

• valuestring

curl-Beispiel

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

listSendIntents

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body

Im Vertrag ist kein Anfrage-Body angegeben.

Erfolgsantwort 200

Aktuelle kanonische Sendungen und ihr Anbieterstatus.

application/json

• valueobject
• dataarrayerforderlich
• Jedes Elementobject

  Keine zusätzlichen Eigenschaften

• idstringerforderlich

  format: "uuid"

• statusstringerforderlich

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

• traffic_classstringerforderlich

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

• recipient_countintegererforderlich

  minimum: 1

• provider_keystringerforderlich
• provider_statestringerforderlich

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

• provider_message_idstring | null
• error_codestring | null
• created_atstringerforderlich

  format: "date-time"

• updated_atstringerforderlich

  format: "date-time"

• completed_atstring | null

  format: "date-time"

curl-Beispiel

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

getSendIntent

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body

Im Vertrag ist kein Anfrage-Body angegeben.

Erfolgsantwort 200

Kanonischer asynchroner Versandstatus.

application/json

• valueobject
• dataobjecterforderlich

  Keine zusätzlichen Eigenschaften

• idstringerforderlich

  format: "uuid"

• statusstringerforderlich

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

• traffic_classstringerforderlich

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

• recipient_countintegererforderlich

  minimum: 1

• provider_keystringerforderlich
• provider_statestringerforderlich

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

• provider_message_idstring | null
• error_codestring | null
• created_atstringerforderlich

  format: "date-time"

• updated_atstringerforderlich

  format: "date-time"

• completed_atstring | null

  format: "date-time"

curl-Beispiel

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

listTransactionalSends

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body

Im Vertrag ist kein Anfrage-Body angegeben.

Erfolgsantwort 200

Erfolgreiche Antwort.

application/json

• valueobject
• dataarrayerforderlich
• Jedes Elementobject
• idstringerforderlich

  format: "uuid"

• mailbox_idstring | nullerforderlich

  format: "uuid"

• command_idstring | nullerforderlich

  format: "uuid"

• statusstringerforderlich
• command_statusstring | nullerforderlich
• subjectstring
• recipientsarray
• Jedes Elementobject
• emailstringerforderlich
• namestring
• recipient_countintegererforderlich
• error_codestring | null
• send_intent_idstring

  format: "uuid"

• providerstring | null
• route_kindstring | null
• sourcestring
• from_addressstring
• recipient_statesobject
• Zusätzliche Eigenschaftinteger
• provider_message_idstring | null
• languagenicht angegeben

  Sprache, in der diese E-Mail gesendet wurde; null, wenn sie nicht übersetzt wurde.

• anyOf 1object

  Sprache, in der eine Person eine E-Mail erhielt. Nur übersetzte E-Mails (verwaltete Inhalte) haben eine.

• localestringerforderlich

  BCP-47-Tag der Sprache, in der die E-Mail verfasst wurde.

• requested_localestring

  Nur bei einer älteren Sendung in einer anderen Sprache vorhanden: die Sprache, die die Person hätte erhalten sollen.

• fallback_reasonstring

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

• anyOf 2null
• journeyobject | null

  Journey-Schritt und Anmeldung, die diese E-Mail gesendet haben; null bei anderen Sendungen.

• journey_idstringerforderlich

  format: "uuid"

• step_idstringerforderlich

  format: "uuid"

• enrollment_idstringerforderlich

  format: "uuid"

• experimentobject | null

  Experimentvariante dieser E-Mail; null, wenn keine zutraf.

• experiment_idstringerforderlich

  format: "uuid"

• variant_keystringerforderlich
• created_atstringerforderlich

  format: "date-time"

• updated_atstringerforderlich

  format: "date-time"

• completed_atstring | nullerforderlich

  format: "date-time"

• template_idstring | null

  format: "uuid"

• template_versioninteger | null
• workspace_revisioninteger | null
• command_resultobject
• Zusätzliche EigenschaftBeliebiger Wert
• command_started_atstring | null

  format: "date-time"

• command_completed_atstring | null

  format: "date-time"

• body_textstring
• body_htmlstring
• reply_toarray
• Jedes Elementobject
• emailstringerforderlich
• namestring
• headersobject
• Zusätzliche Eigenschaftstring
• tagsarray
• Jedes Elementobject
• namestringerforderlich
• valuestringerforderlich

curl-Beispiel

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

createTransactionalSend

Ein Empfänger pro Journey-Sendung. To akzeptiert einen Empfänger in jedem RecipientInput-Format ("a@example.com", "Pat <a@example.com>", { email, name } oder eine Liste mit einem Element); Cc und Bcc müssen leer sein. reply_to verwendet standardmäßig das Journey-Postfach (auch eine leere Liste bedeutet den Standard); Produkt-E-Mails benötigen genau eines. Eine neue API-Journey verwendet standardmäßig verwaltete Quellinhalte; ältere Code-Journeys behalten Sendungen mit vollständigem Inhalt. Eine Ablehnung (4xx) friert für den Empfänger nichts ein, sodass ein korrigierter Aufruf mit neuem Idempotenzschlüssel sendet.

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body erforderlich

application/json

• valueobject
• mailbox_idstringerforderlich

  format: "uuid"

• tonicht angegebenerforderlich

  Empfänger für to, cc, bcc und reply_to: eine Adresse ("a@example.com" oder "Pat <a@example.com>"), ein { email, name }-Objekt oder eine Liste mit beiden Formen. Banger speichert sie als { email, name }-Objekte mit kleingeschriebener E-Mail-Adresse. Der Idempotenzhash umfasst den Body wie gesendet; wiederhole deshalb mit derselben Form.

• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringerforderlich

  format: "email"

• oneOf 3array

  maxItems: 500

• Jedes Elementnicht angegeben
• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringerforderlich

  format: "email"

• ccarray

  maxItems: 0

• Jedes Elementobject
• namestring
• emailstringerforderlich

  format: "email"

• bccarray

  maxItems: 0

• Jedes Elementobject
• namestring
• emailstringerforderlich

  format: "email"

• subjectstring

  maxLength: 10000

• expires_atstring

  Verwirf eine verzögerte Journey-Sendung nach diesem Zeitpunkt; höchstens sieben Tage nach der ursprünglichen Anfrage.

  format: "date-time"

• expires_after_secondsinteger

  minimum: 1 · maximum: 604800

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

• reply_tonicht angegeben

  Empfänger für to, cc, bcc und reply_to: eine Adresse ("a@example.com" oder "Pat <a@example.com>"), ein { email, name }-Objekt oder eine Liste mit beiden Formen. Banger speichert sie als { email, name }-Objekte mit kleingeschriebener E-Mail-Adresse. Der Idempotenzhash umfasst den Body wie gesendet; wiederhole deshalb mit derselben Form.

• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringerforderlich

  format: "email"

• oneOf 3array

  maxItems: 500

• Jedes Elementnicht angegeben
• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringerforderlich

  format: "email"

• headersobject
• Zusätzliche Eigenschaftstring

  maxLength: 5000

• tagsarray

  maxItems: 49

• Jedes Elementobject

  Keine zusätzlichen Eigenschaften

• namestringerforderlich

  minLength: 1 · maxLength: 256

• valuestringerforderlich

  minLength: 1 · maxLength: 256

Erfolgsantwort 202

Erfolgreiche Antwort.

application/json

• valueobject
• dataobjecterforderlich
• action_kindstringerforderlich

  enum: "transactional.send"

• idstring

  format: "uuid"

• send_intent_idstring

  format: "uuid"

• provider_attempt_idstring

  format: "uuid"

• statusstringerforderlich

  sent/queued-Zustände der Zustellung oder bei eingefrorenen Anfragen: deferred (durch Richtlinie geplant oder auf Übersetzung wartend), processing (wird gesendet), discarded.

• replayedboolean
• journeynicht angegebenerforderlich
• anyOf 1object
• journey_idstringerforderlich

  format: "uuid"

• enrollment_idstringerforderlich

  format: "uuid"

• step_idstringerforderlich

  format: "uuid"

• step_positionintegererforderlich
• originstring

  enum: "journey"

• journey_identitystring
• anyOf 2null
• ignored_variablesarrayerforderlich
• Jedes Elementstring
• scheduled_atstring

  format: "date-time"

• reasonstring
• communication_reservation_idstring

  format: "uuid"

curl-Beispiel

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

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body

Im Vertrag ist kein Anfrage-Body angegeben.

Erfolgsantwort 200

Erfolgreiche Antwort.

application/json

• valueobject
• dataobjecterforderlich
• idstringerforderlich

  format: "uuid"

• mailbox_idstring | nullerforderlich

  format: "uuid"

• command_idstring | nullerforderlich

  format: "uuid"

• statusstringerforderlich
• command_statusstring | nullerforderlich
• subjectstring
• recipientsarray
• Jedes Elementobject
• emailstringerforderlich
• namestring
• recipient_countintegererforderlich
• error_codestring | null
• send_intent_idstring

  format: "uuid"

• providerstring | null
• route_kindstring | null
• sourcestring
• from_addressstring
• recipient_statesobject
• Zusätzliche Eigenschaftinteger
• provider_message_idstring | null
• languagenicht angegeben

  Sprache, in der diese E-Mail gesendet wurde; null, wenn sie nicht übersetzt wurde.

• anyOf 1object

  Sprache, in der eine Person eine E-Mail erhielt. Nur übersetzte E-Mails (verwaltete Inhalte) haben eine.

• localestringerforderlich

  BCP-47-Tag der Sprache, in der die E-Mail verfasst wurde.

• requested_localestring

  Nur bei einer älteren Sendung in einer anderen Sprache vorhanden: die Sprache, die die Person hätte erhalten sollen.

• fallback_reasonstring

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

• anyOf 2null
• journeyobject | null

  Journey-Schritt und Anmeldung, die diese E-Mail gesendet haben; null bei anderen Sendungen.

• journey_idstringerforderlich

  format: "uuid"

• step_idstringerforderlich

  format: "uuid"

• enrollment_idstringerforderlich

  format: "uuid"

• experimentobject | null

  Experimentvariante dieser E-Mail; null, wenn keine zutraf.

• experiment_idstringerforderlich

  format: "uuid"

• variant_keystringerforderlich
• created_atstringerforderlich

  format: "date-time"

• updated_atstringerforderlich

  format: "date-time"

• completed_atstring | nullerforderlich

  format: "date-time"

• template_idstring | null

  format: "uuid"

• template_versioninteger | null
• workspace_revisioninteger | null
• command_resultobject
• Zusätzliche EigenschaftBeliebiger Wert
• command_started_atstring | null

  format: "date-time"

• command_completed_atstring | null

  format: "date-time"

• body_textstring
• body_htmlstring
• reply_toarray
• Jedes Elementobject
• emailstringerforderlich
• namestring
• headersobject
• Zusätzliche Eigenschaftstring
• tagsarray
• Jedes Elementobject
• namestringerforderlich
• valuestringerforderlich

curl-Beispiel

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

listTransactionalSendTimeline

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body

Im Vertrag ist kein Anfrage-Body angegeben.

Erfolgsantwort 200

Geordnete Zeitleiste von Annahme, Anbieterversuchen und Empfängerereignissen.

application/json

• valueobject
• dataarrayerforderlich
• Jedes Elementobject
• occurred_atstringerforderlich

  format: "date-time"

• event_typestringerforderlich
• labelstringerforderlich
• providerstring | null
• recipient_domainstring | null
• error_codestring | null

curl-Beispiel

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

retryTransactionalSend

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body

Im Vertrag ist kein Anfrage-Body angegeben.

Erfolgsantwort 202

Erfolgreiche Antwort.

application/json

• valueobject
• dataobjecterforderlich
• action_kindstringerforderlich

  enum: "transactional.send"

• idstringerforderlich

  format: "uuid"

• send_intent_idstringerforderlich

  format: "uuid"

• provider_attempt_idstringerforderlich

  format: "uuid"

• statusstringerforderlich
• replayedbooleanerforderlich

curl-Beispiel

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

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body

Im Vertrag ist kein Anfrage-Body angegeben.

Erfolgsantwort 200

Workspace-Unterhaltungen mit Keyset-Paginierung.

application/json

• valueobject
• dataarrayerforderlich
• Jedes Elementobject
• idstringerforderlich

  format: "uuid"

• mailbox_idstringerforderlich

  format: "uuid"

• subjectstringerforderlich
• snippetstringerforderlich
• last_message_atstringerforderlich

  format: "date-time"

• message_countintegererforderlich
• unread_countintegererforderlich
• is_archivedbooleanerforderlich
• is_trashbooleanerforderlich
• is_spambooleanerforderlich
• is_starredbooleanerforderlich
• is_sentbooleanerforderlich
• has_attachmentsbooleanerforderlich
• labelsarrayerforderlich
• Jedes Elementstring
• participantsarray
• Jedes Elementobject
• namestring
• emailstringerforderlich

  format: "email"

• pageobjecterforderlich
• next_cursorstring
• has_morebooleanerforderlich

curl-Beispiel

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

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body

Im Vertrag ist kein Anfrage-Body angegeben.

Erfolgsantwort 200

Unterhaltung und geordnete Nachrichten.

application/json

• valueobject
• datanicht angegebenerforderlich
• allOf 1object
• idstringerforderlich

  format: "uuid"

• mailbox_idstringerforderlich

  format: "uuid"

• subjectstringerforderlich
• snippetstringerforderlich
• last_message_atstringerforderlich

  format: "date-time"

• message_countintegererforderlich
• unread_countintegererforderlich
• is_archivedbooleanerforderlich
• is_trashbooleanerforderlich
• is_spambooleanerforderlich
• is_starredbooleanerforderlich
• is_sentbooleanerforderlich
• has_attachmentsbooleanerforderlich
• labelsarrayerforderlich
• Jedes Elementstring
• participantsarray
• Jedes Elementobject
• namestring
• emailstringerforderlich

  format: "email"

• allOf 2object
• messagesarrayerforderlich
• Jedes Elementobject
• idstringerforderlich

  format: "uuid"

• mailbox_idstringerforderlich

  format: "uuid"

• thread_idstringerforderlich

  format: "uuid"

• sent_atstringerforderlich

  format: "date-time"

• received_atstring

  format: "date-time"

• envelope_recipientsarray

  Ursprüngliche SMTP-Umschlagempfänger, vom SMTP-Eingang hinsichtlich Groß-/Kleinschreibung normalisiert, vor dem Routing reiner Empfangsaliase. Leer bei älteren Nachrichten oder Nicht-SMTP-Quellen. Unabhängig von sichtbaren To/Cc-Headern.

• Jedes Elementstring

  format: "email"

  Weitere Verschachtelung ausgelassen

• fromobjecterforderlich
• namestring

  Weitere Verschachtelung ausgelassen

• emailstringerforderlich

  format: "email"

  Weitere Verschachtelung ausgelassen

• toarrayerforderlich
• Jedes Elementobject

  Weitere Verschachtelung ausgelassen

• ccarray
• Jedes Elementobject

  Weitere Verschachtelung ausgelassen

• reply_toarray
• Jedes Elementobject

  Weitere Verschachtelung ausgelassen

• is_sentboolean

  Ob diese Nachricht vom Postfach gesendet wurde, auch über einen Alias.

• body_textstring
• body_html_urlstring

  format: "uri"

• reply_originobject
• send_intent_idstringerforderlich

  format: "uuid"

  Weitere Verschachtelung ausgelassen

• sourcestringerforderlich

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

  Weitere Verschachtelung ausgelassen

• source_idstring

  format: "uuid"

  Weitere Verschachtelung ausgelassen

• traffic_classstringerforderlich

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

  Weitere Verschachtelung ausgelassen

• kindstringerforderlich

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

  Weitere Verschachtelung ausgelassen

• namestring

  Weitere Verschachtelung ausgelassen

• has_attachmentsbooleanerforderlich
• attachmentsarray
• Jedes Elementobject

  Weitere Verschachtelung ausgelassen

curl-Beispiel

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

getMessageHtml

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body

Im Vertrag ist kein Anfrage-Body angegeben.

Erfolgsantwort 200

Authentifizierter, durch Sandbox beschränkter HTML-Nachrichtenbody.

text/html

• valuestring

curl-Beispiel

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

downloadAttachment

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body

Im Vertrag ist kein Anfrage-Body angegeben.

Erfolgsantwort 200

Authentifizierter Anhangstream.

application/octet-stream

• valuestring

  format: "binary"

curl-Beispiel

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

searchMail

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body

Im Vertrag ist kein Anfrage-Body angegeben.

Erfolgsantwort 200

Suchergebnisse im gesamten Workspace.

application/json

• valueobject
• dataarrayerforderlich
• Jedes Elementobject
• idstringerforderlich

  format: "uuid"

• mailbox_idstringerforderlich

  format: "uuid"

• subjectstringerforderlich
• snippetstringerforderlich
• last_message_atstringerforderlich

  format: "date-time"

• message_countintegererforderlich
• unread_countintegererforderlich
• is_archivedbooleanerforderlich
• is_trashbooleanerforderlich
• is_spambooleanerforderlich
• is_starredbooleanerforderlich
• is_sentbooleanerforderlich
• has_attachmentsbooleanerforderlich
• labelsarrayerforderlich
• Jedes Elementstring
• participantsarray
• Jedes Elementobject
• namestring
• emailstringerforderlich

  format: "email"

• pageobjecterforderlich
• next_cursorstring
• has_morebooleanerforderlich

curl-Beispiel

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

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body

Im Vertrag ist kein Anfrage-Body angegeben.

Erfolgsantwort 200

Erfolgreiche Antwort.

application/json

• valueobject
• dataarrayerforderlich
• Jedes Elementobject
• idstringerforderlich

  format: "uuid"

• emailstringerforderlich

  format: "email"

• display_namestring | nullerforderlich
• attributesobjecterforderlich
• Zusätzliche EigenschaftBeliebiger Wert
• statusstringerforderlich

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

• created_atstringerforderlich

  format: "date-time"

• updated_atstringerforderlich

  format: "date-time"

• pageobjecterforderlich
• next_cursorstring
• has_morebooleanerforderlich

curl-Beispiel

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

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body erforderlich

application/json

• valueobject

  Keine zusätzlichen Eigenschaften

• emailstringerforderlich

  format: "email"

• display_namestring

  maxLength: 1000

• statusstringerforderlich

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

• attributesobject
• Zusätzliche EigenschaftBeliebiger Wert
• consent_confirmedboolean

  Beim erstmaligen Abonnieren einer Adresse erforderlich.

Erfolgsantwort 201

Erfolgreiche Antwort.

application/json

• valueobject
• dataobjecterforderlich
• idstringerforderlich

  format: "uuid"

• emailstringerforderlich

  format: "email"

• display_namestring | nullerforderlich
• attributesobjecterforderlich
• Zusätzliche EigenschaftBeliebiger Wert
• statusstringerforderlich

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

• created_atstringerforderlich

  format: "date-time"

• updated_atstringerforderlich

  format: "date-time"

curl-Beispiel

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

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body

Im Vertrag ist kein Anfrage-Body angegeben.

Erfolgsantwort 200

Erfolgreiche Antwort.

application/json

• valueobject
• dataobjecterforderlich
• idstringerforderlich

  format: "uuid"

• emailstringerforderlich

  format: "email"

• display_namestring | nullerforderlich
• attributesobjecterforderlich
• Zusätzliche EigenschaftBeliebiger Wert
• statusstringerforderlich

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

• created_atstringerforderlich

  format: "date-time"

• updated_atstringerforderlich

  format: "date-time"

• suppressedbooleanerforderlich
• suppression_reasonstring | nullerforderlich
• sourcesarrayerforderlich
• Jedes Elementobject
• kindstringerforderlich
• referencestringerforderlich
• connection_idstring | nullerforderlich

  format: "uuid"

• metadataobjecterforderlich
• Zusätzliche EigenschaftBeliebiger Wert
• first_seen_atstringerforderlich

  format: "date-time"

• last_seen_atstringerforderlich

  format: "date-time"

• listsarrayerforderlich
• Jedes Elementobject
• idstringerforderlich

  format: "uuid"

• namestringerforderlich
• subscription_statusstringerforderlich
• consent_evidencearrayerforderlich
• Jedes Elementobject
• kindstringerforderlich
• referencestringerforderlich
• connection_idstring | nullerforderlich

  format: "uuid"

• metadataobjecterforderlich
• Zusätzliche EigenschaftBeliebiger Wert
• first_seen_atstringerforderlich

  format: "date-time"

• last_seen_atstringerforderlich

  format: "date-time"

curl-Beispiel

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

deleteContact

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body

Im Vertrag ist kein Anfrage-Body angegeben.

Erfolgsantwort 204

Kontakt gelöscht.

Kein Antwort-Body.

curl-Beispiel

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

listContactImports

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body

Im Vertrag ist kein Anfrage-Body angegeben.

Erfolgsantwort 200

Erfolgreiche Antwort.

application/json

• valueobject
• dataarrayerforderlich
• Jedes Elementobject
• idstring

  format: "uuid"

• filenamestring
• list_idstring | null

  format: "uuid"

• list_namestring | null
• statusstring
• total_rowsinteger
• imported_rowsinteger
• invalid_rowsinteger
• error_summaryarray
• Jedes Elementstring
• consent_confirmedboolean
• consent_confirmed_atstring | null

  format: "date-time"

• processed_rowsinteger
• attempt_countinteger
• last_error_codestring | null
• created_atstring

  format: "date-time"

• completed_atstring | null

  format: "date-time"

curl-Beispiel

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

importContacts

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body erforderlich

application/json

• valueobject
• filenamestringerforderlich

  minLength: 1 · maxLength: 500

• list_idstring

  format: "uuid"

• consent_confirmedboolean

  Erforderlich, wenn eine importierte Zeile abonniert ist.

• rowsarrayerforderlich

  minItems: 1 · maxItems: 5000

• Jedes Elementobject
• emailstringerforderlich

  format: "email"

• display_namestring

  maxLength: 1000

• statusstring

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

• attributesobject
• Zusätzliche EigenschaftBeliebiger Wert

Erfolgsantwort 201

Erfolgreiche Antwort.

application/json

• valueobject
• dataobjecterforderlich
• idstringerforderlich

  format: "uuid"

• statusstringerforderlich

  enum: "queued"

• total_rowsintegererforderlich
• imported_rowsintegererforderlich
• invalid_rowsintegererforderlich
• list_idstring | nullerforderlich

  format: "uuid"

curl-Beispiel

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

Typisierte Attribute zusammenführen, ohne Abonnement oder Einwilligung zu ändern

Erfordert contacts:write und contacts:read. Aktualisiert nur einen bestehenden Kontakt. Ausgelassene Attribute bleiben erhalten, explizites false wird gespeichert und null entfernt ein Feld. Gib verifizierte Quellfakten an; fehlende Daten bedeuten nicht false. Abonnement, Sperre, Identität und Quellhistorie bleiben unverändert.

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body erforderlich

application/json

• valueobject

  Keine zusätzlichen Eigenschaften

• attributesobjecterforderlich
• Zusätzliche EigenschaftBeliebiger Wert

Erfolgsantwort 200

Aktueller zurückgelesener Kontakt; replayed ist true, wenn diese Änderung bereits angewendet wurde.

application/json

• valueobject
• dataobjecterforderlich
• idstringerforderlich

  format: "uuid"

• attributesobjecterforderlich
• Zusätzliche EigenschaftBeliebiger Wert
• statusstringerforderlich

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

• replayedbooleanerforderlich
• Zusätzliche EigenschaftBeliebiger Wert

curl-Beispiel

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

Authentifizierung: Bearer-API-Schlüssel des Workspace.

Parameter

Anfrage-Body erforderlich

application/json

• valueobject

  Keine zusätzlichen Eigenschaften

• emailstringerforderlich

  format: "email" · maxLength: 320

• display_namestring

  minLength: 0 · maxLength: 1000

• attributesobject
• Zusätzliche EigenschaftBeliebiger Wert
• statusstringerforderlich

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

• consent_evidenceobject

  Keine zusätzlichen Eigenschaften

• sourcestring

  minLength: 1 · maxLength: 2000

• referencestring

  minLength: 1 · maxLength: 2000

• observed_atstring

  format: "date-time"

• statementstring

  minLength: 1 · maxLength: 2000

• consent_confirmedboolean

Erfolgsantwort 200

Kanonischer Rücklesewert oder idempotente Bestätigung. Anbieterannahme ist sent; delivered benötigt ein Zustellereignis und belegt keine Platzierung im Posteingang.

application/json

• valueobject
• datanicht angegebenerforderlich
• allOf 1object
• idstringerforderlich

  format: "uuid"

• emailstringerforderlich

  format: "email"

• display_namestring | nullerforderlich
• attributesobjecterforderlich
• Zusätzliche EigenschaftBeliebiger Wert
• statusstringerforderlich

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

• created_atstringerforderlich

  format: "date-time"

• updated_atstringerforderlich

  format: "date-time"

• suppressedbooleanerforderlich
• suppression_reasonstring | nullerforderlich
• sourcesarrayerforderlich
• Jedes Elementobject
• kindstringerforderlich
• referencestringerforderlich
• connection_idstring | nullerforderlich

  format: "uuid"

• metadataobjecterforderlich
• Zusätzliche EigenschaftBeliebiger Wert
• first_seen_atstringerforderlich

  format: "date-time"

• last_seen_atstringerforderlich

  format: "date-time"

• listsarrayerforderlich
• Jedes Elementobject
• idstringerforderlich

  format: "uuid"

• namestringerforderlich
• subscription_statusstringerforderlich
• consent_evidencearrayerforderlich
• Jedes Elementobject
• kindstringerforderlich
• referencestringerforderlich
• connection_idstring | nullerforderlich

  format: "uuid"

• metadataobjecterforderlich
• Zusätzliche EigenschaftBeliebiger Wert
• first_seen_atstringerforderlich

  format: "date-time"

• last_seen_atstringerforderlich

  format: "date-time"

• allOf 2object
• replayedbooleanerforderlich