Skip to main content
POST
Retry a sequence's failed contacts

Authorizations

X-API-Key
string
header
required

Path Parameters

sequence_id
string<uuid>
required

Body

application/json

Which contacts a bulk action on the Audience tab reaches.

Send ids for contacts picked one by one. Send all: true for every contact the filters below match (every contact, with none), less any excluded_ids, resolved on the server at the moment of the action so it covers every match across pages. A body that names nobody is refused.

all
boolean
default:false

Act on every contact the filters match, or every contact when there are none. Required when ids is absent.

created_from
string<date-time> | null

Only contacts added on or after this instant. The grid's date range, which an action on everything matching has to honor or it reaches past what the person was looking at.

created_to
string<date-time> | null
exclude
boolean
default:false

Read 'statuses' and 'stop_reasons' as 'everything but', matching the Contacts tab's one Include/Exclude toggle.

excluded_ids
string<uuid>[]

With all, contacts to leave out: the rows unticked after ticking the header.

Maximum array length: 1000
group
enum<string> | null

The Audience tab's tab the grid was showing. An action on everything matching reaches only the contacts under it, or Select all under one tab would act on everyone.

Available options:
in_progress,
needs_approval,
paused,
done,
blocked,
removed
ids
string<uuid>[] | null

The contacts to act on, by enrolment id.

Maximum array length: 1000
order_by
enum<string>
default:created_at

The order the grid was listing in. Under a 'group', the action judges the same contacts the tab's list judged in that order.

Available options:
created_at,
due_at,
status
order_direction
enum<string>
default:desc

The direction of order_by.

Available options:
asc,
desc
outcomes
enum<string>[] | null

Only contacts whose latest settled Browser use run took one of these outcomes: the grid's Outcome filter.

Which way an edge leaves its step.

DEFAULT for message-step flow; YES/NO for a condition's two branches. A connection request leaves by the answer it got: CONNECTED (accepted, and already connected unless that has a branch of its own), ALREADY_CONNECTED (present only when the request splits it out) and NOT_ACCEPTED.

A Browser use step leaves by the outcome its run reached: OUTCOME_1 to OUTCOME_8 are fixed slots whose words the step's browser_config holds (a slot is never given to a second outcome once its first is removed), and NEEDS_HUMAN is the way every run may end, when the site wanted something only a person can give. Fixed slots rather than free keys, so a branch still fits the stored columns, the edge's unique constraint and every reader of this enum.

Available options:
default,
yes,
no,
connected,
already_connected,
not_accepted,
outcome_1,
outcome_2,
outcome_3,
outcome_4,
outcome_5,
outcome_6,
outcome_7,
outcome_8,
needs_human
search
string | null
Maximum string length: 255
statuses
enum<string>[] | null

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 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; 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.

A contact the workspace's recontact rule refuses is STOPPED with StopReason.COOLDOWN. There is deliberately no held state: a cooldown settles a contact rather than parking them, so nothing here waits on a date and nothing lets itself out later.

AWAITING_ACTION is a contact parked behind a task that needs a person or a channel, modelled on PAUSED: live, keeps its step and its one-live-sequence slot, unclaimable because the tick claims strictly on ACTIVE, and a compliance stop reaches it. Unlike PAUSED nobody wakes it by hand: only the outreach-task sweep does, once the task it waits on is decided or delivered. Deliberately not "awaiting approval": an AUTO-mode LinkedIn park is waiting for a browser rather than for anyone's approval, and this value is the word the Contacts tab shows for both.

PENDING is a draft's roster: in, standing on a step, and NOT live. Binding an audience enrols on the spot so the Contacts tab can show who is in, but a sequence nobody has launched must not hold anybody's one-live-sequence slot, or a second sequence written for the same people skips them all. uq_sequence_enrolment_one_live leaves PENDING out, the tick never claims it, and launch turns each row ACTIVE, settling the ones another sequence took meanwhile as SKIPPED_DUPLICATE.

Available options:
pending,
active,
claimed,
paused,
awaiting_action,
completed,
stopped,
failed,
suppressed,
skipped_duplicate
step_branch
enum<string> | null

With step_id, instead of step_state: the arm's list the action was taken from.

Available options:
default,
yes,
no,
connected,
already_connected,
not_accepted,
outcome_1,
outcome_2,
outcome_3,
outcome_4,
outcome_5,
outcome_6,
outcome_7,
outcome_8,
needs_human
step_id
string<uuid> | null

The step of the Builder the list was showing. An action on everything matching reaches only that step's contacts, as its card counts them.

step_state
enum<string> | null

With step_id: which of the step's lists the action was taken from, 'waiting' or 'failed', as the contacts list reads them.

Available options:
waiting,
failed
stop_reasons
enum<string>[] | null
Available options:
reply,
unsubscribe,
do_not_contact,
bounce,
manual,
company_reply,
row_left_audience,
row_left_paused,
step_removed,
removed,
cooldown,
rejected,
mailbox_removed,
unread_reply,
declined,
trashed,
trashed_paused

Response

Successful Response

One retry of a sequence's failed contacts, run in the background.

Its counts grow as it works through its contacts; once status is succeeded or failed they are final. A failed Run keeps what it reached: the rest stay failed, and a new retry picks them up.

created_at
string<date-time>
required
done
integer
required

How many of them it has reached so far.

id
string<uuid>
required

The Run, to read it again while it works.

in_other_sequence
integer
required

Of the rest, the contacts another live sequence has taken since they failed: they stay failed here, on the step that broke, for a retry once that sequence is done with them.

missing_values
string[]
required

The values still_missing counts contacts for, in the order first met.

retried
integer
required

How many it re-queued at the exact step that broke, so far.

sequence_id
string<uuid>
required
status
enum<string>
required

queued until it starts, running while it works, then succeeded or failed. One Run of a sequence is queued or running at a time.

Available options:
queued,
running,
succeeded,
failed
still_missing
integer
required

Of the rest, the contacts a Browser use step failed for an empty value that is still empty on their row; fill it in, then retry them.

total
integer
required

How many failed contacts of the selection it reaches, fixed when it was started: a contact that fails afterwards is not part of it.

updated_at
string<date-time>
required

When it last moved on.