Référence de l’API

Libellés et règles de classement

Classez le courrier envoyé et reçu dans des dossiers, automatiquement ou manuellement.

Filtrer les libellés et règles de classement

POST/emails/:id/labels

Clé API

Ajouter ou retirer des libellés sur un e-mail

Ajoutez et retirez des libellés par nom ou par identifiant lbl_. Les noms inconnus passés dans `add` sont créés, sauf si `create` vaut false. Un e-mail peut porter au maximum 10 libellés.

Requête

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

Réponse 200

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

GET/labels

Clé API

Lister les libellés avec leur nombre de messages et leurs règles de classement

Requête

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

Réponse 200

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

POST/labels

Clé API

Créer un libellé, avec des règles de classement automatique en option

Crée un libellé de type dossier. Définissez `skip_inbox: true` pour en faire une catégorie : le courrier reçu qui obtient ce libellé (via une règle, via une réponse à une conversation envoyée avec ce libellé, ou ajouté manuellement) est archivé, de sorte qu’il n’apparaît que dans le libellé, jamais dans la Boîte de réception. Les `rules` facultatives classent automatiquement le nouveau courrier envoyé ou reçu : chaque condition définie sur une règle doit correspondre (inbox_id, direction, et sous-chaînes from/to/subject insensibles à la casse). Définissez `apply_to_existing` pour classer également le courrier déjà conservé.

Requête

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

Réponse 201

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

GET/labels/:id

Clé API

Récupérer un libellé par identifiant ou par nom

Requête

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

Réponse 200

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

PATCH/labels/:id

Clé API

Renommer un libellé, changer sa couleur ou le transformer en catégorie

Modifiez `name`, `color` ou `skip_inbox`. Activer `skip_inbox` archive aussi le courrier reçu déjà présent dans le libellé, sauf si `apply_to_existing` vaut false.

Requête

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

Réponse 200

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

DELETE/labels/:id

Clé API

Supprimer un libellé sans supprimer ses e-mails

Requête

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

Réponse 200

{
  "ok": true
}

POST/labels/:id/rules

Clé API

Ajouter une règle de classement automatique à un libellé

Requête

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

Réponse 201

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

DELETE/labels/:id/rules/:rule_id

Clé API

Supprimer une règle de classement automatique

Requête

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

Réponse 200

{
  "ok": true
}