Skip to main content
POST
Start the campaign 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 campaign 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
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
messages
WizardMessageReadSchema · object[]
required
outlook_available
boolean
required

Continue with Microsoft is offered: Outlook sign-in is configured here. False shows the Outlook waitlist instead.

people
WizardPersonReadSchema · object[]
required
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
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.