Changer le déclencheur d'un brouillon

PATCH /api/v1/sequences/{sequenceId}/versions/{versionId} Change le déclencheur d'un brouillon — la liste ou le tag qui inscrit les contacts. Envoyez les deux champs : le déclencheur est remplacé, jamais fusionné.
ConditionRéponse
un brouillon, les deux champs valides200 — la version revient avec son nouveau déclencheur
champ manquant, triggerType inconnu, id mal formé400 — details nomme le champ
cible du déclencheur appartenant à une autre organisation404 — comme un tag qui n'existe pas
triggerType: "fixed_date"400 — les séries à date fixe se configurent dans l'application, pas ici
la version n'est pas un brouillon400 — les versions publiées sont des instantanés ; ouvrez un brouillon
Personne n'est inscrit sur le nouveau déclencheur tant que vous n'avez pas publié le brouillon. Les contacts qui parcourent déjà la version publiée continuent d'entrer sur l'ancien, et terminent le parcours dans lequel ils sont entrés.

Autorisation

Rôle dans l'organisationCet endpoint
OWNERAutorisé
ADMINAutorisé
MEMBERRefusé — 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

ChampTypeObligatoireDescription
triggerTypestringouilist_joined ou tag_added. fixed_date est refusé ici : une série pilotée par une date porte aussi son audience, sa date de début et le calendrier de chaque étape, et cette requête ne peut pas les exprimer.
triggerTargetIdstringouiL'id de la liste pour list_joined, l'id du tag pour tag_added

Exemple

bash
curl -X PATCH -H "x-api-key: $AGENTMAIL_API_KEY" -H "content-type: application/json" \
  -d '{"triggerType":"tag_added","triggerTargetId":"'$TAG_ID'"}' \
  "https://www.agentsmail.io/api/v1/sequences/$SEQUENCE_ID/versions/$VERSION_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

ChampTypeDescription
successbooleanIndique si l'opération a réussi
data.idstringIdentifiant unique de la version
data.sequenceIdstringLa séquence à laquelle elle appartient
data.versionnumberSon rang, à partir de 1
data.statusstringdraft ou published
data.publishedAtstringnull
data.triggerTypestringlist_joined ou tag_added
data.triggerTargetIdstringLa liste ou le tag qui inscrit les contacts
data.createdAtstringDate de création ISO
data.updatedAtstringDate ISO de la dernière modification

Exemple de réponse

json
{
  "success": true,
  "data": {
    "id": "4d19c0a2",
    "sequenceId": "9b3f2d10",
    "version": 1,
    "status": "subscribed",
    "publishedAt": "2026-08-23T10:22:05.000Z",
    "triggerType": "list_joined",
    "triggerTargetId": "0b7c51e8",
    "createdAt": "2026-08-23T10:22:05.000Z",
    "updatedAt": "2026-08-23T10:22:05.000Z"
  }
}

Voir aussi