เอกสารอ้างอิง Banger API

แสดงผลิตภัณฑ์ในพื้นที่ทำงาน

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ

สัญญาไม่ได้ระบุเนื้อหาคำขอ

การตอบกลับสำเร็จ 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"

สร้างผลิตภัณฑ์

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ จำเป็น

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

ดึงผลิตภัณฑ์

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ

สัญญาไม่ได้ระบุเนื้อหาคำขอ

การตอบกลับสำเร็จ 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"

อัปเดตผลิตภัณฑ์

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ จำเป็น

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

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ จำเป็น

application/json

• valueobject

  ไม่มีพร็อพเพอร์ตีเพิ่มเติม

• confirm_namestringจำเป็น

  ชื่อผลิตภัณฑ์ที่ตรงทุกตัวอักษร

  minLength: 1 · maxLength: 160

• preview_tokenstringจำเป็น

  minLength: 64 · maxLength: 64

การตอบกลับสำเร็จ 202

ผลิตภัณฑ์หยุดใช้งานและถูกลบถาวรเมื่อถึง delete_after เว้นแต่กู้คืนก่อน การเรียกซ้ำแบบ idempotent คืนผลเดิม

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 ที่ผู้ใช้อนุญาต

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ

สัญญาไม่ได้ระบุเนื้อหาคำขอ

การตอบกลับสำเร็จ 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 ที่ผู้ใช้อนุญาต

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ

สัญญาไม่ได้ระบุเนื้อหาคำขอ

การตอบกลับสำเร็จ 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"

อัปเดตรายการตั้งค่าผลิตภัณฑ์

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ จำเป็น

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

เชื่อมโดเมนกับผลิตภัณฑ์

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ จำเป็น

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

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ

สัญญาไม่ได้ระบุเนื้อหาคำขอ

การตอบกลับสำเร็จ 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 ในโดเมนส่งของพื้นที่ทำงาน

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ จำเป็น

application/json

• valueobject

  ไม่มีพร็อพเพอร์ตีเพิ่มเติม

• domain_idstringจำเป็น

  format: "uuid"

• local_partstringจำเป็น

  minLength: 1 · maxLength: 64

• display_namestring

  maxLength: 200

การตอบกลับสำเร็จ 200

การเรียกซ้ำแบบ idempotent สำหรับการสร้างกล่องจดหมายบนระบบ

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

ดูตัวอย่างการลบกล่องจดหมายถาวรและขั้นตอนส่งที่พึ่งพา ต้องเป็นผู้ดูแลพื้นที่ทำงานและมีขอบเขตผลิตภัณฑ์

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ

สัญญาไม่ได้ระบุเนื้อหาคำขอ

การตอบกลับสำเร็จ 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 ต่อไป ต้องเป็นผู้ดูแลพื้นที่ทำงาน

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ จำเป็น

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

ลบหนึ่งกล่องจดหมายถาวรโดยเก็บโดเมนและกล่องจดหมายอื่น ต้องเป็นผู้ดูแลพื้นที่ทำงานและมีขอบเขตผลิตภัณฑ์

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ จำเป็น

application/json

• valueobject

  ไม่มีพร็อพเพอร์ตีเพิ่มเติม

• confirm_addressstringจำเป็น

  minLength: 3 · maxLength: 320

• preview_tokenstringจำเป็น

  minLength: 64 · maxLength: 64

การตอบกลับสำเร็จ 200

ลบแล้วหรือเป็นการเรียกซ้ำแบบ idempotent ไฟล์ที่จัดเก็บเข้าคิวเพื่อล้างถาวร

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

สร้างกล่องจดหมายที่โฮสต์ โดยจำกัดให้ติดต่อกล่องจดหมายเข้าที่โฮสต์ของผลิตภัณฑ์เดียวกันและผู้รับที่สมัครพื้นที่ทำงาน

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ จำเป็น

application/json

• valueobject

  ไม่มีพร็อพเพอร์ตีเพิ่มเติม

• create_newboolean

  สร้างกล่องจดหมายที่โฮสต์เพิ่มแทนการกลับมาใช้กล่องแรก

• local_partstring

  ชื่อก่อน @bangermail.com หากไม่ระบุ กล่องจดหมายจะได้ชื่อจากคำ เช่น quiet-maple-harbor

  minLength: 3 · maxLength: 40

• display_namestring

  maxLength: 200

การตอบกลับสำเร็จ 200

การเรียกซ้ำแบบ idempotent สำหรับการสร้างตัวตนเริ่มต้น

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

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ จำเป็น

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

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ

สัญญาไม่ได้ระบุเนื้อหาคำขอ

การตอบกลับสำเร็จ 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

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ จำเป็น

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

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ

สัญญาไม่ได้ระบุเนื้อหาคำขอ

การตอบกลับสำเร็จ 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

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ จำเป็น

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

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ

สัญญาไม่ได้ระบุเนื้อหาคำขอ

การตอบกลับสำเร็จ 204

ฉบับร่างและออบเจ็กต์ที่อ้างถึงถูกตั้งเวลาลบ

ไม่มีเนื้อหาการตอบกลับ

ตัวอย่าง curl

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

sendDraft

ส่งฉบับร่างจากกล่องจดหมายที่ผู้เรียกต้องเข้าถึงได้ ผู้เรียกที่ต้องขออนุมัติการส่งจะได้รับการอนุมัติที่รอดำเนินการแทน ผู้ที่ส่งฉบับร่างโดยตรงได้เป็นผู้ตัดสิน

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ

สัญญาไม่ได้ระบุเนื้อหาคำขอ

การตอบกลับสำเร็จ 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

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ จำเป็น

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

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ

สัญญาไม่ได้ระบุเนื้อหาคำขอ

การตอบกลับสำเร็จ 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 ของฉบับร่าง

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ

สัญญาไม่ได้ระบุเนื้อหาคำขอ

การตอบกลับสำเร็จ 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

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ

สัญญาไม่ได้ระบุเนื้อหาคำขอ

การตอบกลับสำเร็จ 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

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ

สัญญาไม่ได้ระบุเนื้อหาคำขอ

การตอบกลับสำเร็จ 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

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ

สัญญาไม่ได้ระบุเนื้อหาคำขอ

การตอบกลับสำเร็จ 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) จะไม่ตรึงสิ่งใดของผู้รับ ดังนั้นคำขอที่แก้แล้วพร้อมคีย์ idempotency ใหม่จะส่งได้

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ จำเป็น

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 } โดยอีเมลเป็นตัวพิมพ์เล็ก แฮช idempotency ครอบคลุมเนื้อหาตามที่ส่ง จึงต้องลองซ้ำด้วยรูปแบบเดิม

• 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

  ยกเลิกการส่งเส้นทางที่เลื่อนหลังเวลานี้ ไม่เกินเจ็ดวันจากคำขอเดิม

  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 } โดยอีเมลเป็นตัวพิมพ์เล็ก แฮช idempotency ครอบคลุมเนื้อหาตามที่ส่ง จึงต้องลองซ้ำด้วยรูปแบบเดิม

• 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

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ

สัญญาไม่ได้ระบุเนื้อหาคำขอ

การตอบกลับสำเร็จ 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

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ

สัญญาไม่ได้ระบุเนื้อหาคำขอ

การตอบกลับสำเร็จ 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

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ

สัญญาไม่ได้ระบุเนื้อหาคำขอ

การตอบกลับสำเร็จ 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

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ

สัญญาไม่ได้ระบุเนื้อหาคำขอ

การตอบกลับสำเร็จ 200

เธรดพื้นที่ทำงานที่แบ่งหน้าแบบ keyset

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

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ

สัญญาไม่ได้ระบุเนื้อหาคำขอ

การตอบกลับสำเร็จ 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

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ

สัญญาไม่ได้ระบุเนื้อหาคำขอ

การตอบกลับสำเร็จ 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

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ

สัญญาไม่ได้ระบุเนื้อหาคำขอ

การตอบกลับสำเร็จ 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

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ

สัญญาไม่ได้ระบุเนื้อหาคำขอ

การตอบกลับสำเร็จ 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

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ

สัญญาไม่ได้ระบุเนื้อหาคำขอ

การตอบกลับสำเร็จ 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

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ จำเป็น

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

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ

สัญญาไม่ได้ระบุเนื้อหาคำขอ

การตอบกลับสำเร็จ 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

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ

สัญญาไม่ได้ระบุเนื้อหาคำขอ

การตอบกลับสำเร็จ 204

ลบรายชื่อติดต่อแล้ว

ไม่มีเนื้อหาการตอบกลับ

ตัวอย่าง curl

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

listContactImports

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ

สัญญาไม่ได้ระบุเนื้อหาคำขอ

การตอบกลับสำเร็จ 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

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ จำเป็น

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 การสมัครรับข่าวสาร การระงับ ตัวตน และประวัติแหล่งข้อมูลไม่เปลี่ยน

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ จำเป็น

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

การยืนยันตัวตน: คีย์ API พื้นที่ทำงานแบบ Bearer

พารามิเตอร์

เนื้อหาคำขอ จำเป็น

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

ข้อมูลหลักที่อ่านกลับหรือใบรับแบบ idempotent ผู้ให้บริการรับแล้วคือ 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จำเป็น