Skip to main content
POST
Create a media link
Required scope
  • write:creator — Modify creator profiles, settings, and creator-specific data.

Authorizations

Authorization
string
header
required

OAuth 2.0 access token, presented as a JWT bearer token in the Authorization header. Obtain a token via the authorization-code flow; the scopes granted to the token determine which operations it may call.

Headers

X-Fanvue-API-Version
string
default:2025-06-26
required

API version to use for the request

Example:

"2025-06-26"

Body

application/json
mediaUuids
string<uuid>[]
required

UUIDs of the vault media items to bundle into the link. All must be owned by the creator.

Minimum array length: 1
price
integer
required

Price fans pay to unlock the media, in integer minor units of the currency (e.g. cents: 1999 = $19.99). Must be between 300 and 50000 minor units. Note: the Fanvue dashboard displays prices in major units; this API always uses integer minor units.

Required range: 300 <= x <= 50000

Response

Media link created successfully

uuid
string<uuid>
required

Media link UUID

url
string | null
required

Shareable URL fans use to unlock the media

price
integer
required

Price in integer minor units of the currency (e.g. cents) fans pay to unlock

mediaUuids
string<uuid>[]
required

UUIDs of the media items bundled into the link, oldest first

clicks
integer
required

Number of times the link has been viewed

unlocks
integer
required

Number of paid unlocks (completed purchases)

earnings
integer
required

Total gross earnings from the link, in integer minor units of the currency

createdAt
string<date-time>
required

When the link was created