مرجع API
برچسبها و قوانین بایگانی
ایمیلهای ارسالی و دریافتی را بهصورت خودکار یا دستی در پوشهها سازماندهی کنید.
هیچ عملیاتی با این فیلتر مطابقت ندارد.
/emails/:id/labelsافزودن یا حذف برچسبهای یک ایمیل
برچسبها را با نام یا شناسه lbl_ اضافه و حذف کنید. نامهای ناشناخته در `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دریافت یک برچسب با شناسه یا نام
دریافت یک برچسب با شناسه یا نام
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
}