Pause Sequence

const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: JSON.stringify({paused_until: '2023-11-07T05:31:56Z'}) }; fetch('https://api.topo.io/v1/sequences/{sequence_id}/pause', options) .then(res => res.json()) .then(res => console.log(res)) .catch(err => console.error(err));

{ "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "sequence_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "variables": {}, "source_contact_list_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "last_step_executed_at": "2023-11-07T05:31:56Z", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z" }

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

Pause Sequence payload

paused_until

string<date-time>

required

When the sequence should resume.

Response

200 - application/json

Successful Response

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

required

Per-run template variables substituted into outbound messages.

Hide child attributes

variables.{key}

string | null

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.