Skip to main content
POST
Start the sequence anyway

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

run_id
string<uuid>
required

Body

application/json

Which sign-in the person used, so the sequence sends from that mailbox.

mailbox
enum<string>
default:gmail

gmail after Continue with Google, outlook after Continue with Microsoft.

Available options:
gmail,
outlook

Response

Successful Response

A preview: everything the wizard's page shows.

build_error
string | null
required
claimed
boolean
required

A visitor's preview was claimed: the workspace is a customer's now. Never true of a run in the person's own workspace, which nobody claims.

context
WizardContextReadSchema · object | null
required

What the research wrote about the company.

dns_issue
enum<string> | null
required

What the silent check of a company's sending setup found missing.

Available options:
no_dmarc,
no_spf
domain
string
required
id
string<uuid>
required
insights_error
string | null
required
join_requested_at
string<date-time> | null
required
launch_error
string | null
required
launched_at
string<date-time> | null
required
learnings
string[]
required

What the writer already follows: the template's learnings and any saved since.

messages
WizardMessageReadSchema · object[]
required
outlook_available
boolean
required

Continue with Microsoft is offered: Outlook is open to every workspace (to this one, in your own workspace), as on Mailboxes. False shows the Outlook waitlist instead.

own_workspace
boolean
required

Started after sign-up in the person's own workspace: nothing is claimed at the end, and the Connect step only connects Gmail.

people
WizardPersonReadSchema · object[]
required
people_table_ready
boolean
required

The people table is made: its stream (GET .../events/) can be followed from now.

research
WizardResearchReadSchema · object | null
required

The business-context research, as it runs.

segment_index
integer | null
required
segments
WizardSegmentReadSchema · object[]
required
sender_name
string | null
required
sender_source
enum<string> | null
required

Where the name the messages are signed with came from.

Available options:
about_page,
typed,
sign_in
sender_title
string | null
required
sequence_id
string<uuid> | null
required
stage
enum<string>
required

Where a run stands, derived from what it holds. Never stored.

The frontend's five steps map onto these: researching and segments are step 1 and 2, finding is step 3, and writing is step 4 from the first message written (the page reads the messages themselves to tell).

Available options:
researching,
research_failed,
segments,
finding,
finding_failed,
writing,
launched
stalled
boolean
required

The research's next step or the people's search never started: resume the preview to start it.

company_name
string | null

The company's name as its homepage writes it; null until read, or when it names none.

connect_credits
integer
default:0

What Connect goes on to spend researching the people after the first twenty, said before the press.

credits_left
integer
default:0

The workspace's credits left.

credits_per_person
integer
default:0

What researching and writing to one person usually costs.

headline
string | null

The homepage's main headline, word for word; null until read, or when it has none.

logo_path
string | null

The company's logo, a path under this API's address that needs no credentials (/accounts/logos/{name}/); null until one is found for its website.

people_covered
integer
default:0

How many of the people the workspace's credits research and write to, which the wizard says in place of the hundred found.

preview_settled
boolean
default:false

Every first message of the picked audience is written or failed: a switch to another audience may start.

subheadline
string | null

The sentence under that headline, word for word; null until read, or when none.

suggestions_full
boolean
default:false

The run offers the most audiences it keeps while one can be picked: Suggest audiences is refused until one is picked.

switch_credits
integer
default:0

What switching to another audience usually costs before sign-up.