Actualizar una serie

PATCH /api/v1/series/{seriesId} Dos mitades en una sola llamada, porque el modelo las guarda en dos sitios: el nombre, el tema y el estado viven en la serie; la fecha de inicio y la audiencia viven en su versión, así que en su borrador, nunca en una versión publicada que los envíos ya siguen. Mover startsAt mueve toda la serie: ningún paso lleva una fecha propia.

Autorización

RolAcceso
OWNERPermitido
ADMINPermitido
MEMBERRechazado — 403

Parámetros de ruta

ParámetroTipoDescripción
seriesIdstring (uuid)El id de la serie

Cuerpo de la solicitud

Todos los campos son opcionales; envía solo lo que cambia.
CampoTipoObligatorioDescripción
namestringNoDe 1 a 100 caracteres
statusstringNoactive o paused. Activar se rechaza mientras no haya una versión publicada
topicIdstring (uuid) | nullNoSu tema editorial
startsAtstring (ISO 8601) | nullNoEl día 1. Requiere un borrador abierto
listIdstring (uuid)NoLa lista a la que envía. Requiere un borrador abierto
audienceSegmentIdstring (uuid) | nullNoRequiere un borrador abierto
audienceTagIdstring (uuid) | nullNoRequiere un borrador abierto
json
{"startsAt": "2026-04-01T08:00:00.000Z"}

Ejemplo

bash
curl -s -X PATCH 'https://www.agentsmail.io/api/v1/series/7d7d7d7d-8888-4ccc-9ddd-eeee00001111' \
  -H "x-api-key: $AGENTMAIL_API_KEY" \
  -H 'content-type: application/json' \
  -d '{"startsAt": "2026-04-01T08:00:00.000Z"}'

Respuesta

CódigoCuándo
200La serie tal como queda
400Cuerpo no válido, este id no es una serie, o se tocó el calendario sin un borrador abierto
401Clave ausente o no válida
403El rol de la clave es MEMBER
404No hay ninguna serie con este id en tu organización

Campos de la respuesta

La misma forma que obtener una serie.

Ejemplo de respuesta

json
{
  "success": true,
  "data": {
    "id": "7d7d7d7d-8888-4ccc-9ddd-eeee00001111",
    "name": "March launch",
    "status": "paused",
    "startsAt": "2026-04-01T08:00:00.000Z",
    "listId": "9f8e7d6c-1111-4bbb-8ccc-ddddeeeeffff",
    "audienceSegmentId": null,
    "audienceTagId": null,
    "topicId": null,
    "createdAt": "2026-03-01T10:00:00.000Z",
    "updatedAt": "2026-03-20T09:00:00.000Z"
  }
}

Notas

Cambiar el calendario requiere un borrador abierto. Sin él, la llamada responde 400 y no cambia nada, en lugar de abrir uno a tus espaldas: abrir una versión es un acto deliberado, y tiene su propia ruta: POST /api/v1/sequences/{seriesId}/versions. Publica después para que el cambio surta efecto. El disparador se escribe completo. Los campos que omites conservan el valor actual del borrador, así que mover solo la fecha nunca borra la audiencia que habías fijado.

Relacionado