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

# Check Mass DM Lists

> Resolve the pool's Mass DM `send_to` and `exclude_lists` on every publisher: which lists were found with their sizes, which names matched nothing (with the closest names of that page) and how many fans the message would reach. Pass `send_to` / `exclude_lists` in the body to try other names without changing the pool. Reads OnlyFans per publisher, so it takes a few seconds.

Resolves the pool's Mass DM audience on every publisher the way a send would: `send_to` and `exclude_lists` names are looked up on each page by letters and digits only (emoji, punctuation, spacing and case are ignored; `*` stands for any characters in exclusions). Per publisher the answer lists the lists found with their sizes, the names that matched nothing with the closest lists that page has, and `audience`: the fans the message reaches after the found exclusions. `reach` sums the audiences that were counted and `reach_complete` says whether every publisher answered (a publisher whose counter failed keeps its lists but has `audience` null); `missing` collects every name that matched nothing on at least one publisher, most misses first, with the closest names across pages. Similar lists come per side; one flagged `matched` is already covered by another name of that side and needs no action there. Pass `send_to` or `exclude_lists` in the body to try other names without changing the pool. A missing exclude list does not stop a send: the engine sends without it and marks the placement with the notice `exclude_missing`, so fix the names before the next mailing. Lists come from the parser's stored copy while it is fresh (refreshed hourly and at every send; `lists_updated_at` says when), `refresh: true` re-reads them from OnlyFans first; the audience counter is always live. One check covers the first 30 publishers of the pool (`truncated` says whether more exist). Takes a few seconds.


## OpenAPI

````yaml POST /shoutouts/pools/{uuid}/check-lists
openapi: 3.0.3
info:
  title: OnlyTraffic Studio API
  version: 1.1.0
  description: >-
    External API for OnlyTraffic Studio. Manage and retrieve data about your
    subscribers, CPL campaigns, CPC orders and CPC campaigns.
servers:
  - url: https://studio-api.onlytraffic.com/api/external/v1
security:
  - ApiKeyAuth: []
tags:
  - name: Account
    description: API key holder's wallet, profile, and aggregate state.
  - name: Accounts
    description: OnlyFans accounts attached to the API key holder.
  - name: Agencies
    description: Agency CRUD and image management. All edits stage in moderation.
  - name: CPL
    description: >-
      Cost-per-lead orders: place, list, cancel, manage settings, browse partner
      offers.
  - name: CPC
    description: Cost-per-click orders and creative management.
  - name: RevShare
    description: Revenue-share campaigns and invoices.
  - name: Swaps
    description: Two-sided traffic swap orders and offers.
  - name: Subscribers
    description: Per-fan delivery feed (cursor-paginated).
  - name: Transactions
    description: Per-transaction OF revenue feed (cursor-paginated).
  - name: Shoutouts
    description: Cross-promo pools, creatives and the publication log.
paths:
  /shoutouts/pools/{uuid}/check-lists:
    post:
      tags:
        - Shoutouts
      summary: Check Mass DM Lists
      description: >-
        Resolve the pool's Mass DM `send_to` and `exclude_lists` on every
        publisher: which lists were found with their sizes, which names matched
        nothing (with the closest names of that page) and how many fans the
        message would reach. Pass `send_to` / `exclude_lists` in the body to try
        other names without changing the pool. Reads OnlyFans per publisher, so
        it takes a few seconds.
      operationId: checkShoutoutPoolLists
      parameters:
        - $ref: '#/components/parameters/ShoutoutPoolIdPath'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShoutoutPoolCheckListsRequest'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    $ref: '#/components/schemas/ShoutoutPoolListsCheck'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Pool not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: >-
            `mass_dm_not_configured`: the pool has no Send to lists and none
            were passed; `pool_has_no_publishers`; validation error on the body
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: >-
            Server error. Body always reads `{success:false,
            error:"server_error", message:"Server error"}` (no internal details
            leak).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  parameters:
    ShoutoutPoolIdPath:
      name: uuid
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: 'Pool id: the `pool_id` value from the pools list.'
      example: 550e8400-e29b-41d4-a716-446655440000
  schemas:
    ShoutoutPoolCheckListsRequest:
      type: object
      properties:
        send_to:
          type: array
          maxItems: 20
          items:
            type: string
            maxLength: 50
          description: >-
            List names to try instead of the pool's `send_to`; the pool is not
            changed.
          example:
            - Fans
            - Following
        exclude_lists:
          type: array
          maxItems: 20
          items:
            type: string
            maxLength: 50
          description: >-
            Names or `*` patterns to try instead of the pool's `exclude_lists`;
            the pool is not changed.
          example:
            - '*NO MASS*'
            - '*ALT LEAD*'
        refresh:
          type: boolean
          default: false
          description: >-
            true re-reads every publisher's lists from OnlyFans before matching;
            otherwise the parser's stored copy is used while it is fresh (it is
            refreshed hourly and at every send)
    ShoutoutPoolListsCheck:
      type: object
      properties:
        pool_id:
          type: string
          format: uuid
          example: 550e8400-e29b-41d4-a716-446655440000
        send_to:
          type: array
          items:
            type: string
          description: Names that were checked
          example:
            - Fans
            - Following
        exclude_lists:
          type: array
          items:
            type: string
          example:
            - '*NO MASS*'
        checked_at:
          type: string
          format: date-time
          example: '2026-09-21T19:58:00Z'
        checked_at_ts:
          type: integer
          example: 1790020680
        reach:
          type: integer
          description: >-
            Sum of `audience` over the publishers whose counter answered; see
            `reach_complete`
          example: 318968
        reach_complete:
          type: boolean
          description: >-
            true when every publisher answered with a known audience; false when
            `reach` misses publishers that failed or whose counter did not
            answer
          example: true
        truncated:
          type: boolean
          description: >-
            true when the pool has more than 30 publishers: only the first 30
            were checked
          example: false
        publishers:
          type: array
          items:
            $ref: '#/components/schemas/ShoutoutPoolListsCheckPublisher'
        missing:
          type: array
          description: >-
            Every name that matched nothing on at least one publisher, most
            misses first, up to 20
          items:
            type: object
            properties:
              name:
                type: string
                example: '*ALT LEAD*'
              side:
                type: string
                enum:
                  - send_to
                  - exclude
              publishers:
                type: integer
                description: How many publishers miss it
                example: 5
              similar:
                type: array
                description: Closest names across those pages
                items:
                  type: object
                  properties:
                    name:
                      type: string
                      example: 📤Alt Lead📤
                    publishers:
                      type: integer
                      example: 4
    ErrorResponse:
      type: object
      description: Standard error envelope for all 4xx/5xx responses.
      required:
        - success
        - error
        - message
      properties:
        success:
          type: boolean
          enum:
            - false
          description: Always false on error responses.
        error:
          type: string
          description: Stable snake_case machine-readable error code. Branch on this.
          example: validation_failed
        message:
          type: string
          description: >-
            Human-friendly text. For 5xx this is always the literal `Server
            error`. For 4xx an actionable validation/auth message is returned.
        details:
          type: object
          nullable: true
          description: >-
            Optional per-field diagnostic information. On 422 carries `{<field>:
            ["error_code", ...]}`. On 402 (`insufficient_balance`) carries
            `{required, current}`. On 426 (`unpaid_invoices`) carries `{count,
            total, oldest_date_ts}`. Absent on most other errors.
          additionalProperties: true
        retry_after:
          type: integer
          nullable: true
          description: >-
            Seconds until the next request will succeed. Present only on 429
            responses (rate limit). Mirrors the `Retry-After` HTTP header.
    ShoutoutPoolListsCheckPublisher:
      type: object
      properties:
        account:
          $ref: '#/components/schemas/ShoutoutAccount'
        ok:
          type: boolean
          description: false when the publisher could not be read; `error` says why
        error:
          type: string
          nullable: true
          enum:
            - host_no_access
            - parser_error
            - null
          description: >-
            `host_no_access`: no account access or no longer your model;
            `parser_error`: OnlyFans did not answer, retry later
        audience:
          type: integer
          nullable: true
          description: >-
            Fans the message reaches: the OnlyFans counter for `send_to` minus
            the found exclusions. Null when the counter did not answer; the
            lists are still valid
          example: 78585
        lists_updated_at:
          type: string
          format: date-time
          nullable: true
          description: When the lists used for this publisher were read from OnlyFans
          example: '2026-09-22T09:12:00Z'
        lists_updated_at_ts:
          type: integer
          nullable: true
          example: 1790068320
        send_to:
          $ref: '#/components/schemas/ShoutoutListsSide'
        exclude:
          $ref: '#/components/schemas/ShoutoutListsSide'
        similar:
          type: object
          description: >-
            For every missing name, per side: the closest lists of this page
            (shared words, biggest first, up to 3); `matched` marks a list
            another name of the same side already resolved
          properties:
            send_to:
              type: object
              additionalProperties:
                type: array
                items:
                  $ref: '#/components/schemas/ShoutoutListMatch'
            exclude:
              type: object
              additionalProperties:
                type: array
                items:
                  $ref: '#/components/schemas/ShoutoutListMatch'
    ShoutoutAccount:
      type: object
      description: One of your OnlyFans accounts as a cross-promo participant.
      properties:
        of_account_id:
          type: integer
          example: 123456
        username:
          type: string
          example: mymodel
        session_status:
          type: string
          enum:
            - active
            - error
            - not_available
          description: Only an account with an `active` session can publish.
        creatives:
          type: object
          description: >-
            Active creatives per format; a model is promoted in a format only
            with a creative of it (it needs a creative of at least one enabled
            format to join a pool).
          properties:
            story:
              type: integer
            post:
              type: integer
            bio:
              type: integer
            mass_dm:
              type: integer
        pools:
          type: array
          description: Active and paused pools the account sits in.
          items:
            type: object
            properties:
              pool_id:
                type: string
                format: uuid
                example: 550e8400-e29b-41d4-a716-446655440000
              name:
                type: string
              status:
                type: string
                enum:
                  - active
                  - paused
              role:
                type: string
                enum:
                  - host
                  - target
                description: '`host` publishes, `target` is promoted.'
    ShoutoutListsSide:
      type: object
      properties:
        found:
          type: array
          items:
            $ref: '#/components/schemas/ShoutoutListMatch'
          description: Lists of this publisher the names resolved to
        missing:
          type: array
          items:
            type: string
          description: Names or patterns that matched nothing on this publisher
          example:
            - '*ALT LEAD*'
    ShoutoutListMatch:
      type: object
      properties:
        name:
          type: string
          description: List name as it is on OnlyFans
          example: ⛔️NO MASS⛔️
        fans:
          type: integer
          description: Fans on that list
          example: 38
        matched:
          type: boolean
          description: >-
            Only inside `similar`: true when another name of the same side
            already resolved this list, so there is nothing to add on that side
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Your API key from the Studio Dashboard

````