Stop pathway

When a pathway is stopped, all scheduled steps will be cancelled and no notifications (eg reminders) will be sent anymore. The pathway will come to a halt at the state it's currently in.

Request

Mutation

graphql
Copy
01mutation StopPathway($input: StopPathwayInput!) {
02  stopPathway(input: $input) {
03    code
04    success
05  }
06}

Variables

We highly recommend to pass a reason for stopping the pathway as this creates transparency for why a pathway was stopped.

json
Copy
01{
02  "input": {
03    "pathway_id": "{{PATHWAY_ID}}",
04    "reason": "{{REASON}}"
05  }
06}