Crear una secuencia

POST /api/v1/sequences Crea la secuencia y su versión 1 en borrador, en una sola transacción. Responde 201. La secuencia nace paused, con publishedVersionId: null: todavía no inscribe a nadie. Los ids de lista vienen de GET /api/v1/lists, los de etiqueta de GET /api/v1/tags, ambos en la API de audiencia.
CondiciónRespuesta
todo válido201
nombre ausente, triggerType desconocido, id mal formado400: details nombra el campo
objetivo del disparador de otra organización404: como una lista que no existe
triggerType: "fixed_date"400: las series de fecha fija se configuran en la app, no aquí
se alcanzó el límite de secuencias de tu plan400 indicando el límite y cuántas tienes ya
El tope de secuencias del plan se aplica aquí exactamente igual que en la app. No es una propiedad de la interfaz: la misma protección rechaza la API. Elimina una secuencia que ya no necesites, o cambia a un plan superior: reintentar no ayudará.

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 en AgentsMail en sí. Consulta Claves de API.

Cuerpo de la solicitud

CampoTipoObligatorioDescripción
namestringsíDe 1 a 100 caracteres
triggerTypestringsílist_joined o tag_added. Existe un tercer valor, fixed_date, en la app para las series guiadas por fecha; aquí se rechaza: una serie también necesita su audiencia, su fecha de inicio y la programación de cada paso, y con solo la mitad de eso quedaría una secuencia que nada puede publicar.
triggerTargetIdstringsíEl id de la lista para list_joined, el id de la etiqueta para tag_added

Ejemplo

bash
curl -X POST -H "x-api-key: $AGENTMAIL_API_KEY" -H "content-type: application/json" \
  -d '{"name":"Onboarding","triggerType":"list_joined","triggerTargetId":"'$LIST_ID'"}' \
  "https://www.agentsmail.io/api/v1/sequences"

Respuesta

  • 201 Created: el recurso creado.
  • 401 Unauthorized: clave ausente o no válida, o su propietario dejó la organización.
  • 403 Forbidden: el propietario de la clave es member de la organización, no admin.
  • 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 único de la secuencia
data.namestringSu nombre
data.statusstringactive o paused
data.publishedVersionIdstringnull
data.createdAtstringFecha ISO de creación
data.updatedAtstringFecha ISO del último cambio

Ejemplo de respuesta

json
{
  "success": true,
  "data": {
    "id": "4d19c0a2",
    "name": "Newsletter",
    "status": "subscribed",
    "publishedVersionId": "c41a7e55",
    "createdAt": "2026-08-23T10:22:05.000Z",
    "updatedAt": "2026-08-23T10:22:05.000Z"
  }
}

Relacionado