Skip to main content
POST
Suggest Invitation Message

Authorizations

Authorization
string
header
required

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

Headers

X-API-Key
string | null

Path Parameters

interview_id
string<uuid>
required

Body

application/json

Optional steering for the AI-suggested invitation message.

campaign_title/campaign_goal/language mirror the builder's CURRENT (possibly unsaved) form values — the builder autosaves with a debounce, so the server row can lag what the user just changed.

instructions
string | null
Maximum string length: 500
current_message
string | null
Maximum string length: 4000
campaign_title
string | null
Maximum string length: 300
campaign_goal
string | null
Maximum string length: 2000
campaign_background
string | null
Maximum string length: 4000
language
string | null
Maximum string length: 20
topics
string[]
Maximum array length: 30
target
enum<string>
default:invitation_message
Available options:
invitation_message,
participant_context

Response

Successful Response

message
string
required