Modifier une étape

PATCH /api/v1/sequences/{sequenceId}/versions/{versionId}/nodes/{nodeId} Modifie un nœud d'un brouillon : subject, content, templateId, waitHours, sendTimeMinutes, tagId ou webhookUrl. N'envoyez que les champs d'une seule famille — mélanger un objet et un waitHours dans le même appel répond 400, tout comme un corps qui ne porte rien.

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.

Paramètres de chemin

ParamètreTypeDescription
nodeIdstringObligatoire. L'étape à modifier

Corps de la requête

ChampTypeObligatoireDescription
subject / contentstringnonSur une étape send_email
preheaderstringnonSur une étape send_email. Jusqu'à 200 caractères, le texte d'aperçu affiché après l'objet. Même famille que subject et content : il peut être envoyé seul ou avec eux
waitHoursnumbernonSur une étape wait
sendTimeMinutesnumber | nullnonSur une étape d'une série : l'heure locale de la journée, en minutes depuis minuit (540 = 09:00). null la supprime, et l'étape part alors dès que l'attente qui la précède est écoulée. Sa propre famille — envoyez-le seul, jamais avec un objet ou un contenu
tagIdstringnonSur une étape add_tag / remove_tag
webhookUrlstringnonSur une étape webhook

Exemple

bash
curl -X PATCH -H "x-api-key: $AGENTMAIL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"waitHours": 48}' \
  "https://www.agentsmail.io/api/v1/sequences/$SEQUENCE_ID/versions/$VERSION_ID/nodes/$NODE_ID"

Réponse

  • 200 OK — l'appel a réussi.
  • 400 Bad Request — la validation a échoué ; details porte les problèmes champ par champ.
  • 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 de l'étape
data.versionIdstringLa version brouillon ou publiée à laquelle elle appartient
data.typestringsend_email, wait, add_tag, remove_tag, end_sequence, webhook
data.subject / contentstring \null
data.preheaderstringTexte d'aperçu de l'étape ; chaîne vide sur une étape qui n'envoie rien
data.templateIdstring \null
data.waitHoursnumber \null
data.tagIdstring \null
data.webhookUrlstring \null
data.createdAt / updatedAtstringDates ISO

Exemple de réponse

json
{
  "success": true,
  "data": {
    "id": "4d19c0a2",
    "versionId": "c41a7e55",
    "type": "send_email",
    "subject` / `content": "value",
    "templateId": "5a44b901",
    "waitHours": 24,
    "tagId": "7c2ef4b1",
    "webhookUrl": "https://example.com/hooks/agentsmail",
    "createdAt` / `updatedAt": "value"
  }
}

Voir aussi