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

# Update organization settings

> This API updates workspace settings. Send at least one field. The `put` method works too. For CLI sessions, this needs the Manage basic info permission. `enable_social_media_sharing` and `facebook_app_id` need the Manage social sharing permission instead. Only the fields you send are checked.


> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](https://apidocs.neetokb.com/api/workspace-subdomain.md).


## OpenAPI

````yaml bundled/settings.yaml PATCH /setting
openapi: 3.0.3
info:
  title: NeetoKB Settings API
  description: APIs to read and update workspace settings.
  version: 1.0.0
servers:
  - description: NeetoKB API
    url: https://{your-subdomain}.neetokb.com/api/external/v2
    variables:
      your-subdomain:
        default: spinkart
        description: >-
          Replace **spinkart** with your [workspace's
          subdomain](/api/workspace-subdomain).
security: []
paths:
  /setting:
    patch:
      tags:
        - Settings
      summary: Update organization settings
      description: >
        This API updates workspace settings. Send at least one field. The `put`
        method works too. For CLI sessions, this needs the Manage basic info
        permission. `enable_social_media_sharing` and `facebook_app_id` need the
        Manage social sharing permission instead. Only the fields you send are
        checked.
      parameters:
        - $ref: '#/components/parameters/api_key_header'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/update_workspace_settings_request'
      responses:
        '200':
          description: >-
            OK - Request succeeded. Returns the same body as Get organization
            settings.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workspace_settings'
        '401':
          $ref: '#/components/responses/unauthorized_response'
        '403':
          $ref: '#/components/responses/forbidden_response'
        '422':
          $ref: '#/components/responses/unprocessable_response'
components:
  parameters:
    api_key_header:
      in: header
      name: X-Api-Key
      description: >-
        Use the X-Api-Key header to provide your workspace API key. Refer to
        [Authentication](/api/authentication) for more information.
      required: true
      schema:
        type: string
        default: your-api-key
  schemas:
    update_workspace_settings_request:
      type: object
      required:
        - setting
      properties:
        setting:
          type: object
          description: Send at least one field. Fields you leave out do not change.
          properties:
            knowledge_base_name:
              type: string
              maxLength: 80
            site_content_preference:
              type: string
            allow_user_signup:
              type: boolean
            show_article_nav_links:
              type: boolean
            header_text:
              type: string
            search_input_text:
              type: string
            copyright_content:
              type: string
            contact_section:
              allOf:
                - $ref: '#/components/schemas/contact_section'
              description: Merged into the current contact section.
            enable_social_media_sharing:
              type: boolean
            facebook_app_id:
              type: string
              description: Letters and digits only.
    workspace_settings:
      type: object
      properties:
        knowledge_base_name:
          type: string
          example: Acme Help
        url:
          type: string
          example: https://acme.neetokb.com
        site_content_preference:
          type: string
          example: Categories
        allow_user_signup:
          type: boolean
        enable_social_media_sharing:
          type: boolean
        facebook_app_id:
          type: string
          nullable: true
        show_article_nav_links:
          type: boolean
        header_text:
          type: string
          example: How can we help?
        search_input_text:
          type: string
          example: Search
        copyright_content:
          type: string
        contact_section:
          $ref: '#/components/schemas/contact_section'
    contact_section:
      type: object
      properties:
        title:
          type: string
        kind:
          type: string
          example: action
        link:
          type: string
          example: '#trigger-chat'
        button_label:
          type: string
          example: Contact us
  responses:
    unauthorized_response:
      description: Unauthorized - API key is missing or invalid
    forbidden_response:
      description: >-
        Forbidden - The CLI session does not have the permission this change
        needs
    unprocessable_response:
      description: >-
        Unprocessable Entity - A parameter is invalid or a rule refused the
        change. The `error` field says which.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
                example: Name can't be blank.

````

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