> ## 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 promotion

> Create a new promotion

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



## OpenAPI

````yaml /openapi/v3.json post /v3/access/promotions
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:
    post:
      tags:
        - Promotions
      summary: Create promotion
      description: |-
        Create a new promotion

        **Required scope:** `promotions:write`
      operationId: access.promotions.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:
                targetAudience:
                  type: string
                  enum:
                    - new_subscribers
                    - expired_subscribers
                    - all_subscribers
                  description: >-
                    Audience for the promotion: all_subscribers targets new and
                    expired subscribers, new_subscribers targets only new
                    subscribers, expired_subscribers targets only expired
                    subscribers.
                discount:
                  oneOf:
                    - type: object
                      properties:
                        type:
                          type: string
                          enum:
                            - free_trial
                        durationDays:
                          type: integer
                          minimum: 1
                          maximum: 30
                          description: Free trial duration in days once accepted.
                      required:
                        - type
                        - durationDays
                    - type: object
                      properties:
                        type:
                          type: string
                          enum:
                            - first_month_discount
                        percent:
                          type: integer
                          description: First month discount percentage.
                          minimum: 5
                          maximum: 65
                          multipleOf: 5
                      required:
                        - type
                        - percent
                offer:
                  type: object
                  properties:
                    limit:
                      type: integer
                      minimum: 0
                      maximum: 100
                      description: >-
                        Maximum number of subscribers who can claim the offer.
                        Use 0 for no limit.
                    expirationDays:
                      type: integer
                      minimum: 0
                      maximum: 30
                      description: Days until the offer expires. Use 0 for no expiration.
                  required:
                    - limit
                    - expirationDays
                message:
                  type: string
                  maxLength: 1000
                  description: Promotion message
              required:
                - targetAudience
                - discount
                - offer
                - message
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: number
                        text:
                          type: string
                        related:
                          type: boolean
                        price:
                          type: number
                        type:
                          type: string
                        canClaim:
                          type: boolean
                        claimsCount:
                          type: number
                        subscribeCount:
                          type: number
                        days:
                          type: number
                        createdAt:
                          type: string
                        finishedAt:
                          type: string
                        finished:
                          type: boolean
                      required:
                        - id
                        - text
                        - related
                        - type
                        - canClaim
                        - claimsCount
                        - subscribeCount
                        - days
                        - createdAt
                        - finishedAt
                        - finished
                  page:
                    type: object
                    properties:
                      cursor:
                        type: string
                        nullable: true
                        default: null
                        description: >-
                          The cursor for this page. Pass it as `cursor` to get
                          the same page again.
                      nextCursor:
                        type: string
                        nullable: true
                      hasMore:
                        type: boolean
                    required:
                      - nextCursor
                      - hasMore
                    additionalProperties: false
                required:
                  - items
                  - page
                additionalProperties: false
        '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.