Renombrar, activar o pausar

PATCH /api/v1/sequences/{sequenceId} Renombra la secuencia, define su tema editorial, la activa o la pausa. Envía un campo, o varios.

Condición	Respuesta
el cuerpo no lleva ninguno de los tres campos	`400`: nada que cambiar
`status` es cualquier otra cosa	`400`: `active` y `paused` son los dos únicos valores
`active` sin versión publicada	`400`: publica primero, una secuencia «activa» sin nada publicado no inscribiría a nadie
`topicId: null` mientras un paso publicado lleva `{{topicOptOutUrl}}`	`400`: quitar el tema dejaría un enlace muerto; el mensaje nombra los pasos

Pausar detiene los envíos: los contactos se quedan donde están y sus plazos nunca se recalculan. Volver a activar los reanuda en la fecha en que ya tocaban.

Autorización

Rol en la organización	Este endpoint
`OWNER`	Permitido
`ADMIN`	Permitido
`MEMBER`	Rechazado — `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

Campo	Tipo	Obligatorio	Descripción
`name`	string	no	De 1 a 100 caracteres
`status`	string	no	`active` o `paused`
`topicId`	string	no	Tema editorial que lleva la secuencia, o `null` para borrarlo. Resuélvelo con `GET /api/v1/topics`

Ejemplo

bash

curl -X PATCH -H "x-api-key: $AGENTMAIL_API_KEY" -H "content-type: application/json" \
  -d '{"status":"active"}' \
  "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.
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 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

Campo	Tipo	Descripción
`success`	boolean	Indica si la operación tuvo éxito
`data.id`	string	Identificador único de la secuencia
`data.name`	string	Su nombre
`data.status`	string	`active` o `paused`
`data.publishedVersionId`	string	null
`data.topicId`	string	null
`data.createdAt`	string	Fecha ISO de creación
`data.updatedAt`	string	Fecha ISO del último cambio

Ejemplo de respuesta

json

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

Notas

Una secuencia recibe su tema aquí, nunca al crearla. POST /api/v1/sequences no acepta topicId: lo defines después, como hacen las pantallas.