Skip to main content
POST
Review proposed live changes

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
sequence_id
string<uuid>
required

Body

application/json

A person's waiting changes to a live sequence, as Review changes holds them.

​
expected_updated_at
string<date-time>
required
​
agent
OutboundAgentUpdateSchema · object | null

A change to an agent, sent whole against the version it was read at.

The configuration travels as one object rather than as fifteen optional fields: the AI writing tab reads the agent, edits it and sends it back, and expected_version makes two people editing at once a 409 rather than a silent overwrite.

​
audience
AudiencePutSchema · object | null
​
copy_from_sequence_id
string<uuid> | null
​
expected_agent_version
integer | null
​
graph
SequenceGraphPutSchema · object | null
​
mapping
ColumnMappingSchema · object | null

Which audience columns carry a meaning, all detected from the table.

One field per channel (email, LinkedIn) plus the company domain the coverage line reports on. Leave the whole object out when binding an audience and the columns are detected server-side. Send it only to correct a detection: a first name, a company or a last-contacted date is no longer part of this, because every column on the table is already addressable as a {{Column name}} variable.

​
restore_version
integer | null
Required range: x >= 1
​
review_token
string | null
Maximum string length: 255
​
sender_profile_ids
string<uuid>[] | null
Maximum array length: 100
​
settings
SequenceUpdateSchema · object | null

Response

Successful Response

​
active_contacts
integer
required
​
changes
SequenceChangeReadSchema · object[]
required
​
mailbox_stopped_contacts
integer
required

Live contacts the change stops at their next email because it removes the sender whose mailbox emails them: a contact is only ever emailed from one mailbox. LinkedIn steps before that email still run.

​
processing_contacts
integer
required
​
removed_step_contacts
integer
required
​
review_token
string
required
​
waiting_contacts
integer
required
​
approvals_released
integer
default:0

Cards waiting for approval in Tasks that the change lets go out without it, at most: those on a step whose approval it switches off, held only by the sequence's own approval for their channel, which it loosens, or held by a sender's own setting when it takes a sender off (that sender may have been the strictest). A card the remaining senders' setting or the agent's words on review still holds stays, and so does one a person edited and has not approved.

​
audience_restart
AudienceRestartReviewSchema · object | null

Set when the change replaces the audience and starts contacts over.

​
finished_contacts_at_most
boolean
default:false

True when the two finished-contact counts are of who stands at those ends, the most that go on, rather than each contact judged: more stand there than the review judges one by one. They are judged when the change applies.

​
finished_contacts_awaiting_answer
Finished Contacts Awaiting Answer · object

For each connection request whose branches all ended and one of which the change gives a step, by step id: how many contacts who finished once it was sent go back to waiting for its answer, judged as above.

​
finished_contacts_continuing
Finished Contacts Continuing · object

For each step a contact who had finished goes on to, by step id: how many finished at an end the change connects to that step, and go on to it once the change applies. Those who since replied, opted out, bounced, went on the do-not-contact list, answered or joined another sequence, were reached by one, left the audience, or lost their mailbox stay finished. Empty when the change connects no end anyone finished at.

​
removed_outcomes
RemovedOutcomeReviewSchema · object[]

Each outcome the change takes off a Browser use step that stays: how many contacts took it (their history keeps it) and how many still on the step have the agent choose among the other outcomes, with the review's sentences.

​
removed_step_going_on
integer
default:0

Live contacts on the steps the change removes who go on to what now follows them, as a new contact would, or finish there when nothing does; the rest of those on removed steps stop (removed_step_contacts).

​
removed_steps
RemovedStepReviewSchema · object[]

Each removed step anybody stands on, by name, with what happens to them: the review says it per step. removed_step_contacts and removed_step_going_on are the same counts summed.

​
rewritten_messages
integer
default:0

Messages the agent already wrote and nobody has sent, edited or approved that the change has it write again: their step's prompt, subject or thread changed, or how the agent writes did. A person's own edit and words a person approved are kept.

​
shortened_window_contacts
Shortened Window Contacts · object

For each connection request whose answer window the change shortens, by step id: how many contacts waiting for its answer have already waited longer than the new window, so their wait ends as soon as the change applies. Empty when no window shortens.