Banger API 레퍼런스

워크스페이스 제품 목록 조회

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문

계약에 요청 본문이 지정돼 있지 않아요.

성공 응답 200

성공 응답.

application/json

• valueobject
• dataarray필수
• 각 항목object
• idstring필수

  format: "uuid"

• workspace_idstring필수

  format: "uuid"

• namestring필수
• slugstring필수
• kindstring필수

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

• website_urlstring | null필수
• domainsarray필수
• 각 항목string
• descriptionstring필수
• contextobject필수
• 추가 속성모든 값
• brandobject필수
• company_namestring

  maxLength: 160

• logo_urlstring

  아이콘: 마크 단독으로 이메일 바닥글, 슬라이드인 양식에 작게 쓰거나 워드마크가 없을 때 헤더로 사용해요.

  maxLength: 2000

• wordmark_urlstring

  워드마크: 디자인된 회사 이름으로 모든 이메일 상단에 단독으로 표시돼요.

  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필수

  deleting: 사람이 삭제했으며 delete_after까지 복구할 수 있고 이후 영구 삭제돼요.

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

• delete_afterstring | null

  deleting 상태인 제품이 영구 삭제되는 시점.

  format: "date-time"

• is_defaultboolean필수
• route_readyboolean필수
• setuparray필수
• 각 항목object
• keystring필수

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

• statusstring필수

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

• completion_sourcestring | null필수

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

• notestring필수
• updated_atstring | null필수

  format: "date-time"

• created_atstring필수

  format: "date-time"

• updated_atstring필수

  format: "date-time"

curl 예제

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

제품 만들기

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문 필수

application/json

• valueobject
• namestring필수

  minLength: 1 · maxLength: 160

• kindstring

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

• website_urlstring | null

  maxLength: 2000

• descriptionstring

  maxLength: 4000

• contextobject
• 추가 속성모든 값
• domainsarray

  maxItems: 20

• 각 항목string

  maxLength: 253

성공 응답 201

성공 응답.

application/json

• valueobject
• dataobject필수
• idstring필수

  format: "uuid"

• workspace_idstring필수

  format: "uuid"

• namestring필수
• slugstring필수
• kindstring필수

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

• website_urlstring | null필수
• domainsarray필수
• 각 항목string
• descriptionstring필수
• contextobject필수
• 추가 속성모든 값
• brandobject필수
• company_namestring

  maxLength: 160

• logo_urlstring

  아이콘: 마크 단독으로 이메일 바닥글, 슬라이드인 양식에 작게 쓰거나 워드마크가 없을 때 헤더로 사용해요.

  maxLength: 2000

• wordmark_urlstring

  워드마크: 디자인된 회사 이름으로 모든 이메일 상단에 단독으로 표시돼요.

  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필수

  deleting: 사람이 삭제했으며 delete_after까지 복구할 수 있고 이후 영구 삭제돼요.

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

• delete_afterstring | null

  deleting 상태인 제품이 영구 삭제되는 시점.

  format: "date-time"

• is_defaultboolean필수
• route_readyboolean필수
• setuparray필수
• 각 항목object
• keystring필수

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

• statusstring필수

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

• completion_sourcestring | null필수

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

• notestring필수
• updated_atstring | null필수

  format: "date-time"

• created_atstring필수

  format: "date-time"

• updated_atstring필수

  format: "date-time"

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

제품 조회

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문

계약에 요청 본문이 지정돼 있지 않아요.

성공 응답 200

성공 응답.

application/json

• valueobject
• dataobject필수
• idstring필수

  format: "uuid"

• workspace_idstring필수

  format: "uuid"

• namestring필수
• slugstring필수
• kindstring필수

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

• website_urlstring | null필수
• domainsarray필수
• 각 항목string
• descriptionstring필수
• contextobject필수
• 추가 속성모든 값
• brandobject필수
• company_namestring

  maxLength: 160

• logo_urlstring

  아이콘: 마크 단독으로 이메일 바닥글, 슬라이드인 양식에 작게 쓰거나 워드마크가 없을 때 헤더로 사용해요.

  maxLength: 2000

• wordmark_urlstring

  워드마크: 디자인된 회사 이름으로 모든 이메일 상단에 단독으로 표시돼요.

  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필수

  deleting: 사람이 삭제했으며 delete_after까지 복구할 수 있고 이후 영구 삭제돼요.

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

• delete_afterstring | null

  deleting 상태인 제품이 영구 삭제되는 시점.

  format: "date-time"

• is_defaultboolean필수
• route_readyboolean필수
• setuparray필수
• 각 항목object
• keystring필수

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

• statusstring필수

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

• completion_sourcestring | null필수

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

• notestring필수
• updated_atstring | null필수

  format: "date-time"

• created_atstring필수

  format: "date-time"

• updated_atstring필수

  format: "date-time"

curl 예제

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

제품 업데이트

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문 필수

application/json

• valueobject
• namestring

  maxLength: 160

• kindstring

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

• website_urlstring | null

  maxLength: 2000

• descriptionstring

  maxLength: 4000

• contextobject
• 추가 속성모든 값
• brandobject
• company_namestring

  maxLength: 160

• logo_urlstring

  아이콘: 마크 단독으로 이메일 바닥글, 슬라이드인 양식에 작게 쓰거나 워드마크가 없을 때 헤더로 사용해요.

  maxLength: 2000

• wordmark_urlstring

  워드마크: 디자인된 회사 이름으로 모든 이메일 상단에 단독으로 표시돼요.

  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"

성공 응답 200

성공 응답.

application/json

• valueobject
• dataobject필수
• idstring필수

  format: "uuid"

• workspace_idstring필수

  format: "uuid"

• namestring필수
• slugstring필수
• kindstring필수

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

• website_urlstring | null필수
• domainsarray필수
• 각 항목string
• descriptionstring필수
• contextobject필수
• 추가 속성모든 값
• brandobject필수
• company_namestring

  maxLength: 160

• logo_urlstring

  아이콘: 마크 단독으로 이메일 바닥글, 슬라이드인 양식에 작게 쓰거나 워드마크가 없을 때 헤더로 사용해요.

  maxLength: 2000

• wordmark_urlstring

  워드마크: 디자인된 회사 이름으로 모든 이메일 상단에 단독으로 표시돼요.

  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필수

  deleting: 사람이 삭제했으며 delete_after까지 복구할 수 있고 이후 영구 삭제돼요.

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

• delete_afterstring | null

  deleting 상태인 제품이 영구 삭제되는 시점.

  format: "date-time"

• is_defaultboolean필수
• route_readyboolean필수
• setuparray필수
• 각 항목object
• keystring필수

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

• statusstring필수

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

• completion_sourcestring | null필수

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

• notestring필수
• updated_atstring | null필수

  format: "date-time"

• created_atstring필수

  format: "date-time"

• updated_atstring필수

  format: "date-time"

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

삭제 미리보기를 검토한 후 제품 하나(앱의 프로젝트)를 삭제해요. 즉시 사용이 중지되고 발송도 멈추며 24시간 동안 복구할 수 있어요. 이후 Banger가 발송 도메인과 소유한 모든 행을 제거해요. 워크스페이스의 마지막 활성 제품은 삭제할 수 없어요. 워크스페이스 관리자와 로그인 세션이 필요하며 API 키와 OAuth 권한은 거부돼요.

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문 필수

application/json

• valueobject

  추가 속성 없음

• confirm_namestring필수

  정확한 제품 이름.

  minLength: 1 · maxLength: 160

• preview_tokenstring필수

  minLength: 64 · maxLength: 64

성공 응답 202

제품은 사용 중지 상태이며 먼저 복구하지 않으면 delete_after에 영구 삭제돼요. 멱등 재실행은 같은 결과를 반환해요.

application/json

• valueobject
• dataobject필수
• idstring필수

  format: "uuid"

• namestring필수
• statusstring필수

  enum: "deleting"

• delete_afterstring필수

  제품이 영구 삭제되는 시점이며 그전까지 복구할 수 있어요.

  format: "date-time"

• next_product_idstring필수

  현재 워크스페이스 기본 제품.

  format: "uuid"

• replayedboolean

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

아무것도 삭제하지 않고 제품 하나와 소유한 모든 항목의 삭제를 미리 봐요. 로그인하거나 사용자가 승인한 OAuth를 사용하는 워크스페이스 관리자가 필요해요.

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문

계약에 요청 본문이 지정돼 있지 않아요.

성공 응답 200

제품 삭제로 제거되고 중지되는 항목.

application/json

• valueobject
• dataobject필수
• productobject필수
• idstring필수

  format: "uuid"

• namestring필수
• is_defaultboolean필수
• next_default_product지정되지 않음필수

  기본 제품 삭제 시 워크스페이스 기본이 되는 제품.

• oneOf 1null
• oneOf 2object
• idstring필수

  format: "uuid"

• namestring필수
• last_productboolean필수

  유일한 활성 제품은 삭제할 수 없어요.

• mailboxesarray필수
• 각 항목object
• idstring필수

  format: "uuid"

• addressstring필수
• domainsarray필수

  복구 기간이 지나면 Banger가 제거하는 발송 도메인.

• 각 항목object
• idstring필수

  format: "uuid"

• domainstring필수
• journeysinteger필수
• broadcastsinteger필수
• signup_formsinteger필수
• contactsinteger필수
• api_keysinteger필수
• webhooksinteger필수
• pending_sendsinteger필수
• impactarray필수
• 각 항목string
• preview_tokenstring필수

curl 예제

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

삭제된 제품을 delete_after 전에 복구해요. 메일함, 여정, 가입 양식, 웹훅, 연동은 다시 켜지며 단체 발송은 일시 중지 상태로 유지돼요. 로그인하거나 사용자가 승인한 OAuth를 사용하는 워크스페이스 관리자가 필요해요.

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문

계약에 요청 본문이 지정돼 있지 않아요.

성공 응답 200

제품이 다시 활성화됐어요.

application/json

• valueobject
• dataobject필수
• idstring필수

  format: "uuid"

• namestring필수
• statusstring필수

  enum: "active"

curl 예제

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

제품 설정 항목 업데이트

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문 필수

application/json

• valueobject
• statusstring필수

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

• completion_sourcestring

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

• notestring

  maxLength: 1000

성공 응답 200

성공 응답.

application/json

• valueobject
• dataobject필수
• keystring필수

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

• statusstring필수

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

• completion_sourcestring | null필수

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

• notestring필수
• updated_atstring | null필수

  format: "date-time"

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

도메인을 제품에 연결

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문 필수

application/json

• valueobject
• domainstring필수

  minLength: 3 · maxLength: 253

성공 응답 201

성공 응답.

application/json

• valueobject
• dataobject필수
• idstring필수

  format: "uuid"

• workspace_idstring필수

  format: "uuid"

• namestring필수
• slugstring필수
• kindstring필수

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

• website_urlstring | null필수
• domainsarray필수
• 각 항목string
• descriptionstring필수
• contextobject필수
• 추가 속성모든 값
• brandobject필수
• company_namestring

  maxLength: 160

• logo_urlstring

  아이콘: 마크 단독으로 이메일 바닥글, 슬라이드인 양식에 작게 쓰거나 워드마크가 없을 때 헤더로 사용해요.

  maxLength: 2000

• wordmark_urlstring

  워드마크: 디자인된 회사 이름으로 모든 이메일 상단에 단독으로 표시돼요.

  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필수

  deleting: 사람이 삭제했으며 delete_after까지 복구할 수 있고 이후 영구 삭제돼요.

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

• delete_afterstring | null

  deleting 상태인 제품이 영구 삭제되는 시점.

  format: "date-time"

• is_defaultboolean필수
• route_readyboolean필수
• setuparray필수
• 각 항목object
• keystring필수

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

• statusstring필수

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

• completion_sourcestring | null필수

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

• notestring필수
• updated_atstring | null필수

  format: "date-time"

• created_atstring필수

  format: "date-time"

• updated_atstring필수

  format: "date-time"

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

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문

계약에 요청 본문이 지정돼 있지 않아요.

성공 응답 200

작업자에게 보이는 메일함.

application/json

• valueobject
• dataarray필수
• 각 항목object
• idstring필수

  format: "uuid"

• workspace_idstring필수

  format: "uuid"

• product_idstring | null

  메일함이 속한 제품(프로젝트)이에요. 클라이언트는 이를 사용해 메일함을 묶고 웹 앱 링크를 만들어요.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstring필수

  format: "email"

• display_namestring필수
• providerstring필수

  enum: "gmail", "smtp"

• statusstring필수

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstring필수

  enum: "domain", "starter"

curl 예제

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

워크스페이스 발송 도메인에 Banger 기본 업무 메일함을 만들어요.

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문 필수

application/json

• valueobject

  추가 속성 없음

• domain_idstring필수

  format: "uuid"

• local_partstring필수

  minLength: 1 · maxLength: 64

• display_namestring

  maxLength: 200

성공 응답 200

기본 메일함 생성의 멱등 재실행.

application/json

• valueobject
• dataobject필수
• idstring필수

  format: "uuid"

• workspace_idstring필수

  format: "uuid"

• product_idstring | null

  메일함이 속한 제품(프로젝트)이에요. 클라이언트는 이를 사용해 메일함을 묶고 웹 앱 링크를 만들어요.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstring필수

  format: "email"

• display_namestring필수
• providerstring필수

  enum: "gmail", "smtp"

• statusstring필수

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstring필수

  enum: "domain", "starter"

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

메일함 영구 삭제와 종속 발송 흐름을 미리 봐요. 워크스페이스 관리자와 제품 범위가 필요해요.

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문

계약에 요청 본문이 지정돼 있지 않아요.

성공 응답 200

아무것도 삭제하지 않고 정확한 메일함과 현재 삭제 영향을 확인해요.

application/json

• valueobject
• dataobject필수
• mailboxobject필수
• idstring필수

  format: "uuid"

• addressstring필수
• providerstring필수
• domain_idstring | null필수

  format: "uuid"

• provider_connection_idstring | null필수

  format: "uuid"

• messagesinteger필수
• draftsinteger필수
• pending_sendsinteger필수
• broadcastsarray필수
• 각 항목object
• idstring필수

  format: "uuid"

• namestring필수
• statusstring필수
• journeysarray필수
• 각 항목object
• idstring필수

  format: "uuid"

• namestring필수
• statusstring필수
• signup_formsarray필수
• 각 항목object
• idstring필수

  format: "uuid"

• namestring필수
• statusstring필수
• impactarray필수
• 각 항목string
• preview_tokenstring필수

curl 예제

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

Banger 메일함 하나에서 보낸 메일에 수신자가 보는 보낸 사람 이름("Name <address>")을 설정해요. Gmail 메일함은 Gmail에서 설정한 이름을 유지해요. 워크스페이스 관리자가 필요해요.

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문 필수

application/json

• valueobject

  추가 속성 없음

• display_namestring필수

  한 줄이에요. 비어 있으면 주소만 보내요.

  maxLength: 200

성공 응답 200

보낸 사람 이름이 포함된 메일함.

application/json

• valueobject
• dataobject필수
• idstring필수

  format: "uuid"

• workspace_idstring필수

  format: "uuid"

• product_idstring | null

  메일함이 속한 제품(프로젝트)이에요. 클라이언트는 이를 사용해 메일함을 묶고 웹 앱 링크를 만들어요.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstring필수

  format: "email"

• display_namestring필수
• providerstring필수

  enum: "gmail", "smtp"

• statusstring필수

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstring필수

  enum: "domain", "starter"

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

도메인과 다른 메일함을 유지하면서 메일함 하나를 영구 삭제해요. 워크스페이스 관리자와 제품 범위가 필요해요.

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문 필수

application/json

• valueobject

  추가 속성 없음

• confirm_addressstring필수

  minLength: 3 · maxLength: 320

• preview_tokenstring필수

  minLength: 64 · maxLength: 64

성공 응답 200

삭제됐거나 멱등 재실행이에요. 저장된 파일은 영구 정리 대기열에 추가돼요.

application/json

• valueobject
• dataobject필수
• idstring필수

  format: "uuid"

• addressstring필수
• deletedboolean필수
• replayedboolean

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

같은 제품의 호스팅 받은편지함과 워크스페이스 가입 수신자로 제한된 호스팅 메일함을 만들어요.

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문 필수

application/json

• valueobject

  추가 속성 없음

• create_newboolean

  최초 메일함을 재개하는 대신 추가 호스팅 메일함을 만들어요.

• local_partstring

  @bangermail.com 앞의 이름이에요. 없으면 quiet-maple-harbor 같은 단어형 이름이 부여돼요.

  minLength: 3 · maxLength: 40

• display_namestring

  maxLength: 200

성공 응답 200

시작 ID 생성의 멱등 재실행.

application/json

• valueobject
• dataobject필수
• idstring필수

  format: "uuid"

• workspace_idstring필수

  format: "uuid"

• product_idstring | null

  메일함이 속한 제품(프로젝트)이에요. 클라이언트는 이를 사용해 메일함을 묶고 웹 앱 링크를 만들어요.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstring필수

  format: "email"

• display_namestring필수
• providerstring필수

  enum: "gmail", "smtp"

• statusstring필수

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstring필수

  enum: "domain", "starter"

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

resumeSending의 셀프서비스 재개 규칙에 따라 메일함 하나의 보낸 사람 평판에 따른 일시 중지를 해제해요.

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문 필수

application/json

• valueobject

  추가 속성 없음

• acknowledge_recipient_complaintboolean필수

  const: true

• reasonstring

  발송을 재개하는 이유로 감사 로그에 기록돼요.

  maxLength: 500

성공 응답 200

메일함이 재활성화됐거나 이전 요청 성공 후 이미 활성 상태예요.

application/json

• valueobject
• dataobject필수
• idstring필수

  format: "uuid"

• workspace_idstring필수

  format: "uuid"

• product_idstring | null

  메일함이 속한 제품(프로젝트)이에요. 클라이언트는 이를 사용해 메일함을 묶고 웹 앱 링크를 만들어요.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstring필수

  format: "email"

• display_namestring필수
• providerstring필수

  enum: "gmail", "smtp"

• statusstring필수

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstring필수

  enum: "domain", "starter"

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

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문

계약에 요청 본문이 지정돼 있지 않아요.

성공 응답 200

성공 응답.

application/json

• valueobject
• dataarray필수
• 각 항목object
• idstring필수

  format: "uuid"

• mailbox_idstring필수

  format: "uuid"

• thread_idstring | null필수

  format: "uuid"

• versioninteger필수
• toarray필수
• 각 항목object
• emailstring필수
• namestring
• ccarray필수
• 각 항목object
• emailstring필수
• namestring
• bccarray필수
• 각 항목object
• emailstring필수
• namestring
• subjectstring필수
• body_textstring필수
• statusstring필수
• created_atstring필수

  format: "date-time"

• updated_atstring필수

  format: "date-time"

• attachmentsarray필수
• 각 항목object
• idstring필수

  format: "uuid"

• filenamestring필수
• content_typestring필수
• size_bytesinteger필수
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

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

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문 필수

application/json

• valueobject

  추가 속성 없음

• mailbox_idstring필수

  format: "uuid"

• thread_idstring

  format: "uuid"

• toarray

  maxItems: 500

• 각 항목object
• namestring
• emailstring필수

  format: "email"

• ccarray

  maxItems: 500

• 각 항목object
• namestring
• emailstring필수

  format: "email"

• bccarray

  maxItems: 500

• 각 항목object
• namestring
• emailstring필수

  format: "email"

• subjectstring

  maxLength: 10000

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

성공 응답 201

성공 응답.

application/json

• valueobject
• dataobject필수
• idstring필수

  format: "uuid"

• mailbox_idstring필수

  format: "uuid"

• thread_idstring | null필수

  format: "uuid"

• versioninteger필수
• toarray필수
• 각 항목object
• emailstring필수
• namestring
• ccarray필수
• 각 항목object
• emailstring필수
• namestring
• bccarray필수
• 각 항목object
• emailstring필수
• namestring
• subjectstring필수
• body_textstring필수
• statusstring필수
• created_atstring필수

  format: "date-time"

• updated_atstring필수

  format: "date-time"

• attachmentsarray필수
• 각 항목object
• idstring필수

  format: "uuid"

• filenamestring필수
• content_typestring필수
• size_bytesinteger필수
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

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

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문

계약에 요청 본문이 지정돼 있지 않아요.

성공 응답 200

기준 전달률 성능, 상태, 사고.

application/json

• valueobject
• dataobject필수
• idstring필수

  format: "uuid"

• mailbox_idstring필수

  format: "uuid"

• thread_idstring | null필수

  format: "uuid"

• versioninteger필수
• toarray필수
• 각 항목object
• emailstring필수
• namestring
• ccarray필수
• 각 항목object
• emailstring필수
• namestring
• bccarray필수
• 각 항목object
• emailstring필수
• namestring
• subjectstring필수
• body_textstring필수
• statusstring필수
• created_atstring필수

  format: "date-time"

• updated_atstring필수

  format: "date-time"

• attachmentsarray필수
• 각 항목object
• idstring필수

  format: "uuid"

• filenamestring필수
• content_typestring필수
• size_bytesinteger필수
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

curl 예제

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

updateDraft

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문 필수

application/json

• value지정되지 않음
• allOf 1object

  추가 속성 없음

• mailbox_idstring필수

  format: "uuid"

• thread_idstring

  format: "uuid"

• toarray

  maxItems: 500

• 각 항목object
• namestring
• emailstring필수

  format: "email"

• ccarray

  maxItems: 500

• 각 항목object
• namestring
• emailstring필수

  format: "email"

• bccarray

  maxItems: 500

• 각 항목object
• namestring
• emailstring필수

  format: "email"

• subjectstring

  maxLength: 10000

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

• allOf 2object
• versioninteger필수

  minimum: 1

성공 응답 200

성공 응답.

application/json

• valueobject
• dataobject필수
• idstring필수

  format: "uuid"

• mailbox_idstring필수

  format: "uuid"

• thread_idstring | null필수

  format: "uuid"

• versioninteger필수
• toarray필수
• 각 항목object
• emailstring필수
• namestring
• ccarray필수
• 각 항목object
• emailstring필수
• namestring
• bccarray필수
• 각 항목object
• emailstring필수
• namestring
• subjectstring필수
• body_textstring필수
• statusstring필수
• created_atstring필수

  format: "date-time"

• updated_atstring필수

  format: "date-time"

• attachmentsarray필수
• 각 항목object
• idstring필수

  format: "uuid"

• filenamestring필수
• content_typestring필수
• size_bytesinteger필수
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

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

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문

계약에 요청 본문이 지정돼 있지 않아요.

성공 응답 204

임시저장과 참조 객체가 삭제 예약됐어요.

응답 본문 없음.

curl 예제

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

sendDraft

호출자가 접근할 수 있는 메일함에서 임시저장을 보내요. 발송에 승인이 필요한 호출자는 대신 대기 중인 승인을 받으며 임시저장을 직접 보낼 수 있는 사람이 결정해요.

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문

계약에 요청 본문이 지정돼 있지 않아요.

성공 응답 202

발송이 대기열에 있거나 승인을 기다려요.

application/json

• valueobject
• data지정되지 않음필수
• oneOf 1object
• idstring필수

  format: "uuid"

• typestring필수
• statusstring필수

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

• workspace_revisioninteger필수

  format: "int64"

• created_atstring필수

  format: "date-time"

• oneOf 2object

  추가 속성 없음

• approvalobject필수
• idstring필수

  format: "uuid"

• requested_by_actor_idstring필수
• action_kindstring필수
• summarystring필수
• capability_scopesarray필수
• 각 항목string
• resource_scopeobject필수
• 추가 속성array
• 각 항목string

  추가 중첩 생략

• payloadobject필수
• 추가 속성모든 값
• payload_sha256string필수

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

• statusstring필수

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

• missedboolean필수
• expires_atstring필수

  format: "date-time"

• decided_by_actor_idstring | null
• decision_reasonstring | null
• created_atstring필수

  format: "date-time"

• updated_atstring필수

  format: "date-time"

• decided_atstring | null

  format: "date-time"

• execution_job_idstring

  format: "uuid"

• reviewobject

  추가 속성 없음

• dispositionstring필수

  enum: "automatic", "human_required"

• recipient_countinteger | null필수

  minimum: 0

• reasonsarray필수
• 각 항목string

  추가 중첩 생략

• checksarray필수
• 각 항목string

  추가 중첩 생략

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

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문 필수

application/octet-stream

• valuestring

  format: "binary" · maxLength: 26214400

성공 응답 201

성공 응답.

application/json

• valueobject
• dataobject필수
• idstring필수

  format: "uuid"

• filenamestring필수
• content_typestring필수
• size_bytesinteger필수
• sha256string
• created_atstring

  format: "date-time"

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

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문

계약에 요청 본문이 지정돼 있지 않아요.

성공 응답 204

첨부 파일은 버전을 고려한 B2 삭제가 예약됐어요.

응답 본문 없음.

curl 예제

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

임시저장 HTML 본문 읽기

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문

계약에 요청 본문이 지정돼 있지 않아요.

성공 응답 200

임시저장 HTML.

text/html

• valuestring

curl 예제

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

listSendIntents

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문

계약에 요청 본문이 지정돼 있지 않아요.

성공 응답 200

최근 기준 발송과 공급자 상태.

application/json

• valueobject
• dataarray필수
• 각 항목object

  추가 속성 없음

• idstring필수

  format: "uuid"

• statusstring필수

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

• traffic_classstring필수

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

• recipient_countinteger필수

  minimum: 1

• provider_keystring필수
• provider_statestring필수

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

• provider_message_idstring | null
• error_codestring | null
• created_atstring필수

  format: "date-time"

• updated_atstring필수

  format: "date-time"

• completed_atstring | null

  format: "date-time"

curl 예제

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

getSendIntent

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문

계약에 요청 본문이 지정돼 있지 않아요.

성공 응답 200

기준 비동기 발송 상태.

application/json

• valueobject
• dataobject필수

  추가 속성 없음

• idstring필수

  format: "uuid"

• statusstring필수

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

• traffic_classstring필수

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

• recipient_countinteger필수

  minimum: 1

• provider_keystring필수
• provider_statestring필수

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

• provider_message_idstring | null
• error_codestring | null
• created_atstring필수

  format: "date-time"

• updated_atstring필수

  format: "date-time"

• completed_atstring | null

  format: "date-time"

curl 예제

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

listTransactionalSends

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문

계약에 요청 본문이 지정돼 있지 않아요.

성공 응답 200

성공 응답.

application/json

• valueobject
• dataarray필수
• 각 항목object
• idstring필수

  format: "uuid"

• mailbox_idstring | null필수

  format: "uuid"

• command_idstring | null필수

  format: "uuid"

• statusstring필수
• command_statusstring | null필수
• subjectstring
• recipientsarray
• 각 항목object
• emailstring필수
• namestring
• recipient_countinteger필수
• error_codestring | null
• send_intent_idstring

  format: "uuid"

• providerstring | null
• route_kindstring | null
• sourcestring
• from_addressstring
• recipient_statesobject
• 추가 속성integer
• provider_message_idstring | null
• language지정되지 않음

  이메일이 발송된 언어이며 번역되지 않았으면 null이에요.

• anyOf 1object

  사람이 이메일을 받은 언어예요. 번역된 관리형 콘텐츠 이메일에만 있어요.

• localestring필수

  이메일 작성 언어의 BCP 47 태그.

• requested_localestring

  다른 언어로 보낸 이전 발송에만 있으며 수신자가 받아야 했던 언어예요.

• fallback_reasonstring

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

• anyOf 2null
• journeyobject | null

  이 이메일을 보낸 여정 단계와 등록이며 다른 발송은 null이에요.

• journey_idstring필수

  format: "uuid"

• step_idstring필수

  format: "uuid"

• enrollment_idstring필수

  format: "uuid"

• experimentobject | null

  이 이메일의 실험 변형이며 해당하지 않으면 null이에요.

• experiment_idstring필수

  format: "uuid"

• variant_keystring필수
• created_atstring필수

  format: "date-time"

• updated_atstring필수

  format: "date-time"

• completed_atstring | null필수

  format: "date-time"

• template_idstring | null

  format: "uuid"

• template_versioninteger | null
• workspace_revisioninteger | null
• command_resultobject
• 추가 속성모든 값
• command_started_atstring | null

  format: "date-time"

• command_completed_atstring | null

  format: "date-time"

• body_textstring
• body_htmlstring
• reply_toarray
• 각 항목object
• emailstring필수
• namestring
• headersobject
• 추가 속성string
• tagsarray
• 각 항목object
• namestring필수
• valuestring필수

curl 예제

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

createTransactionalSend

여정 발송마다 수신자는 한 명이에요. To는 모든 RecipientInput 형식("a@example.com", "Pat <a@example.com>", { email, name }, 또는 요소 하나인 목록)으로 수신자 한 명을 받으며 Cc와 Bcc는 비어 있어야 해요. reply_to 기본값은 여정 메일함이고 빈 목록도 기본값을 뜻해요. 제품 이메일에는 정확히 하나가 필요해요. 새 API 여정은 관리형 원본 콘텐츠가 기본이고 기존 코드 여정은 전체 콘텐츠 발송을 유지해요. 거부(4xx)는 수신자에 대해 동결된 항목을 남기지 않으므로 새 멱등성 키로 수정한 호출은 발송돼요.

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문 필수

application/json

• valueobject
• mailbox_idstring필수

  format: "uuid"

• to지정되지 않음필수

  to, cc, bcc, reply_to 수신자: 주소("a@example.com" 또는 "Pat <a@example.com>"), { email, name } 객체, 또는 둘을 섞은 목록이에요. Banger는 이메일을 소문자로 바꾼 { email, name } 객체로 저장해요. 멱등성 해시는 발송된 본문을 포함하므로 같은 형식으로 재시도하세요.

• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstring필수

  format: "email"

• oneOf 3array

  maxItems: 500

• 각 항목지정되지 않음
• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstring필수

  format: "email"

• ccarray

  maxItems: 0

• 각 항목object
• namestring
• emailstring필수

  format: "email"

• bccarray

  maxItems: 0

• 각 항목object
• namestring
• emailstring필수

  format: "email"

• subjectstring

  maxLength: 10000

• expires_atstring

  이 시점 이후 지연된 여정 발송을 폐기하며 원래 요청부터 최대 7일이에요.

  format: "date-time"

• expires_after_secondsinteger

  minimum: 1 · maximum: 604800

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

• reply_to지정되지 않음

  to, cc, bcc, reply_to 수신자: 주소("a@example.com" 또는 "Pat <a@example.com>"), { email, name } 객체, 또는 둘을 섞은 목록이에요. Banger는 이메일을 소문자로 바꾼 { email, name } 객체로 저장해요. 멱등성 해시는 발송된 본문을 포함하므로 같은 형식으로 재시도하세요.

• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstring필수

  format: "email"

• oneOf 3array

  maxItems: 500

• 각 항목지정되지 않음
• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstring필수

  format: "email"

• headersobject
• 추가 속성string

  maxLength: 5000

• tagsarray

  maxItems: 49

• 각 항목object

  추가 속성 없음

• namestring필수

  minLength: 1 · maxLength: 256

• valuestring필수

  minLength: 1 · maxLength: 256

성공 응답 202

성공 응답.

application/json

• valueobject
• dataobject필수
• action_kindstring필수

  enum: "transactional.send"

• idstring

  format: "uuid"

• send_intent_idstring

  format: "uuid"

• provider_attempt_idstring

  format: "uuid"

• statusstring필수

  전달에 따른 sent/queued 상태 또는 동결된 요청의 상태: deferred(정책 예약 또는 번역 대기), processing(발송 중), discarded.

• replayedboolean
• journey지정되지 않음필수
• anyOf 1object
• journey_idstring필수

  format: "uuid"

• enrollment_idstring필수

  format: "uuid"

• step_idstring필수

  format: "uuid"

• step_positioninteger필수
• originstring

  enum: "journey"

• journey_identitystring
• anyOf 2null
• ignored_variablesarray필수
• 각 항목string
• scheduled_atstring

  format: "date-time"

• reasonstring
• communication_reservation_idstring

  format: "uuid"

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

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문

계약에 요청 본문이 지정돼 있지 않아요.

성공 응답 200

성공 응답.

application/json

• valueobject
• dataobject필수
• idstring필수

  format: "uuid"

• mailbox_idstring | null필수

  format: "uuid"

• command_idstring | null필수

  format: "uuid"

• statusstring필수
• command_statusstring | null필수
• subjectstring
• recipientsarray
• 각 항목object
• emailstring필수
• namestring
• recipient_countinteger필수
• error_codestring | null
• send_intent_idstring

  format: "uuid"

• providerstring | null
• route_kindstring | null
• sourcestring
• from_addressstring
• recipient_statesobject
• 추가 속성integer
• provider_message_idstring | null
• language지정되지 않음

  이메일이 발송된 언어이며 번역되지 않았으면 null이에요.

• anyOf 1object

  사람이 이메일을 받은 언어예요. 번역된 관리형 콘텐츠 이메일에만 있어요.

• localestring필수

  이메일 작성 언어의 BCP 47 태그.

• requested_localestring

  다른 언어로 보낸 이전 발송에만 있으며 수신자가 받아야 했던 언어예요.

• fallback_reasonstring

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

• anyOf 2null
• journeyobject | null

  이 이메일을 보낸 여정 단계와 등록이며 다른 발송은 null이에요.

• journey_idstring필수

  format: "uuid"

• step_idstring필수

  format: "uuid"

• enrollment_idstring필수

  format: "uuid"

• experimentobject | null

  이 이메일의 실험 변형이며 해당하지 않으면 null이에요.

• experiment_idstring필수

  format: "uuid"

• variant_keystring필수
• created_atstring필수

  format: "date-time"

• updated_atstring필수

  format: "date-time"

• completed_atstring | null필수

  format: "date-time"

• template_idstring | null

  format: "uuid"

• template_versioninteger | null
• workspace_revisioninteger | null
• command_resultobject
• 추가 속성모든 값
• command_started_atstring | null

  format: "date-time"

• command_completed_atstring | null

  format: "date-time"

• body_textstring
• body_htmlstring
• reply_toarray
• 각 항목object
• emailstring필수
• namestring
• headersobject
• 추가 속성string
• tagsarray
• 각 항목object
• namestring필수
• valuestring필수

curl 예제

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

listTransactionalSendTimeline

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문

계약에 요청 본문이 지정돼 있지 않아요.

성공 응답 200

접수, 공급자 시도, 수신자 이벤트의 순서별 타임라인.

application/json

• valueobject
• dataarray필수
• 각 항목object
• occurred_atstring필수

  format: "date-time"

• event_typestring필수
• labelstring필수
• providerstring | null
• recipient_domainstring | null
• error_codestring | null

curl 예제

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

retryTransactionalSend

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문

계약에 요청 본문이 지정돼 있지 않아요.

성공 응답 202

성공 응답.

application/json

• valueobject
• dataobject필수
• action_kindstring필수

  enum: "transactional.send"

• idstring필수

  format: "uuid"

• send_intent_idstring필수

  format: "uuid"

• provider_attempt_idstring필수

  format: "uuid"

• statusstring필수
• replayedboolean필수

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

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문

계약에 요청 본문이 지정돼 있지 않아요.

성공 응답 200

키셋으로 페이지를 나눈 워크스페이스 스레드.

application/json

• valueobject
• dataarray필수
• 각 항목object
• idstring필수

  format: "uuid"

• mailbox_idstring필수

  format: "uuid"

• subjectstring필수
• snippetstring필수
• last_message_atstring필수

  format: "date-time"

• message_countinteger필수
• unread_countinteger필수
• is_archivedboolean필수
• is_trashboolean필수
• is_spamboolean필수
• is_starredboolean필수
• is_sentboolean필수
• has_attachmentsboolean필수
• labelsarray필수
• 각 항목string
• participantsarray
• 각 항목object
• namestring
• emailstring필수

  format: "email"

• pageobject필수
• next_cursorstring
• has_moreboolean필수

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

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문

계약에 요청 본문이 지정돼 있지 않아요.

성공 응답 200

스레드와 정렬된 메시지.

application/json

• valueobject
• data지정되지 않음필수
• allOf 1object
• idstring필수

  format: "uuid"

• mailbox_idstring필수

  format: "uuid"

• subjectstring필수
• snippetstring필수
• last_message_atstring필수

  format: "date-time"

• message_countinteger필수
• unread_countinteger필수
• is_archivedboolean필수
• is_trashboolean필수
• is_spamboolean필수
• is_starredboolean필수
• is_sentboolean필수
• has_attachmentsboolean필수
• labelsarray필수
• 각 항목string
• participantsarray
• 각 항목object
• namestring
• emailstring필수

  format: "email"

• allOf 2object
• messagesarray필수
• 각 항목object
• idstring필수

  format: "uuid"

• mailbox_idstring필수

  format: "uuid"

• thread_idstring필수

  format: "uuid"

• sent_atstring필수

  format: "date-time"

• received_atstring

  format: "date-time"

• envelope_recipientsarray

  수신 전용 별칭 라우팅 전에 SMTP 에지에서 대소문자를 정규화한 원래 SMTP 봉투 수신자예요. 이전 메시지나 SMTP 외 소스에서는 비어 있으며 표시되는 To/Cc 헤더와는 독립적이에요.

• 각 항목string

  format: "email"

  추가 중첩 생략

• fromobject필수
• namestring

  추가 중첩 생략

• emailstring필수

  format: "email"

  추가 중첩 생략

• toarray필수
• 각 항목object

  추가 중첩 생략

• ccarray
• 각 항목object

  추가 중첩 생략

• reply_toarray
• 각 항목object

  추가 중첩 생략

• is_sentboolean

  별칭을 포함해 메일함에서 보낸 메시지인지 여부.

• body_textstring
• body_html_urlstring

  format: "uri"

• reply_originobject
• send_intent_idstring필수

  format: "uuid"

  추가 중첩 생략

• sourcestring필수

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

  추가 중첩 생략

• source_idstring

  format: "uuid"

  추가 중첩 생략

• traffic_classstring필수

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

  추가 중첩 생략

• kindstring필수

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

  추가 중첩 생략

• namestring

  추가 중첩 생략

• has_attachmentsboolean필수
• attachmentsarray
• 각 항목object

  추가 중첩 생략

curl 예제

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

getMessageHtml

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문

계약에 요청 본문이 지정돼 있지 않아요.

성공 응답 200

인증되고 샌드박스 제약을 받는 HTML 메시지 본문.

text/html

• valuestring

curl 예제

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

downloadAttachment

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문

계약에 요청 본문이 지정돼 있지 않아요.

성공 응답 200

인증된 첨부 파일 스트림.

application/octet-stream

• valuestring

  format: "binary"

curl 예제

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

searchMail

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문

계약에 요청 본문이 지정돼 있지 않아요.

성공 응답 200

워크스페이스 전체 검색 결과.

application/json

• valueobject
• dataarray필수
• 각 항목object
• idstring필수

  format: "uuid"

• mailbox_idstring필수

  format: "uuid"

• subjectstring필수
• snippetstring필수
• last_message_atstring필수

  format: "date-time"

• message_countinteger필수
• unread_countinteger필수
• is_archivedboolean필수
• is_trashboolean필수
• is_spamboolean필수
• is_starredboolean필수
• is_sentboolean필수
• has_attachmentsboolean필수
• labelsarray필수
• 각 항목string
• participantsarray
• 각 항목object
• namestring
• emailstring필수

  format: "email"

• pageobject필수
• next_cursorstring
• has_moreboolean필수

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

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문

계약에 요청 본문이 지정돼 있지 않아요.

성공 응답 200

성공 응답.

application/json

• valueobject
• dataarray필수
• 각 항목object
• idstring필수

  format: "uuid"

• emailstring필수

  format: "email"

• display_namestring | null필수
• attributesobject필수
• 추가 속성모든 값
• statusstring필수

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

• created_atstring필수

  format: "date-time"

• updated_atstring필수

  format: "date-time"

• pageobject필수
• next_cursorstring
• has_moreboolean필수

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

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문 필수

application/json

• valueobject

  추가 속성 없음

• emailstring필수

  format: "email"

• display_namestring

  maxLength: 1000

• statusstring필수

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

• attributesobject
• 추가 속성모든 값
• consent_confirmedboolean

  주소를 새로 구독 등록할 때 필수예요.

성공 응답 201

성공 응답.

application/json

• valueobject
• dataobject필수
• idstring필수

  format: "uuid"

• emailstring필수

  format: "email"

• display_namestring | null필수
• attributesobject필수
• 추가 속성모든 값
• statusstring필수

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

• created_atstring필수

  format: "date-time"

• updated_atstring필수

  format: "date-time"

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

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문

계약에 요청 본문이 지정돼 있지 않아요.

성공 응답 200

성공 응답.

application/json

• valueobject
• dataobject필수
• idstring필수

  format: "uuid"

• emailstring필수

  format: "email"

• display_namestring | null필수
• attributesobject필수
• 추가 속성모든 값
• statusstring필수

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

• created_atstring필수

  format: "date-time"

• updated_atstring필수

  format: "date-time"

• suppressedboolean필수
• suppression_reasonstring | null필수
• sourcesarray필수
• 각 항목object
• kindstring필수
• referencestring필수
• connection_idstring | null필수

  format: "uuid"

• metadataobject필수
• 추가 속성모든 값
• first_seen_atstring필수

  format: "date-time"

• last_seen_atstring필수

  format: "date-time"

• listsarray필수
• 각 항목object
• idstring필수

  format: "uuid"

• namestring필수
• subscription_statusstring필수
• consent_evidencearray필수
• 각 항목object
• kindstring필수
• referencestring필수
• connection_idstring | null필수

  format: "uuid"

• metadataobject필수
• 추가 속성모든 값
• first_seen_atstring필수

  format: "date-time"

• last_seen_atstring필수

  format: "date-time"

curl 예제

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

deleteContact

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문

계약에 요청 본문이 지정돼 있지 않아요.

성공 응답 204

연락처가 삭제됐어요.

응답 본문 없음.

curl 예제

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

listContactImports

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문

계약에 요청 본문이 지정돼 있지 않아요.

성공 응답 200

성공 응답.

application/json

• valueobject
• dataarray필수
• 각 항목object
• idstring

  format: "uuid"

• filenamestring
• list_idstring | null

  format: "uuid"

• list_namestring | null
• statusstring
• total_rowsinteger
• imported_rowsinteger
• invalid_rowsinteger
• error_summaryarray
• 각 항목string
• 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 예제

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

importContacts

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문 필수

application/json

• valueobject
• filenamestring필수

  minLength: 1 · maxLength: 500

• list_idstring

  format: "uuid"

• consent_confirmedboolean

  가져온 행 중 구독 상태인 행이 있으면 필수예요.

• rowsarray필수

  minItems: 1 · maxItems: 5000

• 각 항목object
• emailstring필수

  format: "email"

• display_namestring

  maxLength: 1000

• statusstring

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

• attributesobject
• 추가 속성모든 값

성공 응답 201

성공 응답.

application/json

• valueobject
• dataobject필수
• idstring필수

  format: "uuid"

• statusstring필수

  enum: "queued"

• total_rowsinteger필수
• imported_rowsinteger필수
• invalid_rowsinteger필수
• list_idstring | null필수

  format: "uuid"

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

구독이나 동의를 바꾸지 않고 유형이 있는 속성 병합

contacts:write와 contacts:read가 필요해요. 기존 연락처만 업데이트해요. 생략한 속성은 유지하고 명시적 false는 저장하며 null은 필드를 제거해요. 검증된 원본 사실을 제공하세요. 없는 데이터는 false가 아니에요. 구독, 발송 억제, ID, 소스 이력은 바뀌지 않아요.

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문 필수

application/json

• valueobject

  추가 속성 없음

• attributesobject필수
• 추가 속성모든 값

성공 응답 200

현재 연락처 다시 읽기이며 이 변경이 이미 적용됐으면 replayed가 true예요.

application/json

• valueobject
• dataobject필수
• idstring필수

  format: "uuid"

• attributesobject필수
• 추가 속성모든 값
• statusstring필수

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

• replayedboolean필수
• 추가 속성모든 값

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

인증: Bearer 워크스페이스 API 키.

매개변수

요청 본문 필수

application/json

• valueobject

  추가 속성 없음

• emailstring필수

  format: "email" · maxLength: 320

• display_namestring

  minLength: 0 · maxLength: 1000

• attributesobject
• 추가 속성모든 값
• statusstring필수

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

• consent_evidenceobject

  추가 속성 없음

• sourcestring

  minLength: 1 · maxLength: 2000

• referencestring

  minLength: 1 · maxLength: 2000

• observed_atstring

  format: "date-time"

• statementstring

  minLength: 1 · maxLength: 2000

• consent_confirmedboolean

성공 응답 200

기준 다시 읽기 또는 멱등 수신 확인이에요. 공급자 접수는 sent이며 delivered는 전달 이벤트가 필요하고 받은편지함 도착을 증명하지 않아요.

application/json

• valueobject
• data지정되지 않음필수
• allOf 1object
• idstring필수

  format: "uuid"

• emailstring필수

  format: "email"

• display_namestring | null필수
• attributesobject필수
• 추가 속성모든 값
• statusstring필수

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

• created_atstring필수

  format: "date-time"

• updated_atstring필수

  format: "date-time"

• suppressedboolean필수
• suppression_reasonstring | null필수
• sourcesarray필수
• 각 항목object
• kindstring필수
• referencestring필수
• connection_idstring | null필수

  format: "uuid"

• metadataobject필수
• 추가 속성모든 값
• first_seen_atstring필수

  format: "date-time"

• last_seen_atstring필수

  format: "date-time"

• listsarray필수
• 각 항목object
• idstring필수

  format: "uuid"

• namestring필수
• subscription_statusstring필수
• consent_evidencearray필수
• 각 항목object
• kindstring필수
• referencestring필수
• connection_idstring | null필수

  format: "uuid"

• metadataobject필수
• 추가 속성모든 값
• first_seen_atstring필수

  format: "date-time"

• last_seen_atstring필수

  format: "date-time"

• allOf 2object
• replayedboolean필수