Volver a suscribir un contacto a un tema

POST /api/v1/contacts/{contactId}/topics/{topicId}/resubscribe Reactiva los mensajes asignados a un tema para un contacto. No vuelve a suscribir globalmente a un contacto dado de baja, y deja sin cambios todos los demás temas.

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. Identificador del contacto
topicIdstringObligatorio. Identificador del tema que se reactiva

Ejemplo

bash
curl -X POST -H "x-api-key: $AGENTMAIL_API_KEY" \
  "https://www.agentsmail.io/api/v1/contacts/$CONTACT_ID/topics/$TOPIC_ID/resubscribe"

Respuesta

  • 200 OK: la preferencia del tema es subscribed, también cuando no existía ningún rechazo.
  • 400 Bad Request: un identificador de la ruta no es un UUID válido; details identifica el campo.
  • 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, no admin.
  • 404 Not Found: el contacto o el tema no existe, pertenece a otra organización, o los dos recursos no pertenecen a la misma organización.
  • 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.contactIdstringIdentificador del contacto
data.topicIdstringIdentificador del tema
data.statusstringSiempre subscribed

Ejemplo de respuesta

json
{
  "success": true,
  "data": {
    "contactId": "4d19c0a2-8f20-4fb8-9d55-39a88f86d778",
    "topicId": "a338c425-3115-4890-a01c-f2f6f012db93",
    "status": "subscribed"
  }
}

Notas

  • La llamada es idempotente. Si el contacto nunca se excluyó del tema, no es necesario crear ninguna fila de preferencia.
  • Una exclusión anterior permanece en el historial de preferencias; reactivar el tema registra la vuelta en lugar de borrar ese historial.
  • Esta llamada nunca cambia el estado de suscripción global del contacto.

Relacionado