Skip to main content
POST
Create a tracking link

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
required

Required. A new unique value per new request (8 to 64 letters, digits, - or _; a UUID is ideal). If the request times out or fails with a 5xx, retry with the SAME key: you get the original response (with Idempotent-Replayed: true) and nothing is done twice. Keys are kept for 24 hours. Without it the answer is 400 IDEMPOTENCY_KEY_REQUIRED.

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

Path Parameters

creatorId
string
required

The creator id (cre_…).

Body

application/json
kind
enum<string>
required

tracking or trial.

Available options:
tracking,
trial
name
string
required

The name, 1 to 100 characters, as it will appear on OnlyFans.

Required string length: 1 - 100
claimsLimit
integer

Trial links only: the most trials it may give, 1 to 100000.

Required range: 1 <= x <= 100000
expiresAt
string<date-time>

Trial links only: when the link stops working (ISO-8601, in the future).

trialDays
integer

Trial links only: free-trial length, 1 to 365 days.

Required range: 1 <= x <= 365

Response

Accepted: the link is being created. Poll the creationId.

creationId
string
required

An opaque id to poll with GET …/tracking-links/creations/{creationId}.

state
string
required

Always creating.

Allowed value: "creating"