latestOpenAPI 3.1.02026-08-08243131.9 MB

c5ddcd5c7e72

Create a media link

Create a shareable media link that bundles one or more vault media items for a single unlock price. All referenced media must be owned by the creator. Amounts are integer minor units of the currency (e.g. cents: 1999 = $19.99). Requires media links to be enabled.

post/media-links

Headers

X-Fanvue-API-Versionstring required

Example:2025-06-26

API version to use for the request

Request body

mediaUuidsstring[] required

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

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

Response

Media link created successfully

uuidstring uuid required

Media link UUID

urlstring nullable required

Shareable URL fans use to unlock the media

priceinteger required

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

mediaUuidsstring[] required

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

clicksinteger required

Number of times the link has been viewed

unlocksinteger required

Number of paid unlocks (completed purchases)

earningsinteger required

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

createdAtstring date-time required

When the link was created