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

# Patch account setting

> Patch one account setting by setting ID.

**Permission Required:** `profile:write`



## OpenAPI

````yaml /openapi/v3.json patch /v3/access/settings/:settingId
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/settings/:settingId:
    patch:
      tags:
        - Self
      summary: Patch account setting
      description: |-
        Patch one account setting by setting ID.

        **Permission Required:** `profile:write`
      operationId: access.settings.update
      parameters:
        - name: x-linked-account-id
          in: header
          required: true
          description: >-
            The linked account the request acts on. The authorization must
            include this account; a missing or ungranted account fails with
            `linked_account_required` or `linked_account_not_granted`.
          schema:
            type: string
            example: conn_example123
        - schema:
            type: string
            minLength: 1
          required: true
          name: settingId
          in: path
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                coStreamingRequestFrom:
                  type: string
                isAutoFollowBack:
                  type: boolean
                isDrmEnabled:
                  type: boolean
                isPrivate:
                  type: boolean
                isSuggestionsOptOut:
                  type: boolean
                isWantComments:
                  type: boolean
                phoneOtp:
                  type: boolean
                requireFaceIdForPayoutUpdate:
                  type: boolean
                showFriendsToSubscribers:
                  type: boolean
                showMediaCount:
                  type: boolean
                showPostsTips:
                  type: boolean
                showSubscribersCount:
                  type: boolean
                showSubscribesOffers:
                  type: boolean
                unfollowAutoFollowBack:
                  type: boolean
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  init:
                    type: object
                    properties:
                      upload:
                        type: object
                        properties:
                          geoUploadArgs:
                            type: object
                            properties:
                              isDelay:
                                type: boolean
                              needThumbs:
                                type: boolean
                              preset:
                                type: string
                              preset_png:
                                type: string
                              preset_public:
                                type: string
                              protected_preset:
                                type: string
                            additionalProperties: true
                            required:
                              - isDelay
                              - needThumbs
                              - preset
                              - preset_png
                              - preset_public
                              - protected_preset
                        additionalProperties: true
                        required:
                          - geoUploadArgs
                    additionalProperties: true
                    required:
                      - upload
                  success:
                    type: boolean
                additionalProperties: true
                required:
                  - init
                  - success
        '400':
          $ref: '#/components/responses/Access400'
        '401':
          $ref: '#/components/responses/Access401'
        '403':
          $ref: '#/components/responses/Access403'
        '404':
          $ref: '#/components/responses/Access404'
        '409':
          $ref: '#/components/responses/Access409'
        '429':
          $ref: '#/components/responses/Access429'
        '500':
          $ref: '#/components/responses/Access500'
        '502':
          $ref: '#/components/responses/Access502'
        '503':
          $ref: '#/components/responses/Access503'
      deprecated: false
      security:
        - ExternalOAuth: []
          LinkedAccountId: []
components:
  responses:
    Access400:
      description: >-
        Bad Request: `AccessError400`; or `RequestValidationError` or
        `AccessHandlerError`.
      content:
        application/json:
          schema:
            anyOf:
              - $ref: '#/components/schemas/AccessError400'
              - $ref: '#/components/schemas/RequestValidationError'
              - $ref: '#/components/schemas/AccessHandlerError'
    Access401:
      description: 'Unauthorized: `AccessError401`; or `AccessHandlerError`.'
      content:
        application/json:
          schema:
            anyOf:
              - $ref: '#/components/schemas/AccessError401'
              - $ref: '#/components/schemas/AccessHandlerError'
    Access403:
      description: 'Forbidden: `AccessError403`; or `AccessHandlerError`.'
      content:
        application/json:
          schema:
            anyOf:
              - $ref: '#/components/schemas/AccessError403'
              - $ref: '#/components/schemas/AccessHandlerError'
    Access404:
      description: 'Not Found: `AccessError404`; or `AccessHandlerError`.'
      content:
        application/json:
          schema:
            anyOf:
              - $ref: '#/components/schemas/AccessError404'
              - $ref: '#/components/schemas/AccessHandlerError'
    Access409:
      description: 'Conflict: `AccessError409`; or `AccessHandlerError`.'
      content:
        application/json:
          schema:
            anyOf:
              - $ref: '#/components/schemas/AccessError409'
              - $ref: '#/components/schemas/AccessHandlerError'
    Access429:
      description: 'Rate Limit Exceeded: `AccessError429`; or `AccessHandlerError`.'
      content:
        application/json:
          schema:
            anyOf:
              - $ref: '#/components/schemas/AccessError429'
              - $ref: '#/components/schemas/AccessHandlerError'
    Access500:
      description: 'Internal Server Error: `AccessHandlerError`.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AccessHandlerError'
    Access502:
      description: >-
        Bad Gateway: `AccessHandlerError`. For example an upstream upload
        failure.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AccessHandlerError'
    Access503:
      description: 'Service Unavailable: `AccessError503`; or `AccessHandlerError`.'
      content:
        application/json:
          schema:
            anyOf:
              - $ref: '#/components/schemas/AccessError503'
              - $ref: '#/components/schemas/AccessHandlerError'
  schemas:
    AccessError400:
      allOf:
        - $ref: '#/components/schemas/RuntimeError'
        - type: object
          properties:
            error:
              type: string
              enum:
                - provider_request_rejected
              description: >-
                Stable error code: `provider_request_rejected`
                (`correct_request` or `check_request`).
    RequestValidationError:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - false
        error:
          type: object
          properties:
            name:
              type: string
              enum:
                - ZodError
            issues:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                    example: too_big
                  path:
                    type: array
                    items:
                      anyOf:
                        - type: string
                        - type: number
                  message:
                    type: string
                required:
                  - code
                  - path
                  - message
          required:
            - name
            - issues
      required:
        - success
        - error
      description: A query, path or JSON body parameter failed validation.
    AccessHandlerError:
      type: object
      properties:
        error:
          type: string
          description: Human-readable message.
          example: Upload not found
        type:
          type: string
          enum:
            - UNAUTHORIZED
            - SESSION_NOT_PROVIDED
            - RULES_OUTDATED
            - SESSION_EXPIRED
            - PROXY_ERROR
            - UPSTREAM_MAINTENANCE
            - NETWORK_ERROR
            - UNKNOWN_ERROR
            - RESOURCE_NOT_FOUND
            - ROUTE_NOT_FOUND
            - BAD_REQUEST
            - RATE_LIMIT_EXCEEDED
            - SPEND_LIMIT_REACHED
            - FORBIDDEN
            - PROVIDER_FORBIDDEN
            - UPLOAD_ERROR
          description: Error class.
        requestId:
          type: string
        message:
          type: string
        success:
          type: boolean
          enum:
            - false
      required:
        - error
      description: >-
        Returned by some Access handlers (uploads, Sandbox data, user lookups,
        request body parsing) instead of `RuntimeError`: `error` is a message,
        so branch on the HTTP status and `type`.
    AccessError401:
      allOf:
        - $ref: '#/components/schemas/RuntimeError'
        - type: object
          properties:
            error:
              type: string
              enum:
                - authorization_required
                - external_oauth_bearer_required
                - grant_revoked_or_expired
                - invalid_token
                - linked_account_reconnect_required
              description: >-
                Stable error code: `authorization_required`
                (`restart_authorization`), `external_oauth_bearer_required`
                (`obtain_external_oauth_token`), `grant_revoked_or_expired`
                (`restart_authorization`), `invalid_token`
                (`obtain_external_oauth_token`),
                `linked_account_reconnect_required`
                (`reconnect_linked_account`).
    AccessError403:
      allOf:
        - $ref: '#/components/schemas/RuntimeError'
        - type: object
          properties:
            error:
              type: string
              enum:
                - additional_consent_required
                - authorization_required
                - client_deleted
                - integration_not_approved
                - integration_suspended
                - linked_account_not_granted
                - linked_account_required
                - missing_scope
                - provider_request_rejected
                - security_suspended
                - subscription_required
              description: >-
                Stable error code: `additional_consent_required`
                (`request_additional_consent`), `authorization_required`
                (`restart_authorization`), `client_deleted`
                (`contact_integration_owner`), `integration_not_approved`
                (`complete_integration_approval`), `integration_suspended`
                (`contact_integration_owner`), `linked_account_not_granted`
                (`grant_linked_account`), `linked_account_required`
                (`select_linked_account`), `missing_scope`
                (`request_additional_consent`), `provider_request_rejected`
                (`do_not_repeat`), `security_suspended`
                (`contact_integration_owner`), `subscription_required`
                (`update_developer_plan`).
    AccessError404:
      allOf:
        - $ref: '#/components/schemas/RuntimeError'
        - type: object
          properties:
            error:
              type: string
              enum:
                - provider_resource_not_found
              description: >-
                Stable error code: `provider_resource_not_found`
                (`check_resource`).
    AccessError409:
      allOf:
        - $ref: '#/components/schemas/RuntimeError'
        - type: object
          properties:
            error:
              type: string
              enum:
                - capability_execution_completed
              description: >-
                Stable error code: `capability_execution_completed`
                (`do_not_repeat`).
    AccessError429:
      allOf:
        - $ref: '#/components/schemas/RuntimeError'
        - type: object
          properties:
            error:
              type: string
              enum:
                - quota_exhausted
                - rate_limited
              description: >-
                Stable error code: `quota_exhausted` (`retry_after_reset`),
                `rate_limited` (`retry`).
    AccessError503:
      allOf:
        - $ref: '#/components/schemas/RuntimeError'
        - type: object
          properties:
            error:
              type: string
              enum:
                - authorization_temporarily_unavailable
                - capability_execution_failed
                - capability_execution_in_progress
                - capability_execution_unavailable
                - provider_maintenance
                - provider_outcome_unknown
                - transient_provider_failure
              description: >-
                Stable error code: `authorization_temporarily_unavailable`
                (`retry`), `capability_execution_failed` (`restart_upload`),
                `capability_execution_in_progress` (`retry`),
                `capability_execution_unavailable` (`retry`),
                `provider_maintenance` (`retry`), `provider_outcome_unknown`
                (`do_not_repeat`), `transient_provider_failure` (`retry`).
    RuntimeError:
      type: object
      properties:
        error:
          type: string
          description: >-
            Stable error code. Each error response lists the codes its status
            can carry. `missing_scope` means the access token lacks the scope;
            `additional_consent_required` means the token has it but the linked
            account's current consent no longer covers it. Both recover with
            `request_additional_consent`.
          example: invalid_token
        recovery:
          type: object
          properties:
            action:
              type: string
              enum:
                - obtain_external_oauth_token
                - retry
                - retry_after_reset
                - restart_authorization
                - request_additional_consent
                - grant_linked_account
                - select_linked_account
                - reconnect_linked_account
                - list_linked_accounts
                - complete_integration_approval
                - contact_integration_owner
                - update_developer_plan
                - enable_vault_plus
                - enable_linked_account_vault_plus
                - correct_request
                - check_request
                - check_resource
                - do_not_repeat
                - restart_upload
              description: What to do before retrying.
          required:
            - action
          description: >-
            Absent on `invalid_request` and other errors with no recovery
            action.
        requestId:
          type: string
          example: 4f5c3f0e-8d7c-4ff5-9b7f-7d0d9e7c2a61
        message:
          type: string
          description: Human-readable detail, when available.
        details:
          type: string
          description: Upstream failure detail (Vault+ `502`).
        not_allowed_qualities:
          type: object
          properties:
            image_qualities:
              type: array
              items:
                type: string
                enum:
                  - thumb
                  - preview
                  - full
            video_qualities:
              type: array
              items:
                type: string
                enum:
                  - preview
                  - 720p
                  - 1080p
                  - source
          required:
            - image_qualities
            - video_qualities
          description: >-
            `vault_plus_quality_not_in_plan`: the requested qualities your
            Developer plan does not include.
        allowed_qualities:
          type: object
          properties:
            image_qualities:
              type: array
              items:
                type: string
                enum:
                  - thumb
                  - preview
                  - full
            video_qualities:
              type: array
              items:
                type: string
                enum:
                  - preview
                  - 720p
                  - 1080p
                  - source
          required:
            - image_qualities
            - video_qualities
          description: >-
            `vault_plus_quality_not_in_plan`: the qualities your Developer plan
            includes.
      required:
        - error
        - requestId
  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.