> ## 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 mass message

> Create a mass message to send to multiple fans

**Permission Required:** `messages:write`



## OpenAPI

````yaml https://api.ofauth.com/openapi.json post /v2/access/mass-messages
openapi: 3.1.0
info:
  title: OFAuth API
  version: 1.0.0
  description: >-
    OFAuth API including Account, Connections, Link, Access, Dynamic Rules,
    Vault+, and Realtime webhook contracts
  contact:
    email: support@ofauth.com
    url: https://ofauth.com/
servers:
  - url: https://api.ofauth.com
security:
  - ApiKey: []
tags:
  - name: Account
    description: Account management endpoints.
  - name: Connections
    description: Connection management endpoints.
  - name: Link
    description: Link authentication and session endpoints.
  - name: Access
    description: All Access related endpoints.
  - name: Analytics
    description: 'Access: charts, tops, and performance metrics.'
  - 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: authenticated account details and settings.'
  - name: Stories
    description: 'Access: stories listing and management.'
  - name: Subscriptions
    description: 'Access: subscription offers, discounts, and management.'
  - name: Realtime
    description: >-
      Realtime webhook delivery contracts, including relayed OnlyFans websocket
      events.
  - name: Dynamic Rules
    description: Dynamic signing rules operations.
  - name: Vault+
    description: Vault+ caching and management.
externalDocs:
  description: OFAuth Developer Documentation
  url: https://docs.ofauth.com
paths:
  /v2/access/mass-messages:
    post:
      tags:
        - Messages
      summary: Create mass message
      description: |-
        Create a mass message to send to multiple fans

        **Permission Required:** `messages:write`
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                isForwardedMessage:
                  type: boolean
                  nullable: true
                  default: false
                  description: Whether this is a forwarded message
                text:
                  type: string
                  maxLength: 10000
                  default: ''
                  description: >-
                    Text content. Supports markdown by default. See [Text
                    Formatting Guide](/guides/how-to/text-formatting).
                replyToMessageId:
                  type: string
                  nullable: true
                  minLength: 1
                  description: Reply to an existing chat message
                mediaItems:
                  type: array
                  items:
                    anyOf:
                      - type: integer
                        minimum: 0
                        exclusiveMinimum: true
                        description: OnlyFans media ID
                      - type: string
                        minLength: 1
                  default: []
                  description: >-
                    Media references to attach. Accepts vault media IDs, upload
                    references (mediaUploadId), or http(s) URLs. See [mediaItems
                    reference](/guides/media-items).
                isLockedText:
                  type: boolean
                  nullable: true
                  default: false
                  description: Whether text is locked behind paywall (defaults to false).
                price:
                  type: number
                  nullable: true
                  minimum: 0
                  maximum: 200
                  default: 0
                  description: Price to unlock message content (0 for free)
                previewMediaCount:
                  type: integer
                  nullable: true
                  minimum: 0
                  default: 0
                  description: >-
                    How many items in mediaItems should be previews. Uses the
                    first N items from left to right.
                releaseForms:
                  type: object
                  properties:
                    users:
                      type: array
                      items:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                        description: OnlyFans user ID
                      default: []
                      description: Users to add to release form
                    partners:
                      type: array
                      items:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                        description: OnlyFans user ID
                      default: []
                      description: Partners to add to release form
                    guests:
                      type: array
                      items:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                        description: OnlyFans user ID
                      default: []
                      description: Guests to add to release form
                  description: Release form participants
                userTags:
                  type: array
                  items:
                    type: integer
                    minimum: 0
                    exclusiveMinimum: true
                    description: OnlyFans user ID
                  default: []
                  description: Users to tag
                isMarkdown:
                  type: boolean
                  nullable: true
                  default: true
                  description: >-
                    Whether to parse text as markdown (default: true). See [Text
                    Formatting Guide](/guides/how-to/text-formatting).
                scheduledDate:
                  anyOf:
                    - type: string
                      nullable: true
                    - nullable: true
                    - nullable: true
                  description: When to send the message (omit for immediate)
                userIds:
                  type: array
                  items:
                    anyOf:
                      - type: integer
                        minimum: 0
                        exclusiveMinimum: true
                        description: OnlyFans user ID
                      - type: string
                        minLength: 1
                  description: Specific user IDs to send to
                userLists:
                  type: array
                  items:
                    anyOf:
                      - type: integer
                        minimum: 0
                        exclusiveMinimum: true
                        description: OnlyFans user ID
                      - type: string
                        minLength: 1
                  description: User list IDs to send to
                subscribedAfterDate:
                  anyOf:
                    - type: string
                      nullable: true
                    - nullable: true
                    - nullable: true
                  description: Only send to users subscribed after this date
                excludeUserLists:
                  type: array
                  items:
                    anyOf:
                      - type: integer
                        minimum: 0
                        exclusiveMinimum: true
                        description: OnlyFans user ID
                      - type: string
                        minLength: 1
                  description: User list IDs to exclude
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: number
                  date:
                    type: string
                  isReady:
                    type: boolean
                  isDone:
                    type: boolean
                  total:
                    type: number
                  pending:
                    type: number
                  canUnsend:
                    type: boolean
                  unsendSeconds:
                    type: number
                  hasError:
                    type: boolean
                  isCanceled:
                    type: boolean
                  isCouplePeopleMedia:
                    type: boolean
                required:
                  - id
                  - date
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '429':
          description: Rate Limit Exceeded
        '500':
          description: Internal Server Error
        '502':
          description: Bad Gateway
      security:
        - ApiKey: []
          ConnectionId: []
components:
  securitySchemes:
    ApiKey:
      type: apiKey
      name: apiKey
      in: header
      description: >-
        Your OFAuth [API key](/quickstart#2-copy-your-api-key) for
        authenticating requests.
    ConnectionId:
      type: apiKey
      name: x-connection-id
      in: header
      description: >-
        Requires a [connection](/guides/connections) via the x-connection-id
        header.

````