Automations

Restart contacts from the beginning of the flow

Ends the run in progress and rewrites the contacts onto the version published today.

Use it only for structural errors. Enrollment pins the version, the DAG travels inside the workflow and one enrollment per contact prevents re-entering: whoever entered on a version with an extra node or a wrong branch cannot be reached in any other way. A text error does not need it: message content is re-read from the current version at every send, so a PATCH of the journey is enough.

It is destructive: the contact starts over and will see again the emails already received, which is why confirm: true is mandatory. The old run is marked as superseded and not deleted, so sent messages and the step log stay readable. Works only on active automations (409 on drafts and paused automations) and also answers 409 if none of the given contacts is inside the flow. Required scope: automations:write.

post/automations/{id}/restart

Request

  • Base URL: https://sending.dev/api/v1
  • URL: https://sending.dev/api/v1/automations/{id}/restart
  • Auth: HTTP bearer

Path parameters

idstring required

Automation ID.

Request body

contactIdsstring[] required
confirmtrue required

Explicit confirmation: contacts will see again the emails already received.

Response

Restart queued.

idstring uuid required
queuedboolean required
contactsinteger required

Contacts found inside the flow, which will restart.

notEnrolledinteger required

Given but never entered in this automation.

Changes

No recorded changes to this operation across all 1 revision of this API.