Skip to main content
POST
Create a tracking link for a creator
Required scopes
  • write:tracking_links — Create and delete tracking links.
  • 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"

Path Parameters

creatorUserUuid
string<uuid>
required

Body

application/json
name
string
required

Name of the tracking link

Minimum string length: 1
externalSocialPlatform
enum<string>
required

Social platform

Available options:
facebook,
instagram,
other,
reddit,
snapchat,
tiktok,
twitter,
youtube

Response

Tracking link created successfully

uuid
string<uuid>
required

Tracking link UUID

name
string
required

Name of the tracking link

Tracking link URL (e.g., 'fv-123')

externalSocialPlatform
enum<string>
required

Social platform

Available options:
facebook,
instagram,
other,
reddit,
snapchat,
tiktok,
twitter,
youtube
createdAt
string<date-time>
required

When the link was created

clicks
number
required

Number of clicks on this link

engagement
object
required

Engagement metrics from this tracking link

earnings
object | null
required

Earnings from this tracking link (null for newly created links)