Obtener una secuencia

GET /api/v1/sequences/{sequenceId} El mismo objeto, por separado. publishedVersionId es lo único que hay que leer aquí: null significa que no se ejecuta nada, diga lo que diga el estado.

Autorización

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

Parámetros de ruta

ParámetroTipoDescripción
sequenceIdstringObligatorio. La secuencia que se lee

Ejemplo

bash
curl -H "x-api-key: $AGENTMAIL_API_KEY" \
  "https://www.agentsmail.io/api/v1/sequences/$SEQUENCE_ID"

Respuesta

  • 200 OK: la llamada tuvo éxito.
  • 401 Unauthorized: clave ausente o no válida, o su propietario dejó la organización.
  • 404 Not Found: no existe ese recurso, o pertenece a otra organización. La API nunca confirma que un id existe a quien 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 tuvo éxito
data.idstringIdentificador de la secuencia
data.namestringSu nombre
data.statusstringactive o paused
data.publishedVersionIdstring \null
data.topicIdstring | nullTema editorial que lleva esta secuencia, si lo hay
data.createdAt / updatedAtstringFechas ISO

Ejemplo de respuesta

json
{
  "success": true,
  "data": {
    "id": "4d19c0a2",
    "name": "Newsletter",
    "status": "subscribed",
    "publishedVersionId": "c41a7e55",
    "topicId": null,
    "createdAt` / `updatedAt": "value"
  }
}

Relacionado