Sign in

v7

latestOpenAPI 3.1.02026-08-0776170186.5 KB
sequences

Enroll Contact

Enroll a contact into a sequence template, starting a sequence run.

The template must be ACTIVE and have at least one step; the sequence is instantiated from the template's steps and scheduled exactly like an enrollment made from the app, including task-owner assignment.

A contact already running this template is rejected rather than enrolled twice, and so is a contact (or its company) on an exclusion list.

A contact with an active sequence from a different template is also rejected: stop that sequence first (POST /v1/sequences/{id}/stop) to avoid two sequences messaging the same person at once. Templates the contact only has completed or stopped sequences for do not block enrollment.

Requires the sequences:write scope on the API key.

post/v1/sequences

Request body

contact_idstring uuid required

Contact to enroll.

sequence_template_idstring uuid required

Active template to instantiate the sequence from.

Response

Successful Response

idstring uuid required

Unique identifier.

organization_idstring uuid required

Workspace this sequence belongs to.

contact_idstring uuid nullable required

Contact this sequence is targeting.

sequence_template_idstring uuid required

Template the sequence was instantiated from.

status'ACTIVE' | 'SUCCEEDED' | 'FAILED' | 'COMPLETED' | 'WAITING_FOR_LEAD' | 'WAITING_FOR_USER' | 'STOPPED_EARLY' | 'FOUND' | 'REFUSED' required
variablesobject nullable required

Per-run template variables substituted into outbound messages.

source_contact_list_idstring uuid nullable required

Contact list that triggered this sequence, if any.

last_step_executed_atstring date-time nullable required

When the most recent step ran.

created_atstring date-time required

When the sequence was created.

updated_atstring date-time required

When the sequence last changed.