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

# Add Users to User List (/api-reference/user-list-collections/add-users-to-user-list)

Add multiple Users To OnlyFans User List

## OpenAPI

````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml post /api/{account}/user-lists/{userListId}/users
openapi: 3.0.3
info:
  title: OnlyFans API
  description: ""
  version: 1.0.0
servers:
  - url: https://app.onlyfansapi.com
security:
  - default: []
tags:
  - name: API Keys
    description: ""
  - name: Account
    description: Endpoints for your linked accounts
  - name: Analytics - Financial
    description: APIs for retrieving financial analytics data
  - name: Analytics - Summary
    description: APIs for retrieving summary analytics data
  - name: Banking
    description: Operations related to user banking details, payout methods, legal
      and tax information, and account country settings.
  - name: Banned Words
    description: Reference list of OnlyFans banned words used by the
      `blockBannedWords` screening parameter
  - name: Blocked / Restricted Users
    description: APIs for listing the users an account has blocked or restricted
  - name: Chargebacks
    description: ""
  - name: Chat Messages
    description: ""
  - name: Chats
    description: ""
  - name: Client Sessions
    description: ""
  - name: Connect OnlyFans Account
    description: ""
  - name: Data Exports
    description: APIs for managing data exports
  - name: Endpoints
    description: ""
  - name: Engagement / Messages
    description: ""
  - name: Fans
    description: APIs for managing OnlyFans fans (subscribers)
  - name: Fans - AI Summary
    description: APIs for generating and retrieving AI-powered fan profile summaries
  - name: Following
    description: APIs for managing OnlyFans followings (people you're subscribed to)
  - name: Free Trial Links
    description: APIs for managing Free Trial Links
  - name: Giphy
    description: ""
  - name: Link Tags
    description: APIs for managing tags on free trial links, tracking links, and Smart Links
  - name: Mass Messaging
    description: ""
  - name: Media
    description: ""
  - name: Media Vault
    description: ""
  - name: Media Vault Lists
    description: ""
  - name: Notifications
    description: Endpoints for managingr account notifications
  - name: Payouts
    description: ""
  - name: Post Comments
    description: ""
  - name: Post Labels
    description: APIs for managing your post labels
  - name: Posts
    description: APIs for managing OnlyFans posts
  - name: Promotions
    description: ""
  - name: Public Profiles
    description: ""
  - name: Queue
    description: ""
  - name: Release Forms
    description: APIs for managing OnlyFans release forms
  - name: Saved For Later (Messages)
    description: ""
  - name: Saved For Later (Posts)
    description: ""
  - name: Settings
    description: ""
  - name: Shared Free Trial Links
    description: APIs for Free Trial Links that other OF creators have shared with
      this account. Revenue, cost, and spender data are not available for shared
      links.
  - name: Shared Tracking Links
    description: APIs for Tracking Links (campaigns) that other OF creators have
      shared with this account. Revenue, cost, and spender data are not
      available for shared campaigns.
  - name: Smart Link Postbacks
    description: APIs for managing Smart Link postback destinations
  - name: Smart Links
    description: APIs for managing Smart Links (Free Trial Links and Tracking Links
      with pooled inventory)
  - name: Statistics
    description: ""
  - name: Stored Free Trial Links
    description: Instant APIs for retrieving stored free trial links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Free Trial Links
    description: Instant APIs for retrieving stored shared Free Trial Links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stored Shared Tracking Links
    description: Instant APIs for retrieving stored shared Tracking Links
      (campaigns) from the OnlyFansAPI Cache (free, no credits used)
  - name: Stored Tracking Links
    description: Instant APIs for retrieving stored tracking links from the
      OnlyFansAPI Cache (free, no credits used)
  - name: Stories
    description: APIs for managing OnlyFans stories
  - name: Story Highlights
    description: APIs for managing OnlyFans story highlights
  - name: Subscription Bundles
    description: ""
  - name: Tracking Links
    description: APIs for managing tracking links
  - name: Transactions
    description: APIs for managing OnlyFans transactions
  - name: Usage
    description: Credit usage reporting for your team
  - name: User List Collections
    description: ""
  - name: Users
    description: APIs for fetching OnlyFans users
  - name: Webhooks
    description: ""
paths:
  /api/{account}/user-lists/{userListId}/users:
    parameters:
      - in: path
        name: account
        description: The Account ID
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      - in: path
        name: userListId
        description: OnlyFans User List ID, or a default list name like `tagged`
        example: 1224114714
        required: true
        schema:
          type: string
    post:
      summary: Add Users to User List
      operationId: addUsersToUserList
      description: Add multiple Users To OnlyFans User List
      parameters: []
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                oneOf:
                  - description: "Default: OnlyFans accepted every User ID"
                    type: object
                    example:
                      data:
                        "1224114714":
                          - 123456
                          - 44112233
                          - 22113344
                      _meta:
                        _credits:
                          used: 1
                          balance: 224745
                          note: Always
                        _cache:
                          is_cached: false
                          note: Cache disabled for this endpoint
                        _rate_limits:
                          limit_minute: 1000
                          limit_day: 50000
                          remaining_minute: 998
                          remaining_day: 49947
                    properties:
                      data:
                        type: object
                        properties:
                          "1224114714":
                            type: array
                            example:
                              - 123456
                              - 44112233
                              - 22113344
                            items:
                              type: integer
                      _meta:
                        type: object
                        properties:
                          _credits:
                            type: object
                            properties:
                              used:
                                type: integer
                                example: 1
                              balance:
                                type: integer
                                example: 224745
                              note:
                                type: string
                                example: Always
                          _cache:
                            type: object
                            properties:
                              is_cached:
                                type: boolean
                                example: false
                              note:
                                type: string
                                example: Cache disabled for this endpoint
                          _rate_limits:
                            type: object
                            properties:
                              limit_minute:
                                type: integer
                                example: 1000
                              limit_day:
                                type: integer
                                example: 50000
                              remaining_minute:
                                type: integer
                                example: 998
                              remaining_day:
                                type: integer
                                example: 49947
                  - description: "With `skip_invalid=true`: the rejected User IDs are reported
                      instead of failing the batch"
                    type: object
                    example:
                      data:
                        added:
                          - 44112233
                          - 22113344
                        failed:
                          "123456": Unable to add SAMPLE USER to Custom - OFAPI Test
                      _meta:
                        _credits:
                          used: 2
                          balance: 224744
                          note: Always
                        _cache:
                          is_cached: false
                          note: Cache disabled for this endpoint
                        _rate_limits:
                          limit_minute: 1000
                          limit_day: 50000
                          remaining_minute: 998
                          remaining_day: 49947
                    properties:
                      data:
                        type: object
                        properties:
                          added:
                            type: array
                            example:
                              - 44112233
                              - 22113344
                            items:
                              type: integer
                          failed:
                            type: object
                            properties:
                              "123456":
                                type: string
                                example: Unable to add SAMPLE USER to Custom - OFAPI Test
                      _meta:
                        type: object
                        properties:
                          _credits:
                            type: object
                            properties:
                              used:
                                type: integer
                                example: 2
                              balance:
                                type: integer
                                example: 224744
                              note:
                                type: string
                                example: Always
                          _cache:
                            type: object
                            properties:
                              is_cached:
                                type: boolean
                                example: false
                              note:
                                type: string
                                example: Cache disabled for this endpoint
                          _rate_limits:
                            type: object
                            properties:
                              limit_minute:
                                type: integer
                                example: 1000
                              limit_day:
                                type: integer
                                example: 50000
                              remaining_minute:
                                type: integer
                                example: 998
                              remaining_day:
                                type: integer
                                example: 49947
        "400":
          description: "Usually if the user is already in the list or some of the user ids
            don't exist. OnlyFans rejects the entire batch if any ID cannot be
            added. Send `skip_invalid=true` to have us skip the offending IDs
            and add the rest in this same request. Otherwise, handle it
            client-side: in the 400 response, `onlyfans_response.body.errors` is
            keyed by list ID. When individual users are rejected,
            `errors[listId]` is an object keyed by the offending user ID (values
            are message arrays) — parse those user IDs out and retry the
            remaining IDs in a single follow-up request (no need for one-by-one
            adds). If `errors[listId]` is instead a plain array of message
            strings, the failure is list-level (e.g. an invalid or inaccessible
            list ID), not per-user — do not treat the array indices as user IDs;
            fix the list ID rather than retrying."
          content:
            application/json:
              schema:
                type: object
                example:
                  error: ONLYFANS_COM_ERROR
                  message: Bad Request - The request could not be understood by the server.
                  description: This error happened most probably because of a bug in the
                    OnlyFans.com API or you sent wrong parameters (like a
                    non-existing user id).
                  onlyfans_response:
                    status: 400
                    body:
                      error:
                        code: 0
                        message: Unable to add SAMPLE USER to Custom - OFAPI Test
                      errors:
                        "1224114714":
                          "123456":
                            - Unable to add SAMPLE USER to Custom - OFAPI Test
                  _meta:
                    _credits:
                      used: 1
                      balance: 224744
                      note: OnlyFans returned an error, but we still had to make an API request to
                        OnlyFans.com
                    _cache:
                      is_cached: false
                      note: Cache disabled for this endpoint
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49946
                properties:
                  error:
                    type: string
                    example: ONLYFANS_COM_ERROR
                  message:
                    type: string
                    example: Bad Request - The request could not be understood by the server.
                  description:
                    type: string
                    example: This error happened most probably because of a bug in the OnlyFans.com
                      API or you sent wrong parameters (like a non-existing user
                      id).
                  onlyfans_response:
                    type: object
                    properties:
                      status:
                        type: integer
                        example: 400
                      body:
                        type: object
                        properties:
                          error:
                            type: object
                            properties:
                              code:
                                type: integer
                                example: 0
                              message:
                                type: string
                                example: Unable to add SAMPLE USER to Custom - OFAPI Test
                          errors:
                            type: object
                            properties:
                              "1224114714":
                                type: object
                                properties:
                                  "123456":
                                    type: array
                                    example:
                                      - Unable to add SAMPLE USER to Custom -
                                        OFAPI Test
                                    items:
                                      type: string
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 224744
                          note:
                            type: string
                            example: OnlyFans returned an error, but we still had to make an API request to
                              OnlyFans.com
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: Cache disabled for this endpoint
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49946
      tags:
        - User List Collections
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                ids:
                  type: array
                  description: Array of OnlyFans User IDs to be added into the list
                  example:
                    - 123456
                    - 44112233
                    - 22113344
                  items:
                    type: string
                skip_invalid:
                  type: boolean
                  description: Set to `true` to skip the User IDs OnlyFans refuses instead of
                    failing the whole batch. We drop the rejected IDs and retry
                    the remainder for you (up to 5 OnlyFans attempts, each
                    costing 1 credit), then respond `200` with `data.added` (the
                    IDs that made it in) and `data.failed` (an object mapping
                    each rejected User ID to the reason OnlyFans gave). Note
                    this changes the shape of `data` — see the example
                    responses. Failures that are not about individual users
                    (e.g. an invalid or inaccessible list ID) still return the
                    regular `400`.
                  example: true
              required:
                - ids
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: Get your API Key from OnlyFansAPI Console -
        https://app.onlyfansapi.com/api-keys
````