> ## Documentation Index > Fetch the complete documentation index at: https://api.fanvue.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Create a tracking link > Create a new tracking link for the authenticated user. **Required scope** * `write:tracking_links` — Create and delete tracking links. ## OpenAPI ````yaml /openapi.json post /tracking-links openapi: 3.1.0 info: title: Fanvue API version: '0.1' servers: [] security: [] paths: /tracking-links: post: summary: Create a tracking link description: Create a new tracking link for the authenticated user. operationId: createTrackingLink parameters: - $ref: '#/components/parameters/ApiVersionHeader' requestBody: content: application/json: schema: type: object properties: name: type: string minLength: 1 description: Name of the tracking link externalSocialPlatform: type: string enum: - facebook - instagram - other - reddit - snapchat - tiktok - twitter - youtube description: Social platform required: - name - externalSocialPlatform responses: '201': description: Tracking link created successfully content: application/json: schema: type: object properties: uuid: type: string format: uuid description: Tracking link UUID name: type: string description: Name of the tracking link linkUrl: type: string description: Tracking link URL (e.g., 'fv-123') externalSocialPlatform: type: string enum: - facebook - instagram - other - reddit - snapchat - tiktok - twitter - youtube description: Social platform createdAt: type: string format: date-time description: When the link was created clicks: type: number description: Number of clicks on this link engagement: type: object properties: acquiredSubscribers: type: number description: >- Number of subscribers acquired through this link (first-click attribution - users only counted for the first link they clicked) acquiredFollowers: type: number description: >- Number of followers acquired through this link (first-click attribution - users only counted for the first link they clicked) totalSubscribers: type: number description: >- Total count of all users who clicked this link and are currently active subscribers totalFollowers: type: number description: >- Total count of all users who clicked this link and are currently followers required: - acquiredSubscribers - acquiredFollowers - totalSubscribers - totalFollowers description: Engagement metrics from this tracking link earnings: type: - object - 'null' properties: totalGross: type: number description: Total gross earnings from this link (before fees) totalNet: type: number description: Total net earnings from this link (after fees) required: - totalGross - totalNet description: >- Earnings from this tracking link (null for newly created links) required: - uuid - name - linkUrl - externalSocialPlatform - createdAt - clicks - engagement - earnings example: uuid: d4e5f6g7-8h9i-0j1k-2l3m-n4o5p6q7r8s9 name: TikTok Profile linkUrl: fv-123456 externalSocialPlatform: tiktok createdAt: '2024-01-15T00:00:00.000Z' clicks: 0 engagement: acquiredSubscribers: 0 acquiredFollowers: 0 totalSubscribers: 0 totalFollowers: 0 earnings: null '400': description: Bad Request - API version not supported OR validation failed content: application/json: schema: oneOf: - $ref: '#/components/schemas/UnsupportedVersionError' - $ref: '#/components/schemas/ValidationError' '401': $ref: '#/components/responses/UnauthorizedResponse' '403': $ref: '#/components/responses/UnauthorizedResponse' '410': $ref: '#/components/responses/SunsetVersionResponse' '429': $ref: '#/components/responses/RateLimitResponse' security: - BearerAuth: - write:tracking_links components: parameters: ApiVersionHeader: name: X-Fanvue-API-Version in: header required: true schema: type: string default: '2025-06-26' example: '2025-06-26' description: API version to use for the request schemas: UnsupportedVersionError: type: object properties: error: type: string message: type: string required: - error - message description: API version not supported ValidationError: type: object properties: errors: type: array items: type: string required: - errors description: Request validation failed responses: UnauthorizedResponse: description: Unauthorized Response content: application/json: schema: type: object properties: error: type: string required: - error SunsetVersionResponse: description: API version no longer supported (sunset) content: application/json: schema: type: object properties: error: type: string message: type: string nextVersion: type: string required: - error - message RateLimitResponse: description: Too many requests - rate limit exceeded headers: Retry-After: description: Number of seconds to wait before retrying the request schema: type: integer X-RateLimit-Limit: description: The maximum number of requests allowed in the current window schema: type: integer X-RateLimit-Remaining: description: The number of requests remaining in the current window schema: type: integer X-RateLimit-Reset: description: The Unix timestamp (seconds) when the rate limit window resets schema: type: integer content: application/json: schema: type: object properties: error: type: string required: - error securitySchemes: BearerAuth: type: oauth2 description: >- 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. flows: authorizationCode: authorizationUrl: https://auth.fanvue.com/oauth2/auth tokenUrl: https://auth.fanvue.com/oauth2/token refreshUrl: https://auth.fanvue.com/oauth2/token scopes: read:self: >- Access your own user profile information, including basic account details and settings. read:chat: >- Read chat conversations, messages, and chat-related data. This includes viewing chat lists and message history. write:chat: >- Create new chats and send messages. This scope is required for any chat-related actions that modify data. read:experience: >- Exchange a fan's experience token for the resolved experience and the fan's identity, so an embedded fan-facing experience can render the right content. write:experience: >- Request that the creator publish or unpublish a fan-facing experience. The app mints a request token; the creator confirms and Fanvue performs the change. read:fan: Access fan-related data and information within the platform. read:post: Read posts, including post details, comments, likes, and tips. write:post: Create, edit, and manage posts and content on behalf of users. read:media: Access media files, images, videos, and other content assets. write:media: >- Upload, modify, and manage media files and content assets. Also required for vault folder management. read:creator: >- Access creator profiles, content, and creator-specific information. write:creator: Modify creator profiles, settings, and creator-specific data. read:insights: >- Access analytics, metrics, and insights data for performance tracking. read:tracking_links: >- Read tracking links and the users associated with them, including per-user tracking metadata. write:tracking_links: Create and delete tracking links. read:agency: Read agency information, including the agency's team members. write:agency: >- Manage agency team members and invites, including inviting new team members and creators. ````