Riferimento API

Etichette e regole di archiviazione

Organizza la posta inviata e ricevuta in cartelle, automaticamente o a mano.

Filtra etichette e regole di archiviazione

POST/emails/:id/labels

Chiave API

Aggiungi o rimuovi etichette da un'email

Aggiungi e rimuovi etichette per nome o per ID lbl_. I nomi sconosciuti in `add` vengono creati, a meno che `create` sia false. Un'email può avere al massimo 10 etichette.

Richiesta

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

Risposta 200

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

GET/labels

Chiave API

Elenca le etichette con il numero di messaggi e le regole di archiviazione

Richiesta

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

Risposta 200

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

POST/labels

Chiave API

Crea un'etichetta, facoltativamente con regole di archiviazione automatica

Crea un'etichetta in stile cartella. Imposta `skip_inbox: true` per trasformarla in un bucket: la posta ricevuta che ottiene questa etichetta (da una regola, da una risposta a una conversazione inviata con l'etichetta o aggiunta a mano) viene archiviata, così compare solo nell'etichetta e mai nella Inbox. Le `rules` facoltative archiviano automaticamente la nuova posta inviata o ricevuta: ogni condizione impostata su una regola deve corrispondere (inbox_id, direction e sottostringhe from/to/subject senza distinzione tra maiuscole e minuscole). Imposta `apply_to_existing` per archiviare anche la posta già conservata.

Richiesta

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

Risposta 201

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

GET/labels/:id

Chiave API

Recupera un'etichetta per ID o per nome

Richiesta

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

Risposta 200

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

PATCH/labels/:id

Chiave API

Rinomina un'etichetta, cambiane il colore o trasformala in un bucket

Modifica `name`, `color` o `skip_inbox`. Attivare `skip_inbox` archivia anche la posta ricevuta già presente nell'etichetta, a meno che `apply_to_existing` sia false.

Richiesta

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

Risposta 200

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

DELETE/labels/:id

Chiave API

Elimina un'etichetta senza eliminarne le email

Richiesta

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

Risposta 200

{
  "ok": true
}

POST/labels/:id/rules

Chiave API

Aggiungi una regola di archiviazione automatica a un'etichetta

Richiesta

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

Risposta 201

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

DELETE/labels/:id/rules/:rule_id

Chiave API

Elimina una regola di archiviazione automatica

Richiesta

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

Risposta 200

{
  "ok": true
}