Skip to main content
PATCH
Update 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

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_…).

The tracking link id (trk_…).

Body

application/json
archived
boolean

Archive or unarchive it in OnlyX. Nothing changes on OnlyFans.

costCents
integer | null

What the promotion cost, 0 to 100000000 cents. null clears it.

Required range: 0 <= x <= 100000000
note
string | null

Your note, up to 500 characters. null clears it.

Maximum string length: 500
source
string | null

Where you ran it, up to 60 characters. null clears it.

Maximum string length: 60

Response

The updated tracking link.

accountedFans
integer
required

Of those, fans OnlyX could match to spend.

archived
boolean
required

Hidden from the default list.

arpuCents
integer | null
required

Earnings per fan, in cents, or null.

attributedFans
integer
required

Fans OnlyFans attributes to this link.

claims
integer
required

Trial links: trials claimed.

claimsLimit
integer | null
required

Trial links: the most trials it gives, or null for no limit.

clicks
integer
required

Clicks, as counted by OnlyFans.

code
string | null
required

The link code on OnlyFans.

conversion
number | null
required

subscribers / clicks, or null.

costCents
integer | null
required

What you paid for the promotion, in cents. null = never costed, 0 = free.

cpcCents
integer | null
required

Cost per click, in cents, or null.

cpfCents
integer | null
required

Cost per fan (subscriber), in cents, or null.

earningsCents
integer | null
required

Lifetime spend of the fans this link brought, in cents. A floor when accountedFans is below attributedFans. null when no attributed fan is known. Never add link earnings up into creator revenue: a fan on two links counts on both.

earningsKnown
boolean
required

false until earnings could be worked out.

epcCents
integer | null
required

Earnings per click, in cents, or null.

expiresAt
string | null
required

When the link stops working, or null.

firstSeenAt
string | null
required

When OnlyX first read the link.

id
string
required

The tracking link id (trk_…).

kind
enum<string>
required

tracking: a campaign link. trial: a free-trial link.

Available options:
tracking,
trial
lastSeenAt
string | null
required

When OnlyX last read it (about hourly while the creator is connected).

name
string | null
required

The link name on OnlyFans.

note
string | null
required

Your note.

ofCreatedAt
string | null
required

When it was created on OnlyFans.

profitCents
integer | null
required

earnings − cost, in cents, or null.

roi
number | null
required

profit / cost, or null when there is no cost.

source
string | null
required

Where you ran it (your label).

subscribers
integer
required

Subscribers it brought, as counted by OnlyFans.

trialDays
integer | null
required

Trial links: the length of the free trial in days.

url
string | null
required

The public link to share.