Skip to main content
POST
Stop, pause, resume or retry many contacts

Authorizations

X-API-Key
string
header
required

Path Parameters

sequence_id
string<uuid>
required

Body

application/json

One journey action applied to a selection of contacts.

Ids only, deliberately: this is what the Contacts tab's row checkboxes select, and an action that changes what a contact receives should reach exactly the rows a person ticked.

action
enum<string>
required
Available options:
stop,
pause,
resume,
retry
enrolment_ids
string<uuid>[]
required
Required array length: 1 - 1000 elements

Response

Successful Response

changed
integer
required

How many contacts actually took the action. A selection is rarely uniform, so rows the action cannot apply to are skipped, not failed.