API reference
สัญญาเดียวที่ครอบคลุมทุกส่วนที่ลูกค้าใช้งาน
endpoint สำหรับลูกค้ามีให้ใช้ภายใต้ /api/v1 พรีฟิกซ์ /api แบบเดิมยังคงใช้ได้สำหรับแดชบอร์ด ส่วนการเชื่อมต่อฝั่งเซิร์ฟเวอร์ใหม่ควรใช้ base URL ที่มีเวอร์ชัน
ขอบเขตการยืนยันตัวตน
การเชื่อมต่อผลิตภัณฑ์ใช้ API key ระดับเวิร์กสเปซ ซึ่งอ่านข้อมูลการใช้งานบัญชี analytics และเมทาดาทาของ API key ได้ด้วย การเปลี่ยนแปลงการเรียกเก็บเงินและการสร้างหรือเพิกถอน API key ต้องใช้เซสชันเบราว์เซอร์แบบ HTTP-only และมีป้ายระบุไว้ตามนั้น
แหล่งข้อมูล
อีเมลและเธรด
ส่ง ดึง ค้นหา ตอบกลับ และตรวจสอบอีเวนต์การส่ง
8 การดำเนินการป้ายกำกับและกฎการจัดเก็บ
จัดอีเมลที่ส่งและรับเข้าโฟลเดอร์โดยอัตโนมัติหรือด้วยมือ
9 การดำเนินการฉบับร่างและไฟล์แนบ
สร้างโฟลว์ตัวเขียนอีเมลพร้อมที่เก็บไฟล์แนบส่วนตัว
10 การดำเนินการเทมเพลตแบบโฮสต์
ร่าง เรนเดอร์ ทดสอบ กำหนดเวอร์ชัน เผยแพร่ และส่งเนื้อหาที่ใช้ซ้ำได้
7 การดำเนินการโดเมน
จัดเตรียมตัวตนผู้ส่งและทำความเข้าใจสถานะการยืนยัน DNS
8 การดำเนินการอีเมลขาเข้า
สร้างที่อยู่และทำงานกับบทสนทนาที่ได้รับ
5 การดำเนินการความสามารถในการส่งถึง
ตรวจสอบอีเวนต์ ผลลัพธ์ด้านชื่อเสียง และผู้รับที่ถูกบล็อก
8 การดำเนินการบัญชีและการเรียกเก็บเงิน
อ่านข้อมูลการใช้งานบัญชี analytics และเมทาดาทาของคีย์ด้วย API key การเปลี่ยนแปลงการเรียกเก็บเงินและการสร้างหรือเพิกถอนคีย์ต้องใช้เซสชันแดชบอร์ด
ซองข้อผิดพลาด
ข้อผิดพลาด JSON ใช้ซองแบบเดียวที่คาดเดาได้ รหัสสถานะแยกแยะอินพุตไม่ถูกต้อง การยืนยันตัวตน ทรัพยากรที่ไม่พบ ความขัดแย้ง ข้อกำหนดการชำระเงิน การบล็อกด้านความปลอดภัย และขีดจำกัดการใช้งาน
{
"error": {
"message": "The sender domain is not verified",
"status": 403
}
}การกำหนดเวอร์ชัน
เวอร์ชัน API ตามวันที่ระบุตัวสัญญานี้ ฟิลด์ที่เข้ากันได้ย้อนหลังเพิ่มได้ภายในเวอร์ชันเดียวกัน การเปลี่ยนแปลงที่ทำให้ใช้งานไม่ได้ต้องใช้ base path ที่มีเวอร์ชันใหม่และการเปลี่ยนผ่านที่มีเอกสารกำกับ
{
"version": "2026-09-07",
"baseUrl": "https://sendhq.cc/api/v1",
"openapi": "https://sendhq.cc/openapi.json"
}