Referência da API

Marcadores e regras de arquivamento

Organize e-mails enviados e recebidos em pastas, automaticamente ou manualmente.

Filtrar marcadores e regras de arquivamento

POST/emails/:id/labels

Chave de API

Adicionar ou remover marcadores de um e-mail

Adicione e remova marcadores por nome ou ID lbl_. Nomes desconhecidos em `add` são criados, a menos que `create` seja false. Um e-mail pode ter no máximo 10 marcadores.

Requisição

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

Resposta 200

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

GET/labels

Chave de API

Listar marcadores com contagem de mensagens e regras de arquivamento

Requisição

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

Resposta 200

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

POST/labels

Chave de API

Criar um marcador, opcionalmente com regras de arquivamento automático

Cria um marcador no estilo de pasta. Defina `skip_inbox: true` para transformá-lo em uma categoria: os e-mails recebidos que ganharem esse marcador (por uma regra, por uma resposta a uma conversa enviada com o marcador ou adicionado manualmente) são arquivados e aparecem apenas no marcador, nunca na caixa de entrada. As `rules` opcionais arquivam automaticamente novos e-mails enviados ou recebidos: todas as condições definidas em uma regra precisam corresponder (inbox_id, direction e trechos de from/to/subject, sem diferenciar maiúsculas de minúsculas). Defina `apply_to_existing` para arquivar também os e-mails retidos.

Requisição

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

Resposta 201

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

GET/labels/:id

Chave de API

Obter um marcador por ID ou nome

Requisição

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

Resposta 200

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

PATCH/labels/:id

Chave de API

Renomear, mudar a cor ou transformar um marcador em categoria

Altere `name`, `color` ou `skip_inbox`. Ativar `skip_inbox` também arquiva os e-mails recebidos que já estão no marcador, a menos que `apply_to_existing` seja false.

Requisição

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

Resposta 200

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

DELETE/labels/:id

Chave de API

Excluir um marcador sem excluir seus e-mails

Requisição

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

Resposta 200

{
  "ok": true
}

POST/labels/:id/rules

Chave de API

Adicionar uma regra de arquivamento automático a um marcador

Requisição

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

Resposta 201

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

DELETE/labels/:id/rules/:rule_id

Chave de API

Excluir uma regra de arquivamento automático

Requisição

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

Resposta 200

{
  "ok": true
}