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

# Create Pool

> Create a cross-promo pool.

A pool is a set of publishers (`hosts`) and promoted models (`targets`) with the formats that go out and a schedule. Pick both sides from [`GET /shoutouts/accounts`](/docs/api/shoutouts-accounts): every publisher needs an active session, every promoted model an active creative of at least one enabled format; a model without a creative of a format is simply skipped for that format (photos and texts are prepared in Studio).

`daily_limits` is per publisher per day: `story` and `mass_dm` are sends a day, `post` is how many promo posts a publisher holds at once (each one rotates after `post_ttl_days`). Bio lines and friend pins run on their own refresh cycle. Mass messages need `publish_settings.mass_dm.send_to`: OnlyFans list names matched on every publisher's page; a name a publisher does not have is skipped, and a list that is also excluded is never written to.

Rotation: `equal` promotes the least promoted model first, `priority` follows the order of `targets`, `weighted` shares mentions by `target_weights` (3 against 1 means three times as often). The pool starts `active` on `start_date`.


## OpenAPI

````yaml POST /shoutouts/pools
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:
    post:
      tags:
        - Shoutouts
      summary: Create Pool
      description: Create a cross-promo pool.
      operationId: createShoutoutPool
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShoutoutPoolCreateRequest'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: object
                    properties:
                      pool_id:
                        type: string
                        format: uuid
                        example: 550e8400-e29b-41d4-a716-446655440000
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: >-
            Validation error: `daily_limit_invalid`,
            `mass_dm_audience_required`, `mass_dm_lists_conflict`,
            `host_no_access`, `host_not_found`, `target_not_found`,
            `target_no_creative`, `no_valid_pairs`
          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:
  schemas:
    ShoutoutPoolCreateRequest:
      type: object
      required:
        - formats
        - start_date
        - hosts
        - targets
      properties:
        name:
          type: string
          maxLength: 100
          example: Summer promo
        formats:
          type: array
          minItems: 1
          items:
            type: string
            enum:
              - story
              - post
              - bio
              - friends
              - mass_dm
          example:
            - story
            - mass_dm
        start_date:
          type: string
          format: date
          example: '2026-10-01'
        end_date:
          type: string
          format: date
          nullable: true
          description: Omit or send null for a pool that runs until paused.
        rotation_type:
          type: string
          enum:
            - equal
            - priority
            - weighted
          default: equal
          description: >-
            `equal` promotes the least promoted model first, `priority` follows
            the order of `targets`, `weighted` shares mentions by
            `target_weights`.
        daily_limits:
          type: object
          description: >-
            Per publisher per day: `story` 1 to 20, `post` 1 to 20 (posts held
            at once), `mass_dm` 1 to 5. Required for each of these formats.
          additionalProperties:
            type: integer
            minimum: 1
            maximum: 20
          example:
            story: 2
            mass_dm: 1
        same_target_cooldown_days:
          type: integer
          minimum: 1
          maximum: 90
          default: 3
        friends_ttl_days:
          type: integer
          enum:
            - 3
            - 5
            - 7
            - 14
            - 30
          default: 3
        bio_ttl_days:
          type: integer
          enum:
            - 3
            - 5
            - 7
            - 14
            - 30
          default: 3
        post_ttl_days:
          type: integer
          enum:
            - 1
            - 3
            - 5
            - 7
          default: 3
        publish_settings:
          $ref: '#/components/schemas/ShoutoutPublishSettings'
        hosts:
          type: array
          minItems: 1
          maxItems: 200
          items:
            type: integer
          description: '`of_account_id` of the publishers; each needs an active session.'
          example:
            - 123456
        targets:
          type: array
          minItems: 1
          maxItems: 200
          items:
            type: integer
          description: >-
            `of_account_id` of the promoted models; each needs an active
            creative of at least one enabled format (a model without a creative
            of a format is skipped for that format). Order = priority under
            `priority` rotation.
          example:
            - 234567
            - 345678
        target_weights:
          type: object
          description: 'Weighted rotation: `of_account_id` => weight 1 to 5.'
          additionalProperties:
            type: integer
            minimum: 1
            maximum: 5
          example:
            '234567': 3
            '345678': 1
    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.
    ShoutoutPublishSettings:
      type: object
      description: How publications go out.
      properties:
        pin_posts:
          type: boolean
          description: Pin promo posts on top of the publisher's profile.
        post_media_mode:
          type: string
          enum:
            - carousel
            - random
          description: >-
            All photos of the creative in one post, or one random photo per
            post.
        vault_cleanup:
          type: boolean
          description: Hide the published media from the publisher's vault afterwards.
        vault_folder:
          type: boolean
          description: >-
            File the published media into the OT Shoutouts vault folder (ignored
            while `vault_cleanup` is on).
        mass_dm:
          $ref: '#/components/schemas/ShoutoutMassDmSettings'
    ShoutoutMassDmSettings:
      type: object
      description: Mass message audience and behaviour.
      properties:
        send_to:
          type: array
          items:
            type: string
            maxLength: 50
          maxItems: 20
          description: >-
            OnlyFans list names the message goes to, matched by name on every
            publisher (the built-in `Fans`, `Following` or your own lists).
            Required while the `mass_dm` format is on.
          example:
            - Fans
        exclude_lists:
          type: array
          items:
            type: string
            maxLength: 50
          maxItems: 20
          description: >-
            List names removed from the audience; `*` stands for any characters
            (`Alt*`).
          example:
            - Alt*
        unsend_previous:
          type: boolean
          description: >-
            Unsend the earlier promo mailing that reached the same fans before a
            new one goes out.
          default: true
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Your API key from the Studio Dashboard

````