Update Trial Link

Partially updates FansMetric metadata on a trial link — hide state, note, custom name, source URL and promo cost. Requires permission api_trial_links_update.

https://public-api.fansmetric.com

PATCH/v1/{account_id}/trial-links/{link_id}

API keyBearer

Authorization

default

AuthorizationBearer <token>

Send your FansMetric API key as a Bearer token in the Authorization header.

In: header

Path Parameters

account_id*integer
OnlyFans numeric account ID.
link_id*integer
Trial link platform ID.

Request Body

application/json

custom_namestring
FansMetric display-name override. Max 64 characters. Send null to clear.
notestring
Free-text note. Max 2000 characters. Send null to clear.
custom_source_urlstring
Traffic-source URL. Max 2048 characters, must be an http/https URL with a host and no whitespace. Send null to clear.
promo_coststring
Promo cost, between 0 and 99999. Send null to clear.
is_hiddenstring
FansMetric hide flag (the eye toggle). Boolean — not nullable; null returns 400.

Response Fields

dataobject
The full updated trial link, same shape as Get Trial Link.
_meta._credits.usedinteger
Credits consumed by this request (currently always 1).
_meta._rate_limits.limit_minuteinteger
Maximum requests per minute for the organization.
_meta._rate_limits.remaining_minuteinteger
Remaining requests in the current minute window.
_meta._rate_limits.limit_dayinteger
Maximum requests per day for the organization.
_meta._rate_limits.remaining_dayinteger
Remaining requests in the current day window.

Field	Type	Description
data	object	The full updated trial link, same shape as Get Trial Link.
_meta._credits.used	integer	Credits consumed by this request (currently always `1`).
_meta._rate_limits.limit_minute	integer	Maximum requests per minute for the organization.
_meta._rate_limits.remaining_minute	integer	Remaining requests in the current minute window.
_meta._rate_limits.limit_day	integer	Maximum requests per day for the organization.
_meta._rate_limits.remaining_day	integer	Remaining requests in the current day window.

curl --request PATCH "https://public-api.fansmetric.com/v1/100000001/trial-links/sample_link_id" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "note": null
}'

Response

200

{"data":{"id":100000020
"trialLinkName":"July trial"
"url":"https://onlyfans.com/action/trial/XXXXXXXXXXXXXXXXXXXXXXXXX"
"subscribeDays":7
"subscribeCounts":100
"claimCounts":9
"allClaimCounts":9
"isFinished":false
"createdAt":"2026-07-01T00:00:00Z"
"expiredAt":null
"customName":"July — Reddit"
"customSourceUrl":"https://reddit.com/r/example"
"note":null
"isHidden":false
"isRevenueShared":false
"lastScannedAt":"2026-08-31T08:02:11Z"
"user":{"username":"creator_XXXXX"
}
"tags":[0:{"id":1
"name":"Reddit"
"color":"#FF5733"
"created_at":"2026-01-12T09:14:22Z"
}
]
"revenue":{"total":"245.50"
"spendersCount":8
"revenuePerSubscriber":"27.27777777777778"
"conversionToSpender":"0.8888888888888888"
}
"cost":{"perPromo":"50.00"
"perSub":"5.555555555555555"
"profit":"195.50"
"roi":"391"
}
"links":{"related":{"subscribers":"/v1/100000001/trial-links/100000020/subscribers"
}
}
}
"_meta":{"_credits":{"used":1
}
"_rate_limits":{"limit_minute":1000
"remaining_minute":999
"limit_day":50000
"remaining_day":49999
}
}
}

Get Trial Link Stats

List Trial Link ClaimersOF