Referencia de la API

Etiquetas y reglas de archivado

Organice el correo enviado y recibido en carpetas, de forma automática o manual.

Filtrar etiquetas y reglas de archivado

POST/emails/:id/labels

Clave de API

Agregar o quitar etiquetas de un correo

Agregue y quite etiquetas por nombre o por ID lbl_. Los nombres desconocidos en `add` se crean, salvo que `create` sea false. Un correo puede llevar como máximo 10 etiquetas.

Solicitud

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

Respuesta 200

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

GET/labels

Clave de API

Listar etiquetas con recuentos de mensajes y reglas de archivado

Solicitud

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

Respuesta 200

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

POST/labels

Clave de API

Crear una etiqueta, opcionalmente con reglas de archivado automático

Crea una etiqueta tipo carpeta. Defina `skip_inbox: true` para convertirla en una categoría: el correo recibido que obtiene esta etiqueta (por una regla, por una respuesta a una conversación enviada con la etiqueta o agregada manualmente) se archiva para que aparezca solo en la etiqueta y nunca en la bandeja de entrada. Las `rules` opcionales archivan automáticamente el correo nuevo enviado o recibido: todas las condiciones definidas en una regla deben coincidir (inbox_id, direction y subcadenas de from/to/subject sin distinguir mayúsculas y minúsculas). Defina `apply_to_existing` para archivar también el correo conservado.

Solicitud

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

Respuesta 201

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

GET/labels/:id

Clave de API

Obtener una etiqueta por ID o nombre

Solicitud

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

Respuesta 200

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

PATCH/labels/:id

Clave de API

Renombrar, cambiar el color o convertir una etiqueta en categoría

Cambie `name`, `color` o `skip_inbox`. Activar `skip_inbox` también archiva el correo recibido que ya está en la etiqueta, salvo que `apply_to_existing` sea false.

Solicitud

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

Respuesta 200

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

DELETE/labels/:id

Clave de API

Eliminar una etiqueta sin eliminar su correo

Solicitud

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

Respuesta 200

{
  "ok": true
}

POST/labels/:id/rules

Clave de API

Agregar una regla de archivado automático a una etiqueta

Solicitud

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

Respuesta 201

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

DELETE/labels/:id/rules/:rule_id

Clave de API

Eliminar una regla de archivado automático

Solicitud

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

Respuesta 200

{
  "ok": true
}