API reference
ป้ายกำกับและกฎการจัดเก็บ
จัดระเบียบอีเมลที่ส่งและได้รับเป็นโฟลเดอร์โดยอัตโนมัติหรือด้วยตนเอง
ไม่มีรายการที่ตรงกับตัวกรองนี้
/emails/:id/labelsเพิ่มหรือลบป้ายกำกับของอีเมล
เพิ่มและลบป้ายกำกับด้วยชื่อหรือ lbl_ ID ชื่อที่ไม่รู้จักใน `add` จะถูกสร้างขึ้น เว้นแต่ `create` เป็น false อีเมลหนึ่งฉบับมีป้ายกำกับได้สูงสุด 10 รายการ
curl https://sendhq.cc/api/v1/emails/id_value/labels \
-X POST \
-H "Authorization: Bearer $SENDHQ_API_KEY" \
-H "Content-Type: application/json" \
-d '{"add":["Billing"],"remove":["Support"]}'{
"id": "em_…",
"labels": [
{
"id": "lbl_…",
"name": "Billing",
"color": "#188038"
}
]
}/labelsแสดงรายการป้ายกำกับพร้อมจำนวนข้อความและกฎการจัดเก็บ
แสดงรายการป้ายกำกับพร้อมจำนวนข้อความและกฎการจัดเก็บ
curl https://sendhq.cc/api/v1/labels \
-X GET \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"data": [],
"count": 0,
"mailbox": {
"inboxUnread": 0,
"updatesUnread": 0,
"spamTotal": 0,
"importantUnread": 0,
"resortPending": 0
}
}/labelsสร้างป้ายกำกับ โดยเลือกใส่กฎจัดเก็บอัตโนมัติได้
สร้างป้ายกำกับแบบโฟลเดอร์ ตั้ง `skip_inbox: true` เพื่อทำให้เป็น bucket คืออีเมลที่ได้รับและได้ป้ายกำกับนี้ (จากกฎ จากการตอบกลับบทสนทนาที่ส่งด้วยป้ายกำกับนั้น หรือเพิ่มด้วยมือ) จะถูกเก็บถาวรและปรากฏเฉพาะในป้ายกำกับ ไม่ปรากฏในกล่องเข้า `rules` ที่ไม่บังคับจะจัดเก็บอีเมลใหม่ที่ส่งหรือได้รับโดยอัตโนมัติ โดยทุกเงื่อนไขที่ตั้งไว้ในกฎต้องตรงกัน (inbox_id, direction และสตริงย่อยของ from/to/subject โดยไม่สนตัวพิมพ์) ตั้ง `apply_to_existing` เพื่อจัดเก็บอีเมลที่เก็บรักษาไว้ด้วย
curl https://sendhq.cc/api/v1/labels \
-X POST \
-H "Authorization: Bearer $SENDHQ_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"Agent/Orders","color":"#188038","skip_inbox":true,"rules":[{"inbox_id":"inb_…"}],"apply_to_existing":true}'{
"id": "lbl_…",
"name": "Agent/Orders",
"color": "#188038",
"skipInbox": true,
"totalCount": 0,
"unreadCount": 0,
"rules": []
}/labels/:idดึงป้ายกำกับด้วย ID หรือชื่อ
ดึงป้ายกำกับด้วย ID หรือชื่อ
curl https://sendhq.cc/api/v1/labels/id_value \
-X GET \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"id": "lbl_…",
"name": "Billing",
"color": "#188038",
"skipInbox": false,
"totalCount": 0,
"unreadCount": 0,
"rules": []
}/labels/:idเปลี่ยนชื่อ เปลี่ยนสี หรือเปลี่ยนป้ายกำกับให้เป็น bucket
เปลี่ยน `name`, `color` หรือ `skip_inbox` การเปิด `skip_inbox` จะเก็บถาวรอีเมลที่ได้รับซึ่งอยู่ในป้ายกำกับอยู่แล้วด้วย เว้นแต่ `apply_to_existing` เป็น false
curl https://sendhq.cc/api/v1/labels/id_value \
-X PATCH \
-H "Authorization: Bearer $SENDHQ_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"Finance/Billing","color":"#1a73e8","skip_inbox":true}'{
"id": "lbl_…",
"name": "Finance/Billing",
"color": "#1a73e8",
"skipInbox": true
}/labels/:idลบป้ายกำกับโดยไม่ลบอีเมล
ลบป้ายกำกับโดยไม่ลบอีเมล
curl https://sendhq.cc/api/v1/labels/id_value \
-X DELETE \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"ok": true
}/labels/:id/rulesเพิ่มกฎจัดเก็บอัตโนมัติให้ป้ายกำกับ
เพิ่มกฎจัดเก็บอัตโนมัติให้ป้ายกำกับ
curl https://sendhq.cc/api/v1/labels/id_value/rules \
-X POST \
-H "Authorization: Bearer $SENDHQ_API_KEY" \
-H "Content-Type: application/json" \
-d '{"direction":"in","from":"@stripe.com","subject":"invoice","skip_inbox":true,"apply_to_existing":false}'{
"id": "lrule_…",
"labelId": "lbl_…",
"direction": "in",
"inboxId": null,
"from": "@stripe.com",
"to": null,
"subject": "invoice",
"skipInbox": true
}/labels/:id/rules/:rule_idลบกฎจัดเก็บอัตโนมัติ
ลบกฎจัดเก็บอัตโนมัติ
curl https://sendhq.cc/api/v1/labels/id_value/rules/rule_id_value \
-X DELETE \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"ok": true
}