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

# Update list

> Update a list by id.

**Required scope:** `lists:write`



## OpenAPI

````yaml /openapi/v3.json patch /v3/access/lists/:listId
openapi: 3.1.0
info:
  title: OFAuth API
  version: 1.0.0
  description: >-
    OFAuth V3 API for linking accounts, making OnlyFans API requests, and
    receiving events.
  contact:
    email: support@ofauth.com
    url: https://ofauth.com/
servers:
  - url: https://api.ofauth.com
security:
  - ExternalOAuth: []
tags:
  - name: Link
    description: Link accounts, get and refresh tokens, and end access.
  - name: Linked accounts
    description: The linked accounts of one authorization, and their settings.
  - name: Access
    description: Make OnlyFans API requests for a linked account.
  - name: Analytics
    description: 'Access: charts, rankings, and performance data.'
  - name: Earnings
    description: 'Access: earnings charts, transactions, and chargebacks.'
  - name: Messages
    description: 'Access: messaging, chats, queue, and mass messaging.'
  - name: Posts
    description: 'Access: create, edit, list, and manage posts.'
  - name: Promotions
    description: 'Access: promotions, trials, and bundles.'
  - name: Users
    description: 'Access: user profiles, subscriptions, and actions.'
  - name: Vault
    description: 'Access: vault folders, media, and management.'
  - name: Upload
    description: 'Access: media upload and processing.'
  - name: Self
    description: 'Access: linked account profile and settings.'
  - name: Stories
    description: 'Access: stories listing and management.'
  - name: Subscriptions
    description: 'Access: subscription offers, discounts, and management.'
  - name: Realtime
    description: Webhook event formats, including OnlyFans activity events.
externalDocs:
  description: OFAuth Developer Documentation
  url: https://docs.ofauth.com
paths:
  /v3/access/lists/:listId:
    patch:
      tags:
        - Lists
      summary: Update list
      description: |-
        Update a list by id.

        **Required scope:** `lists:write`
      operationId: access.lists.update
      parameters:
        - name: x-linked-account-id
          in: header
          required: true
          description: >-
            The linked account to use. The user must have shared it with your
            app. A missing account returns `linked_account_required`; an account
            outside your access returns `linked_account_not_granted`.
          schema:
            type: string
            example: conn_example123
        - schema:
            anyOf:
              - type: string
                pattern: ^\d+$
              - type: string
                enum:
                  - friends
          required: true
          name: listId
          in: path
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                isPinnedToChat:
                  type: boolean
                isPinnedToFeed:
                  type: boolean
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  canAddUsers:
                    type: boolean
                  canDelete:
                    type: boolean
                  canManageUsers:
                    type: boolean
                  canPinnedToChat:
                    type: boolean
                  canPinnedToFeed:
                    type: boolean
                  canUpdate:
                    type: boolean
                  direction:
                    type: string
                  id:
                    type: string
                  isPinnedToChat:
                    type: boolean
                  isPinnedToFeed:
                    type: boolean
                  name:
                    type: string
                  order:
                    type: string
                  postsCount:
                    type: number
                  sortList:
                    type: object
                    properties:
                      direction:
                        type: string
                      order:
                        type: string
                    additionalProperties: true
                    required:
                      - direction
                      - order
                  type:
                    type: string
                  users:
                    type: array
                    items:
                      type: object
                      properties:
                        avatar:
                          anyOf:
                            - type: 'null'
                            - type: string
                        avatarThumbs:
                          anyOf:
                            - type: 'null'
                            - type: object
                              properties:
                                c144:
                                  type: string
                                c50:
                                  type: string
                              additionalProperties: true
                              required:
                                - c144
                                - c50
                        id:
                          type: number
                        isActive:
                          type: boolean
                        isDeleted:
                          type: boolean
                        isVerified:
                          type: boolean
                        name:
                          type: string
                        username:
                          type: string
                      additionalProperties: true
                      required:
                        - avatar
                        - avatarThumbs
                        - id
                        - isActive
                        - isDeleted
                        - isVerified
                        - name
                        - username
                  usersCount:
                    type: number
                additionalProperties: true
                required:
                  - canAddUsers
                  - canDelete
                  - canManageUsers
                  - canPinnedToChat
                  - canPinnedToFeed
                  - canUpdate
                  - direction
                  - id
                  - isPinnedToChat
                  - isPinnedToFeed
                  - name
                  - order
                  - postsCount
                  - sortList
                  - type
                  - users
                  - usersCount
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '429':
          description: Rate Limit Exceeded
        '500':
          description: Internal Server Error
        '502':
          description: Bad Gateway
      deprecated: false
      security:
        - ExternalOAuth: []
          LinkedAccountId: []
components:
  securitySchemes:
    ExternalOAuth:
      type: http
      scheme: bearer
      bearerFormat: opaque
      description: Link access token for one Sandbox, Test, or Live authorization.
    LinkedAccountId:
      type: apiKey
      name: x-linked-account-id
      in: header
      description: >-
        Selects one of the authorization's linked accounts via the
        x-linked-account-id header.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.