Skip to main content
POST
Send an onboarding message

Authorizations

x-api-key
string
header
required

API key created in Dashboard → Settings → Developer

Path Parameters

creatorId
string
required

Opaque creator id returned by /creators

Query Parameters

scope
enum<string>
default:company

Choose the data scope. company (default) limits results to the API key company's data. agency includes the parent agency and its linked brands. scope=agency requires a parent agency key; other keys receive 403.

Available options:
company,
agency

Body

application/json
programId
string<uuid>
required
message
string
required

Shown to the creator. Say what to do next.

Required string length: 1 - 1000

Response

Message sent

programId
string<uuid>
required
creatorId
string
required
sent
enum<boolean>
required
Available options:
true