Renommer, activer ou mettre en pause

PATCH /api/v1/sequences/{sequenceId} Renomme la séquence, définit son sujet éditorial, l'active ou la met en pause. Envoyez un champ, ou plusieurs.

Condition	Réponse
le corps ne porte aucun des trois champs	`400` — rien à changer
`status` a une autre valeur	`400` — `active` et `paused` sont les deux seules possibles
`active` sans version publiée	`400` — publiez d'abord ; une séquence « active » sans rien de publié n'inscrirait personne
`topicId: null` alors qu'une étape publiée porte `{{topicOptOutUrl}}`	`400` — retirer le sujet laisserait un lien mort ; le message nomme les étapes

La mise en pause arrête les envois : les contacts restent où ils sont, et leurs échéances ne sont jamais recalculées. Réactiver les rejoue à la date à laquelle ils étaient déjà dus.

Autorisation

Rôle dans l'organisation	Cet endpoint
`OWNER`	Autorisé
`ADMIN`	Autorisé
`MEMBER`	Refusé — `403`

Une clé porte le rôle que son créateur détient dans cette organisation — jamais un rôle sur AgentsMail lui-même. Voir Clés d'API.

Corps de la requête

Champ	Type	Obligatoire	Description
`name`	string	non	1 à 100 caractères
`status`	string	non	`active` ou `paused`
`topicId`	string	non	Sujet éditorial que porte la séquence, ou `null` pour l'effacer. Résolvez-le avec `GET /api/v1/topics`

Exemple

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"

Réponse

200 OK — l'appel a réussi.
401 Unauthorized — clé absente ou invalide, ou son propriétaire a quitté l'organisation.
403 Forbidden — le propriétaire de la clé est member de l'organisation, pas admin.
404 Not Found — aucune ressource de ce type, ou elle appartient à une autre organisation. L'API ne confirme jamais l'existence d'un id à un appelant qui n'y a pas droit.
429 Too Many Requests — plus de 120 requêtes en une minute pour cette clé.

Champs de la réponse

Champ	Type	Description
`success`	boolean	Indique si l'opération a réussi
`data.id`	string	Identifiant unique de la séquence
`data.name`	string	Son nom
`data.status`	string	`active` ou `paused`
`data.publishedVersionId`	string	null
`data.topicId`	string	null
`data.createdAt`	string	Date de création ISO
`data.updatedAt`	string	Date ISO de la dernière modification

Exemple de réponse

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

Remarques

Une séquence reçoit son sujet ici, jamais à la création. POST /api/v1/sequences n'accepte pas topicId — vous le définissez ensuite, comme le font les écrans.