> ## 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 linked account settings

> Turn Vault+ on or off and change its settings for one linked account. Your token selects the environment. Other environments keep their settings.

Send changed fields in `overrides`. Set a field to `null` to use the integration setting again. Set `"overrides": null` to use the integration settings for every override field. Your plan must include each requested media quality.

If you remove a media type or quality, Vault+ deletes saved media that no longer matches the settings. Requires the `vault:write` scope for the account. Test accounts need a paid Developer plan.



## OpenAPI

````yaml /openapi/v3.json patch /v3/linked-accounts/{id}/settings
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/linked-accounts/{id}/settings:
    patch:
      tags:
        - Linked accounts
      summary: Update linked account settings
      description: >-
        Turn Vault+ on or off and change its settings for one linked account.
        Your token selects the environment. Other environments keep their
        settings.


        Send changed fields in `overrides`. Set a field to `null` to use the
        integration setting again. Set `"overrides": null` to use the
        integration settings for every override field. Your plan must include
        each requested media quality.


        If you remove a media type or quality, Vault+ deletes saved media that
        no longer matches the settings. Requires the `vault:write` scope for the
        account. Test accounts need a paid Developer plan.
      operationId: linkedAccounts.settings.update
      parameters:
        - schema:
            type: string
            minLength: 1
            example: conn_example123
          required: true
          name: id
          in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LinkedAccountSettingsUpdate'
      responses:
        '200':
          description: The updated settings.
          headers:
            Cache-Control:
              schema:
                type: string
                example: no-store
              required: true
            Pragma:
              schema:
                type: string
                example: no-cache
              required: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LinkedAccountSettings'
        '400':
          description: >-
            `invalid_request`: the body is not `{ "vault_plus": { "enabled"?:
            boolean, "overrides"?: object | null } }` or a setting is out of
            range.
          headers:
            Cache-Control:
              schema:
                type: string
                example: no-store
              required: true
            Pragma:
              schema:
                type: string
                example: no-cache
              required: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LinkedAccountsError400'
        '401':
          description: >-
            `external_oauth_bearer_required`, `invalid_token`, or
            `grant_revoked_or_expired`.
          headers:
            Cache-Control:
              schema:
                type: string
                example: no-store
              required: true
            Pragma:
              schema:
                type: string
                example: no-cache
              required: true
            WWW-Authenticate:
              schema:
                type: string
                example: Bearer
              required: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LinkedAccountsError401'
        '403':
          description: >-
            `missing_scope`, `subscription_required`,
            `vault_plus_quality_not_in_plan` (with `not_allowed_qualities` and
            `allowed_qualities`), or the authorization can no longer be used.
          headers:
            Cache-Control:
              schema:
                type: string
                example: no-store
              required: true
            Pragma:
              schema:
                type: string
                example: no-cache
              required: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LinkedAccountSettingsUpdateError403'
        '404':
          description: '`linked_account_not_found`: not part of this authorization.'
          headers:
            Cache-Control:
              schema:
                type: string
                example: no-store
              required: true
            Pragma:
              schema:
                type: string
                example: no-cache
              required: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LinkedAccountsError404'
        '409':
          description: >-
            `linked_account_settings_conflict` (retry) or
            `linked_account_settings_fixed` (Sandbox).
          headers:
            Cache-Control:
              schema:
                type: string
                example: no-store
              required: true
            Pragma:
              schema:
                type: string
                example: no-cache
              required: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LinkedAccountSettingsUpdateError409'
        '429':
          description: '`rate_limited` or `quota_exhausted`.'
          headers:
            Cache-Control:
              schema:
                type: string
                example: no-store
              required: true
            Pragma:
              schema:
                type: string
                example: no-cache
              required: true
            Retry-After:
              schema:
                type: string
                example: '3600'
              required: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LinkedAccountsError429'
        '503':
          description: '`authorization_temporarily_unavailable`; retry.'
          headers:
            Cache-Control:
              schema:
                type: string
                example: no-store
              required: true
            Pragma:
              schema:
                type: string
                example: no-cache
              required: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LinkedAccountsError503'
      security:
        - ExternalOAuth: []
components:
  schemas:
    LinkedAccountSettingsUpdate:
      type: object
      properties:
        vault_plus:
          type: object
          properties:
            enabled:
              type: boolean
            overrides:
              type: object
              nullable: true
              properties:
                auto_cache_vault:
                  type: boolean
                  nullable: true
                  description: Save Vault media automatically.
                auto_cache_messages:
                  type: boolean
                  nullable: true
                  description: Save message media automatically.
                auto_cache_posts:
                  type: boolean
                  nullable: true
                  description: Save post media automatically.
                auto_cache_stories:
                  type: boolean
                  nullable: true
                  description: Save story media automatically.
                min_access_count_vault:
                  type: integer
                  nullable: true
                  minimum: 0
                  maximum: 1000
                  description: >-
                    Number of times Vault media must be requested before Vault+
                    saves it.
                min_access_count_messages:
                  type: integer
                  nullable: true
                  minimum: 0
                  maximum: 1000
                  description: >-
                    Number of times message media must be requested before
                    Vault+ saves it.
                min_access_count_posts:
                  type: integer
                  nullable: true
                  minimum: 0
                  maximum: 1000
                  description: >-
                    Number of times post media must be requested before Vault+
                    saves it.
                min_access_count_stories:
                  type: integer
                  nullable: true
                  minimum: 0
                  maximum: 1000
                  description: >-
                    Number of times story media must be requested before Vault+
                    saves it.
                cache_images:
                  type: boolean
                  nullable: true
                  description: Save images.
                cache_videos:
                  type: boolean
                  nullable: true
                  description: Save videos.
                cache_audio:
                  type: boolean
                  nullable: true
                  description: Save audio.
                image_qualities:
                  type: array
                  nullable: true
                  items:
                    type: string
                    enum:
                      - thumb
                      - preview
                      - full
                  maxItems: 3
                  description: >-
                    Image qualities to save. Your Developer plan must include
                    each quality.
                video_qualities:
                  type: array
                  nullable: true
                  items:
                    type: string
                    enum:
                      - preview
                      - 720p
                      - 1080p
                      - source
                  maxItems: 4
                  description: >-
                    Video qualities to save. Your Developer plan must include
                    each quality.
                retention_days:
                  type: integer
                  nullable: true
                  minimum: 1
                  maximum: 3650
                  description: Number of days Vault+ keeps saved media.
                access_expiry_days:
                  type: integer
                  nullable: true
                  minimum: 1
                  maximum: 3650
                  description: >-
                    Vault+ deletes saved media if it is not read for this many
                    days.
                presigned_url_ttl_seconds:
                  type: integer
                  nullable: true
                  minimum: 60
                  maximum: 604800
                  description: Lifetime of download URLs, in seconds.
                storage_limit_bytes:
                  type: integer
                  nullable: true
                  minimum: 0
                  maximum: 1000000000000000
                  description: >-
                    Storage limit for this account in bytes; 0 means no account
                    limit.
                storage_limit_purge_strategy:
                  type: string
                  nullable: true
                  enum:
                    - purge_oldest
                    - purge_largest
                    - purge_smallest
                    - block_new
                  description: >-
                    What happens at the storage limit. `block_new` stops saving
                    new media.
              additionalProperties: false
              description: >-
                Account settings to change. Set a field to `null` to use the
                integration setting again. Set `overrides` to `null` to use the
                integration settings for every override field.
          additionalProperties: false
      required:
        - vault_plus
      additionalProperties: false
      example:
        vault_plus:
          enabled: true
          overrides:
            retention_days: 90
            image_qualities:
              - thumb
              - preview
    LinkedAccountSettings:
      type: object
      properties:
        linked_account_id:
          type: string
          example: conn_example123
        vault_plus:
          type: object
          properties:
            enabled:
              type: boolean
              description: Whether Vault+ saves this account’s media.
            overrides:
              type: object
              properties:
                auto_cache_vault:
                  type: boolean
                  description: Save Vault media automatically.
                auto_cache_messages:
                  type: boolean
                  description: Save message media automatically.
                auto_cache_posts:
                  type: boolean
                  description: Save post media automatically.
                auto_cache_stories:
                  type: boolean
                  description: Save story media automatically.
                min_access_count_vault:
                  type: integer
                  minimum: 0
                  maximum: 1000
                  description: >-
                    Number of times Vault media must be requested before Vault+
                    saves it.
                min_access_count_messages:
                  type: integer
                  minimum: 0
                  maximum: 1000
                  description: >-
                    Number of times message media must be requested before
                    Vault+ saves it.
                min_access_count_posts:
                  type: integer
                  minimum: 0
                  maximum: 1000
                  description: >-
                    Number of times post media must be requested before Vault+
                    saves it.
                min_access_count_stories:
                  type: integer
                  minimum: 0
                  maximum: 1000
                  description: >-
                    Number of times story media must be requested before Vault+
                    saves it.
                cache_images:
                  type: boolean
                  description: Save images.
                cache_videos:
                  type: boolean
                  description: Save videos.
                cache_audio:
                  type: boolean
                  description: Save audio.
                image_qualities:
                  type: array
                  items:
                    type: string
                    enum:
                      - thumb
                      - preview
                      - full
                  maxItems: 3
                  description: >-
                    Image qualities to save. Your Developer plan must include
                    each quality.
                video_qualities:
                  type: array
                  items:
                    type: string
                    enum:
                      - preview
                      - 720p
                      - 1080p
                      - source
                  maxItems: 4
                  description: >-
                    Video qualities to save. Your Developer plan must include
                    each quality.
                retention_days:
                  type: integer
                  minimum: 1
                  maximum: 3650
                  description: Number of days Vault+ keeps saved media.
                access_expiry_days:
                  type: integer
                  minimum: 1
                  maximum: 3650
                  description: >-
                    Vault+ deletes saved media if it is not read for this many
                    days.
                presigned_url_ttl_seconds:
                  type: integer
                  minimum: 60
                  maximum: 604800
                  description: Lifetime of download URLs, in seconds.
                storage_limit_bytes:
                  type: integer
                  minimum: 0
                  maximum: 1000000000000000
                  description: >-
                    Storage limit for this account in bytes; 0 means no account
                    limit.
                storage_limit_purge_strategy:
                  type: string
                  enum:
                    - purge_oldest
                    - purge_largest
                    - purge_smallest
                    - block_new
                  description: >-
                    What happens at the storage limit. `block_new` stops saving
                    new media.
              description: >-
                Settings this account overrides. Every other field follows the
                integration's Vault+ settings.
            effective:
              type: object
              properties:
                auto_cache_vault:
                  type: boolean
                  description: Save Vault media automatically.
                auto_cache_messages:
                  type: boolean
                  description: Save message media automatically.
                auto_cache_posts:
                  type: boolean
                  description: Save post media automatically.
                auto_cache_stories:
                  type: boolean
                  description: Save story media automatically.
                min_access_count_vault:
                  type: integer
                  minimum: 0
                  maximum: 1000
                  description: >-
                    Number of times Vault media must be requested before Vault+
                    saves it.
                min_access_count_messages:
                  type: integer
                  minimum: 0
                  maximum: 1000
                  description: >-
                    Number of times message media must be requested before
                    Vault+ saves it.
                min_access_count_posts:
                  type: integer
                  minimum: 0
                  maximum: 1000
                  description: >-
                    Number of times post media must be requested before Vault+
                    saves it.
                min_access_count_stories:
                  type: integer
                  minimum: 0
                  maximum: 1000
                  description: >-
                    Number of times story media must be requested before Vault+
                    saves it.
                cache_images:
                  type: boolean
                  description: Save images.
                cache_videos:
                  type: boolean
                  description: Save videos.
                cache_audio:
                  type: boolean
                  description: Save audio.
                image_qualities:
                  type: array
                  items:
                    type: string
                    enum:
                      - thumb
                      - preview
                      - full
                  maxItems: 3
                  description: >-
                    Image qualities to save. Your Developer plan must include
                    each quality.
                video_qualities:
                  type: array
                  items:
                    type: string
                    enum:
                      - preview
                      - 720p
                      - 1080p
                      - source
                  maxItems: 4
                  description: >-
                    Video qualities to save. Your Developer plan must include
                    each quality.
                retention_days:
                  type: integer
                  minimum: 1
                  maximum: 3650
                  description: Number of days Vault+ keeps saved media.
                access_expiry_days:
                  type: integer
                  minimum: 1
                  maximum: 3650
                  description: >-
                    Vault+ deletes saved media if it is not read for this many
                    days.
                presigned_url_ttl_seconds:
                  type: integer
                  minimum: 60
                  maximum: 604800
                  description: Lifetime of download URLs, in seconds.
                storage_limit_bytes:
                  type: integer
                  minimum: 0
                  maximum: 1000000000000000
                  description: >-
                    Storage limit for this account in bytes; 0 means no account
                    limit.
                storage_limit_purge_strategy:
                  type: string
                  enum:
                    - purge_oldest
                    - purge_largest
                    - purge_smallest
                    - block_new
                  description: >-
                    What happens at the storage limit. `block_new` stops saving
                    new media.
              required:
                - auto_cache_vault
                - auto_cache_messages
                - auto_cache_posts
                - auto_cache_stories
                - min_access_count_vault
                - min_access_count_messages
                - min_access_count_posts
                - min_access_count_stories
                - cache_images
                - cache_videos
                - cache_audio
                - image_qualities
                - video_qualities
                - retention_days
                - access_expiry_days
                - presigned_url_ttl_seconds
                - storage_limit_bytes
                - storage_limit_purge_strategy
              description: >-
                The Vault+ settings used for this account. Account settings
                replace matching integration settings. Your plan limits which
                media qualities can be saved.
            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: Qualities your Developer plan includes.
            restricted_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: >-
                Media quality settings your plan does not include. OFAuth keeps
                these settings and applies them if you upgrade to a plan that
                includes them.
          required:
            - enabled
            - overrides
            - effective
            - allowed_qualities
            - restricted_qualities
      required:
        - linked_account_id
        - vault_plus
    LinkedAccountsError400:
      allOf:
        - $ref: '#/components/schemas/RuntimeError'
        - properties:
            error:
              description: 'Stable error code: `invalid_request`.'
              enum:
                - invalid_request
              type: string
          type: object
    LinkedAccountsError401:
      allOf:
        - $ref: '#/components/schemas/RuntimeError'
        - type: object
          properties:
            error:
              type: string
              enum:
                - authorization_required
                - external_oauth_bearer_required
                - grant_revoked_or_expired
                - invalid_token
              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`).
    LinkedAccountSettingsUpdateError403:
      allOf:
        - $ref: '#/components/schemas/RuntimeError'
        - properties:
            error:
              description: >-
                Stable error code: `additional_consent_required`
                (`request_additional_consent`), `client_deleted`
                (`contact_integration_owner`), `integration_not_approved`
                (`complete_integration_approval`), `integration_suspended`
                (`contact_integration_owner`), `linked_account_not_granted`
                (`grant_linked_account`), `missing_scope`
                (`request_additional_consent`), `security_suspended`
                (`contact_integration_owner`), `subscription_required`
                (`update_developer_plan`), `vault_plus_quality_not_in_plan`
                (`update_developer_plan`).
              enum:
                - additional_consent_required
                - client_deleted
                - integration_not_approved
                - integration_suspended
                - linked_account_not_granted
                - missing_scope
                - security_suspended
                - subscription_required
                - vault_plus_quality_not_in_plan
              type: string
          type: object
    LinkedAccountsError404:
      allOf:
        - $ref: '#/components/schemas/RuntimeError'
        - properties:
            error:
              description: >-
                Stable error code: `linked_account_not_found`
                (`list_linked_accounts`).
              enum:
                - linked_account_not_found
              type: string
          type: object
    LinkedAccountSettingsUpdateError409:
      allOf:
        - $ref: '#/components/schemas/RuntimeError'
        - properties:
            error:
              description: >-
                Stable error code: `linked_account_settings_conflict` (`retry`),
                `linked_account_settings_fixed`.
              enum:
                - linked_account_settings_conflict
                - linked_account_settings_fixed
              type: string
          type: object
    LinkedAccountsError429:
      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`).
    LinkedAccountsError503:
      allOf:
        - $ref: '#/components/schemas/RuntimeError'
        - type: object
          properties:
            error:
              type: string
              enum:
                - authorization_temporarily_unavailable
              description: >-
                Stable error code: `authorization_temporarily_unavailable`
                (`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.

````

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