Tài liệu tham khảo Banger API

Liệt kê sản phẩm trong không gian làm việc

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu

Hợp đồng không quy định nội dung yêu cầu.

Phản hồi thành công 200

Phản hồi thành công.

application/json

• valueobject
• dataarraybắt buộc
• Mỗi mụcobject
• idstringbắt buộc

  format: "uuid"

• workspace_idstringbắt buộc

  format: "uuid"

• namestringbắt buộc
• slugstringbắt buộc
• kindstringbắt buộc

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

• website_urlstring | nullbắt buộc
• domainsarraybắt buộc
• Mỗi mụcstring
• descriptionstringbắt buộc
• contextobjectbắt buộc
• Thuộc tính bổ sungGiá trị bất kỳ
• brandobjectbắt buộc
• company_namestring

  maxLength: 160

• logo_urlstring

  Biểu tượng: dấu hiệu đứng riêng, dùng ở kích thước nhỏ (chân email, biểu mẫu trượt vào) và làm đầu trang khi không có logo chữ.

  maxLength: 2000

• wordmark_urlstring

  Logo chữ: tên công ty theo thiết kế, hiển thị riêng ở đầu mỗi email.

  maxLength: 2000

• website_urlstring

  maxLength: 2000

• primary_colorstring

  maxLength: 7

• accent_colorstring

  maxLength: 7

• background_colorstring

  maxLength: 7

• surface_colorstring

  maxLength: 7

• text_colorstring

  maxLength: 7

• muted_text_colorstring

  maxLength: 7

• heading_font_familystring

  maxLength: 200

• body_font_familystring

  maxLength: 200

• tonestring

  maxLength: 1000

• footer_addressstring

  maxLength: 500

• email_stylestring

  maxLength: 20

• statusstringbắt buộc

  deleting: do một người xóa; có thể khôi phục đến delete_after, sau đó xóa vĩnh viễn.

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

• delete_afterstring | null

  Thời điểm sản phẩm có trạng thái deleting bị xóa vĩnh viễn.

  format: "date-time"

• is_defaultbooleanbắt buộc
• route_readybooleanbắt buộc
• setuparraybắt buộc
• Mỗi mụcobject
• keystringbắt buộc

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

• statusstringbắt buộc

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

• completion_sourcestring | nullbắt buộc

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

• notestringbắt buộc
• updated_atstring | nullbắt buộc

  format: "date-time"

• created_atstringbắt buộc

  format: "date-time"

• updated_atstringbắt buộc

  format: "date-time"

Ví dụ curl

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

Tạo sản phẩm

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu bắt buộc

application/json

• valueobject
• namestringbắt buộc

  minLength: 1 · maxLength: 160

• kindstring

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

• website_urlstring | null

  maxLength: 2000

• descriptionstring

  maxLength: 4000

• contextobject
• Thuộc tính bổ sungGiá trị bất kỳ
• domainsarray

  maxItems: 20

• Mỗi mụcstring

  maxLength: 253

Phản hồi thành công 201

Phản hồi thành công.

application/json

• valueobject
• dataobjectbắt buộc
• idstringbắt buộc

  format: "uuid"

• workspace_idstringbắt buộc

  format: "uuid"

• namestringbắt buộc
• slugstringbắt buộc
• kindstringbắt buộc

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

• website_urlstring | nullbắt buộc
• domainsarraybắt buộc
• Mỗi mụcstring
• descriptionstringbắt buộc
• contextobjectbắt buộc
• Thuộc tính bổ sungGiá trị bất kỳ
• brandobjectbắt buộc
• company_namestring

  maxLength: 160

• logo_urlstring

  Biểu tượng: dấu hiệu đứng riêng, dùng ở kích thước nhỏ (chân email, biểu mẫu trượt vào) và làm đầu trang khi không có logo chữ.

  maxLength: 2000

• wordmark_urlstring

  Logo chữ: tên công ty theo thiết kế, hiển thị riêng ở đầu mỗi email.

  maxLength: 2000

• website_urlstring

  maxLength: 2000

• primary_colorstring

  maxLength: 7

• accent_colorstring

  maxLength: 7

• background_colorstring

  maxLength: 7

• surface_colorstring

  maxLength: 7

• text_colorstring

  maxLength: 7

• muted_text_colorstring

  maxLength: 7

• heading_font_familystring

  maxLength: 200

• body_font_familystring

  maxLength: 200

• tonestring

  maxLength: 1000

• footer_addressstring

  maxLength: 500

• email_stylestring

  maxLength: 20

• statusstringbắt buộc

  deleting: do một người xóa; có thể khôi phục đến delete_after, sau đó xóa vĩnh viễn.

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

• delete_afterstring | null

  Thời điểm sản phẩm có trạng thái deleting bị xóa vĩnh viễn.

  format: "date-time"

• is_defaultbooleanbắt buộc
• route_readybooleanbắt buộc
• setuparraybắt buộc
• Mỗi mụcobject
• keystringbắt buộc

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

• statusstringbắt buộc

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

• completion_sourcestring | nullbắt buộc

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

• notestringbắt buộc
• updated_atstring | nullbắt buộc

  format: "date-time"

• created_atstringbắt buộc

  format: "date-time"

• updated_atstringbắt buộc

  format: "date-time"

Ví dụ 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"
  ]
}'

Lấy sản phẩm

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu

Hợp đồng không quy định nội dung yêu cầu.

Phản hồi thành công 200

Phản hồi thành công.

application/json

• valueobject
• dataobjectbắt buộc
• idstringbắt buộc

  format: "uuid"

• workspace_idstringbắt buộc

  format: "uuid"

• namestringbắt buộc
• slugstringbắt buộc
• kindstringbắt buộc

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

• website_urlstring | nullbắt buộc
• domainsarraybắt buộc
• Mỗi mụcstring
• descriptionstringbắt buộc
• contextobjectbắt buộc
• Thuộc tính bổ sungGiá trị bất kỳ
• brandobjectbắt buộc
• company_namestring

  maxLength: 160

• logo_urlstring

  Biểu tượng: dấu hiệu đứng riêng, dùng ở kích thước nhỏ (chân email, biểu mẫu trượt vào) và làm đầu trang khi không có logo chữ.

  maxLength: 2000

• wordmark_urlstring

  Logo chữ: tên công ty theo thiết kế, hiển thị riêng ở đầu mỗi email.

  maxLength: 2000

• website_urlstring

  maxLength: 2000

• primary_colorstring

  maxLength: 7

• accent_colorstring

  maxLength: 7

• background_colorstring

  maxLength: 7

• surface_colorstring

  maxLength: 7

• text_colorstring

  maxLength: 7

• muted_text_colorstring

  maxLength: 7

• heading_font_familystring

  maxLength: 200

• body_font_familystring

  maxLength: 200

• tonestring

  maxLength: 1000

• footer_addressstring

  maxLength: 500

• email_stylestring

  maxLength: 20

• statusstringbắt buộc

  deleting: do một người xóa; có thể khôi phục đến delete_after, sau đó xóa vĩnh viễn.

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

• delete_afterstring | null

  Thời điểm sản phẩm có trạng thái deleting bị xóa vĩnh viễn.

  format: "date-time"

• is_defaultbooleanbắt buộc
• route_readybooleanbắt buộc
• setuparraybắt buộc
• Mỗi mụcobject
• keystringbắt buộc

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

• statusstringbắt buộc

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

• completion_sourcestring | nullbắt buộc

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

• notestringbắt buộc
• updated_atstring | nullbắt buộc

  format: "date-time"

• created_atstringbắt buộc

  format: "date-time"

• updated_atstringbắt buộc

  format: "date-time"

Ví dụ curl

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

Cập nhật sản phẩm

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu bắt buộc

application/json

• valueobject
• namestring

  maxLength: 160

• kindstring

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

• website_urlstring | null

  maxLength: 2000

• descriptionstring

  maxLength: 4000

• contextobject
• Thuộc tính bổ sungGiá trị bất kỳ
• brandobject
• company_namestring

  maxLength: 160

• logo_urlstring

  Biểu tượng: dấu hiệu đứng riêng, dùng ở kích thước nhỏ (chân email, biểu mẫu trượt vào) và làm đầu trang khi không có logo chữ.

  maxLength: 2000

• wordmark_urlstring

  Logo chữ: tên công ty theo thiết kế, hiển thị riêng ở đầu mỗi email.

  maxLength: 2000

• website_urlstring

  maxLength: 2000

• primary_colorstring

  maxLength: 7

• accent_colorstring

  maxLength: 7

• background_colorstring

  maxLength: 7

• surface_colorstring

  maxLength: 7

• text_colorstring

  maxLength: 7

• muted_text_colorstring

  maxLength: 7

• heading_font_familystring

  maxLength: 200

• body_font_familystring

  maxLength: 200

• tonestring

  maxLength: 1000

• footer_addressstring

  maxLength: 500

• email_stylestring

  maxLength: 20

• statusstring

  enum: "active", "archived"

Phản hồi thành công 200

Phản hồi thành công.

application/json

• valueobject
• dataobjectbắt buộc
• idstringbắt buộc

  format: "uuid"

• workspace_idstringbắt buộc

  format: "uuid"

• namestringbắt buộc
• slugstringbắt buộc
• kindstringbắt buộc

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

• website_urlstring | nullbắt buộc
• domainsarraybắt buộc
• Mỗi mụcstring
• descriptionstringbắt buộc
• contextobjectbắt buộc
• Thuộc tính bổ sungGiá trị bất kỳ
• brandobjectbắt buộc
• company_namestring

  maxLength: 160

• logo_urlstring

  Biểu tượng: dấu hiệu đứng riêng, dùng ở kích thước nhỏ (chân email, biểu mẫu trượt vào) và làm đầu trang khi không có logo chữ.

  maxLength: 2000

• wordmark_urlstring

  Logo chữ: tên công ty theo thiết kế, hiển thị riêng ở đầu mỗi email.

  maxLength: 2000

• website_urlstring

  maxLength: 2000

• primary_colorstring

  maxLength: 7

• accent_colorstring

  maxLength: 7

• background_colorstring

  maxLength: 7

• surface_colorstring

  maxLength: 7

• text_colorstring

  maxLength: 7

• muted_text_colorstring

  maxLength: 7

• heading_font_familystring

  maxLength: 200

• body_font_familystring

  maxLength: 200

• tonestring

  maxLength: 1000

• footer_addressstring

  maxLength: 500

• email_stylestring

  maxLength: 20

• statusstringbắt buộc

  deleting: do một người xóa; có thể khôi phục đến delete_after, sau đó xóa vĩnh viễn.

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

• delete_afterstring | null

  Thời điểm sản phẩm có trạng thái deleting bị xóa vĩnh viễn.

  format: "date-time"

• is_defaultbooleanbắt buộc
• route_readybooleanbắt buộc
• setuparraybắt buộc
• Mỗi mụcobject
• keystringbắt buộc

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

• statusstringbắt buộc

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

• completion_sourcestring | nullbắt buộc

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

• notestringbắt buộc
• updated_atstring | nullbắt buộc

  format: "date-time"

• created_atstringbắt buộc

  format: "date-time"

• updated_atstringbắt buộc

  format: "date-time"

Ví dụ 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"
}'

Xóa một sản phẩm (dự án trong ứng dụng) sau khi xem trước tác động xóa. Sản phẩm ngừng sử dụng ngay (dừng gửi) và có thể khôi phục trong 24 giờ; sau đó Banger xóa các tên miền gửi và mọi hàng dữ liệu thuộc sản phẩm. Không thể xóa sản phẩm hoạt động cuối cùng của không gian làm việc. Cần quản trị viên không gian làm việc và phiên đã đăng nhập; khóa API và quyền OAuth bị từ chối.

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu bắt buộc

application/json

• valueobject

  Không có thuộc tính bổ sung

• confirm_namestringbắt buộc

  Tên sản phẩm chính xác.

  minLength: 1 · maxLength: 160

• preview_tokenstringbắt buộc

  minLength: 64 · maxLength: 64

Phản hồi thành công 202

Sản phẩm ngừng sử dụng và bị xóa vĩnh viễn tại delete_after trừ khi khôi phục trước. Lần gọi lại idempotent trả cùng kết quả.

application/json

• valueobject
• dataobjectbắt buộc
• idstringbắt buộc

  format: "uuid"

• namestringbắt buộc
• statusstringbắt buộc

  enum: "deleting"

• delete_afterstringbắt buộc

  Thời điểm sản phẩm bị xóa vĩnh viễn; trước đó có thể khôi phục.

  format: "date-time"

• next_product_idstringbắt buộc

  Sản phẩm mặc định hiện tại của không gian làm việc.

  format: "uuid"

• replayedboolean

Ví dụ 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"
}'

Xem trước việc xóa một sản phẩm và mọi thứ thuộc sản phẩm, không xóa gì. Cần quản trị viên không gian làm việc đã đăng nhập hoặc qua OAuth được người dùng cho phép.

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu

Hợp đồng không quy định nội dung yêu cầu.

Phản hồi thành công 200

Những gì bị xóa và dừng khi xóa sản phẩm.

application/json

• valueobject
• dataobjectbắt buộc
• productobjectbắt buộc
• idstringbắt buộc

  format: "uuid"

• namestringbắt buộc
• is_defaultbooleanbắt buộc
• next_default_productkhông quy địnhbắt buộc

  Sản phẩm trở thành mặc định của không gian làm việc khi sản phẩm mặc định bị xóa.

• oneOf 1null
• oneOf 2object
• idstringbắt buộc

  format: "uuid"

• namestringbắt buộc
• last_productbooleanbắt buộc

  Không thể xóa sản phẩm hoạt động duy nhất.

• mailboxesarraybắt buộc
• Mỗi mụcobject
• idstringbắt buộc

  format: "uuid"

• addressstringbắt buộc
• domainsarraybắt buộc

  Tên miền gửi Banger xóa sau khi hết thời hạn khôi phục.

• Mỗi mụcobject
• idstringbắt buộc

  format: "uuid"

• domainstringbắt buộc
• journeysintegerbắt buộc
• broadcastsintegerbắt buộc
• signup_formsintegerbắt buộc
• contactsintegerbắt buộc
• api_keysintegerbắt buộc
• webhooksintegerbắt buộc
• pending_sendsintegerbắt buộc
• impactarraybắt buộc
• Mỗi mụcstring
• preview_tokenstringbắt buộc

Ví dụ curl

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

Khôi phục sản phẩm đã xóa trước delete_after. Hộp thư, hành trình, biểu mẫu đăng ký, webhook và tích hợp được bật lại; chiến dịch vẫn tạm dừng. Cần quản trị viên không gian làm việc đã đăng nhập hoặc qua OAuth được người dùng cho phép.

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu

Hợp đồng không quy định nội dung yêu cầu.

Phản hồi thành công 200

Sản phẩm hoạt động trở lại.

application/json

• valueobject
• dataobjectbắt buộc
• idstringbắt buộc

  format: "uuid"

• namestringbắt buộc
• statusstringbắt buộc

  enum: "active"

Ví dụ curl

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

Cập nhật mục thiết lập sản phẩm

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu bắt buộc

application/json

• valueobject
• statusstringbắt buộc

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

• completion_sourcestring

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

• notestring

  maxLength: 1000

Phản hồi thành công 200

Phản hồi thành công.

application/json

• valueobject
• dataobjectbắt buộc
• keystringbắt buộc

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

• statusstringbắt buộc

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

• completion_sourcestring | nullbắt buộc

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

• notestringbắt buộc
• updated_atstring | nullbắt buộc

  format: "date-time"

Ví dụ 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"
}'

Gắn tên miền với sản phẩm

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu bắt buộc

application/json

• valueobject
• domainstringbắt buộc

  minLength: 3 · maxLength: 253

Phản hồi thành công 201

Phản hồi thành công.

application/json

• valueobject
• dataobjectbắt buộc
• idstringbắt buộc

  format: "uuid"

• workspace_idstringbắt buộc

  format: "uuid"

• namestringbắt buộc
• slugstringbắt buộc
• kindstringbắt buộc

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

• website_urlstring | nullbắt buộc
• domainsarraybắt buộc
• Mỗi mụcstring
• descriptionstringbắt buộc
• contextobjectbắt buộc
• Thuộc tính bổ sungGiá trị bất kỳ
• brandobjectbắt buộc
• company_namestring

  maxLength: 160

• logo_urlstring

  Biểu tượng: dấu hiệu đứng riêng, dùng ở kích thước nhỏ (chân email, biểu mẫu trượt vào) và làm đầu trang khi không có logo chữ.

  maxLength: 2000

• wordmark_urlstring

  Logo chữ: tên công ty theo thiết kế, hiển thị riêng ở đầu mỗi email.

  maxLength: 2000

• website_urlstring

  maxLength: 2000

• primary_colorstring

  maxLength: 7

• accent_colorstring

  maxLength: 7

• background_colorstring

  maxLength: 7

• surface_colorstring

  maxLength: 7

• text_colorstring

  maxLength: 7

• muted_text_colorstring

  maxLength: 7

• heading_font_familystring

  maxLength: 200

• body_font_familystring

  maxLength: 200

• tonestring

  maxLength: 1000

• footer_addressstring

  maxLength: 500

• email_stylestring

  maxLength: 20

• statusstringbắt buộc

  deleting: do một người xóa; có thể khôi phục đến delete_after, sau đó xóa vĩnh viễn.

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

• delete_afterstring | null

  Thời điểm sản phẩm có trạng thái deleting bị xóa vĩnh viễn.

  format: "date-time"

• is_defaultbooleanbắt buộc
• route_readybooleanbắt buộc
• setuparraybắt buộc
• Mỗi mụcobject
• keystringbắt buộc

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

• statusstringbắt buộc

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

• completion_sourcestring | nullbắt buộc

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

• notestringbắt buộc
• updated_atstring | nullbắt buộc

  format: "date-time"

• created_atstringbắt buộc

  format: "date-time"

• updated_atstringbắt buộc

  format: "date-time"

Ví dụ 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

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu

Hợp đồng không quy định nội dung yêu cầu.

Phản hồi thành công 200

Hộp thư tác nhân có thể xem.

application/json

• valueobject
• dataarraybắt buộc
• Mỗi mụcobject
• idstringbắt buộc

  format: "uuid"

• workspace_idstringbắt buộc

  format: "uuid"

• product_idstring | null

  Sản phẩm (dự án) chứa hộp thư. Ứng dụng khách dùng nó để nhóm hộp thư và tạo liên kết ứng dụng web.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringbắt buộc

  format: "email"

• display_namestringbắt buộc
• providerstringbắt buộc

  enum: "gmail", "smtp"

• statusstringbắt buộc

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringbắt buộc

  enum: "domain", "starter"

Ví dụ curl

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

Tạo hộp thư công việc gốc Banger trên tên miền gửi của không gian làm việc.

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu bắt buộc

application/json

• valueobject

  Không có thuộc tính bổ sung

• domain_idstringbắt buộc

  format: "uuid"

• local_partstringbắt buộc

  minLength: 1 · maxLength: 64

• display_namestring

  maxLength: 200

Phản hồi thành công 200

Lần gọi lại idempotent của việc tạo hộp thư gốc.

application/json

• valueobject
• dataobjectbắt buộc
• idstringbắt buộc

  format: "uuid"

• workspace_idstringbắt buộc

  format: "uuid"

• product_idstring | null

  Sản phẩm (dự án) chứa hộp thư. Ứng dụng khách dùng nó để nhóm hộp thư và tạo liên kết ứng dụng web.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringbắt buộc

  format: "email"

• display_namestringbắt buộc
• providerstringbắt buộc

  enum: "gmail", "smtp"

• statusstringbắt buộc

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringbắt buộc

  enum: "domain", "starter"

Ví dụ 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"
}'

Xem trước việc xóa hộp thư vĩnh viễn và các luồng gửi phụ thuộc. Cần quản trị viên không gian làm việc và phạm vi sản phẩm.

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu

Hợp đồng không quy định nội dung yêu cầu.

Phản hồi thành công 200

Hộp thư chính xác và tác động xóa hiện tại, không xóa gì.

application/json

• valueobject
• dataobjectbắt buộc
• mailboxobjectbắt buộc
• idstringbắt buộc

  format: "uuid"

• addressstringbắt buộc
• providerstringbắt buộc
• domain_idstring | nullbắt buộc

  format: "uuid"

• provider_connection_idstring | nullbắt buộc

  format: "uuid"

• messagesintegerbắt buộc
• draftsintegerbắt buộc
• pending_sendsintegerbắt buộc
• broadcastsarraybắt buộc
• Mỗi mụcobject
• idstringbắt buộc

  format: "uuid"

• namestringbắt buộc
• statusstringbắt buộc
• journeysarraybắt buộc
• Mỗi mụcobject
• idstringbắt buộc

  format: "uuid"

• namestringbắt buộc
• statusstringbắt buộc
• signup_formsarraybắt buộc
• Mỗi mụcobject
• idstringbắt buộc

  format: "uuid"

• namestringbắt buộc
• statusstringbắt buộc
• impactarraybắt buộc
• Mỗi mụcstring
• preview_tokenstringbắt buộc

Ví dụ curl

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

Đặt tên người gửi mà người nhận thấy trên email từ một hộp thư Banger ("Name <address>"). Hộp thư Gmail giữ tên đặt trong Gmail. Cần quản trị viên không gian làm việc.

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu bắt buộc

application/json

• valueobject

  Không có thuộc tính bổ sung

• display_namestringbắt buộc

  Một dòng. Để trống sẽ gửi địa chỉ thuần.

  maxLength: 200

Phản hồi thành công 200

Hộp thư cùng tên người gửi.

application/json

• valueobject
• dataobjectbắt buộc
• idstringbắt buộc

  format: "uuid"

• workspace_idstringbắt buộc

  format: "uuid"

• product_idstring | null

  Sản phẩm (dự án) chứa hộp thư. Ứng dụng khách dùng nó để nhóm hộp thư và tạo liên kết ứng dụng web.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringbắt buộc

  format: "email"

• display_namestringbắt buộc
• providerstringbắt buộc

  enum: "gmail", "smtp"

• statusstringbắt buộc

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringbắt buộc

  enum: "domain", "starter"

Ví dụ 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"
}'

Xóa vĩnh viễn một hộp thư, giữ tên miền và hộp thư khác. Cần quản trị viên không gian làm việc và phạm vi sản phẩm.

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu bắt buộc

application/json

• valueobject

  Không có thuộc tính bổ sung

• confirm_addressstringbắt buộc

  minLength: 3 · maxLength: 320

• preview_tokenstringbắt buộc

  minLength: 64 · maxLength: 64

Phản hồi thành công 200

Đã xóa hoặc gọi lại idempotent. Tệp đã lưu được xếp hàng để dọn vĩnh viễn.

application/json

• valueobject
• dataobjectbắt buộc
• idstringbắt buộc

  format: "uuid"

• addressstringbắt buộc
• deletedbooleanbắt buộc
• replayedboolean

Ví dụ 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"
}'

Tạo hộp thư được lưu trữ, giới hạn ở hộp thư đến được lưu trữ cùng sản phẩm và người nhận đăng ký không gian làm việc.

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu bắt buộc

application/json

• valueobject

  Không có thuộc tính bổ sung

• create_newboolean

  Tạo thêm hộp thư được lưu trữ thay vì tiếp tục hộp thư ban đầu.

• local_partstring

  Tên trước @bangermail.com. Nếu không có, hộp thư nhận tên gồm các từ như quiet-maple-harbor.

  minLength: 3 · maxLength: 40

• display_namestring

  maxLength: 200

Phản hồi thành công 200

Lần gọi lại idempotent của việc tạo danh tính khởi đầu.

application/json

• valueobject
• dataobjectbắt buộc
• idstringbắt buộc

  format: "uuid"

• workspace_idstringbắt buộc

  format: "uuid"

• product_idstring | null

  Sản phẩm (dự án) chứa hộp thư. Ứng dụng khách dùng nó để nhóm hộp thư và tạo liên kết ứng dụng web.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringbắt buộc

  format: "email"

• display_namestringbắt buộc
• providerstringbắt buộc

  enum: "gmail", "smtp"

• statusstringbắt buộc

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringbắt buộc

  enum: "domain", "starter"

Ví dụ 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"
}'

Tiếp tục một hộp thư bị tạm dừng do uy tín người gửi, theo quy tắc tự phục vụ của resumeSending.

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu bắt buộc

application/json

• valueobject

  Không có thuộc tính bổ sung

• acknowledge_recipient_complaintbooleanbắt buộc

  const: true

• reasonstring

  Lý do khôi phục gửi; được ghi trong nhật ký kiểm toán.

  maxLength: 500

Phản hồi thành công 200

Hộp thư đã kích hoạt lại, hoặc đã hoạt động sau yêu cầu thành công trước đó.

application/json

• valueobject
• dataobjectbắt buộc
• idstringbắt buộc

  format: "uuid"

• workspace_idstringbắt buộc

  format: "uuid"

• product_idstring | null

  Sản phẩm (dự án) chứa hộp thư. Ứng dụng khách dùng nó để nhóm hộp thư và tạo liên kết ứng dụng web.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringbắt buộc

  format: "email"

• display_namestringbắt buộc
• providerstringbắt buộc

  enum: "gmail", "smtp"

• statusstringbắt buộc

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

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringbắt buộc

  enum: "domain", "starter"

Ví dụ 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

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu

Hợp đồng không quy định nội dung yêu cầu.

Phản hồi thành công 200

Phản hồi thành công.

application/json

• valueobject
• dataarraybắt buộc
• Mỗi mụcobject
• idstringbắt buộc

  format: "uuid"

• mailbox_idstringbắt buộc

  format: "uuid"

• thread_idstring | nullbắt buộc

  format: "uuid"

• versionintegerbắt buộc
• toarraybắt buộc
• Mỗi mụcobject
• emailstringbắt buộc
• namestring
• ccarraybắt buộc
• Mỗi mụcobject
• emailstringbắt buộc
• namestring
• bccarraybắt buộc
• Mỗi mụcobject
• emailstringbắt buộc
• namestring
• subjectstringbắt buộc
• body_textstringbắt buộc
• statusstringbắt buộc
• created_atstringbắt buộc

  format: "date-time"

• updated_atstringbắt buộc

  format: "date-time"

• attachmentsarraybắt buộc
• Mỗi mụcobject
• idstringbắt buộc

  format: "uuid"

• filenamestringbắt buộc
• content_typestringbắt buộc
• size_bytesintegerbắt buộc
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

Ví dụ 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

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu bắt buộc

application/json

• valueobject

  Không có thuộc tính bổ sung

• mailbox_idstringbắt buộc

  format: "uuid"

• thread_idstring

  format: "uuid"

• toarray

  maxItems: 500

• Mỗi mụcobject
• namestring
• emailstringbắt buộc

  format: "email"

• ccarray

  maxItems: 500

• Mỗi mụcobject
• namestring
• emailstringbắt buộc

  format: "email"

• bccarray

  maxItems: 500

• Mỗi mụcobject
• namestring
• emailstringbắt buộc

  format: "email"

• subjectstring

  maxLength: 10000

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

Phản hồi thành công 201

Phản hồi thành công.

application/json

• valueobject
• dataobjectbắt buộc
• idstringbắt buộc

  format: "uuid"

• mailbox_idstringbắt buộc

  format: "uuid"

• thread_idstring | nullbắt buộc

  format: "uuid"

• versionintegerbắt buộc
• toarraybắt buộc
• Mỗi mụcobject
• emailstringbắt buộc
• namestring
• ccarraybắt buộc
• Mỗi mụcobject
• emailstringbắt buộc
• namestring
• bccarraybắt buộc
• Mỗi mụcobject
• emailstringbắt buộc
• namestring
• subjectstringbắt buộc
• body_textstringbắt buộc
• statusstringbắt buộc
• created_atstringbắt buộc

  format: "date-time"

• updated_atstringbắt buộc

  format: "date-time"

• attachmentsarraybắt buộc
• Mỗi mụcobject
• idstringbắt buộc

  format: "uuid"

• filenamestringbắt buộc
• content_typestringbắt buộc
• size_bytesintegerbắt buộc
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

Ví dụ 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

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu

Hợp đồng không quy định nội dung yêu cầu.

Phản hồi thành công 200

Hiệu suất gửi đến, tình trạng và sự cố theo dữ liệu chuẩn.

application/json

• valueobject
• dataobjectbắt buộc
• idstringbắt buộc

  format: "uuid"

• mailbox_idstringbắt buộc

  format: "uuid"

• thread_idstring | nullbắt buộc

  format: "uuid"

• versionintegerbắt buộc
• toarraybắt buộc
• Mỗi mụcobject
• emailstringbắt buộc
• namestring
• ccarraybắt buộc
• Mỗi mụcobject
• emailstringbắt buộc
• namestring
• bccarraybắt buộc
• Mỗi mụcobject
• emailstringbắt buộc
• namestring
• subjectstringbắt buộc
• body_textstringbắt buộc
• statusstringbắt buộc
• created_atstringbắt buộc

  format: "date-time"

• updated_atstringbắt buộc

  format: "date-time"

• attachmentsarraybắt buộc
• Mỗi mụcobject
• idstringbắt buộc

  format: "uuid"

• filenamestringbắt buộc
• content_typestringbắt buộc
• size_bytesintegerbắt buộc
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

Ví dụ curl

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

updateDraft

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu bắt buộc

application/json

• valuekhông quy định
• allOf 1object

  Không có thuộc tính bổ sung

• mailbox_idstringbắt buộc

  format: "uuid"

• thread_idstring

  format: "uuid"

• toarray

  maxItems: 500

• Mỗi mụcobject
• namestring
• emailstringbắt buộc

  format: "email"

• ccarray

  maxItems: 500

• Mỗi mụcobject
• namestring
• emailstringbắt buộc

  format: "email"

• bccarray

  maxItems: 500

• Mỗi mụcobject
• namestring
• emailstringbắt buộc

  format: "email"

• subjectstring

  maxLength: 10000

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

• allOf 2object
• versionintegerbắt buộc

  minimum: 1

Phản hồi thành công 200

Phản hồi thành công.

application/json

• valueobject
• dataobjectbắt buộc
• idstringbắt buộc

  format: "uuid"

• mailbox_idstringbắt buộc

  format: "uuid"

• thread_idstring | nullbắt buộc

  format: "uuid"

• versionintegerbắt buộc
• toarraybắt buộc
• Mỗi mụcobject
• emailstringbắt buộc
• namestring
• ccarraybắt buộc
• Mỗi mụcobject
• emailstringbắt buộc
• namestring
• bccarraybắt buộc
• Mỗi mụcobject
• emailstringbắt buộc
• namestring
• subjectstringbắt buộc
• body_textstringbắt buộc
• statusstringbắt buộc
• created_atstringbắt buộc

  format: "date-time"

• updated_atstringbắt buộc

  format: "date-time"

• attachmentsarraybắt buộc
• Mỗi mụcobject
• idstringbắt buộc

  format: "uuid"

• filenamestringbắt buộc
• content_typestringbắt buộc
• size_bytesintegerbắt buộc
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

Ví dụ 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

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu

Hợp đồng không quy định nội dung yêu cầu.

Phản hồi thành công 204

Bản nháp và đối tượng được tham chiếu đã lên lịch xóa.

Không có nội dung phản hồi.

Ví dụ curl

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

sendDraft

Gửi bản nháp từ hộp thư mà người gọi phải truy cập được. Người gọi cần phê duyệt khi gửi sẽ nhận yêu cầu phê duyệt đang chờ; người có thể gửi trực tiếp bản nháp sẽ quyết định.

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu

Hợp đồng không quy định nội dung yêu cầu.

Phản hồi thành công 202

Lượt gửi đã xếp hàng hoặc chờ phê duyệt.

application/json

• valueobject
• datakhông quy địnhbắt buộc
• oneOf 1object
• idstringbắt buộc

  format: "uuid"

• typestringbắt buộc
• statusstringbắt buộc

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

• workspace_revisionintegerbắt buộc

  format: "int64"

• created_atstringbắt buộc

  format: "date-time"

• oneOf 2object

  Không có thuộc tính bổ sung

• approvalobjectbắt buộc
• idstringbắt buộc

  format: "uuid"

• requested_by_actor_idstringbắt buộc
• action_kindstringbắt buộc
• summarystringbắt buộc
• capability_scopesarraybắt buộc
• Mỗi mụcstring
• resource_scopeobjectbắt buộc
• Thuộc tính bổ sungarray
• Mỗi mụcstring

  Lược bỏ phần lồng sâu hơn

• payloadobjectbắt buộc
• Thuộc tính bổ sungGiá trị bất kỳ
• payload_sha256stringbắt buộc

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

• statusstringbắt buộc

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

• missedbooleanbắt buộc
• expires_atstringbắt buộc

  format: "date-time"

• decided_by_actor_idstring | null
• decision_reasonstring | null
• created_atstringbắt buộc

  format: "date-time"

• updated_atstringbắt buộc

  format: "date-time"

• decided_atstring | null

  format: "date-time"

• execution_job_idstring

  format: "uuid"

• reviewobject

  Không có thuộc tính bổ sung

• dispositionstringbắt buộc

  enum: "automatic", "human_required"

• recipient_countinteger | nullbắt buộc

  minimum: 0

• reasonsarraybắt buộc
• Mỗi mụcstring

  Lược bỏ phần lồng sâu hơn

• checksarraybắt buộc
• Mỗi mụcstring

  Lược bỏ phần lồng sâu hơn

Ví dụ 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

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu bắt buộc

application/octet-stream

• valuestring

  format: "binary" · maxLength: 26214400

Phản hồi thành công 201

Phản hồi thành công.

application/json

• valueobject
• dataobjectbắt buộc
• idstringbắt buộc

  format: "uuid"

• filenamestringbắt buộc
• content_typestringbắt buộc
• size_bytesintegerbắt buộc
• sha256string
• created_atstring

  format: "date-time"

Ví dụ 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

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu

Hợp đồng không quy định nội dung yêu cầu.

Phản hồi thành công 204

Tệp đính kèm đã lên lịch xóa B2 có xét phiên bản.

Không có nội dung phản hồi.

Ví dụ curl

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

Đọc nội dung HTML bản nháp

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu

Hợp đồng không quy định nội dung yêu cầu.

Phản hồi thành công 200

HTML bản nháp.

text/html

• valuestring

Ví dụ curl

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

listSendIntents

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu

Hợp đồng không quy định nội dung yêu cầu.

Phản hồi thành công 200

Lượt gửi chuẩn gần đây và trạng thái nhà cung cấp.

application/json

• valueobject
• dataarraybắt buộc
• Mỗi mụcobject

  Không có thuộc tính bổ sung

• idstringbắt buộc

  format: "uuid"

• statusstringbắt buộc

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

• traffic_classstringbắt buộc

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

• recipient_countintegerbắt buộc

  minimum: 1

• provider_keystringbắt buộc
• provider_statestringbắt buộc

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

• provider_message_idstring | null
• error_codestring | null
• created_atstringbắt buộc

  format: "date-time"

• updated_atstringbắt buộc

  format: "date-time"

• completed_atstring | null

  format: "date-time"

Ví dụ curl

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

getSendIntent

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu

Hợp đồng không quy định nội dung yêu cầu.

Phản hồi thành công 200

Trạng thái gửi bất đồng bộ chuẩn.

application/json

• valueobject
• dataobjectbắt buộc

  Không có thuộc tính bổ sung

• idstringbắt buộc

  format: "uuid"

• statusstringbắt buộc

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

• traffic_classstringbắt buộc

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

• recipient_countintegerbắt buộc

  minimum: 1

• provider_keystringbắt buộc
• provider_statestringbắt buộc

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

• provider_message_idstring | null
• error_codestring | null
• created_atstringbắt buộc

  format: "date-time"

• updated_atstringbắt buộc

  format: "date-time"

• completed_atstring | null

  format: "date-time"

Ví dụ curl

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

listTransactionalSends

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu

Hợp đồng không quy định nội dung yêu cầu.

Phản hồi thành công 200

Phản hồi thành công.

application/json

• valueobject
• dataarraybắt buộc
• Mỗi mụcobject
• idstringbắt buộc

  format: "uuid"

• mailbox_idstring | nullbắt buộc

  format: "uuid"

• command_idstring | nullbắt buộc

  format: "uuid"

• statusstringbắt buộc
• command_statusstring | nullbắt buộc
• subjectstring
• recipientsarray
• Mỗi mụcobject
• emailstringbắt buộc
• namestring
• recipient_countintegerbắt buộc
• error_codestring | null
• send_intent_idstring

  format: "uuid"

• providerstring | null
• route_kindstring | null
• sourcestring
• from_addressstring
• recipient_statesobject
• Thuộc tính bổ sunginteger
• provider_message_idstring | null
• languagekhông quy định

  Ngôn ngữ gửi email này; null nếu không được dịch.

• anyOf 1object

  Ngôn ngữ người nhận nhận được email. Chỉ email được dịch (nội dung được quản lý) mới có.

• localestringbắt buộc

  Thẻ BCP 47 của ngôn ngữ dùng viết email.

• requested_localestring

  Chỉ có ở lượt gửi cũ bằng ngôn ngữ khác: ngôn ngữ người nhận lẽ ra phải nhận.

• fallback_reasonstring

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

• anyOf 2null
• journeyobject | null

  Bước hành trình và lượt tham gia đã gửi email này; null với lượt gửi khác.

• journey_idstringbắt buộc

  format: "uuid"

• step_idstringbắt buộc

  format: "uuid"

• enrollment_idstringbắt buộc

  format: "uuid"

• experimentobject | null

  Biến thể thử nghiệm của email này; null khi không áp dụng.

• experiment_idstringbắt buộc

  format: "uuid"

• variant_keystringbắt buộc
• created_atstringbắt buộc

  format: "date-time"

• updated_atstringbắt buộc

  format: "date-time"

• completed_atstring | nullbắt buộc

  format: "date-time"

• template_idstring | null

  format: "uuid"

• template_versioninteger | null
• workspace_revisioninteger | null
• command_resultobject
• Thuộc tính bổ sungGiá trị bất kỳ
• command_started_atstring | null

  format: "date-time"

• command_completed_atstring | null

  format: "date-time"

• body_textstring
• body_htmlstring
• reply_toarray
• Mỗi mụcobject
• emailstringbắt buộc
• namestring
• headersobject
• Thuộc tính bổ sungstring
• tagsarray
• Mỗi mụcobject
• namestringbắt buộc
• valuestringbắt buộc

Ví dụ curl

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

createTransactionalSend

Một người nhận mỗi lượt gửi hành trình. To nhận một người theo bất kỳ dạng RecipientInput nào ("a@example.com", "Pat <a@example.com>", { email, name }, hoặc danh sách một phần tử); Cc và Bcc phải trống. reply_to mặc định là hộp thư hành trình (danh sách trống cũng là mặc định); email Sản phẩm cần đúng một. Hành trình API mới mặc định dùng nội dung nguồn được quản lý; hành trình mã cũ giữ gửi nội dung đầy đủ. Từ chối (4xx) không cố định gì cho người nhận, nên lệnh đã sửa với khóa idempotency mới sẽ gửi.

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu bắt buộc

application/json

• valueobject
• mailbox_idstringbắt buộc

  format: "uuid"

• tokhông quy địnhbắt buộc

  Người nhận cho to, cc, bcc và reply_to: địa chỉ ("a@example.com" hoặc "Pat <a@example.com>"), đối tượng { email, name }, hoặc danh sách kết hợp cả hai. Banger lưu dưới dạng đối tượng { email, name } với email viết thường. Mã băm idempotency bao gồm body như đã gửi, nên thử lại cùng dạng.

• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringbắt buộc

  format: "email"

• oneOf 3array

  maxItems: 500

• Mỗi mụckhông quy định
• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringbắt buộc

  format: "email"

• ccarray

  maxItems: 0

• Mỗi mụcobject
• namestring
• emailstringbắt buộc

  format: "email"

• bccarray

  maxItems: 0

• Mỗi mụcobject
• namestring
• emailstringbắt buộc

  format: "email"

• subjectstring

  maxLength: 10000

• expires_atstring

  Loại bỏ lượt gửi hành trình bị hoãn sau thời điểm này; tối đa bảy ngày từ yêu cầu gốc.

  format: "date-time"

• expires_after_secondsinteger

  minimum: 1 · maximum: 604800

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

• reply_tokhông quy định

  Người nhận cho to, cc, bcc và reply_to: địa chỉ ("a@example.com" hoặc "Pat <a@example.com>"), đối tượng { email, name }, hoặc danh sách kết hợp cả hai. Banger lưu dưới dạng đối tượng { email, name } với email viết thường. Mã băm idempotency bao gồm body như đã gửi, nên thử lại cùng dạng.

• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringbắt buộc

  format: "email"

• oneOf 3array

  maxItems: 500

• Mỗi mụckhông quy định
• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringbắt buộc

  format: "email"

• headersobject
• Thuộc tính bổ sungstring

  maxLength: 5000

• tagsarray

  maxItems: 49

• Mỗi mụcobject

  Không có thuộc tính bổ sung

• namestringbắt buộc

  minLength: 1 · maxLength: 256

• valuestringbắt buộc

  minLength: 1 · maxLength: 256

Phản hồi thành công 202

Phản hồi thành công.

application/json

• valueobject
• dataobjectbắt buộc
• action_kindstringbắt buộc

  enum: "transactional.send"

• idstring

  format: "uuid"

• send_intent_idstring

  format: "uuid"

• provider_attempt_idstring

  format: "uuid"

• statusstringbắt buộc

  Trạng thái sent/queued từ chuyển phát, hoặc với yêu cầu đã cố định: deferred (lên lịch theo chính sách hoặc chờ dịch), processing (đang gửi), discarded.

• replayedboolean
• journeykhông quy địnhbắt buộc
• anyOf 1object
• journey_idstringbắt buộc

  format: "uuid"

• enrollment_idstringbắt buộc

  format: "uuid"

• step_idstringbắt buộc

  format: "uuid"

• step_positionintegerbắt buộc
• originstring

  enum: "journey"

• journey_identitystring
• anyOf 2null
• ignored_variablesarraybắt buộc
• Mỗi mụcstring
• scheduled_atstring

  format: "date-time"

• reasonstring
• communication_reservation_idstring

  format: "uuid"

Ví dụ 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

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu

Hợp đồng không quy định nội dung yêu cầu.

Phản hồi thành công 200

Phản hồi thành công.

application/json

• valueobject
• dataobjectbắt buộc
• idstringbắt buộc

  format: "uuid"

• mailbox_idstring | nullbắt buộc

  format: "uuid"

• command_idstring | nullbắt buộc

  format: "uuid"

• statusstringbắt buộc
• command_statusstring | nullbắt buộc
• subjectstring
• recipientsarray
• Mỗi mụcobject
• emailstringbắt buộc
• namestring
• recipient_countintegerbắt buộc
• error_codestring | null
• send_intent_idstring

  format: "uuid"

• providerstring | null
• route_kindstring | null
• sourcestring
• from_addressstring
• recipient_statesobject
• Thuộc tính bổ sunginteger
• provider_message_idstring | null
• languagekhông quy định

  Ngôn ngữ gửi email này; null nếu không được dịch.

• anyOf 1object

  Ngôn ngữ người nhận nhận được email. Chỉ email được dịch (nội dung được quản lý) mới có.

• localestringbắt buộc

  Thẻ BCP 47 của ngôn ngữ dùng viết email.

• requested_localestring

  Chỉ có ở lượt gửi cũ bằng ngôn ngữ khác: ngôn ngữ người nhận lẽ ra phải nhận.

• fallback_reasonstring

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

• anyOf 2null
• journeyobject | null

  Bước hành trình và lượt tham gia đã gửi email này; null với lượt gửi khác.

• journey_idstringbắt buộc

  format: "uuid"

• step_idstringbắt buộc

  format: "uuid"

• enrollment_idstringbắt buộc

  format: "uuid"

• experimentobject | null

  Biến thể thử nghiệm của email này; null khi không áp dụng.

• experiment_idstringbắt buộc

  format: "uuid"

• variant_keystringbắt buộc
• created_atstringbắt buộc

  format: "date-time"

• updated_atstringbắt buộc

  format: "date-time"

• completed_atstring | nullbắt buộc

  format: "date-time"

• template_idstring | null

  format: "uuid"

• template_versioninteger | null
• workspace_revisioninteger | null
• command_resultobject
• Thuộc tính bổ sungGiá trị bất kỳ
• command_started_atstring | null

  format: "date-time"

• command_completed_atstring | null

  format: "date-time"

• body_textstring
• body_htmlstring
• reply_toarray
• Mỗi mụcobject
• emailstringbắt buộc
• namestring
• headersobject
• Thuộc tính bổ sungstring
• tagsarray
• Mỗi mụcobject
• namestringbắt buộc
• valuestringbắt buộc

Ví dụ curl

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

listTransactionalSendTimeline

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu

Hợp đồng không quy định nội dung yêu cầu.

Phản hồi thành công 200

Dòng thời gian có thứ tự về chấp nhận, lần thử của nhà cung cấp và sự kiện người nhận.

application/json

• valueobject
• dataarraybắt buộc
• Mỗi mụcobject
• occurred_atstringbắt buộc

  format: "date-time"

• event_typestringbắt buộc
• labelstringbắt buộc
• providerstring | null
• recipient_domainstring | null
• error_codestring | null

Ví dụ curl

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

retryTransactionalSend

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu

Hợp đồng không quy định nội dung yêu cầu.

Phản hồi thành công 202

Phản hồi thành công.

application/json

• valueobject
• dataobjectbắt buộc
• action_kindstringbắt buộc

  enum: "transactional.send"

• idstringbắt buộc

  format: "uuid"

• send_intent_idstringbắt buộc

  format: "uuid"

• provider_attempt_idstringbắt buộc

  format: "uuid"

• statusstringbắt buộc
• replayedbooleanbắt buộc

Ví dụ 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

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu

Hợp đồng không quy định nội dung yêu cầu.

Phản hồi thành công 200

Chuỗi hội thoại không gian làm việc phân trang keyset.

application/json

• valueobject
• dataarraybắt buộc
• Mỗi mụcobject
• idstringbắt buộc

  format: "uuid"

• mailbox_idstringbắt buộc

  format: "uuid"

• subjectstringbắt buộc
• snippetstringbắt buộc
• last_message_atstringbắt buộc

  format: "date-time"

• message_countintegerbắt buộc
• unread_countintegerbắt buộc
• is_archivedbooleanbắt buộc
• is_trashbooleanbắt buộc
• is_spambooleanbắt buộc
• is_starredbooleanbắt buộc
• is_sentbooleanbắt buộc
• has_attachmentsbooleanbắt buộc
• labelsarraybắt buộc
• Mỗi mụcstring
• participantsarray
• Mỗi mụcobject
• namestring
• emailstringbắt buộc

  format: "email"

• pageobjectbắt buộc
• next_cursorstring
• has_morebooleanbắt buộc

Ví dụ 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

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu

Hợp đồng không quy định nội dung yêu cầu.

Phản hồi thành công 200

Chuỗi hội thoại và tin nhắn có thứ tự.

application/json

• valueobject
• datakhông quy địnhbắt buộc
• allOf 1object
• idstringbắt buộc

  format: "uuid"

• mailbox_idstringbắt buộc

  format: "uuid"

• subjectstringbắt buộc
• snippetstringbắt buộc
• last_message_atstringbắt buộc

  format: "date-time"

• message_countintegerbắt buộc
• unread_countintegerbắt buộc
• is_archivedbooleanbắt buộc
• is_trashbooleanbắt buộc
• is_spambooleanbắt buộc
• is_starredbooleanbắt buộc
• is_sentbooleanbắt buộc
• has_attachmentsbooleanbắt buộc
• labelsarraybắt buộc
• Mỗi mụcstring
• participantsarray
• Mỗi mụcobject
• namestring
• emailstringbắt buộc

  format: "email"

• allOf 2object
• messagesarraybắt buộc
• Mỗi mụcobject
• idstringbắt buộc

  format: "uuid"

• mailbox_idstringbắt buộc

  format: "uuid"

• thread_idstringbắt buộc

  format: "uuid"

• sent_atstringbắt buộc

  format: "date-time"

• received_atstring

  format: "date-time"

• envelope_recipientsarray

  Người nhận phong bì SMTP gốc, đã chuẩn hóa chữ hoa/thường tại biên SMTP, trước khi định tuyến bí danh chỉ nhận. Trống với tin cũ hoặc nguồn không dùng SMTP. Độc lập với header To/Cc hiển thị.

• Mỗi mụcstring

  format: "email"

  Lược bỏ phần lồng sâu hơn

• fromobjectbắt buộc
• namestring

  Lược bỏ phần lồng sâu hơn

• emailstringbắt buộc

  format: "email"

  Lược bỏ phần lồng sâu hơn

• toarraybắt buộc
• Mỗi mụcobject

  Lược bỏ phần lồng sâu hơn

• ccarray
• Mỗi mụcobject

  Lược bỏ phần lồng sâu hơn

• reply_toarray
• Mỗi mụcobject

  Lược bỏ phần lồng sâu hơn

• is_sentboolean

  Tin nhắn này có được hộp thư gửi hay không, kể cả từ bí danh.

• body_textstring
• body_html_urlstring

  format: "uri"

• reply_originobject
• send_intent_idstringbắt buộc

  format: "uuid"

  Lược bỏ phần lồng sâu hơn

• sourcestringbắt buộc

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

  Lược bỏ phần lồng sâu hơn

• source_idstring

  format: "uuid"

  Lược bỏ phần lồng sâu hơn

• traffic_classstringbắt buộc

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

  Lược bỏ phần lồng sâu hơn

• kindstringbắt buộc

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

  Lược bỏ phần lồng sâu hơn

• namestring

  Lược bỏ phần lồng sâu hơn

• has_attachmentsbooleanbắt buộc
• attachmentsarray
• Mỗi mụcobject

  Lược bỏ phần lồng sâu hơn

Ví dụ curl

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

getMessageHtml

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu

Hợp đồng không quy định nội dung yêu cầu.

Phản hồi thành công 200

Nội dung tin nhắn HTML có xác thực, bị giới hạn bởi sandbox.

text/html

• valuestring

Ví dụ curl

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

downloadAttachment

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu

Hợp đồng không quy định nội dung yêu cầu.

Phản hồi thành công 200

Luồng tệp đính kèm có xác thực.

application/octet-stream

• valuestring

  format: "binary"

Ví dụ curl

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

searchMail

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu

Hợp đồng không quy định nội dung yêu cầu.

Phản hồi thành công 200

Kết quả tìm kiếm toàn không gian làm việc.

application/json

• valueobject
• dataarraybắt buộc
• Mỗi mụcobject
• idstringbắt buộc

  format: "uuid"

• mailbox_idstringbắt buộc

  format: "uuid"

• subjectstringbắt buộc
• snippetstringbắt buộc
• last_message_atstringbắt buộc

  format: "date-time"

• message_countintegerbắt buộc
• unread_countintegerbắt buộc
• is_archivedbooleanbắt buộc
• is_trashbooleanbắt buộc
• is_spambooleanbắt buộc
• is_starredbooleanbắt buộc
• is_sentbooleanbắt buộc
• has_attachmentsbooleanbắt buộc
• labelsarraybắt buộc
• Mỗi mụcstring
• participantsarray
• Mỗi mụcobject
• namestring
• emailstringbắt buộc

  format: "email"

• pageobjectbắt buộc
• next_cursorstring
• has_morebooleanbắt buộc

Ví dụ 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

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu

Hợp đồng không quy định nội dung yêu cầu.

Phản hồi thành công 200

Phản hồi thành công.

application/json

• valueobject
• dataarraybắt buộc
• Mỗi mụcobject
• idstringbắt buộc

  format: "uuid"

• emailstringbắt buộc

  format: "email"

• display_namestring | nullbắt buộc
• attributesobjectbắt buộc
• Thuộc tính bổ sungGiá trị bất kỳ
• statusstringbắt buộc

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

• created_atstringbắt buộc

  format: "date-time"

• updated_atstringbắt buộc

  format: "date-time"

• pageobjectbắt buộc
• next_cursorstring
• has_morebooleanbắt buộc

Ví dụ 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

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu bắt buộc

application/json

• valueobject

  Không có thuộc tính bổ sung

• emailstringbắt buộc

  format: "email"

• display_namestring

  maxLength: 1000

• statusstringbắt buộc

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

• attributesobject
• Thuộc tính bổ sungGiá trị bất kỳ
• consent_confirmedboolean

  Bắt buộc khi đăng ký nhận tin mới cho địa chỉ.

Phản hồi thành công 201

Phản hồi thành công.

application/json

• valueobject
• dataobjectbắt buộc
• idstringbắt buộc

  format: "uuid"

• emailstringbắt buộc

  format: "email"

• display_namestring | nullbắt buộc
• attributesobjectbắt buộc
• Thuộc tính bổ sungGiá trị bất kỳ
• statusstringbắt buộc

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

• created_atstringbắt buộc

  format: "date-time"

• updated_atstringbắt buộc

  format: "date-time"

Ví dụ 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

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu

Hợp đồng không quy định nội dung yêu cầu.

Phản hồi thành công 200

Phản hồi thành công.

application/json

• valueobject
• dataobjectbắt buộc
• idstringbắt buộc

  format: "uuid"

• emailstringbắt buộc

  format: "email"

• display_namestring | nullbắt buộc
• attributesobjectbắt buộc
• Thuộc tính bổ sungGiá trị bất kỳ
• statusstringbắt buộc

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

• created_atstringbắt buộc

  format: "date-time"

• updated_atstringbắt buộc

  format: "date-time"

• suppressedbooleanbắt buộc
• suppression_reasonstring | nullbắt buộc
• sourcesarraybắt buộc
• Mỗi mụcobject
• kindstringbắt buộc
• referencestringbắt buộc
• connection_idstring | nullbắt buộc

  format: "uuid"

• metadataobjectbắt buộc
• Thuộc tính bổ sungGiá trị bất kỳ
• first_seen_atstringbắt buộc

  format: "date-time"

• last_seen_atstringbắt buộc

  format: "date-time"

• listsarraybắt buộc
• Mỗi mụcobject
• idstringbắt buộc

  format: "uuid"

• namestringbắt buộc
• subscription_statusstringbắt buộc
• consent_evidencearraybắt buộc
• Mỗi mụcobject
• kindstringbắt buộc
• referencestringbắt buộc
• connection_idstring | nullbắt buộc

  format: "uuid"

• metadataobjectbắt buộc
• Thuộc tính bổ sungGiá trị bất kỳ
• first_seen_atstringbắt buộc

  format: "date-time"

• last_seen_atstringbắt buộc

  format: "date-time"

Ví dụ curl

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

deleteContact

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu

Hợp đồng không quy định nội dung yêu cầu.

Phản hồi thành công 204

Đã xóa liên hệ.

Không có nội dung phản hồi.

Ví dụ curl

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

listContactImports

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu

Hợp đồng không quy định nội dung yêu cầu.

Phản hồi thành công 200

Phản hồi thành công.

application/json

• valueobject
• dataarraybắt buộc
• Mỗi mụcobject
• idstring

  format: "uuid"

• filenamestring
• list_idstring | null

  format: "uuid"

• list_namestring | null
• statusstring
• total_rowsinteger
• imported_rowsinteger
• invalid_rowsinteger
• error_summaryarray
• Mỗi mụcstring
• 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"

Ví dụ curl

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

importContacts

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu bắt buộc

application/json

• valueobject
• filenamestringbắt buộc

  minLength: 1 · maxLength: 500

• list_idstring

  format: "uuid"

• consent_confirmedboolean

  Bắt buộc khi bất kỳ hàng nhập nào đăng ký nhận tin.

• rowsarraybắt buộc

  minItems: 1 · maxItems: 5000

• Mỗi mụcobject
• emailstringbắt buộc

  format: "email"

• display_namestring

  maxLength: 1000

• statusstring

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

• attributesobject
• Thuộc tính bổ sungGiá trị bất kỳ

Phản hồi thành công 201

Phản hồi thành công.

application/json

• valueobject
• dataobjectbắt buộc
• idstringbắt buộc

  format: "uuid"

• statusstringbắt buộc

  enum: "queued"

• total_rowsintegerbắt buộc
• imported_rowsintegerbắt buộc
• invalid_rowsintegerbắt buộc
• list_idstring | nullbắt buộc

  format: "uuid"

Ví dụ 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": {}
    }
  ]
}'

Gộp thuộc tính có kiểu mà không đổi đăng ký hay đồng ý

Cần contacts:write và contacts:read. Chỉ cập nhật liên hệ hiện có. Giữ thuộc tính bỏ qua, lưu false rõ ràng, và null xóa trường. Cung cấp dữ kiện nguồn đã xác minh; dữ liệu vắng không phải false. Đăng ký, chặn gửi, danh tính và lịch sử nguồn không đổi.

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu bắt buộc

application/json

• valueobject

  Không có thuộc tính bổ sung

• attributesobjectbắt buộc
• Thuộc tính bổ sungGiá trị bất kỳ

Phản hồi thành công 200

Dữ liệu liên hệ đọc lại hiện tại; replayed là true khi thay đổi đã áp dụng.

application/json

• valueobject
• dataobjectbắt buộc
• idstringbắt buộc

  format: "uuid"

• attributesobjectbắt buộc
• Thuộc tính bổ sungGiá trị bất kỳ
• statusstringbắt buộc

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

• replayedbooleanbắt buộc
• Thuộc tính bổ sungGiá trị bất kỳ

Ví dụ 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

Xác thực: khóa API không gian làm việc dạng Bearer.

Tham số

Nội dung yêu cầu bắt buộc

application/json

• valueobject

  Không có thuộc tính bổ sung

• emailstringbắt buộc

  format: "email" · maxLength: 320

• display_namestring

  minLength: 0 · maxLength: 1000

• attributesobject
• Thuộc tính bổ sungGiá trị bất kỳ
• statusstringbắt buộc

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

• consent_evidenceobject

  Không có thuộc tính bổ sung

• sourcestring

  minLength: 1 · maxLength: 2000

• referencestring

  minLength: 1 · maxLength: 2000

• observed_atstring

  format: "date-time"

• statementstring

  minLength: 1 · maxLength: 2000

• consent_confirmedboolean

Phản hồi thành công 200

Dữ liệu chuẩn đọc lại hoặc biên nhận idempotent. Nhà cung cấp chấp nhận là sent; delivered cần sự kiện chuyển phát và không chứng minh email vào hộp thư đến.

application/json

• valueobject
• datakhông quy địnhbắt buộc
• allOf 1object
• idstringbắt buộc

  format: "uuid"

• emailstringbắt buộc

  format: "email"

• display_namestring | nullbắt buộc
• attributesobjectbắt buộc
• Thuộc tính bổ sungGiá trị bất kỳ
• statusstringbắt buộc

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

• created_atstringbắt buộc

  format: "date-time"

• updated_atstringbắt buộc

  format: "date-time"

• suppressedbooleanbắt buộc
• suppression_reasonstring | nullbắt buộc
• sourcesarraybắt buộc
• Mỗi mụcobject
• kindstringbắt buộc
• referencestringbắt buộc
• connection_idstring | nullbắt buộc

  format: "uuid"

• metadataobjectbắt buộc
• Thuộc tính bổ sungGiá trị bất kỳ
• first_seen_atstringbắt buộc

  format: "date-time"

• last_seen_atstringbắt buộc

  format: "date-time"

• listsarraybắt buộc
• Mỗi mụcobject
• idstringbắt buộc

  format: "uuid"

• namestringbắt buộc
• subscription_statusstringbắt buộc
• consent_evidencearraybắt buộc
• Mỗi mụcobject
• kindstringbắt buộc
• referencestringbắt buộc
• connection_idstring | nullbắt buộc

  format: "uuid"

• metadataobjectbắt buộc
• Thuộc tính bổ sungGiá trị bất kỳ
• first_seen_atstringbắt buộc

  format: "date-time"

• last_seen_atstringbắt buộc

  format: "date-time"

• allOf 2object
• replayedbooleanbắt buộc