Skip to main content
POST
Cancel a campaign or trigger execution

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

id
string
required

The ID of the campaign or trigger execution

Response

200 - application/json

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

id
string
required

The ID of the execution

customer
string
required

The customer executing through the campaign

scheduled_at
string | null
required

The scheduled time for the next step to execute

step_count
integer
required

The index of the next step to execute

current_step_id
string | null
required

The ID of the current step

status
enum<string>
required

The status of the execution

Available options:
pending,
in_progress,
retrying,
finished,
failed,
stopped
failed_at
string | null
required

The time when the execution failed in ISO 8601 format

failed_reason
string | null
required

The reason the execution failed

finished_at
string | null
required

The time when the execution finished in ISO 8601 format

finished_reason
string | null
required

The reason the execution finished

stopped_at
string | null
required

The time when the execution was stopped in ISO 8601 format

started_at
string | null
required

The time when the execution started processing in ISO 8601 format

created_at
string
required

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