sequences

Review proposed live changes

post/sequences/{sequence_id}/changes/preview/

Request

  • Base URL: https://api.getoneprofile.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.getoneprofile.ai/sequences/{sequence_id}/changes/preview/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

sequence_idstring uuid required

Request body

copy_from_sequence_idstring uuid nullable
expected_agent_versioninteger nullable
expected_updated_atstring date-time required
restore_versioninteger nullable
review_tokenstring nullable
sender_profile_idsstring[] nullable
training_revisioninteger nullable
training_rewriteboolean
training_session_idstring uuid nullable
training_slot_keysstring[] nullable

Response

Successful Response

active_contactsinteger required
approvals_releasedinteger

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.

finished_contacts_at_mostboolean

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_answerobject

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_continuingobject

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.

mailbox_stopped_contactsinteger 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_contactsinteger required
removed_step_contactsinteger required
removed_step_going_oninteger

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

review_tokenstring required
rewritten_messagesinteger

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.

rewritten_messages_tenthsinteger

The most writing those messages again costs, in tenths of a credit: each at the dearest turn the agent's settings allow.

shortened_window_contactsobject

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.

waiting_contactsinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.