Skip to main content
POST
Write complete sequences for up to ten contacts

Authorizations

X-API-Key
string
header
required

Path Parameters

sequence_id
string<uuid>
required

Body

application/json
record_ids
string<uuid>[]
required
Required array length: 1 - 10 elements
close_open
boolean
default:false

Close the sequence's open training session first, keeping its reviews, and start a new one. Without it the contacts join the open session, so the ones already written stay; a contact already in it is written again. Still refused while that session is writing.

Response

Successful Response

agent_id
string<uuid>
required
applied_version
integer | null
required
base_version
integer
required
contacts
SequenceTrainingContactReadSchema · object[]
required
created_at
string<date-time>
required
error
string | null
required
id
string<uuid>
required
proposal
ContactTrainingProposal · object | null
required

The session's candidate prompt update, kept pending until applied.

revision
integer
required
status
enum<string>
required

A session's phase, also used to resume its review screen.

Available options:
running,
reviewing,
proposing,
proposed,
completed,
abandoned
steps
AiStep · object[]