Dokumentacja API Banger

Wyświetl produkty przestrzeni roboczej

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania

Kontrakt nie określa treści żądania.

Odpowiedź przy powodzeniu 200

Pomyślna odpowiedź.

application/json

• valueobject
• dataarraywymagane
• Każdy elementobject
• idstringwymagane

  format: "uuid"

• workspace_idstringwymagane

  format: "uuid"

• namestringwymagane
• slugstringwymagane
• kindstringwymagane

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

• website_urlstring | nullwymagane
• domainsarraywymagane
• Każdy elementstring
• descriptionstringwymagane
• contextobjectwymagane
• Dodatkowa właściwośćDowolna wartość
• brandobjectwymagane
• company_namestring

  maxLength: 160

• logo_urlstring

  Ikona: sam znak, używany w małym rozmiarze (stopka emaila, formularze wysuwane) oraz jako nagłówek, gdy nie ma logotypu tekstowego.

  maxLength: 2000

• wordmark_urlstring

  Logotyp tekstowy: nazwa firmy w zaprojektowanej formie, wyświetlana samodzielnie na górze każdego emaila.

  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

• statusstringwymagane

  deleting: usunięty przez osobę; możliwy do przywrócenia do delete_after, potem usuwany na stałe.

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

• delete_afterstring | null

  Kiedy produkt w stanie deleting zostaje trwale usunięty.

  format: "date-time"

• is_defaultbooleanwymagane
• route_readybooleanwymagane
• setuparraywymagane
• Każdy elementobject
• keystringwymagane

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

• statusstringwymagane

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

• completion_sourcestring | nullwymagane

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

• notestringwymagane
• updated_atstring | nullwymagane

  format: "date-time"

• created_atstringwymagane

  format: "date-time"

• updated_atstringwymagane

  format: "date-time"

Przykład curl

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

Utwórz produkt

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania wymagane

application/json

• valueobject
• namestringwymagane

  minLength: 1 · maxLength: 160

• kindstring

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

• website_urlstring | null

  maxLength: 2000

• descriptionstring

  maxLength: 4000

• contextobject
• Dodatkowa właściwośćDowolna wartość
• domainsarray

  maxItems: 20

• Każdy elementstring

  maxLength: 253

Odpowiedź przy powodzeniu 201

Pomyślna odpowiedź.

application/json

• valueobject
• dataobjectwymagane
• idstringwymagane

  format: "uuid"

• workspace_idstringwymagane

  format: "uuid"

• namestringwymagane
• slugstringwymagane
• kindstringwymagane

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

• website_urlstring | nullwymagane
• domainsarraywymagane
• Każdy elementstring
• descriptionstringwymagane
• contextobjectwymagane
• Dodatkowa właściwośćDowolna wartość
• brandobjectwymagane
• company_namestring

  maxLength: 160

• logo_urlstring

  Ikona: sam znak, używany w małym rozmiarze (stopka emaila, formularze wysuwane) oraz jako nagłówek, gdy nie ma logotypu tekstowego.

  maxLength: 2000

• wordmark_urlstring

  Logotyp tekstowy: nazwa firmy w zaprojektowanej formie, wyświetlana samodzielnie na górze każdego emaila.

  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

• statusstringwymagane

  deleting: usunięty przez osobę; możliwy do przywrócenia do delete_after, potem usuwany na stałe.

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

• delete_afterstring | null

  Kiedy produkt w stanie deleting zostaje trwale usunięty.

  format: "date-time"

• is_defaultbooleanwymagane
• route_readybooleanwymagane
• setuparraywymagane
• Każdy elementobject
• keystringwymagane

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

• statusstringwymagane

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

• completion_sourcestring | nullwymagane

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

• notestringwymagane
• updated_atstring | nullwymagane

  format: "date-time"

• created_atstringwymagane

  format: "date-time"

• updated_atstringwymagane

  format: "date-time"

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

Pobierz produkt

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania

Kontrakt nie określa treści żądania.

Odpowiedź przy powodzeniu 200

Pomyślna odpowiedź.

application/json

• valueobject
• dataobjectwymagane
• idstringwymagane

  format: "uuid"

• workspace_idstringwymagane

  format: "uuid"

• namestringwymagane
• slugstringwymagane
• kindstringwymagane

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

• website_urlstring | nullwymagane
• domainsarraywymagane
• Każdy elementstring
• descriptionstringwymagane
• contextobjectwymagane
• Dodatkowa właściwośćDowolna wartość
• brandobjectwymagane
• company_namestring

  maxLength: 160

• logo_urlstring

  Ikona: sam znak, używany w małym rozmiarze (stopka emaila, formularze wysuwane) oraz jako nagłówek, gdy nie ma logotypu tekstowego.

  maxLength: 2000

• wordmark_urlstring

  Logotyp tekstowy: nazwa firmy w zaprojektowanej formie, wyświetlana samodzielnie na górze każdego emaila.

  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

• statusstringwymagane

  deleting: usunięty przez osobę; możliwy do przywrócenia do delete_after, potem usuwany na stałe.

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

• delete_afterstring | null

  Kiedy produkt w stanie deleting zostaje trwale usunięty.

  format: "date-time"

• is_defaultbooleanwymagane
• route_readybooleanwymagane
• setuparraywymagane
• Każdy elementobject
• keystringwymagane

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

• statusstringwymagane

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

• completion_sourcestring | nullwymagane

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

• notestringwymagane
• updated_atstring | nullwymagane

  format: "date-time"

• created_atstringwymagane

  format: "date-time"

• updated_atstringwymagane

  format: "date-time"

Przykład curl

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

Zaktualizuj produkt

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania wymagane

application/json

• valueobject
• namestring

  maxLength: 160

• kindstring

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

• website_urlstring | null

  maxLength: 2000

• descriptionstring

  maxLength: 4000

• contextobject
• Dodatkowa właściwośćDowolna wartość
• brandobject
• company_namestring

  maxLength: 160

• logo_urlstring

  Ikona: sam znak, używany w małym rozmiarze (stopka emaila, formularze wysuwane) oraz jako nagłówek, gdy nie ma logotypu tekstowego.

  maxLength: 2000

• wordmark_urlstring

  Logotyp tekstowy: nazwa firmy w zaprojektowanej formie, wyświetlana samodzielnie na górze każdego emaila.

  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"

Odpowiedź przy powodzeniu 200

Pomyślna odpowiedź.

application/json

• valueobject
• dataobjectwymagane
• idstringwymagane

  format: "uuid"

• workspace_idstringwymagane

  format: "uuid"

• namestringwymagane
• slugstringwymagane
• kindstringwymagane

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

• website_urlstring | nullwymagane
• domainsarraywymagane
• Każdy elementstring
• descriptionstringwymagane
• contextobjectwymagane
• Dodatkowa właściwośćDowolna wartość
• brandobjectwymagane
• company_namestring

  maxLength: 160

• logo_urlstring

  Ikona: sam znak, używany w małym rozmiarze (stopka emaila, formularze wysuwane) oraz jako nagłówek, gdy nie ma logotypu tekstowego.

  maxLength: 2000

• wordmark_urlstring

  Logotyp tekstowy: nazwa firmy w zaprojektowanej formie, wyświetlana samodzielnie na górze każdego emaila.

  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

• statusstringwymagane

  deleting: usunięty przez osobę; możliwy do przywrócenia do delete_after, potem usuwany na stałe.

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

• delete_afterstring | null

  Kiedy produkt w stanie deleting zostaje trwale usunięty.

  format: "date-time"

• is_defaultbooleanwymagane
• route_readybooleanwymagane
• setuparraywymagane
• Każdy elementobject
• keystringwymagane

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

• statusstringwymagane

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

• completion_sourcestring | nullwymagane

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

• notestringwymagane
• updated_atstring | nullwymagane

  format: "date-time"

• created_atstringwymagane

  format: "date-time"

• updated_atstringwymagane

  format: "date-time"

Przykład 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"
}'

Usuń jeden produkt (projekt w aplikacji) po sprawdzeniu podglądu usunięcia. Natychmiast przestaje działać (wysyłanie zostaje zatrzymane) i można go przywrócić przez 24 godziny; potem Banger usuwa jego domeny wysyłania i wszystkie należące do niego wiersze. Nie można usunąć ostatniego aktywnego produktu przestrzeni roboczej. Wymaga administratora przestrzeni roboczej i zalogowanej sesji; klucze API i uprawnienia OAuth są odrzucane.

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania wymagane

application/json

• valueobject

  Bez dodatkowych właściwości

• confirm_namestringwymagane

  Dokładna nazwa produktu.

  minLength: 1 · maxLength: 160

• preview_tokenstringwymagane

  minLength: 64 · maxLength: 64

Odpowiedź przy powodzeniu 202

Produkt nie jest używany i zostanie trwale usunięty o delete_after, chyba że wcześniej zostanie przywrócony. Idempotentne ponowienie zwraca ten sam wynik.

application/json

• valueobject
• dataobjectwymagane
• idstringwymagane

  format: "uuid"

• namestringwymagane
• statusstringwymagane

  enum: "deleting"

• delete_afterstringwymagane

  Kiedy produkt zostanie trwale usunięty; do tego czasu można go przywrócić.

  format: "date-time"

• next_product_idstringwymagane

  Obecny domyślny produkt przestrzeni roboczej.

  format: "uuid"

• replayedboolean

Przykład 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"
}'

Wyświetl podgląd usunięcia produktu i wszystkiego, co do niego należy, bez usuwania danych. Wymaga administratora przestrzeni roboczej, zalogowanego lub działającego przez OAuth autoryzowany przez użytkownika.

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania

Kontrakt nie określa treści żądania.

Odpowiedź przy powodzeniu 200

Co usuwa i zatrzymuje usunięcie produktu.

application/json

• valueobject
• dataobjectwymagane
• productobjectwymagane
• idstringwymagane

  format: "uuid"

• namestringwymagane
• is_defaultbooleanwymagane
• next_default_productnieokreślonewymagane

  Produkt, który staje się domyślny w przestrzeni roboczej po usunięciu produktu domyślnego.

• oneOf 1null
• oneOf 2object
• idstringwymagane

  format: "uuid"

• namestringwymagane
• last_productbooleanwymagane

  Nie można usunąć jedynego aktywnego produktu.

• mailboxesarraywymagane
• Każdy elementobject
• idstringwymagane

  format: "uuid"

• addressstringwymagane
• domainsarraywymagane

  Domeny wysyłania, które Banger usuwa po upływie okresu przywracania.

• Każdy elementobject
• idstringwymagane

  format: "uuid"

• domainstringwymagane
• journeysintegerwymagane
• broadcastsintegerwymagane
• signup_formsintegerwymagane
• contactsintegerwymagane
• api_keysintegerwymagane
• webhooksintegerwymagane
• pending_sendsintegerwymagane
• impactarraywymagane
• Każdy elementstring
• preview_tokenstringwymagane

Przykład curl

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

Przywróć usunięty produkt przed delete_after. Jego skrzynki, Ścieżki, formularze zapisu, webhooki i integracje zostają włączone ponownie; Kampanie pozostają wstrzymane. Wymaga administratora przestrzeni roboczej, zalogowanego lub działającego przez OAuth autoryzowany przez użytkownika.

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania

Kontrakt nie określa treści żądania.

Odpowiedź przy powodzeniu 200

Produkt jest ponownie aktywny.

application/json

• valueobject
• dataobjectwymagane
• idstringwymagane

  format: "uuid"

• namestringwymagane
• statusstringwymagane

  enum: "active"

Przykład curl

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

Zaktualizuj element konfiguracji produktu

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania wymagane

application/json

• valueobject
• statusstringwymagane

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

• completion_sourcestring

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

• notestring

  maxLength: 1000

Odpowiedź przy powodzeniu 200

Pomyślna odpowiedź.

application/json

• valueobject
• dataobjectwymagane
• keystringwymagane

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

• statusstringwymagane

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

• completion_sourcestring | nullwymagane

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

• notestringwymagane
• updated_atstring | nullwymagane

  format: "date-time"

Przykład 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"
}'

Powiąż domenę z produktem

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania wymagane

application/json

• valueobject
• domainstringwymagane

  minLength: 3 · maxLength: 253

Odpowiedź przy powodzeniu 201

Pomyślna odpowiedź.

application/json

• valueobject
• dataobjectwymagane
• idstringwymagane

  format: "uuid"

• workspace_idstringwymagane

  format: "uuid"

• namestringwymagane
• slugstringwymagane
• kindstringwymagane

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

• website_urlstring | nullwymagane
• domainsarraywymagane
• Każdy elementstring
• descriptionstringwymagane
• contextobjectwymagane
• Dodatkowa właściwośćDowolna wartość
• brandobjectwymagane
• company_namestring

  maxLength: 160

• logo_urlstring

  Ikona: sam znak, używany w małym rozmiarze (stopka emaila, formularze wysuwane) oraz jako nagłówek, gdy nie ma logotypu tekstowego.

  maxLength: 2000

• wordmark_urlstring

  Logotyp tekstowy: nazwa firmy w zaprojektowanej formie, wyświetlana samodzielnie na górze każdego emaila.

  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

• statusstringwymagane

  deleting: usunięty przez osobę; możliwy do przywrócenia do delete_after, potem usuwany na stałe.

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

• delete_afterstring | null

  Kiedy produkt w stanie deleting zostaje trwale usunięty.

  format: "date-time"

• is_defaultbooleanwymagane
• route_readybooleanwymagane
• setuparraywymagane
• Każdy elementobject
• keystringwymagane

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

• statusstringwymagane

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

• completion_sourcestring | nullwymagane

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

• notestringwymagane
• updated_atstring | nullwymagane

  format: "date-time"

• created_atstringwymagane

  format: "date-time"

• updated_atstringwymagane

  format: "date-time"

Przykład 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

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania

Kontrakt nie określa treści żądania.

Odpowiedź przy powodzeniu 200

Skrzynki widoczne dla wykonującego.

application/json

• valueobject
• dataarraywymagane
• Każdy elementobject
• idstringwymagane

  format: "uuid"

• workspace_idstringwymagane

  format: "uuid"

• product_idstring | null

  Produkt (projekt), do którego należy skrzynka. Klienci używają go do grupowania skrzynek i tworzenia linków do aplikacji webowej.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringwymagane

  format: "email"

• display_namestringwymagane
• providerstringwymagane

  enum: "gmail", "smtp"

• statusstringwymagane

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringwymagane

  enum: "domain", "starter"

Przykład curl

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

Utwórz natywną skrzynkę służbową Banger w domenie wysyłania przestrzeni roboczej.

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania wymagane

application/json

• valueobject

  Bez dodatkowych właściwości

• domain_idstringwymagane

  format: "uuid"

• local_partstringwymagane

  minLength: 1 · maxLength: 64

• display_namestring

  maxLength: 200

Odpowiedź przy powodzeniu 200

Idempotentne ponowienie utworzenia natywnej skrzynki.

application/json

• valueobject
• dataobjectwymagane
• idstringwymagane

  format: "uuid"

• workspace_idstringwymagane

  format: "uuid"

• product_idstring | null

  Produkt (projekt), do którego należy skrzynka. Klienci używają go do grupowania skrzynek i tworzenia linków do aplikacji webowej.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringwymagane

  format: "email"

• display_namestringwymagane
• providerstringwymagane

  enum: "gmail", "smtp"

• statusstringwymagane

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringwymagane

  enum: "domain", "starter"

Przykład 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"
}'

Podgląd trwałego usunięcia skrzynki i zależnych przepływów wysyłania. Wymaga administratora przestrzeni roboczej i zakresu produktu.

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania

Kontrakt nie określa treści żądania.

Odpowiedź przy powodzeniu 200

Dokładna skrzynka i obecne skutki usunięcia, bez usuwania danych.

application/json

• valueobject
• dataobjectwymagane
• mailboxobjectwymagane
• idstringwymagane

  format: "uuid"

• addressstringwymagane
• providerstringwymagane
• domain_idstring | nullwymagane

  format: "uuid"

• provider_connection_idstring | nullwymagane

  format: "uuid"

• messagesintegerwymagane
• draftsintegerwymagane
• pending_sendsintegerwymagane
• broadcastsarraywymagane
• Każdy elementobject
• idstringwymagane

  format: "uuid"

• namestringwymagane
• statusstringwymagane
• journeysarraywymagane
• Każdy elementobject
• idstringwymagane

  format: "uuid"

• namestringwymagane
• statusstringwymagane
• signup_formsarraywymagane
• Każdy elementobject
• idstringwymagane

  format: "uuid"

• namestringwymagane
• statusstringwymagane
• impactarraywymagane
• Każdy elementstring
• preview_tokenstringwymagane

Przykład curl

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

Ustaw nazwę nadawcy widoczną dla odbiorców poczty z jednej skrzynki Banger ("Name <address>"). Skrzynki Gmail zachowują nazwę ustawioną w Gmail. Wymaga administratora przestrzeni roboczej.

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania wymagane

application/json

• valueobject

  Bez dodatkowych właściwości

• display_namestringwymagane

  Jeden wiersz. Pusta wartość oznacza wysyłanie samego adresu.

  maxLength: 200

Odpowiedź przy powodzeniu 200

Skrzynka z nazwą nadawcy.

application/json

• valueobject
• dataobjectwymagane
• idstringwymagane

  format: "uuid"

• workspace_idstringwymagane

  format: "uuid"

• product_idstring | null

  Produkt (projekt), do którego należy skrzynka. Klienci używają go do grupowania skrzynek i tworzenia linków do aplikacji webowej.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringwymagane

  format: "email"

• display_namestringwymagane
• providerstringwymagane

  enum: "gmail", "smtp"

• statusstringwymagane

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringwymagane

  enum: "domain", "starter"

Przykład 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"
}'

Trwale usuń jedną skrzynkę, zachowując jej domenę i pozostałe skrzynki. Wymaga administratora przestrzeni roboczej i zakresu produktu.

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania wymagane

application/json

• valueobject

  Bez dodatkowych właściwości

• confirm_addressstringwymagane

  minLength: 3 · maxLength: 320

• preview_tokenstringwymagane

  minLength: 64 · maxLength: 64

Odpowiedź przy powodzeniu 200

Usunięto lub idempotentne ponowienie. Zapisane pliki trafiają do kolejki trwałego usuwania.

application/json

• valueobject
• dataobjectwymagane
• idstringwymagane

  format: "uuid"

• addressstringwymagane
• deletedbooleanwymagane
• replayedboolean

Przykład 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"
}'

Utwórz hostowaną skrzynkę ograniczoną do hostowanych skrzynek tego samego produktu i odbiorcy rejestracji przestrzeni roboczej.

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania wymagane

application/json

• valueobject

  Bez dodatkowych właściwości

• create_newboolean

  Utwórz dodatkową hostowaną skrzynkę zamiast wznawiać początkową.

• local_partstring

  Nazwa przed @bangermail.com. Bez niej skrzynka otrzyma nazwę złożoną ze słów, np. quiet-maple-harbor.

  minLength: 3 · maxLength: 40

• display_namestring

  maxLength: 200

Odpowiedź przy powodzeniu 200

Idempotentne ponowienie utworzenia tożsamości startowej.

application/json

• valueobject
• dataobjectwymagane
• idstringwymagane

  format: "uuid"

• workspace_idstringwymagane

  format: "uuid"

• product_idstring | null

  Produkt (projekt), do którego należy skrzynka. Klienci używają go do grupowania skrzynek i tworzenia linków do aplikacji webowej.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringwymagane

  format: "email"

• display_namestringwymagane
• providerstringwymagane

  enum: "gmail", "smtp"

• statusstringwymagane

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringwymagane

  enum: "domain", "starter"

Przykład 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"
}'

Wznów skrzynkę wstrzymaną z powodu reputacji nadawcy, zgodnie z regułami samodzielnego wznowienia resumeSending.

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania wymagane

application/json

• valueobject

  Bez dodatkowych właściwości

• acknowledge_recipient_complaintbooleanwymagane

  const: true

• reasonstring

  Powód przywrócenia wysyłania; zapisywany w dzienniku audytu.

  maxLength: 500

Odpowiedź przy powodzeniu 200

Skrzynka reaktywowana lub już aktywna po wcześniejszym pomyślnym żądaniu.

application/json

• valueobject
• dataobjectwymagane
• idstringwymagane

  format: "uuid"

• workspace_idstringwymagane

  format: "uuid"

• product_idstring | null

  Produkt (projekt), do którego należy skrzynka. Klienci używają go do grupowania skrzynek i tworzenia linków do aplikacji webowej.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringwymagane

  format: "email"

• display_namestringwymagane
• providerstringwymagane

  enum: "gmail", "smtp"

• statusstringwymagane

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringwymagane

  enum: "domain", "starter"

Przykład 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

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania

Kontrakt nie określa treści żądania.

Odpowiedź przy powodzeniu 200

Pomyślna odpowiedź.

application/json

• valueobject
• dataarraywymagane
• Każdy elementobject
• idstringwymagane

  format: "uuid"

• mailbox_idstringwymagane

  format: "uuid"

• thread_idstring | nullwymagane

  format: "uuid"

• versionintegerwymagane
• toarraywymagane
• Każdy elementobject
• emailstringwymagane
• namestring
• ccarraywymagane
• Każdy elementobject
• emailstringwymagane
• namestring
• bccarraywymagane
• Każdy elementobject
• emailstringwymagane
• namestring
• subjectstringwymagane
• body_textstringwymagane
• statusstringwymagane
• created_atstringwymagane

  format: "date-time"

• updated_atstringwymagane

  format: "date-time"

• attachmentsarraywymagane
• Każdy elementobject
• idstringwymagane

  format: "uuid"

• filenamestringwymagane
• content_typestringwymagane
• size_bytesintegerwymagane
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

Przykład 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

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania wymagane

application/json

• valueobject

  Bez dodatkowych właściwości

• mailbox_idstringwymagane

  format: "uuid"

• thread_idstring

  format: "uuid"

• toarray

  maxItems: 500

• Każdy elementobject
• namestring
• emailstringwymagane

  format: "email"

• ccarray

  maxItems: 500

• Każdy elementobject
• namestring
• emailstringwymagane

  format: "email"

• bccarray

  maxItems: 500

• Każdy elementobject
• namestring
• emailstringwymagane

  format: "email"

• subjectstring

  maxLength: 10000

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

Odpowiedź przy powodzeniu 201

Pomyślna odpowiedź.

application/json

• valueobject
• dataobjectwymagane
• idstringwymagane

  format: "uuid"

• mailbox_idstringwymagane

  format: "uuid"

• thread_idstring | nullwymagane

  format: "uuid"

• versionintegerwymagane
• toarraywymagane
• Każdy elementobject
• emailstringwymagane
• namestring
• ccarraywymagane
• Każdy elementobject
• emailstringwymagane
• namestring
• bccarraywymagane
• Każdy elementobject
• emailstringwymagane
• namestring
• subjectstringwymagane
• body_textstringwymagane
• statusstringwymagane
• created_atstringwymagane

  format: "date-time"

• updated_atstringwymagane

  format: "date-time"

• attachmentsarraywymagane
• Każdy elementobject
• idstringwymagane

  format: "uuid"

• filenamestringwymagane
• content_typestringwymagane
• size_bytesintegerwymagane
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

Przykład 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

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania

Kontrakt nie określa treści żądania.

Odpowiedź przy powodzeniu 200

Kanoniczne wyniki dostarczalności, stan i incydenty.

application/json

• valueobject
• dataobjectwymagane
• idstringwymagane

  format: "uuid"

• mailbox_idstringwymagane

  format: "uuid"

• thread_idstring | nullwymagane

  format: "uuid"

• versionintegerwymagane
• toarraywymagane
• Każdy elementobject
• emailstringwymagane
• namestring
• ccarraywymagane
• Każdy elementobject
• emailstringwymagane
• namestring
• bccarraywymagane
• Każdy elementobject
• emailstringwymagane
• namestring
• subjectstringwymagane
• body_textstringwymagane
• statusstringwymagane
• created_atstringwymagane

  format: "date-time"

• updated_atstringwymagane

  format: "date-time"

• attachmentsarraywymagane
• Każdy elementobject
• idstringwymagane

  format: "uuid"

• filenamestringwymagane
• content_typestringwymagane
• size_bytesintegerwymagane
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

Przykład curl

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

updateDraft

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania wymagane

application/json

• valuenieokreślone
• allOf 1object

  Bez dodatkowych właściwości

• mailbox_idstringwymagane

  format: "uuid"

• thread_idstring

  format: "uuid"

• toarray

  maxItems: 500

• Każdy elementobject
• namestring
• emailstringwymagane

  format: "email"

• ccarray

  maxItems: 500

• Każdy elementobject
• namestring
• emailstringwymagane

  format: "email"

• bccarray

  maxItems: 500

• Każdy elementobject
• namestring
• emailstringwymagane

  format: "email"

• subjectstring

  maxLength: 10000

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

• allOf 2object
• versionintegerwymagane

  minimum: 1

Odpowiedź przy powodzeniu 200

Pomyślna odpowiedź.

application/json

• valueobject
• dataobjectwymagane
• idstringwymagane

  format: "uuid"

• mailbox_idstringwymagane

  format: "uuid"

• thread_idstring | nullwymagane

  format: "uuid"

• versionintegerwymagane
• toarraywymagane
• Każdy elementobject
• emailstringwymagane
• namestring
• ccarraywymagane
• Każdy elementobject
• emailstringwymagane
• namestring
• bccarraywymagane
• Każdy elementobject
• emailstringwymagane
• namestring
• subjectstringwymagane
• body_textstringwymagane
• statusstringwymagane
• created_atstringwymagane

  format: "date-time"

• updated_atstringwymagane

  format: "date-time"

• attachmentsarraywymagane
• Każdy elementobject
• idstringwymagane

  format: "uuid"

• filenamestringwymagane
• content_typestringwymagane
• size_bytesintegerwymagane
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

Przykład 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

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania

Kontrakt nie określa treści żądania.

Odpowiedź przy powodzeniu 204

Wersja robocza i obiekty, do których się odwołuje, zaplanowane do usunięcia.

Brak treści odpowiedzi.

Przykład curl

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

sendDraft

Wysyła wersję roboczą z jej skrzynki, do której wywołujący musi mieć dostęp. Jeśli jego wysyłki wymagają zatwierdzenia, otrzymuje oczekujące zatwierdzenie; decyduje osoba, która mogłaby wysłać wersję roboczą bezpośrednio.

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania

Kontrakt nie określa treści żądania.

Odpowiedź przy powodzeniu 202

Wysyłka jest w kolejce lub czeka na zatwierdzenie.

application/json

• valueobject
• datanieokreślonewymagane
• oneOf 1object
• idstringwymagane

  format: "uuid"

• typestringwymagane
• statusstringwymagane

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

• workspace_revisionintegerwymagane

  format: "int64"

• created_atstringwymagane

  format: "date-time"

• oneOf 2object

  Bez dodatkowych właściwości

• approvalobjectwymagane
• idstringwymagane

  format: "uuid"

• requested_by_actor_idstringwymagane
• action_kindstringwymagane
• summarystringwymagane
• capability_scopesarraywymagane
• Każdy elementstring
• resource_scopeobjectwymagane
• Dodatkowa właściwośćarray
• Każdy elementstring

  Dalsze zagnieżdżenia pominięto

• payloadobjectwymagane
• Dodatkowa właściwośćDowolna wartość
• payload_sha256stringwymagane

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

• statusstringwymagane

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

• missedbooleanwymagane
• expires_atstringwymagane

  format: "date-time"

• decided_by_actor_idstring | null
• decision_reasonstring | null
• created_atstringwymagane

  format: "date-time"

• updated_atstringwymagane

  format: "date-time"

• decided_atstring | null

  format: "date-time"

• execution_job_idstring

  format: "uuid"

• reviewobject

  Bez dodatkowych właściwości

• dispositionstringwymagane

  enum: "automatic", "human_required"

• recipient_countinteger | nullwymagane

  minimum: 0

• reasonsarraywymagane
• Każdy elementstring

  Dalsze zagnieżdżenia pominięto

• checksarraywymagane
• Każdy elementstring

  Dalsze zagnieżdżenia pominięto

Przykład 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

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania wymagane

application/octet-stream

• valuestring

  format: "binary" · maxLength: 26214400

Odpowiedź przy powodzeniu 201

Pomyślna odpowiedź.

application/json

• valueobject
• dataobjectwymagane
• idstringwymagane

  format: "uuid"

• filenamestringwymagane
• content_typestringwymagane
• size_bytesintegerwymagane
• sha256string
• created_atstring

  format: "date-time"

Przykład 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

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania

Kontrakt nie określa treści żądania.

Odpowiedź przy powodzeniu 204

Załącznik zaplanowany do usunięcia z B2 z uwzględnieniem wersji.

Brak treści odpowiedzi.

Przykład curl

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

Odczytaj treść HTML wersji roboczej

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania

Kontrakt nie określa treści żądania.

Odpowiedź przy powodzeniu 200

HTML wersji roboczej.

text/html

• valuestring

Przykład curl

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

listSendIntents

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania

Kontrakt nie określa treści żądania.

Odpowiedź przy powodzeniu 200

Ostatnie kanoniczne wysyłki i ich stan u dostawcy.

application/json

• valueobject
• dataarraywymagane
• Każdy elementobject

  Bez dodatkowych właściwości

• idstringwymagane

  format: "uuid"

• statusstringwymagane

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

• traffic_classstringwymagane

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

• recipient_countintegerwymagane

  minimum: 1

• provider_keystringwymagane
• provider_statestringwymagane

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

• provider_message_idstring | null
• error_codestring | null
• created_atstringwymagane

  format: "date-time"

• updated_atstringwymagane

  format: "date-time"

• completed_atstring | null

  format: "date-time"

Przykład curl

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

getSendIntent

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania

Kontrakt nie określa treści żądania.

Odpowiedź przy powodzeniu 200

Kanoniczny stan wysyłki asynchronicznej.

application/json

• valueobject
• dataobjectwymagane

  Bez dodatkowych właściwości

• idstringwymagane

  format: "uuid"

• statusstringwymagane

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

• traffic_classstringwymagane

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

• recipient_countintegerwymagane

  minimum: 1

• provider_keystringwymagane
• provider_statestringwymagane

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

• provider_message_idstring | null
• error_codestring | null
• created_atstringwymagane

  format: "date-time"

• updated_atstringwymagane

  format: "date-time"

• completed_atstring | null

  format: "date-time"

Przykład curl

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

listTransactionalSends

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania

Kontrakt nie określa treści żądania.

Odpowiedź przy powodzeniu 200

Pomyślna odpowiedź.

application/json

• valueobject
• dataarraywymagane
• Każdy elementobject
• idstringwymagane

  format: "uuid"

• mailbox_idstring | nullwymagane

  format: "uuid"

• command_idstring | nullwymagane

  format: "uuid"

• statusstringwymagane
• command_statusstring | nullwymagane
• subjectstring
• recipientsarray
• Każdy elementobject
• emailstringwymagane
• namestring
• recipient_countintegerwymagane
• error_codestring | null
• send_intent_idstring

  format: "uuid"

• providerstring | null
• route_kindstring | null
• sourcestring
• from_addressstring
• recipient_statesobject
• Dodatkowa właściwośćinteger
• provider_message_idstring | null
• languagenieokreślone

  Język, w którym wysłano ten email; null, jeśli nie został przetłumaczony.

• anyOf 1object

  Język, w którym osoba otrzymała email. Występuje tylko w przetłumaczonych emailach (managed-content).

• localestringwymagane

  Tag BCP 47 języka, w którym napisano email.

• requested_localestring

  Obecne tylko przy starszej wysyłce w innym języku: język, w którym osoba powinna była otrzymać email.

• fallback_reasonstring

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

• anyOf 2null
• journeyobject | null

  Krok Ścieżki i zapis, które wysłały ten email; null dla innych wysyłek.

• journey_idstringwymagane

  format: "uuid"

• step_idstringwymagane

  format: "uuid"

• enrollment_idstringwymagane

  format: "uuid"

• experimentobject | null

  Wariant eksperymentu dla tego emaila; null, jeśli żaden nie miał zastosowania.

• experiment_idstringwymagane

  format: "uuid"

• variant_keystringwymagane
• created_atstringwymagane

  format: "date-time"

• updated_atstringwymagane

  format: "date-time"

• completed_atstring | nullwymagane

  format: "date-time"

• template_idstring | null

  format: "uuid"

• template_versioninteger | null
• workspace_revisioninteger | null
• command_resultobject
• Dodatkowa właściwośćDowolna wartość
• command_started_atstring | null

  format: "date-time"

• command_completed_atstring | null

  format: "date-time"

• body_textstring
• body_htmlstring
• reply_toarray
• Każdy elementobject
• emailstringwymagane
• namestring
• headersobject
• Dodatkowa właściwośćstring
• tagsarray
• Każdy elementobject
• namestringwymagane
• valuestringwymagane

Przykład curl

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

createTransactionalSend

Jeden odbiorca na wysyłkę Ścieżki. To przyjmuje jednego odbiorcę w dowolnej postaci RecipientInput ("a@example.com", "Pat <a@example.com>", { email, name } lub lista jednoelementowa); Cc i Bcc muszą być puste. reply_to domyślnie wskazuje skrzynkę Ścieżki (pusta lista też oznacza wartość domyślną); email Produktu wymaga dokładnie jednego. Nowa Ścieżka API domyślnie używa zarządzanej treści źródłowej; starsze Ścieżki kodowe zachowują wysyłki z pełną treścią. Odmowa (4xx) niczego nie zamraża dla odbiorcy, więc poprawione wywołanie z nowym kluczem idempotencji wysyła wiadomość.

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania wymagane

application/json

• valueobject
• mailbox_idstringwymagane

  format: "uuid"

• tonieokreślonewymagane

  Odbiorcy dla to, cc, bcc i reply_to: adres ("a@example.com" lub "Pat <a@example.com>"), obiekt { email, name } lub lista łącząca obie formy. Banger zapisuje ich jako obiekty { email, name } z adresem email małymi literami. Hash idempotencji obejmuje treść w wysłanej postaci, więc ponawiaj z tą samą postacią.

• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringwymagane

  format: "email"

• oneOf 3array

  maxItems: 500

• Każdy elementnieokreślone
• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringwymagane

  format: "email"

• ccarray

  maxItems: 0

• Każdy elementobject
• namestring
• emailstringwymagane

  format: "email"

• bccarray

  maxItems: 0

• Każdy elementobject
• namestring
• emailstringwymagane

  format: "email"

• subjectstring

  maxLength: 10000

• expires_atstring

  Odrzuć odroczoną wysyłkę Ścieżki po tej chwili; najwyżej siedem dni od pierwotnego żądania.

  format: "date-time"

• expires_after_secondsinteger

  minimum: 1 · maximum: 604800

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

• reply_tonieokreślone

  Odbiorcy dla to, cc, bcc i reply_to: adres ("a@example.com" lub "Pat <a@example.com>"), obiekt { email, name } lub lista łącząca obie formy. Banger zapisuje ich jako obiekty { email, name } z adresem email małymi literami. Hash idempotencji obejmuje treść w wysłanej postaci, więc ponawiaj z tą samą postacią.

• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringwymagane

  format: "email"

• oneOf 3array

  maxItems: 500

• Każdy elementnieokreślone
• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringwymagane

  format: "email"

• headersobject
• Dodatkowa właściwośćstring

  maxLength: 5000

• tagsarray

  maxItems: 49

• Każdy elementobject

  Bez dodatkowych właściwości

• namestringwymagane

  minLength: 1 · maxLength: 256

• valuestringwymagane

  minLength: 1 · maxLength: 256

Odpowiedź przy powodzeniu 202

Pomyślna odpowiedź.

application/json

• valueobject
• dataobjectwymagane
• action_kindstringwymagane

  enum: "transactional.send"

• idstring

  format: "uuid"

• send_intent_idstring

  format: "uuid"

• provider_attempt_idstring

  format: "uuid"

• statusstringwymagane

  Stany sent/queued z dostarczania lub, dla zamrożonego żądania: deferred (zaplanowane przez politykę lub oczekiwanie na tłumaczenie), processing (wysyłanie), discarded.

• replayedboolean
• journeynieokreślonewymagane
• anyOf 1object
• journey_idstringwymagane

  format: "uuid"

• enrollment_idstringwymagane

  format: "uuid"

• step_idstringwymagane

  format: "uuid"

• step_positionintegerwymagane
• originstring

  enum: "journey"

• journey_identitystring
• anyOf 2null
• ignored_variablesarraywymagane
• Każdy elementstring
• scheduled_atstring

  format: "date-time"

• reasonstring
• communication_reservation_idstring

  format: "uuid"

Przykład 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

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania

Kontrakt nie określa treści żądania.

Odpowiedź przy powodzeniu 200

Pomyślna odpowiedź.

application/json

• valueobject
• dataobjectwymagane
• idstringwymagane

  format: "uuid"

• mailbox_idstring | nullwymagane

  format: "uuid"

• command_idstring | nullwymagane

  format: "uuid"

• statusstringwymagane
• command_statusstring | nullwymagane
• subjectstring
• recipientsarray
• Każdy elementobject
• emailstringwymagane
• namestring
• recipient_countintegerwymagane
• error_codestring | null
• send_intent_idstring

  format: "uuid"

• providerstring | null
• route_kindstring | null
• sourcestring
• from_addressstring
• recipient_statesobject
• Dodatkowa właściwośćinteger
• provider_message_idstring | null
• languagenieokreślone

  Język, w którym wysłano ten email; null, jeśli nie został przetłumaczony.

• anyOf 1object

  Język, w którym osoba otrzymała email. Występuje tylko w przetłumaczonych emailach (managed-content).

• localestringwymagane

  Tag BCP 47 języka, w którym napisano email.

• requested_localestring

  Obecne tylko przy starszej wysyłce w innym języku: język, w którym osoba powinna była otrzymać email.

• fallback_reasonstring

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

• anyOf 2null
• journeyobject | null

  Krok Ścieżki i zapis, które wysłały ten email; null dla innych wysyłek.

• journey_idstringwymagane

  format: "uuid"

• step_idstringwymagane

  format: "uuid"

• enrollment_idstringwymagane

  format: "uuid"

• experimentobject | null

  Wariant eksperymentu dla tego emaila; null, jeśli żaden nie miał zastosowania.

• experiment_idstringwymagane

  format: "uuid"

• variant_keystringwymagane
• created_atstringwymagane

  format: "date-time"

• updated_atstringwymagane

  format: "date-time"

• completed_atstring | nullwymagane

  format: "date-time"

• template_idstring | null

  format: "uuid"

• template_versioninteger | null
• workspace_revisioninteger | null
• command_resultobject
• Dodatkowa właściwośćDowolna wartość
• command_started_atstring | null

  format: "date-time"

• command_completed_atstring | null

  format: "date-time"

• body_textstring
• body_htmlstring
• reply_toarray
• Każdy elementobject
• emailstringwymagane
• namestring
• headersobject
• Dodatkowa właściwośćstring
• tagsarray
• Każdy elementobject
• namestringwymagane
• valuestringwymagane

Przykład curl

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

listTransactionalSendTimeline

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania

Kontrakt nie określa treści żądania.

Odpowiedź przy powodzeniu 200

Uporządkowana oś czasu akceptacji, prób dostawcy i zdarzeń odbiorcy.

application/json

• valueobject
• dataarraywymagane
• Każdy elementobject
• occurred_atstringwymagane

  format: "date-time"

• event_typestringwymagane
• labelstringwymagane
• providerstring | null
• recipient_domainstring | null
• error_codestring | null

Przykład curl

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

retryTransactionalSend

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania

Kontrakt nie określa treści żądania.

Odpowiedź przy powodzeniu 202

Pomyślna odpowiedź.

application/json

• valueobject
• dataobjectwymagane
• action_kindstringwymagane

  enum: "transactional.send"

• idstringwymagane

  format: "uuid"

• send_intent_idstringwymagane

  format: "uuid"

• provider_attempt_idstringwymagane

  format: "uuid"

• statusstringwymagane
• replayedbooleanwymagane

Przykład 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

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania

Kontrakt nie określa treści żądania.

Odpowiedź przy powodzeniu 200

Wątki przestrzeni roboczej stronicowane według klucza.

application/json

• valueobject
• dataarraywymagane
• Każdy elementobject
• idstringwymagane

  format: "uuid"

• mailbox_idstringwymagane

  format: "uuid"

• subjectstringwymagane
• snippetstringwymagane
• last_message_atstringwymagane

  format: "date-time"

• message_countintegerwymagane
• unread_countintegerwymagane
• is_archivedbooleanwymagane
• is_trashbooleanwymagane
• is_spambooleanwymagane
• is_starredbooleanwymagane
• is_sentbooleanwymagane
• has_attachmentsbooleanwymagane
• labelsarraywymagane
• Każdy elementstring
• participantsarray
• Każdy elementobject
• namestring
• emailstringwymagane

  format: "email"

• pageobjectwymagane
• next_cursorstring
• has_morebooleanwymagane

Przykład 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

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania

Kontrakt nie określa treści żądania.

Odpowiedź przy powodzeniu 200

Wątek i uporządkowane wiadomości.

application/json

• valueobject
• datanieokreślonewymagane
• allOf 1object
• idstringwymagane

  format: "uuid"

• mailbox_idstringwymagane

  format: "uuid"

• subjectstringwymagane
• snippetstringwymagane
• last_message_atstringwymagane

  format: "date-time"

• message_countintegerwymagane
• unread_countintegerwymagane
• is_archivedbooleanwymagane
• is_trashbooleanwymagane
• is_spambooleanwymagane
• is_starredbooleanwymagane
• is_sentbooleanwymagane
• has_attachmentsbooleanwymagane
• labelsarraywymagane
• Każdy elementstring
• participantsarray
• Każdy elementobject
• namestring
• emailstringwymagane

  format: "email"

• allOf 2object
• messagesarraywymagane
• Każdy elementobject
• idstringwymagane

  format: "uuid"

• mailbox_idstringwymagane

  format: "uuid"

• thread_idstringwymagane

  format: "uuid"

• sent_atstringwymagane

  format: "date-time"

• received_atstring

  format: "date-time"

• envelope_recipientsarray

  Pierwotni odbiorcy koperty SMTP, ze znormalizowaną wielkością liter na brzegu SMTP, przed routingiem aliasów tylko do odbioru. Puste dla starszych wiadomości lub źródeł innych niż SMTP. Niezależne od widocznych nagłówków To/Cc.

• Każdy elementstring

  format: "email"

  Dalsze zagnieżdżenia pominięto

• fromobjectwymagane
• namestring

  Dalsze zagnieżdżenia pominięto

• emailstringwymagane

  format: "email"

  Dalsze zagnieżdżenia pominięto

• toarraywymagane
• Każdy elementobject

  Dalsze zagnieżdżenia pominięto

• ccarray
• Każdy elementobject

  Dalsze zagnieżdżenia pominięto

• reply_toarray
• Każdy elementobject

  Dalsze zagnieżdżenia pominięto

• is_sentboolean

  Czy tę wiadomość wysłano ze skrzynki, także z aliasu.

• body_textstring
• body_html_urlstring

  format: "uri"

• reply_originobject
• send_intent_idstringwymagane

  format: "uuid"

  Dalsze zagnieżdżenia pominięto

• sourcestringwymagane

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

  Dalsze zagnieżdżenia pominięto

• source_idstring

  format: "uuid"

  Dalsze zagnieżdżenia pominięto

• traffic_classstringwymagane

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

  Dalsze zagnieżdżenia pominięto

• kindstringwymagane

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

  Dalsze zagnieżdżenia pominięto

• namestring

  Dalsze zagnieżdżenia pominięto

• has_attachmentsbooleanwymagane
• attachmentsarray
• Każdy elementobject

  Dalsze zagnieżdżenia pominięto

Przykład curl

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

getMessageHtml

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania

Kontrakt nie określa treści żądania.

Odpowiedź przy powodzeniu 200

Uwierzytelniona treść HTML wiadomości ograniczona piaskownicą.

text/html

• valuestring

Przykład curl

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

downloadAttachment

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania

Kontrakt nie określa treści żądania.

Odpowiedź przy powodzeniu 200

Uwierzytelniony strumień załącznika.

application/octet-stream

• valuestring

  format: "binary"

Przykład curl

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

searchMail

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania

Kontrakt nie określa treści żądania.

Odpowiedź przy powodzeniu 200

Wyniki wyszukiwania w całej przestrzeni roboczej.

application/json

• valueobject
• dataarraywymagane
• Każdy elementobject
• idstringwymagane

  format: "uuid"

• mailbox_idstringwymagane

  format: "uuid"

• subjectstringwymagane
• snippetstringwymagane
• last_message_atstringwymagane

  format: "date-time"

• message_countintegerwymagane
• unread_countintegerwymagane
• is_archivedbooleanwymagane
• is_trashbooleanwymagane
• is_spambooleanwymagane
• is_starredbooleanwymagane
• is_sentbooleanwymagane
• has_attachmentsbooleanwymagane
• labelsarraywymagane
• Każdy elementstring
• participantsarray
• Każdy elementobject
• namestring
• emailstringwymagane

  format: "email"

• pageobjectwymagane
• next_cursorstring
• has_morebooleanwymagane

Przykład 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

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania

Kontrakt nie określa treści żądania.

Odpowiedź przy powodzeniu 200

Pomyślna odpowiedź.

application/json

• valueobject
• dataarraywymagane
• Każdy elementobject
• idstringwymagane

  format: "uuid"

• emailstringwymagane

  format: "email"

• display_namestring | nullwymagane
• attributesobjectwymagane
• Dodatkowa właściwośćDowolna wartość
• statusstringwymagane

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

• created_atstringwymagane

  format: "date-time"

• updated_atstringwymagane

  format: "date-time"

• pageobjectwymagane
• next_cursorstring
• has_morebooleanwymagane

Przykład 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

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania wymagane

application/json

• valueobject

  Bez dodatkowych właściwości

• emailstringwymagane

  format: "email"

• display_namestring

  maxLength: 1000

• statusstringwymagane

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

• attributesobject
• Dodatkowa właściwośćDowolna wartość
• consent_confirmedboolean

  Wymagane przy nowym zapisie adresu.

Odpowiedź przy powodzeniu 201

Pomyślna odpowiedź.

application/json

• valueobject
• dataobjectwymagane
• idstringwymagane

  format: "uuid"

• emailstringwymagane

  format: "email"

• display_namestring | nullwymagane
• attributesobjectwymagane
• Dodatkowa właściwośćDowolna wartość
• statusstringwymagane

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

• created_atstringwymagane

  format: "date-time"

• updated_atstringwymagane

  format: "date-time"

Przykład 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

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania

Kontrakt nie określa treści żądania.

Odpowiedź przy powodzeniu 200

Pomyślna odpowiedź.

application/json

• valueobject
• dataobjectwymagane
• idstringwymagane

  format: "uuid"

• emailstringwymagane

  format: "email"

• display_namestring | nullwymagane
• attributesobjectwymagane
• Dodatkowa właściwośćDowolna wartość
• statusstringwymagane

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

• created_atstringwymagane

  format: "date-time"

• updated_atstringwymagane

  format: "date-time"

• suppressedbooleanwymagane
• suppression_reasonstring | nullwymagane
• sourcesarraywymagane
• Każdy elementobject
• kindstringwymagane
• referencestringwymagane
• connection_idstring | nullwymagane

  format: "uuid"

• metadataobjectwymagane
• Dodatkowa właściwośćDowolna wartość
• first_seen_atstringwymagane

  format: "date-time"

• last_seen_atstringwymagane

  format: "date-time"

• listsarraywymagane
• Każdy elementobject
• idstringwymagane

  format: "uuid"

• namestringwymagane
• subscription_statusstringwymagane
• consent_evidencearraywymagane
• Każdy elementobject
• kindstringwymagane
• referencestringwymagane
• connection_idstring | nullwymagane

  format: "uuid"

• metadataobjectwymagane
• Dodatkowa właściwośćDowolna wartość
• first_seen_atstringwymagane

  format: "date-time"

• last_seen_atstringwymagane

  format: "date-time"

Przykład curl

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

deleteContact

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania

Kontrakt nie określa treści żądania.

Odpowiedź przy powodzeniu 204

Kontakt usunięty.

Brak treści odpowiedzi.

Przykład curl

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

listContactImports

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania

Kontrakt nie określa treści żądania.

Odpowiedź przy powodzeniu 200

Pomyślna odpowiedź.

application/json

• valueobject
• dataarraywymagane
• Każdy elementobject
• idstring

  format: "uuid"

• filenamestring
• list_idstring | null

  format: "uuid"

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

Przykład curl

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

importContacts

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania wymagane

application/json

• valueobject
• filenamestringwymagane

  minLength: 1 · maxLength: 500

• list_idstring

  format: "uuid"

• consent_confirmedboolean

  Wymagane, jeśli dowolny importowany wiersz jest zapisany.

• rowsarraywymagane

  minItems: 1 · maxItems: 5000

• Każdy elementobject
• emailstringwymagane

  format: "email"

• display_namestring

  maxLength: 1000

• statusstring

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

• attributesobject
• Dodatkowa właściwośćDowolna wartość

Odpowiedź przy powodzeniu 201

Pomyślna odpowiedź.

application/json

• valueobject
• dataobjectwymagane
• idstringwymagane

  format: "uuid"

• statusstringwymagane

  enum: "queued"

• total_rowsintegerwymagane
• imported_rowsintegerwymagane
• invalid_rowsintegerwymagane
• list_idstring | nullwymagane

  format: "uuid"

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

Połącz typowane atrybuty bez zmiany subskrypcji lub zgody

Wymaga contacts:write i contacts:read. Aktualizuje tylko istniejący kontakt. Pominięte atrybuty pozostają, jawne false jest zapisywane, a null usuwa pole. Podawaj zweryfikowane fakty źródłowe; brak danych nie oznacza false. Subskrypcja, blokada, tożsamość i historia źródeł pozostają bez zmian.

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania wymagane

application/json

• valueobject

  Bez dodatkowych właściwości

• attributesobjectwymagane
• Dodatkowa właściwośćDowolna wartość

Odpowiedź przy powodzeniu 200

Bieżący odczyt kontaktu; replayed ma wartość true, gdy tę zmianę już zastosowano.

application/json

• valueobject
• dataobjectwymagane
• idstringwymagane

  format: "uuid"

• attributesobjectwymagane
• Dodatkowa właściwośćDowolna wartość
• statusstringwymagane

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

• replayedbooleanwymagane
• Dodatkowa właściwośćDowolna wartość

Przykład 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

Uwierzytelnianie: klucz API przestrzeni roboczej jako Bearer.

Parametry

Treść żądania wymagane

application/json

• valueobject

  Bez dodatkowych właściwości

• emailstringwymagane

  format: "email" · maxLength: 320

• display_namestring

  minLength: 0 · maxLength: 1000

• attributesobject
• Dodatkowa właściwośćDowolna wartość
• statusstringwymagane

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

• consent_evidenceobject

  Bez dodatkowych właściwości

• sourcestring

  minLength: 1 · maxLength: 2000

• referencestring

  minLength: 1 · maxLength: 2000

• observed_atstring

  format: "date-time"

• statementstring

  minLength: 1 · maxLength: 2000

• consent_confirmedboolean

Odpowiedź przy powodzeniu 200

Kanoniczny odczyt lub idempotentne potwierdzenie. Akceptacja dostawcy to sent; delivered wymaga zdarzenia dostarczenia i nie dowodzi umieszczenia w skrzynce odbiorczej.

application/json

• valueobject
• datanieokreślonewymagane
• allOf 1object
• idstringwymagane

  format: "uuid"

• emailstringwymagane

  format: "email"

• display_namestring | nullwymagane
• attributesobjectwymagane
• Dodatkowa właściwośćDowolna wartość
• statusstringwymagane

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

• created_atstringwymagane

  format: "date-time"

• updated_atstringwymagane

  format: "date-time"

• suppressedbooleanwymagane
• suppression_reasonstring | nullwymagane
• sourcesarraywymagane
• Każdy elementobject
• kindstringwymagane
• referencestringwymagane
• connection_idstring | nullwymagane

  format: "uuid"

• metadataobjectwymagane
• Dodatkowa właściwośćDowolna wartość
• first_seen_atstringwymagane

  format: "date-time"

• last_seen_atstringwymagane

  format: "date-time"

• listsarraywymagane
• Każdy elementobject
• idstringwymagane

  format: "uuid"

• namestringwymagane
• subscription_statusstringwymagane
• consent_evidencearraywymagane
• Każdy elementobject
• kindstringwymagane
• referencestringwymagane
• connection_idstring | nullwymagane

  format: "uuid"

• metadataobjectwymagane
• Dodatkowa właściwośćDowolna wartość
• first_seen_atstringwymagane

  format: "date-time"

• last_seen_atstringwymagane

  format: "date-time"

• allOf 2object
• replayedbooleanwymagane