Справочник API

Метки и правила сортировки

Раскладывайте отправленные и полученные письма по папкам автоматически или вручную.

Фильтр операций с метками и правилами сортировки

POST/emails/:id/labels

API-ключ

Добавить или снять метки с письма

Добавляет и снимает метки по имени или по ID вида 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"]}'

Ответ 200

{
  "id": "em_…",
  "labels": [
    {
      "id": "lbl_…",
      "name": "Billing",
      "color": "#188038"
    }
  ]
}

GET/labels

API-ключ

Список меток с количеством писем и правилами сортировки

Запрос

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

Ответ 200

{
  "data": [],
  "count": 0,
  "mailbox": {
    "inboxUnread": 0,
    "updatesUnread": 0,
    "spamTotal": 0,
    "importantUnread": 0,
    "resortPending": 0
  }
}

POST/labels

API-ключ

Создать метку, при необходимости с правилами автосортировки

Создаёт метку-папку. Укажите `skip_inbox: true`, чтобы сделать её группой: полученные письма с этой меткой (назначенной правилом, пришедшие в ответ на переписку, отправленную с этой меткой, или добавленной вручную) архивируются и отображаются только в метке, но не во «Входящих». Необязательные `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}'

Ответ 201

{
  "id": "lbl_…",
  "name": "Agent/Orders",
  "color": "#188038",
  "skipInbox": true,
  "totalCount": 0,
  "unreadCount": 0,
  "rules": []
}

GET/labels/:id

API-ключ

Получить метку по ID или имени

Запрос

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

Ответ 200

{
  "id": "lbl_…",
  "name": "Billing",
  "color": "#188038",
  "skipInbox": false,
  "totalCount": 0,
  "unreadCount": 0,
  "rules": []
}

PATCH/labels/:id

API-ключ

Переименовать метку, изменить её цвет или превратить в группу

Изменяет `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}'

Ответ 200

{
  "id": "lbl_…",
  "name": "Finance/Billing",
  "color": "#1a73e8",
  "skipInbox": true
}

DELETE/labels/:id

API-ключ

Удалить метку, не удаляя её письма

Запрос

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

Ответ 200

{
  "ok": true
}

POST/labels/:id/rules

API-ключ

Добавить к метке правило автосортировки

Запрос

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

Ответ 201

{
  "id": "lrule_…",
  "labelId": "lbl_…",
  "direction": "in",
  "inboxId": null,
  "from": "@stripe.com",
  "to": null,
  "subject": "invoice",
  "skipInbox": true
}

DELETE/labels/:id/rules/:rule_id

API-ключ

Удалить правило автосортировки

Запрос

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

Ответ 200

{
  "ok": true
}