Skip to main content
POST
Start a preview for a company

Body

application/json

Start a preview for one company.

domain
string
required

The company's website, as typed in the homepage's box.

Required string length: 1 - 253
timezone
string | null

The visitor's browser clock, like Europe/Berlin: the segments are placed in its country, and the sending window starts on it.

Maximum string length: 64

Response

Successful Response

A preview the moment it starts: the only response that carries its session token.

Its own schema rather than a field on WizardRunReadSchema, so no read can serve the token back.

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
session_token
string
required

Send it as the X-Wizard-Session header on every other wizard route.

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.