Skip to main content
GET
Get the welcome message

Authorizations

Authorization
string
header
required

An API key (onx_sk_…) created in OnlyX under Settings → API & MCP, or an OAuth access token (onx_at_…) issued to a connected app. Send it as Authorization: Bearer <credential>. API keys may also be sent as X-API-Key: <key>.

Path Parameters

creatorId
string
required

The creator id (cre_…).

Response

The welcome message as OnlyFans has it, and how your latest change went.

OnlyFans' automatic welcome message, sent to every new subscriber.

connected
boolean
required

false when the creator is not connected; the other fields are then empty.

enabled
boolean
required

Whether OnlyFans sends the welcome message to new subscribers at all.

lastUpdate
WelcomeUpdate · object | null
required

Your latest change, or null if it was never changed through OnlyX.

media
WelcomeMedia · object[]
required

Attached media.

pending
boolean
required

true while a change you made is being applied on OnlyFans.

priceCents
integer
required

The unlock price for its paid media, in cents. 0 when free.

text
string
required

The message text.