User List Collections

Add Users to User List

Changed on

Add multiple Users To OnlyFans User List

post/api/{account}/user-lists/{userListId}/users

Request

  • Base URL
    https://app.onlyfansapi.com
  • URL
    https://app.onlyfansapi.com/api/{account}/user-lists/{userListId}/users
  • Auth
    HTTP bearer

Request body

idsstring[] required

Array of OnlyFans User IDs to be added into the list

skip_invalidboolean

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 request

{
  "ids": [
    123456,
    44112233,
    22113344
  ],
  "skip_invalid": true
}

Response

OR

Example response

{
  "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
    }
  }
}

Changes

    • breaking

      added subschema #1 subschema #2 to the response body oneOf list for the response status

    • breaking

      the response's body type changed from object to no type for status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional request property

    • info

      api tag User List Collections added

    • info

      api tag Collections - User Lists removed