Créer une séquence

Créer une séquence

POST /api/v1/sequences Crée la séquence et le brouillon de sa version 1, en une seule transaction. Répond 201. La séquence naît paused, avec publishedVersionId: null — elle n'inscrit encore personne. Les ids de liste viennent de GET /api/v1/lists, les ids de tag de GET /api/v1/tags, tous deux dans l'API Audience.

Condition	Réponse
tout est valide	`201`
nom manquant, `triggerType` inconnu, id mal formé	`400` — `details` nomme le champ
cible du déclencheur appartenant à une autre organisation	`404` — comme une liste qui n'existe pas
`triggerType: "fixed_date"`	`400` — les séries à date fixe se configurent dans l'application, pas ici
la limite de séquences de votre offre est atteinte	`400` qui nomme la limite et le nombre de séquences que vous avez déjà

Le plafond de séquences de l'offre s'applique ici exactement comme dans l'application. Ce n'est pas une propriété de l'interface : la même garde refuse l'API. Supprimez une séquence dont vous n'avez plus besoin, ou changez d'offre — réessayer n'y changera rien.

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	oui	1 à 100 caractères
`triggerType`	string	oui	`list_joined` ou `tag_added`. Une troisième valeur, `fixed_date`, existe dans l'application pour les séries pilotées par une date ; elle est refusée ici — une série a aussi besoin de son audience, de sa date de début et du calendrier de chaque étape, et n'en fournir que la moitié laisserait une séquence que rien ne peut publier.
`triggerTargetId`	string	oui	L'id de la liste pour `list_joined`, l'id du tag pour `tag_added`

Exemple

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"

Réponse

201 Created — la ressource créée.
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.
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.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",
    "createdAt": "2026-08-23T10:22:05.000Z",
    "updatedAt": "2026-08-23T10:22:05.000Z"
  }
}