Skip to main content
PATCH
Update a creator

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>.

Headers

Idempotency-Key
string

Optional. A unique value (8 to 64 letters, digits, - or _; a UUID is ideal) that makes a retry safe: the same key with the same request within 24 hours returns the stored response, with Idempotent-Replayed: true, instead of doing the work twice. The same key with a different request is 409 IDEMPOTENCY_KEY_REUSED; while the first request still runs it is 409 IDEMPOTENCY_IN_PROGRESS. A malformed key is 400 VALIDATION_ERROR.

Required string length: 8 - 64
Pattern: ^[A-Za-z0-9_-]{8,64}$

Path Parameters

creatorId
string
required

The creator id (cre_…).

Body

application/json
aiEnabled
boolean

The creator's master AI switch. Turning it on lets the AI answer every fan who is waiting in her AI chats, within seconds. Turning it off stops all AI replies and follow-ups for her.

displayName
string

A new label for her, 1 to 120 characters.

Required string length: 1 - 120

Response

The updated creator.

aiEnabled
boolean
required

The creator's master AI switch. false means the AI chatter answers none of her fans.

avatarUrl
string | null
required

Her OnlyFans avatar, once connected.

connection
CreatorConnection · object
required

Headline connection state. GET /v1/creators/{creatorId}/connection has the detail.

true when OnlyFans is asking her to accept its content-consent prompt; media sends fail until she does it in OnlyFans. null when not known yet.

createdAt
string
required

When the creator was added to OnlyX (ISO-8601 UTC).

displayName
string
required

Your team's label for the creator. Set by you, never changed by OnlyFans.

handle
string | null
required

Her OnlyFans username, without @. Replaced by the real username once she connects.

id
string
required

The creator id (cre_…).

onlyfans
OnlyFansProfile · object | null
required

Profile facts read from OnlyFans. null until she has connected once.

platform
enum<string>
required

Always onlyfans for creators added through the API in v1. telegram is reserved for Telegram creators, which are coming soon, so code that reads this should expect more than one value.

Available options:
onlyfans,
telegram
publicName
string | null
required

The display name on her OnlyFans profile, once connected.

stats
CreatorStats · object
required

Headline numbers, cheap to read.