Banger API-referens

Lista arbetsytans produkter

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp

Ingen anropskropp anges i kontraktet.

Framgångsrikt svar 200

Framgångsrikt svar.

application/json

• valueobject
• dataarrayobligatorisk
• Varje objektobject
• idstringobligatorisk

  format: "uuid"

• workspace_idstringobligatorisk

  format: "uuid"

• namestringobligatorisk
• slugstringobligatorisk
• kindstringobligatorisk

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

• website_urlstring | nullobligatorisk
• domainsarrayobligatorisk
• Varje objektstring
• descriptionstringobligatorisk
• contextobjectobligatorisk
• Ytterligare egenskapValfritt värde
• brandobjectobligatorisk
• company_namestring

  maxLength: 160

• logo_urlstring

  Ikonen: symbolen för sig, använd i litet format (e-postfot, inskjutna formulär) och som sidhuvud när ordmärke saknas.

  maxLength: 2000

• wordmark_urlstring

  Ordmärket: företagsnamnet i sin grafiska form, visat ensamt överst i varje mejl.

  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

• statusstringobligatorisk

  deleting: borttaget av en person; kan återställas till delete_after, därefter borttaget permanent.

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

• delete_afterstring | null

  När en produkt med status deleting tas bort permanent.

  format: "date-time"

• is_defaultbooleanobligatorisk
• route_readybooleanobligatorisk
• setuparrayobligatorisk
• Varje objektobject
• keystringobligatorisk

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

• statusstringobligatorisk

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

• completion_sourcestring | nullobligatorisk

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

• notestringobligatorisk
• updated_atstring | nullobligatorisk

  format: "date-time"

• created_atstringobligatorisk

  format: "date-time"

• updated_atstringobligatorisk

  format: "date-time"

curl-exempel

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

Skapa en produkt

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp obligatorisk

application/json

• valueobject
• namestringobligatorisk

  minLength: 1 · maxLength: 160

• kindstring

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

• website_urlstring | null

  maxLength: 2000

• descriptionstring

  maxLength: 4000

• contextobject
• Ytterligare egenskapValfritt värde
• domainsarray

  maxItems: 20

• Varje objektstring

  maxLength: 253

Framgångsrikt svar 201

Framgångsrikt svar.

application/json

• valueobject
• dataobjectobligatorisk
• idstringobligatorisk

  format: "uuid"

• workspace_idstringobligatorisk

  format: "uuid"

• namestringobligatorisk
• slugstringobligatorisk
• kindstringobligatorisk

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

• website_urlstring | nullobligatorisk
• domainsarrayobligatorisk
• Varje objektstring
• descriptionstringobligatorisk
• contextobjectobligatorisk
• Ytterligare egenskapValfritt värde
• brandobjectobligatorisk
• company_namestring

  maxLength: 160

• logo_urlstring

  Ikonen: symbolen för sig, använd i litet format (e-postfot, inskjutna formulär) och som sidhuvud när ordmärke saknas.

  maxLength: 2000

• wordmark_urlstring

  Ordmärket: företagsnamnet i sin grafiska form, visat ensamt överst i varje mejl.

  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

• statusstringobligatorisk

  deleting: borttaget av en person; kan återställas till delete_after, därefter borttaget permanent.

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

• delete_afterstring | null

  När en produkt med status deleting tas bort permanent.

  format: "date-time"

• is_defaultbooleanobligatorisk
• route_readybooleanobligatorisk
• setuparrayobligatorisk
• Varje objektobject
• keystringobligatorisk

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

• statusstringobligatorisk

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

• completion_sourcestring | nullobligatorisk

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

• notestringobligatorisk
• updated_atstring | nullobligatorisk

  format: "date-time"

• created_atstringobligatorisk

  format: "date-time"

• updated_atstringobligatorisk

  format: "date-time"

curl-exempel

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

Hämta en produkt

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp

Ingen anropskropp anges i kontraktet.

Framgångsrikt svar 200

Framgångsrikt svar.

application/json

• valueobject
• dataobjectobligatorisk
• idstringobligatorisk

  format: "uuid"

• workspace_idstringobligatorisk

  format: "uuid"

• namestringobligatorisk
• slugstringobligatorisk
• kindstringobligatorisk

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

• website_urlstring | nullobligatorisk
• domainsarrayobligatorisk
• Varje objektstring
• descriptionstringobligatorisk
• contextobjectobligatorisk
• Ytterligare egenskapValfritt värde
• brandobjectobligatorisk
• company_namestring

  maxLength: 160

• logo_urlstring

  Ikonen: symbolen för sig, använd i litet format (e-postfot, inskjutna formulär) och som sidhuvud när ordmärke saknas.

  maxLength: 2000

• wordmark_urlstring

  Ordmärket: företagsnamnet i sin grafiska form, visat ensamt överst i varje mejl.

  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

• statusstringobligatorisk

  deleting: borttaget av en person; kan återställas till delete_after, därefter borttaget permanent.

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

• delete_afterstring | null

  När en produkt med status deleting tas bort permanent.

  format: "date-time"

• is_defaultbooleanobligatorisk
• route_readybooleanobligatorisk
• setuparrayobligatorisk
• Varje objektobject
• keystringobligatorisk

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

• statusstringobligatorisk

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

• completion_sourcestring | nullobligatorisk

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

• notestringobligatorisk
• updated_atstring | nullobligatorisk

  format: "date-time"

• created_atstringobligatorisk

  format: "date-time"

• updated_atstringobligatorisk

  format: "date-time"

curl-exempel

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

Uppdatera en produkt

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp obligatorisk

application/json

• valueobject
• namestring

  maxLength: 160

• kindstring

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

• website_urlstring | null

  maxLength: 2000

• descriptionstring

  maxLength: 4000

• contextobject
• Ytterligare egenskapValfritt värde
• brandobject
• company_namestring

  maxLength: 160

• logo_urlstring

  Ikonen: symbolen för sig, använd i litet format (e-postfot, inskjutna formulär) och som sidhuvud när ordmärke saknas.

  maxLength: 2000

• wordmark_urlstring

  Ordmärket: företagsnamnet i sin grafiska form, visat ensamt överst i varje mejl.

  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"

Framgångsrikt svar 200

Framgångsrikt svar.

application/json

• valueobject
• dataobjectobligatorisk
• idstringobligatorisk

  format: "uuid"

• workspace_idstringobligatorisk

  format: "uuid"

• namestringobligatorisk
• slugstringobligatorisk
• kindstringobligatorisk

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

• website_urlstring | nullobligatorisk
• domainsarrayobligatorisk
• Varje objektstring
• descriptionstringobligatorisk
• contextobjectobligatorisk
• Ytterligare egenskapValfritt värde
• brandobjectobligatorisk
• company_namestring

  maxLength: 160

• logo_urlstring

  Ikonen: symbolen för sig, använd i litet format (e-postfot, inskjutna formulär) och som sidhuvud när ordmärke saknas.

  maxLength: 2000

• wordmark_urlstring

  Ordmärket: företagsnamnet i sin grafiska form, visat ensamt överst i varje mejl.

  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

• statusstringobligatorisk

  deleting: borttaget av en person; kan återställas till delete_after, därefter borttaget permanent.

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

• delete_afterstring | null

  När en produkt med status deleting tas bort permanent.

  format: "date-time"

• is_defaultbooleanobligatorisk
• route_readybooleanobligatorisk
• setuparrayobligatorisk
• Varje objektobject
• keystringobligatorisk

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

• statusstringobligatorisk

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

• completion_sourcestring | nullobligatorisk

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

• notestringobligatorisk
• updated_atstring | nullobligatorisk

  format: "date-time"

• created_atstringobligatorisk

  format: "date-time"

• updated_atstringobligatorisk

  format: "date-time"

curl-exempel

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

Ta bort en produkt (ett projekt i appen) efter att ha granskat förhandsvisningen av borttagningen. Den tas ur bruk direkt (sändning stoppas) och kan återställas i 24 timmar; sedan tar Banger bort dess sändningsdomäner och alla rader den äger. Arbetsytans sista aktiva produkt kan inte tas bort. Kräver arbetsyteadministratör och en inloggad session; API-nycklar och OAuth-behörigheter nekas.

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp obligatorisk

application/json

• valueobject

  Inga ytterligare egenskaper

• confirm_namestringobligatorisk

  Det exakta produktnamnet.

  minLength: 1 · maxLength: 160

• preview_tokenstringobligatorisk

  minLength: 64 · maxLength: 64

Framgångsrikt svar 202

Produkten är ur bruk och tas bort permanent vid delete_after om den inte återställs först. En idempotent upprepning ger samma resultat.

application/json

• valueobject
• dataobjectobligatorisk
• idstringobligatorisk

  format: "uuid"

• namestringobligatorisk
• statusstringobligatorisk

  enum: "deleting"

• delete_afterstringobligatorisk

  När produkten tas bort permanent; fram till dess kan den återställas.

  format: "date-time"

• next_product_idstringobligatorisk

  Arbetsytans standardprodukt nu.

  format: "uuid"

• replayedboolean

curl-exempel

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

Förhandsvisa borttagning av en produkt och allt den äger utan att ta bort något. Kräver arbetsyteadministratör, inloggad eller via användarauktoriserad OAuth.

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp

Ingen anropskropp anges i kontraktet.

Framgångsrikt svar 200

Vad borttagning av produkten tar bort och stoppar.

application/json

• valueobject
• dataobjectobligatorisk
• productobjectobligatorisk
• idstringobligatorisk

  format: "uuid"

• namestringobligatorisk
• is_defaultbooleanobligatorisk
• next_default_productinte angivetobligatorisk

  Produkten som blir arbetsytans standard när standardprodukten tas bort.

• oneOf 1null
• oneOf 2object
• idstringobligatorisk

  format: "uuid"

• namestringobligatorisk
• last_productbooleanobligatorisk

  Den enda aktiva produkten kan inte tas bort.

• mailboxesarrayobligatorisk
• Varje objektobject
• idstringobligatorisk

  format: "uuid"

• addressstringobligatorisk
• domainsarrayobligatorisk

  Sändningsdomäner Banger tar bort när återställningsperioden har löpt ut.

• Varje objektobject
• idstringobligatorisk

  format: "uuid"

• domainstringobligatorisk
• journeysintegerobligatorisk
• broadcastsintegerobligatorisk
• signup_formsintegerobligatorisk
• contactsintegerobligatorisk
• api_keysintegerobligatorisk
• webhooksintegerobligatorisk
• pending_sendsintegerobligatorisk
• impactarrayobligatorisk
• Varje objektstring
• preview_tokenstringobligatorisk

curl-exempel

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

Återställ en borttagen produkt före dess delete_after. Brevlådor, flöden, registreringsformulär, webhooks och integrationer aktiveras igen; utskick förblir pausade. Kräver arbetsyteadministratör, inloggad eller via användarauktoriserad OAuth.

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp

Ingen anropskropp anges i kontraktet.

Framgångsrikt svar 200

Produkten är aktiv igen.

application/json

• valueobject
• dataobjectobligatorisk
• idstringobligatorisk

  format: "uuid"

• namestringobligatorisk
• statusstringobligatorisk

  enum: "active"

curl-exempel

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

Uppdatera ett produktkonfigurationsobjekt

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp obligatorisk

application/json

• valueobject
• statusstringobligatorisk

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

• completion_sourcestring

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

• notestring

  maxLength: 1000

Framgångsrikt svar 200

Framgångsrikt svar.

application/json

• valueobject
• dataobjectobligatorisk
• keystringobligatorisk

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

• statusstringobligatorisk

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

• completion_sourcestring | nullobligatorisk

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

• notestringobligatorisk
• updated_atstring | nullobligatorisk

  format: "date-time"

curl-exempel

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

Koppla en domän till en produkt

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp obligatorisk

application/json

• valueobject
• domainstringobligatorisk

  minLength: 3 · maxLength: 253

Framgångsrikt svar 201

Framgångsrikt svar.

application/json

• valueobject
• dataobjectobligatorisk
• idstringobligatorisk

  format: "uuid"

• workspace_idstringobligatorisk

  format: "uuid"

• namestringobligatorisk
• slugstringobligatorisk
• kindstringobligatorisk

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

• website_urlstring | nullobligatorisk
• domainsarrayobligatorisk
• Varje objektstring
• descriptionstringobligatorisk
• contextobjectobligatorisk
• Ytterligare egenskapValfritt värde
• brandobjectobligatorisk
• company_namestring

  maxLength: 160

• logo_urlstring

  Ikonen: symbolen för sig, använd i litet format (e-postfot, inskjutna formulär) och som sidhuvud när ordmärke saknas.

  maxLength: 2000

• wordmark_urlstring

  Ordmärket: företagsnamnet i sin grafiska form, visat ensamt överst i varje mejl.

  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

• statusstringobligatorisk

  deleting: borttaget av en person; kan återställas till delete_after, därefter borttaget permanent.

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

• delete_afterstring | null

  När en produkt med status deleting tas bort permanent.

  format: "date-time"

• is_defaultbooleanobligatorisk
• route_readybooleanobligatorisk
• setuparrayobligatorisk
• Varje objektobject
• keystringobligatorisk

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

• statusstringobligatorisk

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

• completion_sourcestring | nullobligatorisk

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

• notestringobligatorisk
• updated_atstring | nullobligatorisk

  format: "date-time"

• created_atstringobligatorisk

  format: "date-time"

• updated_atstringobligatorisk

  format: "date-time"

curl-exempel

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

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp

Ingen anropskropp anges i kontraktet.

Framgångsrikt svar 200

Brevlådor som aktören kan se.

application/json

• valueobject
• dataarrayobligatorisk
• Varje objektobject
• idstringobligatorisk

  format: "uuid"

• workspace_idstringobligatorisk

  format: "uuid"

• product_idstring | null

  Produkten (projektet) brevlådan tillhör. Klienter använder den för att gruppera brevlådor och skapa webbapplänkar.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringobligatorisk

  format: "email"

• display_namestringobligatorisk
• providerstringobligatorisk

  enum: "gmail", "smtp"

• statusstringobligatorisk

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringobligatorisk

  enum: "domain", "starter"

curl-exempel

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

Skapa en Banger-brevlåda för arbete på en sändningsdomän i arbetsytan.

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp obligatorisk

application/json

• valueobject

  Inga ytterligare egenskaper

• domain_idstringobligatorisk

  format: "uuid"

• local_partstringobligatorisk

  minLength: 1 · maxLength: 64

• display_namestring

  maxLength: 200

Framgångsrikt svar 200

Idempotent upprepning av skapandet av en inbyggd brevlåda.

application/json

• valueobject
• dataobjectobligatorisk
• idstringobligatorisk

  format: "uuid"

• workspace_idstringobligatorisk

  format: "uuid"

• product_idstring | null

  Produkten (projektet) brevlådan tillhör. Klienter använder den för att gruppera brevlådor och skapa webbapplänkar.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringobligatorisk

  format: "email"

• display_namestringobligatorisk
• providerstringobligatorisk

  enum: "gmail", "smtp"

• statusstringobligatorisk

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringobligatorisk

  enum: "domain", "starter"

curl-exempel

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

Förhandsvisa permanent borttagning av en brevlåda och beroende sändningsflöden. Kräver arbetsyteadministratör och produktomfång.

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp

Ingen anropskropp anges i kontraktet.

Framgångsrikt svar 200

Exakt brevlåda och aktuell borttagningspåverkan utan att ta bort något.

application/json

• valueobject
• dataobjectobligatorisk
• mailboxobjectobligatorisk
• idstringobligatorisk

  format: "uuid"

• addressstringobligatorisk
• providerstringobligatorisk
• domain_idstring | nullobligatorisk

  format: "uuid"

• provider_connection_idstring | nullobligatorisk

  format: "uuid"

• messagesintegerobligatorisk
• draftsintegerobligatorisk
• pending_sendsintegerobligatorisk
• broadcastsarrayobligatorisk
• Varje objektobject
• idstringobligatorisk

  format: "uuid"

• namestringobligatorisk
• statusstringobligatorisk
• journeysarrayobligatorisk
• Varje objektobject
• idstringobligatorisk

  format: "uuid"

• namestringobligatorisk
• statusstringobligatorisk
• signup_formsarrayobligatorisk
• Varje objektobject
• idstringobligatorisk

  format: "uuid"

• namestringobligatorisk
• statusstringobligatorisk
• impactarrayobligatorisk
• Varje objektstring
• preview_tokenstringobligatorisk

curl-exempel

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

Ange avsändarnamnet mottagare ser på mejl från en Banger-brevlåda ("Name <address>"). Gmail-brevlådor behåller namnet som angetts i Gmail. Kräver arbetsyteadministratör.

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp obligatorisk

application/json

• valueobject

  Inga ytterligare egenskaper

• display_namestringobligatorisk

  En rad. Tomt skickar bara adressen.

  maxLength: 200

Framgångsrikt svar 200

Brevlådan med dess avsändarnamn.

application/json

• valueobject
• dataobjectobligatorisk
• idstringobligatorisk

  format: "uuid"

• workspace_idstringobligatorisk

  format: "uuid"

• product_idstring | null

  Produkten (projektet) brevlådan tillhör. Klienter använder den för att gruppera brevlådor och skapa webbapplänkar.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringobligatorisk

  format: "email"

• display_namestringobligatorisk
• providerstringobligatorisk

  enum: "gmail", "smtp"

• statusstringobligatorisk

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringobligatorisk

  enum: "domain", "starter"

curl-exempel

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

Ta bort en brevlåda permanent och behåll domänen och övriga brevlådor. Kräver arbetsyteadministratör och produktomfång.

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp obligatorisk

application/json

• valueobject

  Inga ytterligare egenskaper

• confirm_addressstringobligatorisk

  minLength: 3 · maxLength: 320

• preview_tokenstringobligatorisk

  minLength: 64 · maxLength: 64

Framgångsrikt svar 200

Borttaget eller idempotent upprepning. Lagrade filer köas för permanent rensning.

application/json

• valueobject
• dataobjectobligatorisk
• idstringobligatorisk

  format: "uuid"

• addressstringobligatorisk
• deletedbooleanobligatorisk
• replayedboolean

curl-exempel

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

Skapa en värdbaserad brevlåda begränsad till samma produkts värdbaserade inkorgar och arbetsytans registreringsmottagare.

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp obligatorisk

application/json

• valueobject

  Inga ytterligare egenskaper

• create_newboolean

  Skapa ytterligare en värdbaserad brevlåda i stället för att återuppta den ursprungliga.

• local_partstring

  Namn före @bangermail.com. Utan det får brevlådan ett ordnamn som quiet-maple-harbor.

  minLength: 3 · maxLength: 40

• display_namestring

  maxLength: 200

Framgångsrikt svar 200

Idempotent upprepning av skapandet av en startidentitet.

application/json

• valueobject
• dataobjectobligatorisk
• idstringobligatorisk

  format: "uuid"

• workspace_idstringobligatorisk

  format: "uuid"

• product_idstring | null

  Produkten (projektet) brevlådan tillhör. Klienter använder den för att gruppera brevlådor och skapa webbapplänkar.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringobligatorisk

  format: "email"

• display_namestringobligatorisk
• providerstringobligatorisk

  enum: "gmail", "smtp"

• statusstringobligatorisk

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringobligatorisk

  enum: "domain", "starter"

curl-exempel

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

Återuppta en brevlåda som pausats för avsändarrykte enligt självbetjäningsreglerna i resumeSending.

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp obligatorisk

application/json

• valueobject

  Inga ytterligare egenskaper

• acknowledge_recipient_complaintbooleanobligatorisk

  const: true

• reasonstring

  Varför sändning återställs; registreras i granskningsloggen.

  maxLength: 500

Framgångsrikt svar 200

Brevlådan återaktiverad eller redan aktiv efter ett tidigare lyckat anrop.

application/json

• valueobject
• dataobjectobligatorisk
• idstringobligatorisk

  format: "uuid"

• workspace_idstringobligatorisk

  format: "uuid"

• product_idstring | null

  Produkten (projektet) brevlådan tillhör. Klienter använder den för att gruppera brevlådor och skapa webbapplänkar.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringobligatorisk

  format: "email"

• display_namestringobligatorisk
• providerstringobligatorisk

  enum: "gmail", "smtp"

• statusstringobligatorisk

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringobligatorisk

  enum: "domain", "starter"

curl-exempel

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

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp

Ingen anropskropp anges i kontraktet.

Framgångsrikt svar 200

Framgångsrikt svar.

application/json

• valueobject
• dataarrayobligatorisk
• Varje objektobject
• idstringobligatorisk

  format: "uuid"

• mailbox_idstringobligatorisk

  format: "uuid"

• thread_idstring | nullobligatorisk

  format: "uuid"

• versionintegerobligatorisk
• toarrayobligatorisk
• Varje objektobject
• emailstringobligatorisk
• namestring
• ccarrayobligatorisk
• Varje objektobject
• emailstringobligatorisk
• namestring
• bccarrayobligatorisk
• Varje objektobject
• emailstringobligatorisk
• namestring
• subjectstringobligatorisk
• body_textstringobligatorisk
• statusstringobligatorisk
• created_atstringobligatorisk

  format: "date-time"

• updated_atstringobligatorisk

  format: "date-time"

• attachmentsarrayobligatorisk
• Varje objektobject
• idstringobligatorisk

  format: "uuid"

• filenamestringobligatorisk
• content_typestringobligatorisk
• size_bytesintegerobligatorisk
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

curl-exempel

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

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp obligatorisk

application/json

• valueobject

  Inga ytterligare egenskaper

• mailbox_idstringobligatorisk

  format: "uuid"

• thread_idstring

  format: "uuid"

• toarray

  maxItems: 500

• Varje objektobject
• namestring
• emailstringobligatorisk

  format: "email"

• ccarray

  maxItems: 500

• Varje objektobject
• namestring
• emailstringobligatorisk

  format: "email"

• bccarray

  maxItems: 500

• Varje objektobject
• namestring
• emailstringobligatorisk

  format: "email"

• subjectstring

  maxLength: 10000

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

Framgångsrikt svar 201

Framgångsrikt svar.

application/json

• valueobject
• dataobjectobligatorisk
• idstringobligatorisk

  format: "uuid"

• mailbox_idstringobligatorisk

  format: "uuid"

• thread_idstring | nullobligatorisk

  format: "uuid"

• versionintegerobligatorisk
• toarrayobligatorisk
• Varje objektobject
• emailstringobligatorisk
• namestring
• ccarrayobligatorisk
• Varje objektobject
• emailstringobligatorisk
• namestring
• bccarrayobligatorisk
• Varje objektobject
• emailstringobligatorisk
• namestring
• subjectstringobligatorisk
• body_textstringobligatorisk
• statusstringobligatorisk
• created_atstringobligatorisk

  format: "date-time"

• updated_atstringobligatorisk

  format: "date-time"

• attachmentsarrayobligatorisk
• Varje objektobject
• idstringobligatorisk

  format: "uuid"

• filenamestringobligatorisk
• content_typestringobligatorisk
• size_bytesintegerobligatorisk
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

curl-exempel

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

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp

Ingen anropskropp anges i kontraktet.

Framgångsrikt svar 200

Kanoniska leveransresultat, hälsa och incidenter.

application/json

• valueobject
• dataobjectobligatorisk
• idstringobligatorisk

  format: "uuid"

• mailbox_idstringobligatorisk

  format: "uuid"

• thread_idstring | nullobligatorisk

  format: "uuid"

• versionintegerobligatorisk
• toarrayobligatorisk
• Varje objektobject
• emailstringobligatorisk
• namestring
• ccarrayobligatorisk
• Varje objektobject
• emailstringobligatorisk
• namestring
• bccarrayobligatorisk
• Varje objektobject
• emailstringobligatorisk
• namestring
• subjectstringobligatorisk
• body_textstringobligatorisk
• statusstringobligatorisk
• created_atstringobligatorisk

  format: "date-time"

• updated_atstringobligatorisk

  format: "date-time"

• attachmentsarrayobligatorisk
• Varje objektobject
• idstringobligatorisk

  format: "uuid"

• filenamestringobligatorisk
• content_typestringobligatorisk
• size_bytesintegerobligatorisk
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

curl-exempel

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

updateDraft

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp obligatorisk

application/json

• valueinte angivet
• allOf 1object

  Inga ytterligare egenskaper

• mailbox_idstringobligatorisk

  format: "uuid"

• thread_idstring

  format: "uuid"

• toarray

  maxItems: 500

• Varje objektobject
• namestring
• emailstringobligatorisk

  format: "email"

• ccarray

  maxItems: 500

• Varje objektobject
• namestring
• emailstringobligatorisk

  format: "email"

• bccarray

  maxItems: 500

• Varje objektobject
• namestring
• emailstringobligatorisk

  format: "email"

• subjectstring

  maxLength: 10000

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

• allOf 2object
• versionintegerobligatorisk

  minimum: 1

Framgångsrikt svar 200

Framgångsrikt svar.

application/json

• valueobject
• dataobjectobligatorisk
• idstringobligatorisk

  format: "uuid"

• mailbox_idstringobligatorisk

  format: "uuid"

• thread_idstring | nullobligatorisk

  format: "uuid"

• versionintegerobligatorisk
• toarrayobligatorisk
• Varje objektobject
• emailstringobligatorisk
• namestring
• ccarrayobligatorisk
• Varje objektobject
• emailstringobligatorisk
• namestring
• bccarrayobligatorisk
• Varje objektobject
• emailstringobligatorisk
• namestring
• subjectstringobligatorisk
• body_textstringobligatorisk
• statusstringobligatorisk
• created_atstringobligatorisk

  format: "date-time"

• updated_atstringobligatorisk

  format: "date-time"

• attachmentsarrayobligatorisk
• Varje objektobject
• idstringobligatorisk

  format: "uuid"

• filenamestringobligatorisk
• content_typestringobligatorisk
• size_bytesintegerobligatorisk
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

curl-exempel

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

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp

Ingen anropskropp anges i kontraktet.

Framgångsrikt svar 204

Utkast och refererade objekt schemalagda för borttagning.

Ingen svarskropp.

curl-exempel

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

sendDraft

Skickar utkastet från dess brevlåda, som anroparen måste ha åtkomst till. En anropare vars sändningar kräver godkännande får ett väntande godkännande i stället; en person som får skicka utkastet direkt beslutar.

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp

Ingen anropskropp anges i kontraktet.

Framgångsrikt svar 202

Sändningen är köad eller väntar på godkännande.

application/json

• valueobject
• datainte angivetobligatorisk
• oneOf 1object
• idstringobligatorisk

  format: "uuid"

• typestringobligatorisk
• statusstringobligatorisk

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

• workspace_revisionintegerobligatorisk

  format: "int64"

• created_atstringobligatorisk

  format: "date-time"

• oneOf 2object

  Inga ytterligare egenskaper

• approvalobjectobligatorisk
• idstringobligatorisk

  format: "uuid"

• requested_by_actor_idstringobligatorisk
• action_kindstringobligatorisk
• summarystringobligatorisk
• capability_scopesarrayobligatorisk
• Varje objektstring
• resource_scopeobjectobligatorisk
• Ytterligare egenskaparray
• Varje objektstring

  Ytterligare nästling utelämnad

• payloadobjectobligatorisk
• Ytterligare egenskapValfritt värde
• payload_sha256stringobligatorisk

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

• statusstringobligatorisk

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

• missedbooleanobligatorisk
• expires_atstringobligatorisk

  format: "date-time"

• decided_by_actor_idstring | null
• decision_reasonstring | null
• created_atstringobligatorisk

  format: "date-time"

• updated_atstringobligatorisk

  format: "date-time"

• decided_atstring | null

  format: "date-time"

• execution_job_idstring

  format: "uuid"

• reviewobject

  Inga ytterligare egenskaper

• dispositionstringobligatorisk

  enum: "automatic", "human_required"

• recipient_countinteger | nullobligatorisk

  minimum: 0

• reasonsarrayobligatorisk
• Varje objektstring

  Ytterligare nästling utelämnad

• checksarrayobligatorisk
• Varje objektstring

  Ytterligare nästling utelämnad

curl-exempel

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

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp obligatorisk

application/octet-stream

• valuestring

  format: "binary" · maxLength: 26214400

Framgångsrikt svar 201

Framgångsrikt svar.

application/json

• valueobject
• dataobjectobligatorisk
• idstringobligatorisk

  format: "uuid"

• filenamestringobligatorisk
• content_typestringobligatorisk
• size_bytesintegerobligatorisk
• sha256string
• created_atstring

  format: "date-time"

curl-exempel

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

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp

Ingen anropskropp anges i kontraktet.

Framgångsrikt svar 204

Bilaga schemalagd för versionsmedveten B2-borttagning.

Ingen svarskropp.

curl-exempel

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

Läs ett utkasts HTML-kropp

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp

Ingen anropskropp anges i kontraktet.

Framgångsrikt svar 200

Utkastets HTML.

text/html

• valuestring

curl-exempel

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

listSendIntents

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp

Ingen anropskropp anges i kontraktet.

Framgångsrikt svar 200

Senaste kanoniska sändningar och deras leverantörsstatus.

application/json

• valueobject
• dataarrayobligatorisk
• Varje objektobject

  Inga ytterligare egenskaper

• idstringobligatorisk

  format: "uuid"

• statusstringobligatorisk

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

• traffic_classstringobligatorisk

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

• recipient_countintegerobligatorisk

  minimum: 1

• provider_keystringobligatorisk
• provider_statestringobligatorisk

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

• provider_message_idstring | null
• error_codestring | null
• created_atstringobligatorisk

  format: "date-time"

• updated_atstringobligatorisk

  format: "date-time"

• completed_atstring | null

  format: "date-time"

curl-exempel

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

getSendIntent

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp

Ingen anropskropp anges i kontraktet.

Framgångsrikt svar 200

Kanonisk asynkron sändningsstatus.

application/json

• valueobject
• dataobjectobligatorisk

  Inga ytterligare egenskaper

• idstringobligatorisk

  format: "uuid"

• statusstringobligatorisk

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

• traffic_classstringobligatorisk

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

• recipient_countintegerobligatorisk

  minimum: 1

• provider_keystringobligatorisk
• provider_statestringobligatorisk

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

• provider_message_idstring | null
• error_codestring | null
• created_atstringobligatorisk

  format: "date-time"

• updated_atstringobligatorisk

  format: "date-time"

• completed_atstring | null

  format: "date-time"

curl-exempel

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

listTransactionalSends

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp

Ingen anropskropp anges i kontraktet.

Framgångsrikt svar 200

Framgångsrikt svar.

application/json

• valueobject
• dataarrayobligatorisk
• Varje objektobject
• idstringobligatorisk

  format: "uuid"

• mailbox_idstring | nullobligatorisk

  format: "uuid"

• command_idstring | nullobligatorisk

  format: "uuid"

• statusstringobligatorisk
• command_statusstring | nullobligatorisk
• subjectstring
• recipientsarray
• Varje objektobject
• emailstringobligatorisk
• namestring
• recipient_countintegerobligatorisk
• error_codestring | null
• send_intent_idstring

  format: "uuid"

• providerstring | null
• route_kindstring | null
• sourcestring
• from_addressstring
• recipient_statesobject
• Ytterligare egenskapinteger
• provider_message_idstring | null
• languageinte angivet

  Språket detta mejl skickades på; null om det inte översattes.

• anyOf 1object

  Språket en person fick ett mejl på. Bara översatta mejl (hanterat innehåll) har ett.

• localestringobligatorisk

  BCP 47-tagg för språket mejlet skrevs på.

• requested_localestring

  Finns bara på en äldre sändning som gick ut på ett annat språk: språket personen skulle ha fått.

• fallback_reasonstring

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

• anyOf 2null
• journeyobject | null

  Flödessteget och registreringen som skickade detta mejl; null för andra sändningar.

• journey_idstringobligatorisk

  format: "uuid"

• step_idstringobligatorisk

  format: "uuid"

• enrollment_idstringobligatorisk

  format: "uuid"

• experimentobject | null

  Experimentvarianten för detta mejl; null när ingen användes.

• experiment_idstringobligatorisk

  format: "uuid"

• variant_keystringobligatorisk
• created_atstringobligatorisk

  format: "date-time"

• updated_atstringobligatorisk

  format: "date-time"

• completed_atstring | nullobligatorisk

  format: "date-time"

• template_idstring | null

  format: "uuid"

• template_versioninteger | null
• workspace_revisioninteger | null
• command_resultobject
• Ytterligare egenskapValfritt värde
• command_started_atstring | null

  format: "date-time"

• command_completed_atstring | null

  format: "date-time"

• body_textstring
• body_htmlstring
• reply_toarray
• Varje objektobject
• emailstringobligatorisk
• namestring
• headersobject
• Ytterligare egenskapstring
• tagsarray
• Varje objektobject
• namestringobligatorisk
• valuestringobligatorisk

curl-exempel

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

createTransactionalSend

En mottagare per flödessändning. To tar en mottagare i valfri RecipientInput-form ("a@example.com", "Pat <a@example.com>", { email, name } eller en lista med ett element); Cc och Bcc måste vara tomma. reply_to är flödets brevlåda som standard (en tom lista betyder också standard); Produktmejl kräver exakt en. Ett nytt API-flöde använder hanterat källinnehåll som standard; äldre kodflöden behåller sändningar med komplett innehåll. Ett avslag (4xx) fryser inget för mottagaren, så ett korrigerat anrop med en ny idempotensnyckel skickar.

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp obligatorisk

application/json

• valueobject
• mailbox_idstringobligatorisk

  format: "uuid"

• tointe angivetobligatorisk

  Mottagare för to, cc, bcc och reply_to: en adress ("a@example.com" eller "Pat <a@example.com>"), ett { email, name }-objekt eller en lista som blandar båda. Banger lagrar dem som { email, name }-objekt med e-postadressen i gemener. Idempotenshashen omfattar kroppen som skickad, så försök igen med samma form.

• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringobligatorisk

  format: "email"

• oneOf 3array

  maxItems: 500

• Varje objektinte angivet
• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringobligatorisk

  format: "email"

• ccarray

  maxItems: 0

• Varje objektobject
• namestring
• emailstringobligatorisk

  format: "email"

• bccarray

  maxItems: 0

• Varje objektobject
• namestring
• emailstringobligatorisk

  format: "email"

• subjectstring

  maxLength: 10000

• expires_atstring

  Kasta en uppskjuten flödessändning efter denna tidpunkt; högst sju dagar från det ursprungliga anropet.

  format: "date-time"

• expires_after_secondsinteger

  minimum: 1 · maximum: 604800

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

• reply_tointe angivet

  Mottagare för to, cc, bcc och reply_to: en adress ("a@example.com" eller "Pat <a@example.com>"), ett { email, name }-objekt eller en lista som blandar båda. Banger lagrar dem som { email, name }-objekt med e-postadressen i gemener. Idempotenshashen omfattar kroppen som skickad, så försök igen med samma form.

• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringobligatorisk

  format: "email"

• oneOf 3array

  maxItems: 500

• Varje objektinte angivet
• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringobligatorisk

  format: "email"

• headersobject
• Ytterligare egenskapstring

  maxLength: 5000

• tagsarray

  maxItems: 49

• Varje objektobject

  Inga ytterligare egenskaper

• namestringobligatorisk

  minLength: 1 · maxLength: 256

• valuestringobligatorisk

  minLength: 1 · maxLength: 256

Framgångsrikt svar 202

Framgångsrikt svar.

application/json

• valueobject
• dataobjectobligatorisk
• action_kindstringobligatorisk

  enum: "transactional.send"

• idstring

  format: "uuid"

• send_intent_idstring

  format: "uuid"

• provider_attempt_idstring

  format: "uuid"

• statusstringobligatorisk

  sent/queued-status från leveransen eller, för ett fryst anrop: deferred (schemalagt av policy eller väntar på översättning), processing (skickas), discarded.

• replayedboolean
• journeyinte angivetobligatorisk
• anyOf 1object
• journey_idstringobligatorisk

  format: "uuid"

• enrollment_idstringobligatorisk

  format: "uuid"

• step_idstringobligatorisk

  format: "uuid"

• step_positionintegerobligatorisk
• originstring

  enum: "journey"

• journey_identitystring
• anyOf 2null
• ignored_variablesarrayobligatorisk
• Varje objektstring
• scheduled_atstring

  format: "date-time"

• reasonstring
• communication_reservation_idstring

  format: "uuid"

curl-exempel

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

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp

Ingen anropskropp anges i kontraktet.

Framgångsrikt svar 200

Framgångsrikt svar.

application/json

• valueobject
• dataobjectobligatorisk
• idstringobligatorisk

  format: "uuid"

• mailbox_idstring | nullobligatorisk

  format: "uuid"

• command_idstring | nullobligatorisk

  format: "uuid"

• statusstringobligatorisk
• command_statusstring | nullobligatorisk
• subjectstring
• recipientsarray
• Varje objektobject
• emailstringobligatorisk
• namestring
• recipient_countintegerobligatorisk
• error_codestring | null
• send_intent_idstring

  format: "uuid"

• providerstring | null
• route_kindstring | null
• sourcestring
• from_addressstring
• recipient_statesobject
• Ytterligare egenskapinteger
• provider_message_idstring | null
• languageinte angivet

  Språket detta mejl skickades på; null om det inte översattes.

• anyOf 1object

  Språket en person fick ett mejl på. Bara översatta mejl (hanterat innehåll) har ett.

• localestringobligatorisk

  BCP 47-tagg för språket mejlet skrevs på.

• requested_localestring

  Finns bara på en äldre sändning som gick ut på ett annat språk: språket personen skulle ha fått.

• fallback_reasonstring

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

• anyOf 2null
• journeyobject | null

  Flödessteget och registreringen som skickade detta mejl; null för andra sändningar.

• journey_idstringobligatorisk

  format: "uuid"

• step_idstringobligatorisk

  format: "uuid"

• enrollment_idstringobligatorisk

  format: "uuid"

• experimentobject | null

  Experimentvarianten för detta mejl; null när ingen användes.

• experiment_idstringobligatorisk

  format: "uuid"

• variant_keystringobligatorisk
• created_atstringobligatorisk

  format: "date-time"

• updated_atstringobligatorisk

  format: "date-time"

• completed_atstring | nullobligatorisk

  format: "date-time"

• template_idstring | null

  format: "uuid"

• template_versioninteger | null
• workspace_revisioninteger | null
• command_resultobject
• Ytterligare egenskapValfritt värde
• command_started_atstring | null

  format: "date-time"

• command_completed_atstring | null

  format: "date-time"

• body_textstring
• body_htmlstring
• reply_toarray
• Varje objektobject
• emailstringobligatorisk
• namestring
• headersobject
• Ytterligare egenskapstring
• tagsarray
• Varje objektobject
• namestringobligatorisk
• valuestringobligatorisk

curl-exempel

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

listTransactionalSendTimeline

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp

Ingen anropskropp anges i kontraktet.

Framgångsrikt svar 200

Ordnad tidslinje för acceptans, leverantörsförsök och mottagarhändelser.

application/json

• valueobject
• dataarrayobligatorisk
• Varje objektobject
• occurred_atstringobligatorisk

  format: "date-time"

• event_typestringobligatorisk
• labelstringobligatorisk
• providerstring | null
• recipient_domainstring | null
• error_codestring | null

curl-exempel

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

retryTransactionalSend

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp

Ingen anropskropp anges i kontraktet.

Framgångsrikt svar 202

Framgångsrikt svar.

application/json

• valueobject
• dataobjectobligatorisk
• action_kindstringobligatorisk

  enum: "transactional.send"

• idstringobligatorisk

  format: "uuid"

• send_intent_idstringobligatorisk

  format: "uuid"

• provider_attempt_idstringobligatorisk

  format: "uuid"

• statusstringobligatorisk
• replayedbooleanobligatorisk

curl-exempel

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

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp

Ingen anropskropp anges i kontraktet.

Framgångsrikt svar 200

Arbetsytans trådar med keyset-sidindelning.

application/json

• valueobject
• dataarrayobligatorisk
• Varje objektobject
• idstringobligatorisk

  format: "uuid"

• mailbox_idstringobligatorisk

  format: "uuid"

• subjectstringobligatorisk
• snippetstringobligatorisk
• last_message_atstringobligatorisk

  format: "date-time"

• message_countintegerobligatorisk
• unread_countintegerobligatorisk
• is_archivedbooleanobligatorisk
• is_trashbooleanobligatorisk
• is_spambooleanobligatorisk
• is_starredbooleanobligatorisk
• is_sentbooleanobligatorisk
• has_attachmentsbooleanobligatorisk
• labelsarrayobligatorisk
• Varje objektstring
• participantsarray
• Varje objektobject
• namestring
• emailstringobligatorisk

  format: "email"

• pageobjectobligatorisk
• next_cursorstring
• has_morebooleanobligatorisk

curl-exempel

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

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp

Ingen anropskropp anges i kontraktet.

Framgångsrikt svar 200

Tråd och ordnade meddelanden.

application/json

• valueobject
• datainte angivetobligatorisk
• allOf 1object
• idstringobligatorisk

  format: "uuid"

• mailbox_idstringobligatorisk

  format: "uuid"

• subjectstringobligatorisk
• snippetstringobligatorisk
• last_message_atstringobligatorisk

  format: "date-time"

• message_countintegerobligatorisk
• unread_countintegerobligatorisk
• is_archivedbooleanobligatorisk
• is_trashbooleanobligatorisk
• is_spambooleanobligatorisk
• is_starredbooleanobligatorisk
• is_sentbooleanobligatorisk
• has_attachmentsbooleanobligatorisk
• labelsarrayobligatorisk
• Varje objektstring
• participantsarray
• Varje objektobject
• namestring
• emailstringobligatorisk

  format: "email"

• allOf 2object
• messagesarrayobligatorisk
• Varje objektobject
• idstringobligatorisk

  format: "uuid"

• mailbox_idstringobligatorisk

  format: "uuid"

• thread_idstringobligatorisk

  format: "uuid"

• sent_atstringobligatorisk

  format: "date-time"

• received_atstring

  format: "date-time"

• envelope_recipientsarray

  Ursprungliga SMTP-kuvertmottagare, normaliserade för skiftläge av SMTP-gränsen, före routning av alias endast för mottagning. Tomt för äldre meddelanden eller källor utan SMTP. Oberoende av synliga To/Cc-headers.

• Varje objektstring

  format: "email"

  Ytterligare nästling utelämnad

• fromobjectobligatorisk
• namestring

  Ytterligare nästling utelämnad

• emailstringobligatorisk

  format: "email"

  Ytterligare nästling utelämnad

• toarrayobligatorisk
• Varje objektobject

  Ytterligare nästling utelämnad

• ccarray
• Varje objektobject

  Ytterligare nästling utelämnad

• reply_toarray
• Varje objektobject

  Ytterligare nästling utelämnad

• is_sentboolean

  Om detta meddelande skickades av brevlådan, även från ett alias.

• body_textstring
• body_html_urlstring

  format: "uri"

• reply_originobject
• send_intent_idstringobligatorisk

  format: "uuid"

  Ytterligare nästling utelämnad

• sourcestringobligatorisk

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

  Ytterligare nästling utelämnad

• source_idstring

  format: "uuid"

  Ytterligare nästling utelämnad

• traffic_classstringobligatorisk

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

  Ytterligare nästling utelämnad

• kindstringobligatorisk

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

  Ytterligare nästling utelämnad

• namestring

  Ytterligare nästling utelämnad

• has_attachmentsbooleanobligatorisk
• attachmentsarray
• Varje objektobject

  Ytterligare nästling utelämnad

curl-exempel

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

getMessageHtml

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp

Ingen anropskropp anges i kontraktet.

Framgångsrikt svar 200

Autentiserad HTML-meddelandekropp med sandboxbegränsningar.

text/html

• valuestring

curl-exempel

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

downloadAttachment

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp

Ingen anropskropp anges i kontraktet.

Framgångsrikt svar 200

Autentiserad bilageström.

application/octet-stream

• valuestring

  format: "binary"

curl-exempel

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

searchMail

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp

Ingen anropskropp anges i kontraktet.

Framgångsrikt svar 200

Sökresultat för hela arbetsytan.

application/json

• valueobject
• dataarrayobligatorisk
• Varje objektobject
• idstringobligatorisk

  format: "uuid"

• mailbox_idstringobligatorisk

  format: "uuid"

• subjectstringobligatorisk
• snippetstringobligatorisk
• last_message_atstringobligatorisk

  format: "date-time"

• message_countintegerobligatorisk
• unread_countintegerobligatorisk
• is_archivedbooleanobligatorisk
• is_trashbooleanobligatorisk
• is_spambooleanobligatorisk
• is_starredbooleanobligatorisk
• is_sentbooleanobligatorisk
• has_attachmentsbooleanobligatorisk
• labelsarrayobligatorisk
• Varje objektstring
• participantsarray
• Varje objektobject
• namestring
• emailstringobligatorisk

  format: "email"

• pageobjectobligatorisk
• next_cursorstring
• has_morebooleanobligatorisk

curl-exempel

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

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp

Ingen anropskropp anges i kontraktet.

Framgångsrikt svar 200

Framgångsrikt svar.

application/json

• valueobject
• dataarrayobligatorisk
• Varje objektobject
• idstringobligatorisk

  format: "uuid"

• emailstringobligatorisk

  format: "email"

• display_namestring | nullobligatorisk
• attributesobjectobligatorisk
• Ytterligare egenskapValfritt värde
• statusstringobligatorisk

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

• created_atstringobligatorisk

  format: "date-time"

• updated_atstringobligatorisk

  format: "date-time"

• pageobjectobligatorisk
• next_cursorstring
• has_morebooleanobligatorisk

curl-exempel

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

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp obligatorisk

application/json

• valueobject

  Inga ytterligare egenskaper

• emailstringobligatorisk

  format: "email"

• display_namestring

  maxLength: 1000

• statusstringobligatorisk

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

• attributesobject
• Ytterligare egenskapValfritt värde
• consent_confirmedboolean

  Krävs när en adress börjar prenumerera.

Framgångsrikt svar 201

Framgångsrikt svar.

application/json

• valueobject
• dataobjectobligatorisk
• idstringobligatorisk

  format: "uuid"

• emailstringobligatorisk

  format: "email"

• display_namestring | nullobligatorisk
• attributesobjectobligatorisk
• Ytterligare egenskapValfritt värde
• statusstringobligatorisk

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

• created_atstringobligatorisk

  format: "date-time"

• updated_atstringobligatorisk

  format: "date-time"

curl-exempel

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

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp

Ingen anropskropp anges i kontraktet.

Framgångsrikt svar 200

Framgångsrikt svar.

application/json

• valueobject
• dataobjectobligatorisk
• idstringobligatorisk

  format: "uuid"

• emailstringobligatorisk

  format: "email"

• display_namestring | nullobligatorisk
• attributesobjectobligatorisk
• Ytterligare egenskapValfritt värde
• statusstringobligatorisk

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

• created_atstringobligatorisk

  format: "date-time"

• updated_atstringobligatorisk

  format: "date-time"

• suppressedbooleanobligatorisk
• suppression_reasonstring | nullobligatorisk
• sourcesarrayobligatorisk
• Varje objektobject
• kindstringobligatorisk
• referencestringobligatorisk
• connection_idstring | nullobligatorisk

  format: "uuid"

• metadataobjectobligatorisk
• Ytterligare egenskapValfritt värde
• first_seen_atstringobligatorisk

  format: "date-time"

• last_seen_atstringobligatorisk

  format: "date-time"

• listsarrayobligatorisk
• Varje objektobject
• idstringobligatorisk

  format: "uuid"

• namestringobligatorisk
• subscription_statusstringobligatorisk
• consent_evidencearrayobligatorisk
• Varje objektobject
• kindstringobligatorisk
• referencestringobligatorisk
• connection_idstring | nullobligatorisk

  format: "uuid"

• metadataobjectobligatorisk
• Ytterligare egenskapValfritt värde
• first_seen_atstringobligatorisk

  format: "date-time"

• last_seen_atstringobligatorisk

  format: "date-time"

curl-exempel

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

deleteContact

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp

Ingen anropskropp anges i kontraktet.

Framgångsrikt svar 204

Kontakt borttagen.

Ingen svarskropp.

curl-exempel

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

listContactImports

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp

Ingen anropskropp anges i kontraktet.

Framgångsrikt svar 200

Framgångsrikt svar.

application/json

• valueobject
• dataarrayobligatorisk
• Varje objektobject
• idstring

  format: "uuid"

• filenamestring
• list_idstring | null

  format: "uuid"

• list_namestring | null
• statusstring
• total_rowsinteger
• imported_rowsinteger
• invalid_rowsinteger
• error_summaryarray
• Varje objektstring
• 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-exempel

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

importContacts

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp obligatorisk

application/json

• valueobject
• filenamestringobligatorisk

  minLength: 1 · maxLength: 500

• list_idstring

  format: "uuid"

• consent_confirmedboolean

  Krävs när någon importerad rad prenumererar.

• rowsarrayobligatorisk

  minItems: 1 · maxItems: 5000

• Varje objektobject
• emailstringobligatorisk

  format: "email"

• display_namestring

  maxLength: 1000

• statusstring

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

• attributesobject
• Ytterligare egenskapValfritt värde

Framgångsrikt svar 201

Framgångsrikt svar.

application/json

• valueobject
• dataobjectobligatorisk
• idstringobligatorisk

  format: "uuid"

• statusstringobligatorisk

  enum: "queued"

• total_rowsintegerobligatorisk
• imported_rowsintegerobligatorisk
• invalid_rowsintegerobligatorisk
• list_idstring | nullobligatorisk

  format: "uuid"

curl-exempel

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

Slå samman typade attribut utan att ändra prenumeration eller samtycke

Kräver contacts:write och contacts:read. Uppdaterar bara en befintlig kontakt. Utelämnade attribut bevaras, explicit false lagras och null tar bort ett fält. Ange verifierade källfakta; saknade data är inte false. Prenumeration, spärr, identitet och källhistorik ändras inte.

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp obligatorisk

application/json

• valueobject

  Inga ytterligare egenskaper

• attributesobjectobligatorisk
• Ytterligare egenskapValfritt värde

Framgångsrikt svar 200

Aktuell återläsning av kontakten; replayed är true när ändringen redan har tillämpats.

application/json

• valueobject
• dataobjectobligatorisk
• idstringobligatorisk

  format: "uuid"

• attributesobjectobligatorisk
• Ytterligare egenskapValfritt värde
• statusstringobligatorisk

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

• replayedbooleanobligatorisk
• Ytterligare egenskapValfritt värde

curl-exempel

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

Autentisering: arbetsytans Bearer-API-nyckel.

Parametrar

Anropskropp obligatorisk

application/json

• valueobject

  Inga ytterligare egenskaper

• emailstringobligatorisk

  format: "email" · maxLength: 320

• display_namestring

  minLength: 0 · maxLength: 1000

• attributesobject
• Ytterligare egenskapValfritt värde
• statusstringobligatorisk

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

• consent_evidenceobject

  Inga ytterligare egenskaper

• sourcestring

  minLength: 1 · maxLength: 2000

• referencestring

  minLength: 1 · maxLength: 2000

• observed_atstring

  format: "date-time"

• statementstring

  minLength: 1 · maxLength: 2000

• consent_confirmedboolean

Framgångsrikt svar 200

Kanonisk återläsning eller idempotent kvitto. Leverantörsacceptans är sent; delivered kräver en leveranshändelse och bevisar inte inkorgsplacering.

application/json

• valueobject
• datainte angivetobligatorisk
• allOf 1object
• idstringobligatorisk

  format: "uuid"

• emailstringobligatorisk

  format: "email"

• display_namestring | nullobligatorisk
• attributesobjectobligatorisk
• Ytterligare egenskapValfritt värde
• statusstringobligatorisk

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

• created_atstringobligatorisk

  format: "date-time"

• updated_atstringobligatorisk

  format: "date-time"

• suppressedbooleanobligatorisk
• suppression_reasonstring | nullobligatorisk
• sourcesarrayobligatorisk
• Varje objektobject
• kindstringobligatorisk
• referencestringobligatorisk
• connection_idstring | nullobligatorisk

  format: "uuid"

• metadataobjectobligatorisk
• Ytterligare egenskapValfritt värde
• first_seen_atstringobligatorisk

  format: "date-time"

• last_seen_atstringobligatorisk

  format: "date-time"

• listsarrayobligatorisk
• Varje objektobject
• idstringobligatorisk

  format: "uuid"

• namestringobligatorisk
• subscription_statusstringobligatorisk
• consent_evidencearrayobligatorisk
• Varje objektobject
• kindstringobligatorisk
• referencestringobligatorisk
• connection_idstring | nullobligatorisk

  format: "uuid"

• metadataobjectobligatorisk
• Ytterligare egenskapValfritt värde
• first_seen_atstringobligatorisk

  format: "date-time"

• last_seen_atstringobligatorisk

  format: "date-time"

• allOf 2object
• replayedbooleanobligatorisk