Executions

Cancel a campaign or trigger execution

Changed on
post/executions/{id}/cancel

Request

Path parameters

idstring required

The ID of the campaign or trigger execution

Response

The cancelled campaign or trigger execution, finished with reason User cancelled the execution

idstring required

The ID of the execution

triggerstring

The ID of the trigger (expandable to the full trigger object). Only present on trigger executions

eventstring nullable

The ID of the tracked event that created the execution (expandable to the full event object). Only present on trigger executions; null for executions created by internal events

customerstring required

The customer executing through the campaign

scheduled_atstring nullable required

The scheduled time for the next step to execute

step_countinteger required

The index of the next step to execute

current_step_idstring nullable required

The ID of the current step

status'pending' | 'in_progress' | 'retrying' | 'finished' | 'failed' | 'stopped' required

The status of the execution

failed_atstring nullable required

The time when the execution failed in ISO 8601 format

failed_reasonstring nullable required

The reason the execution failed

finished_atstring nullable required

The time when the execution finished in ISO 8601 format

finished_reasonstring nullable required

The reason the execution finished

stopped_atstring nullable required

The time when the execution was stopped in ISO 8601 format

started_atstring nullable required

The time when the execution started processing in ISO 8601 format

created_atstring required

The time the execution was created — i.e. when the customer was enrolled in the campaign — in ISO 8601 format

Changes