API reference

อีเมลและเธรด

ส่ง ดึง ค้นหา ตอบกลับ และตรวจสอบอีเวนต์การส่งถึง

กรองอีเมลและเธรด

POST/emails

API key

ส่งอีเมลหนึ่งฉบับ

ส่งเนื้อหา HTML ข้อความ หรือเทมเพลตแบบโฮสต์ประเภท transactional จากโดเมนเวิร์กสเปซที่ยืนยันแล้ว การส่งโดยตรงสามารถตั้ง message_class เป็น marketing ได้เมื่อเปิดใช้สำหรับโดเมนผู้ส่งที่ยืนยันแล้ว Marketing จะเพิ่มเฮดเดอร์ยกเลิกการรับที่จัดการให้ เว้นแต่การเชื่อมต่อ first-party ที่ตั้งค่าไว้จะจัดหา URL แบบคลิกเดียว HTTPS ที่มองเห็นได้ของตนเอง

เฮดเดอร์ที่ไม่บังคับIdempotency-Key

คำขอ

curl https://sendhq.cc/api/v1/emails \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"from":"Acme <hello@example.com>","to":["customer@example.net"],"subject":"Welcome aboard","html":"<h1>Welcome</h1><p>Your workspace is ready.</p>","text":"Welcome. Your workspace is ready."}'

การตอบกลับ 201

{
  "id": "em_…",
  "providerMessageId": "provider-id",
  "threadId": "em_…"
}

POST/emails/batch

API key

ส่งข้อความที่ปรับแต่งเฉพาะรายได้สูงสุด 100 ฉบับ

เฮดเดอร์ที่ไม่บังคับIdempotency-Key

คำขอ

curl https://sendhq.cc/api/v1/emails/batch \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"emails":[{"from":"Acme <hello@example.com>","to":["customer@example.net"],"subject":"Welcome aboard","html":"<h1>Welcome</h1><p>Your workspace is ready.</p>","text":"Welcome. Your workspace is ready."}]}'

การตอบกลับ 201

{
  "data": [
    {
      "index": 0,
      "ok": true,
      "id": "em_…"
    }
  ],
  "count": 1,
  "successful": 1,
  "failed": 0
}

GET/emails

API key

แสดงรายการอีเมลที่ส่งและได้รับ

รายการเรียงจากใหม่สุดพร้อมตัวกรอง `query` ค้นหาในหัวเรื่อง เนื้อหา ผู้เข้าร่วม และชื่อไฟล์แนบ `label`, `domain` และ `category` รับค่าเดียวหรือรายการที่คั่นด้วยเครื่องหมายจุลภาค (ตรงกับข้อใดข้อหนึ่ง) โดย label อาจเป็น ID หรือชื่อ `archived=false` คืนมุมมองกล่องเข้าสำหรับอีเมลที่ได้รับ อีเมลที่ได้รับจะถูกจัดประเภทเป็น `primary`, `updates` (จดหมายข่าว อีเมลจำนวนมาก และอีเมลอัตโนมัติ) หรือ `spam` และทำเครื่องหมาย `important` ได้ อีเมลสแปมจะไม่รวมเว้นแต่ใช้ `category=spam` หรือ `include_spam=true`

พารามิเตอร์คิวรีdirectionstatusdomaininbox_idlabelarchivedcategoryimportantinclude_spamfromtounreadafterbeforequerylimitoffset

คำขอ

curl https://sendhq.cc/api/v1/emails \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

การตอบกลับ 200

{
  "data": [],
  "count": 0
}

GET/emails/:id

API key

ดึงอีเมลและไฟล์แนบ

คำขอ

curl https://sendhq.cc/api/v1/emails/id_value \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

การตอบกลับ 200

{
  "id": "em_…",
  "direction": "out",
  "status": "sent",
  "attachments": []
}

PATCH/emails/:id

API key

อัปเดตสถานะอ่านแล้ว การเก็บถาวร สแปม หมวดหมู่ หรือความสำคัญ

ตั้งค่า `read`, `archived`, `category` (`primary`, `updates` หรือ `spam` เฉพาะอีเมลที่ได้รับ) และ `important` การเปลี่ยน `category` หรือ `important` เป็นการสอนให้ SendHQ รู้จักผู้ส่ง คือ การรายงานสแปมจะทำให้อีเมลในอนาคตของผู้ส่งรายนั้นไปอยู่ในสแปม `Not spam` จะแทนที่การตรวจสอบสแปมอัตโนมัติสำหรับผู้ส่งนั้น และความสำคัญจะผูกกับผู้ส่ง ส่ง `learn: false` เพื่อเปลี่ยนเฉพาะข้อความนี้

คำขอ

curl https://sendhq.cc/api/v1/emails/id_value \
  -X PATCH \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"category":"spam"}'

การตอบกลับ 200

{
  "id": "em_…",
  "readAt": "2026-08-23T12:00:00.000Z",
  "archivedAt": null,
  "category": "spam",
  "important": false,
  "classification": "you moved it here"
}

DELETE/emails/:id

API key

ลบอีเมลที่เก็บรักษาไว้

คำขอ

curl https://sendhq.cc/api/v1/emails/id_value \
  -X DELETE \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

การตอบกลับ 200

{
  "ok": true
}

GET/emails/:id/events

API key

แสดงรายการอีเวนต์การส่งของอีเมลฉบับหนึ่ง

คำขอ

curl https://sendhq.cc/api/v1/emails/id_value/events \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

การตอบกลับ 200

{
  "data": [],
  "count": 0
}

GET/threads/:id

API key

ดึงบทสนทนาเรียงตามลำดับเวลา

คำขอ

curl https://sendhq.cc/api/v1/threads/id_value \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

การตอบกลับ 200

{
  "id": "em_…",
  "data": [],
  "count": 0
}