> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ofauth.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create trial link

> Create a new trial link

**Required scope:** `promotions:write`



## OpenAPI

````yaml /openapi/v3.json post /v3/access/promotions/trial-links
openapi: 3.1.0
info:
  title: OFAuth API
  version: 1.0.0
  description: >-
    OFAuth V3 API for linking accounts, making OnlyFans API requests, and
    receiving events.
  contact:
    email: support@ofauth.com
    url: https://ofauth.com/
servers:
  - url: https://api.ofauth.com
security:
  - ExternalOAuth: []
tags:
  - name: Link
    description: Link accounts, get and refresh tokens, and end access.
  - name: Linked accounts
    description: The linked accounts of one authorization, and their settings.
  - name: Access
    description: Make OnlyFans API requests for a linked account.
  - name: Analytics
    description: 'Access: charts, rankings, and performance data.'
  - name: Earnings
    description: 'Access: earnings charts, transactions, and chargebacks.'
  - name: Messages
    description: 'Access: messaging, chats, queue, and mass messaging.'
  - name: Posts
    description: 'Access: create, edit, list, and manage posts.'
  - name: Promotions
    description: 'Access: promotions, trials, and bundles.'
  - name: Users
    description: 'Access: user profiles, subscriptions, and actions.'
  - name: Vault
    description: 'Access: vault folders, media, and management.'
  - name: Upload
    description: 'Access: media upload and processing.'
  - name: Self
    description: 'Access: linked account profile and settings.'
  - name: Stories
    description: 'Access: stories listing and management.'
  - name: Subscriptions
    description: 'Access: subscription offers, discounts, and management.'
  - name: Realtime
    description: Webhook event formats, including OnlyFans activity events.
externalDocs:
  description: OFAuth Developer Documentation
  url: https://docs.ofauth.com
paths:
  /v3/access/promotions/trial-links:
    post:
      tags:
        - Promotions
      summary: Create trial link
      description: |-
        Create a new trial link

        **Required scope:** `promotions:write`
      operationId: access.promotions.trialLinks.create
      parameters:
        - name: x-linked-account-id
          in: header
          required: true
          description: >-
            The linked account to use. The user must have shared it with your
            app. A missing account returns `linked_account_required`; an account
            outside your access returns `linked_account_not_granted`.
          schema:
            type: string
            example: conn_example123
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 64
                  description: Trial link name
                durationDays:
                  type: integer
                  description: >-
                    Trial duration in days. 30 means 1 month. Compact strings
                    are accepted: 1m, 3m, 6m, 12m.
                  enum:
                    - 1
                    - 3
                    - 7
                    - 14
                    - 30
                    - 90
                    - 180
                    - 360
                offer:
                  type: object
                  properties:
                    limit:
                      type: integer
                      description: Maximum number of claims. Use 0 for no limit.
                      enum:
                        - 0
                        - 1
                        - 2
                        - 3
                        - 4
                        - 5
                        - 6
                        - 7
                        - 8
                        - 9
                        - 10
                        - 50
                        - 100
                    expirationDays:
                      type: integer
                      nullable: true
                      minimum: 0
                      maximum: 30
                      description: >-
                        Days until the trial link expires. Use 0 for no
                        expiration.
                  required:
                    - limit
                    - expirationDays
              required:
                - name
                - durationDays
                - offer
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                anyOf:
                  - type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: number
                        trialLinkName:
                          type: string
                        url:
                          type: string
                        subscribeDays:
                          type: number
                        subscribeCounts:
                          type: number
                        claimCounts:
                          type: number
                        clicksCounts:
                          type: number
                        expiredAt:
                          type: string
                          nullable: true
                        createdAt:
                          type: string
                        isFinished:
                          type: boolean
                        user:
                          type: object
                          properties:
                            id:
                              type: number
                            username:
                              type: string
                              nullable: true
                            name:
                              type: string
                              nullable: true
                            displayName:
                              type: string
                              nullable: true
                            isVerified:
                              type: boolean
                              nullable: true
                            avatar:
                              type: string
                              nullable: true
                            avatarThumbs:
                              type: object
                              nullable: true
                              additionalProperties:
                                type: string
                        sharedWith:
                          type: object
                          nullable: true
                          properties:
                            id:
                              type: number
                            username:
                              type: string
                              nullable: true
                            name:
                              type: string
                              nullable: true
                            displayName:
                              type: string
                              nullable: true
                            isVerified:
                              type: boolean
                              nullable: true
                            avatar:
                              type: string
                              nullable: true
                            avatarThumbs:
                              type: object
                              nullable: true
                              additionalProperties:
                                type: string
                      required:
                        - id
                        - trialLinkName
                        - url
                        - subscribeDays
                        - subscribeCounts
                        - claimCounts
                        - clicksCounts
                        - expiredAt
                        - createdAt
                        - isFinished
                  - type: object
                    properties:
                      id:
                        type: number
                      trialLinkName:
                        type: string
                      url:
                        type: string
                      subscribeDays:
                        type: number
                      subscribeCounts:
                        type: number
                      claimCounts:
                        type: number
                      clicksCounts:
                        type: number
                      expiredAt:
                        type: string
                        nullable: true
                      createdAt:
                        type: string
                      isFinished:
                        type: boolean
                      user:
                        type: object
                        properties:
                          id:
                            type: number
                          username:
                            type: string
                            nullable: true
                          name:
                            type: string
                            nullable: true
                          displayName:
                            type: string
                            nullable: true
                          isVerified:
                            type: boolean
                            nullable: true
                          avatar:
                            type: string
                            nullable: true
                          avatarThumbs:
                            type: object
                            nullable: true
                            additionalProperties:
                              type: string
                      sharedWith:
                        type: object
                        nullable: true
                        properties:
                          id:
                            type: number
                          username:
                            type: string
                            nullable: true
                          name:
                            type: string
                            nullable: true
                          displayName:
                            type: string
                            nullable: true
                          isVerified:
                            type: boolean
                            nullable: true
                          avatar:
                            type: string
                            nullable: true
                          avatarThumbs:
                            type: object
                            nullable: true
                            additionalProperties:
                              type: string
                    required:
                      - id
                      - trialLinkName
                      - url
                      - subscribeDays
                      - subscribeCounts
                      - claimCounts
                      - clicksCounts
                      - expiredAt
                      - createdAt
                      - isFinished
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '429':
          description: Rate Limit Exceeded
        '500':
          description: Internal Server Error
        '502':
          description: Bad Gateway
      deprecated: false
      security:
        - ExternalOAuth: []
          LinkedAccountId: []
components:
  securitySchemes:
    ExternalOAuth:
      type: http
      scheme: bearer
      bearerFormat: opaque
      description: Link access token for one Sandbox, Test, or Live authorization.
    LinkedAccountId:
      type: apiKey
      name: x-linked-account-id
      in: header
      description: >-
        Selects one of the authorization's linked accounts via the
        x-linked-account-id header.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.