Skip to main content
POST
Stop Sequence

Authorizations

Authorization
string
header
required

Bearer API key issued from Settings → Developers.

Path Parameters

sequence_id
string<uuid>
required

ID of the sequence.

Body

application/json

Stop Sequence payload

reason
enum<string>
required

Why the sequence is being stopped.

Available options:
WIN,
LOSE
scope
enum<string>
required

Whether the stop applies to this sequence only or to all sequences for contacts of the same account.

Available options:
CONTACT,
ACCOUNT

Response

200 - application/json

Successful Response

id
string<uuid>
required

Unique identifier.

organization_id
string<uuid>
required

Workspace this sequence belongs to.

contact_id
string<uuid> | null
required

Contact this sequence is targeting.

sequence_template_id
string<uuid>
required

Template the sequence was instantiated from.

status
enum<string>
required

Current execution state.

Available options:
ACTIVE,
SUCCEEDED,
FAILED,
COMPLETED,
WAITING_FOR_LEAD,
WAITING_FOR_USER,
STOPPED_EARLY,
FOUND,
REFUSED
variables
Variables · object | null
required

Per-run template variables substituted into outbound messages.

source_contact_list_id
string<uuid> | null
required

Contact list that triggered this sequence, if any.

last_step_executed_at
string<date-time> | null
required

When the most recent step ran.

created_at
string<date-time>
required

When the sequence was created.

updated_at
string<date-time>
required

When the sequence last changed.

contact
PublicContactSummary · object | null

Summary of the contact this sequence is targeting.

sequence_template
PublicSequenceTemplateSummary · object | null

Summary of the template this sequence was instantiated from.