sequences

Create a draft from a template, with fresh audience and senders

post/sequences/sequence-templates/{template_id}/use/

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-templates/{template_id}/use/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

template_idstring uuid required

Response

Successful Response

audience_table_idstring uuid nullable required
audience_view_idstring uuid nullable required
bcc_addressesstring[]

Blind copies on every email this sequence sends.

cc_addressesstring[]

Addresses copied on every email this sequence sends.

connection_requests_sentinteger nullable
connections_acceptedinteger nullable

Invitations from this sequence confirmed accepted. With connection_requests_sent this yields the acceptance rate.

contacts_addedinteger nullable

Rollup, list reads only. None when the list's stats have never been built and could not be built on this request (for example, another request was building them). Show a zero state, not a fake 0.

contacts_failedinteger nullable
contacts_finishedinteger nullable
contacts_in_progressinteger nullable
contacts_not_startedinteger nullable

A draft's contacts, who start when it launches (rollup, list reads only).

continuous_enrolmentboolean

TRUE keeps the audience live: rows added to the table later enrol on their own, and rows that leave it stop. FALSE (the default for a new sequence) freezes the audience after launch; Add to sequence still adds rows to it by hand.

created_atstring date-time required
email_approval_modestring nullable

manual requires approval; confident adds approval for uncertain AI-written emails; null follows the sender. There is no value meaning 'send automatically': a sequence can only add an approval.

emails_sentinteger nullable
idstring uuid required
is_favoriteboolean

List reads only: whether the person asking starred the sequence. Their own, never a teammate's; always false for an API key.

last_synced_atstring date-time nullable

When the audience-enrolment diff last completed. None until the first sync (launch runs one inline). The Audience tab shows this plus a manual trigger, never a background job the user cannot see.

last_viewed_atstring date-time nullable

List reads only: when the person asking last opened the sequence; null when they never have, and for an API key.

launched_atstring date-time nullable required
linkedin_approval_modestring nullable

manual requires approval; confident adds approval for uncertain AI-written LinkedIn steps; null follows the sender. There is no value meaning 'send automatically': a sequence can only add an approval.

linkedin_check_max_secondsinteger nullable

Retired. Acceptance checks now use the service-managed interval.

linkedin_check_min_secondsinteger nullable

Retired. Acceptance checks now use the service-managed interval.

linkedin_messages_sentinteger nullable
multithreadingobject nullable required
namestring required
opportunity_valuesobject nullable

Dollars per outcome label; None = tracking off.

opt_out_footer_textstring required
outbound_agent_idstring uuid nullable

The sequence's outbound agent: the writer of every agent-written step and of its replies. Read and configure it under /outbound-agents/{id}/.

pause_reasonstring nullable required
plain_text_onlyboolean

TRUE (recommended) sends no formatting: the bold, italic and link marks are stripped and the email reads as plain text; FALSE renders them. Either way the email carries an HTML part laid out line for line, which keeps its spacing exactly, beside a matching text part.

positiveinteger nullable

Threads labelled positive (rollup, list reads only).

positive_ratenumber nullable
repliesinteger nullable

Distinct contacts who replied: reply_rate's numerator.

reply_ratenumber nullable
sender_profile_idsstring[]

Only meaningful on list reads: the sequence's senders by id, in the same order as sender_profile_names.

sender_profile_namesstring[]

Only meaningful on list reads: the names of the sequence's senders.

senders_readyboolean

Only meaningful on list reads: False when the sequence has senders but none currently has a connected mailbox.

sending_prioritystring

Who gets scarce capacity first: new_contacts or follow_ups.

sending_windowobject nullable required
spending_limit_tenthsinteger nullable
status'draft' | 'running' | 'paused' | 'completed' required

Lifecycle of a sequence.

DRAFT until launch; RUNNING sequences are locked against structural edits (pause → edit → resume); PAUSED stops scheduling while leaving every enrolment exactly where it is; COMPLETED is terminal.

status_column_idstring uuid nullable required
step_countinteger required
updated_atstring date-time required

Changes

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