Etiquetar un contacto

POST /api/v1/contacts/{contactId}/tags Asigna una etiqueta a un contacto por su nombre. La etiqueta se crea en la organización si todavía no existe, exactamente igual que las etiquetas enviadas al insertar o actualizar un contacto. Idempotente: asignar dos veces la misma etiqueta no duplica nada y responde 200.

Autorización

Rol en la organizaciónEste endpoint
OWNERPermitido
ADMINPermitido
MEMBERRechazado — 403
Una clave lleva el rol que su creador tiene en esta organización, nunca un rol sobre AgentsMail en sí. Consulta Claves de API.

Cuerpo de la solicitud

CampoTipoObligatorioDescripción
namestringsíDe 1 a 50 caracteres

Ejemplo

bash
curl -X POST -H "x-api-key: $AGENTMAIL_API_KEY" -H "content-type: application/json" \
  -d '{"name":"vip"}' \
  "https://www.agentsmail.io/api/v1/contacts/$CONTACT_ID/tags"

Respuesta

  • 200 OK: la llamada se realizó correctamente.
  • 401 Unauthorized: clave ausente o no válida, o su propietario salió de la organización.
  • 403 Forbidden: el propietario de la clave es member de la organización, no admin.
  • 404 Not Found: no existe ese recurso, o pertenece a otra organización. La API nunca confirma que un id existe a un llamante que no tiene derecho sobre él.
  • 429 Too Many Requests: más de 120 solicitudes en un minuto para esta clave.

Campos de la respuesta

CampoTipoDescripción
successbooleanIndica si la operación se realizó correctamente
data.idstringIdentificador único del contacto
data.emailstringSu dirección: única dentro de su lista
data.firstNamestringnull
data.lastNamestringnull
data.statusstringpending, subscribed, unsubscribed, bounced, complained
data.listIdstringLa lista a la que pertenece
data.listobject{id, name} de esa lista
data.tagsarray{id, name} de cada etiqueta que lleva
data.createdAtstringFecha de creación ISO
data.updatedAtstringFecha ISO del último cambio

Ejemplo de respuesta

json
{
  "success": true,
  "data": {
    "id": "4d19c0a2",
    "email": "ada@example.com",
    "firstName": "Ada",
    "lastName": "Lovelace",
    "status": "subscribed",
    "listId": "0b7c51e8",
    "list": {
      "id": "0b7c51e8",
      "name": "Newsletter"
    },
    "tags": [
      {
        "id": "7c2ef4b1",
        "name": "vip"
      }
    ],
    "createdAt": "2026-08-23T10:22:05.000Z",
    "updatedAt": "2026-08-23T10:22:05.000Z"
  }
}

Relacionado