Quitar una etiqueta a un contacto

DELETE /api/v1/contacts/{contactId}/tags/{tagId} Quita una etiqueta de un contacto. Idempotente: quitar una etiqueta que el contacto no lleva también 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.

Parámetros de ruta

ParámetroTipoDescripción
contactIdstringObligatorio. El contacto al que se quita la etiqueta
tagIdstringObligatorio. La etiqueta que se quita: la etiqueta en sí no se toca

Ejemplo

bash
curl -X DELETE -H "x-api-key: $AGENTMAIL_API_KEY" \
  "https://www.agentsmail.io/api/v1/contacts/$CONTACT_ID/tags/$TAG_ID"

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

Idempotente: quitar una etiqueta que el contacto nunca llevó responde de la misma manera.
CampoTipoDescripción
successbooleanIndica si la operación se realizó correctamente
data.idstringIdentificador del contacto
data.emailstringSu dirección: única dentro de su lista
data.firstName / lastNamestring \null
data.statusstringpending, subscribed, unsubscribed, bounced, complained
data.listIdstringLa lista a la que pertenece: un contacto pertenece exactamente a una
data.listobject{id, name} de esa lista
data.tagsarray{id, name} de cada etiqueta que lleva
data.createdAt / updatedAtstringFechas ISO

Ejemplo de respuesta

json
{
  "success": true,
  "data": {
    "id": "4d19c0a2",
    "email": "ada@example.com",
    "firstName` / `lastName": "value",
    "status": "subscribed",
    "listId": "0b7c51e8",
    "list": {
      "id": "0b7c51e8",
      "name": "Newsletter"
    },
    "tags": [
      {
        "id": "7c2ef4b1",
        "name": "vip"
      }
    ],
    "createdAt` / `updatedAt": "value"
  }
}

Relacionado