User List Collections

Update User List

Changed on

Update a OnlyFans User List

put/api/{account}/user-lists/{userListId}

Request

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

Request body

namestring required

The new name for the User List.

isPinnedToFeedboolean nullable

Whether to pin the User List to feed to the OnlyFans homepage or not.

Example request

{
  "name": "My Updated List Name",
  "isPinnedToFeed": true
}

Response

Example response

{
  "data": {
    "id": 1224114714,
    "type": "custom",
    "name": "updated - test via onlyfansapi",
    "usersCount": 0,
    "postsCount": 0,
    "order": "default",
    "direction": "asc",
    "canUpdate": true,
    "canDelete": true,
    "canManageUsers": true,
    "canAddUsers": true,
    "canPinnedToFeed": true,
    "isPinnedToFeed": false,
    "canPinnedToChat": true,
    "isPinnedToChat": false,
    "sortList": [],
    "users": []
  },
  "_meta": {
    "_credits": {
      "used": 1,
      "balance": 224847,
      "note": "Always"
    },
    "_cache": {
      "is_cached": false,
      "note": "Cache disabled for this endpoint"
    },
    "_rate_limits": {
      "limit_minute": 1000,
      "limit_day": 50000,
      "remaining_minute": 997,
      "remaining_day": 49980
    }
  }
}

Changes

    • info

      api tag User List Collections added

    • info

      api tag Collections - User Lists removed

    • info

      added the new optional request property