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

# Update folder

> Update a folder. The update is partial: omitted attributes keep their current values.

The update is partial: omitted attributes keep their current values, and an empty body leaves the folder unchanged. Either all provided attributes are saved or none are.

API keys without access to private recordings cannot access folders whose `memberPermission` is `NoAccess`: they are reported as not found.


## OpenAPI

````yaml PATCH /v1/folders/{folderId}
openapi: 3.1.0
info:
  title: Claap API
  description: Development documentation
  version: 0.0.0
servers:
  - url: https://api.claap.io/
security:
  - ApiKey: []
paths:
  /v1/folders/{folderId}:
    patch:
      description: >-
        Update a folder. The update is partial: omitted attributes keep their
        current values.
      operationId: patchV1FoldersByFolderId
      parameters:
        - in: path
          name: folderId
          schema:
            type: string
            description: Folder identifier
          required: true
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  type: string
                  description: >-
                    New folder description, in markdown. Pass an empty string to
                    clear it.
                iconId:
                  type: string
                  description: New emoji shortcode used as the folder icon.
                memberPermission:
                  type: string
                  enum:
                    - NoAccess
                    - CanView
                    - CanComment
                    - FullAccess
                  description: New permission of workspace members on the folder.
                  example: FullAccess
                publicPermission:
                  type: string
                  enum:
                    - NoAccess
                    - CanComment
                  description: >-
                    New public link of the folder. `NoAccess` turns it off.
                    `CanComment` lets anyone with the link open the folder
                    without signing up, and requires public links to be enabled
                    on the workspace.
                  example: NoAccess
                searchable:
                  type: boolean
                  description: >-
                    Whether workspace members can find the recordings of the
                    folder in search results. Ignored when `memberPermission` is
                    `NoAccess`.
                title:
                  type: string
                  minLength: 1
                  description: New folder title.
      responses:
        '200':
          description: Folder was successfully updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    $ref: '#/components/schemas/ApiFolder'
                required:
                  - result
        '400':
          description: >-
            The request is not valid. For instance `memberPermission` is
            `CanView` or `CanComment` while nobody is invited to the folder with
            full access.
        '403':
          description: >-
            The update is not allowed. For instance the workspace plan does not
            allow granular permissions (a `memberPermission` other than
            `FullAccess` or a `publicPermission` other than `CanComment`), or
            `publicPermission` is not `NoAccess` while public links are disabled
            on the workspace.
        '404':
          description: >-
            Folder was not found. Note that API keys without access to private
            recordings cannot access folders whose `memberPermission` is
            `NoAccess`, which are reported as not found.
components:
  schemas:
    ApiFolder:
      type: object
      properties:
        description:
          type: string
          description: Folder description, in markdown.
        folderId:
          type: string
          description: >-
            Folder identifier. It is the `channel.id` of recordings and the
            `channelId` of the recording endpoints.
        iconId:
          type: string
          description: Emoji shortcode used as the folder icon, empty when it has none.
        memberPermission:
          type: string
          enum:
            - NoAccess
            - CanView
            - CanComment
            - FullAccess
          description: >-
            Permission of workspace members on the folder. `NoAccess` means only
            invited users and user groups can access it.
          example: FullAccess
        publicPermission:
          type: string
          enum:
            - NoAccess
            - CanView
            - CanComment
          description: >-
            Public link of the folder. `NoAccess` means it is off. `CanComment`
            means anyone with the link can open the folder without signing up.
            `CanView` can still be returned for older folders, but can no longer
            be set.
          example: NoAccess
        searchable:
          type: boolean
          description: >-
            Whether workspace members can find the recordings of the folder in
            search results. Always `false` when `memberPermission` is
            `NoAccess`.
        spaceId:
          type: string
          description: >-
            Identifier of the space (sidebar group of folders) the folder
            belongs to.
        title:
          type: string
          description: Folder title.
      required:
        - description
        - folderId
        - iconId
        - memberPermission
        - publicPermission
        - searchable
        - spaceId
        - title
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: X-Claap-Key

````