Skip to main content
POST
Release one held contact into this sequence

Authorizations

X-API-Key
string
header
required

Path Parameters

sequence_id
string<uuid>
required
enrolment_id
string<uuid>
required

Response

Successful Response

bounced
boolean
required
company_key
string | null
required
created_at
string<date-time>
required
current_step_id
string<uuid> | null
required
due_at
string<date-time> | null
required
email
string | null
required
id
string<uuid>
required
record_id
string<uuid>
required
replied_at
string<date-time> | null
required
status
enum<string>
required

Where one contact stands in one sequence.

ACTIVE rows carry a due_at and are what the tick claims; CLAIMED is the in-flight guard between claim and outcome. PAUSED (SEQ-30) is a deliberate per-contact hold: unclaimable because the tick claims strictly on ACTIVE, yet still LIVE — it keeps its step and its one-live-sequence slot, and a compliance stop (reply, unsubscribe) reaches it. Everything else is settled: COMPLETED walked off the end; STOPPED was halted (reply, unsubscribe, bounce, manual, company pause); FAILED is terminal per the phase-1 ruling; SUPPRESSED was on the do-not-contact list; SKIPPED_DUPLICATE lost the one-live-sequence-per-contact rule, with the reason visible in the grid.

ONE-1199 adds two HELD states, which are neither live nor settled. COOLDOWN is a contact the workspace's recontact rule is holding back: it carries the eligible-again instant in due_at and resolves ITSELF at the first release sweep after that instant. It is deliberately outside uq_sequence_enrolment_one_live — a hold is not a live cadence, so two sequences may each hold the same person and each releases independently — and outside the due-queue's partial index, so the tick can never claim one. EXCLUDED is an exclusion-list match: the opposite fact, because there is no date on which it resolves.

Available options:
active,
claimed,
paused,
completed,
stopped,
failed,
suppressed,
skipped_duplicate,
cooldown,
excluded
stop_reason
enum<string> | null
required
Available options:
reply,
unsubscribe,
bounce,
manual,
company_reply,
row_left_audience,
step_removed,
removed
updated_at
string<date-time>
required
company
string | null
display_name
string | null
excluded_list_id
string<uuid> | null
hold_list_name
string | null

Which exclusion list excluded this contact.

hold_reason
enum<string> | null

Which dial holds this contact: person or account.

Available options:
person,
account
hold_source_contacted_at
string<date-time> | null

The contact this hold is measured from. For an account hold this is a colleague's; the colleague is deliberately never named.

hold_until
string<date-time> | null

When a held contact becomes eligible again.

linkedin_url
string | null