Modifier une série

PATCH /api/v1/series/{seriesId} Deux moitiés en un seul appel, parce que le modèle les range à deux endroits : le nom, le sujet et le statut vivent sur la série, la date de départ et l'audience vivent sur sa version — donc sur son brouillon, jamais sur une version publiée que des envois suivent déjà. Déplacer startsAt déplace toute la série : aucune étape ne porte de date propre.

Autorisation

RôleAccès
OWNERAutorisé
ADMINAutorisé
MEMBERRefusé — 403

Paramètres de chemin

ParamètreTypeDescription
seriesIdstring (uuid)L'identifiant de la série

Corps de la requête

Tous les champs sont facultatifs ; n'envoyez que ce qui change.
ChampTypeObligatoireDescription
namestringNonDe 1 à 100 caractères
statusstringNonactive ou paused. L'activation est refusée tant qu'aucune version n'est publiée
topicIdstring (uuid) | nullNonSon sujet éditorial
startsAtstring (ISO 8601) | nullNonLe jour 1. Exige un brouillon ouvert
listIdstring (uuid)NonLa liste à laquelle elle envoie. Exige un brouillon ouvert
audienceSegmentIdstring (uuid) | nullNonExige un brouillon ouvert
audienceTagIdstring (uuid) | nullNonExige un brouillon ouvert
json
{"startsAt": "2026-04-01T08:00:00.000Z"}

Exemple

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"}'

Réponse

CodeQuand
200La série telle qu'elle est désormais
400Corps invalide, cet identifiant n'est pas une série, ou le calendrier a été modifié sans brouillon ouvert
401Clé absente ou invalide
403Le rôle de la clé est MEMBER
404Aucune série avec cet identifiant dans votre organisation

Champs de la réponse

Même forme que lire une série.

Exemple de réponse

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"
  }
}

Remarques

Modifier le calendrier exige un brouillon ouvert. Sans brouillon, l'appel répond 400 et ne change rien plutôt que d'en ouvrir un dans votre dos — ouvrir une version est un acte délibéré, et il a sa propre route : POST /api/v1/sequences/{seriesId}/versions. Publiez ensuite pour que le changement prenne effet. Le déclencheur s'écrit en entier. Les champs que vous omettez gardent la valeur actuelle du brouillon : déplacer la date seule ne fait donc jamais perdre l'audience que vous aviez définie.

Voir aussi