APIリファレンス

ラベルと振り分けルール

送信済みメールと受信メールを、自動または手動でフォルダに整理します。

ラベルと振り分けルールのエンドポイントを絞り込む

POST/emails/:id/labels

APIキー

メールのラベルを追加・削除する

ラベルを名前またはlbl_ IDで追加・削除します。`add`に存在しない名前を指定すると、`create`がfalseでない限りラベルが作成されます。1通のメールに付けられるラベルは最大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
}