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

# Rename or Move Folder

> Renames a folder (`name`), moves it under a different parent
(`parentFolderId`), or both. Send only the fields you want to change —
at least one must be present.

Set `parentFolderId` to a folder id to reparent, or to `null` to move
the folder to the owner's top level. The destination must belong to the
same owner, and a folder can never be moved into itself or its own
subtree (`400`).

**Required permission:** `company.file:update`




## OpenAPI

````yaml /openapi/generated-external-api.yaml patch /api/v1/companies/{companyId}/folders/{folderId}
openapi: 3.0.3
info:
  title: AI Insurance External API
  description: External API for AI Insurance platform
  version: 1.0.0
  contact:
    email: support@aiinsurance.io
servers:
  - url: https://go.aiinsurance.io
    description: Production
security:
  - ApiKeyAuth: []
paths:
  /api/v1/companies/{companyId}/folders/{folderId}:
    patch:
      tags:
        - Company Files
      summary: Rename or Move Folder
      description: |
        Renames a folder (`name`), moves it under a different parent
        (`parentFolderId`), or both. Send only the fields you want to change —
        at least one must be present.

        Set `parentFolderId` to a folder id to reparent, or to `null` to move
        the folder to the owner's top level. The destination must belong to the
        same owner, and a folder can never be moved into itself or its own
        subtree (`400`).

        **Required permission:** `company.file:update`
      operationId: updateFolder
      parameters:
        - $ref: '#/components/parameters/companyId'
        - $ref: '#/components/parameters/folderId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: New folder name (must be non-empty)
                parentFolderId:
                  type: string
                  format: uuid
                  nullable: true
                  description: New parent folder id, or null for the owner's top level
            examples:
              rename:
                summary: Rename folder
                value:
                  name: Archived Claims
              move:
                summary: Move folder under a new parent
                value:
                  parentFolderId: 550e8400-e29b-41d4-a716-446655440099
              moveToTopLevel:
                summary: Move folder to the owner's top level
                value:
                  parentFolderId: null
      responses:
        '200':
          description: Folder updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                    description: Id of the updated folder
              examples:
                success:
                  summary: Folder updated
                  value:
                    id: 550e8400-e29b-41d4-a716-446655440001
        '400':
          description: Bad Request — Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                nothingToUpdate:
                  summary: No updatable field provided
                  value:
                    error:
                      code: BadRequest
                      message: 'Nothing to update: provide name and/or parentFolderId'
                cycle:
                  summary: Move into own subtree
                  value:
                    error:
                      code: BadRequest
                      message: A folder cannot be moved into its own subtree
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: Folder or destination parent not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                notFound:
                  summary: Folder does not exist
                  value:
                    error:
                      code: NotFound
                      message: 'Folder not found: 550e8400-e29b-41d4-a716-446655440001'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    companyId:
      name: companyId
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: Company identifier
    folderId:
      name: folderId
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: Folder identifier
  schemas:
    ErrorResponse:
      type: object
      description: Standard error response for all external API endpoints
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: Machine-readable error code
              example: VALIDATION_ERROR
            message:
              type: string
              description: Human-readable error message
              example: 'submissionId: Required field is missing'
            userMessages:
              type: array
              description: >-
                Clean, verbatim-displayable messages — one entry per failure,
                free of error-code tags, field paths, and internal noise.
                Suitable for showing to end users as-is.
              items:
                type: string
              example:
                - Exposures of type 'company' require an address
            details:
              type: array
              description: Additional details for validation errors (field-level errors)
              items:
                type: object
                properties:
                  field:
                    type: string
                    description: The field that caused the error
                    example: submissionId
                  message:
                    type: string
                    description: Description of the field error
                    example: Required field is missing
  responses:
    Unauthorized:
      description: Unauthorized - Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            missingApiKey:
              summary: Missing API key
              value:
                error:
                  code: AuthenticationError
                  message: API key authentication required
                  userMessages:
                    - API key authentication required
            invalidApiKey:
              summary: >-
                Invalid API key (e.g. unknown key, or a Bearer token used
                instead of an API key)
              value:
                error:
                  code: AuthenticationError
                  message: Invalid API key
                  userMessages:
                    - Invalid API key
    Forbidden:
      description: Forbidden - Insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            insufficientPermissions:
              summary: Insufficient permissions
              value:
                error:
                  code: AuthorizationError
                  message: User is not authorized to perform the requested action
                  userMessages:
                    - User is not authorized to perform the requested action
            companyMismatch:
              summary: A valid API key naming another company in the URL
              value:
                error:
                  code: AuthorizationError
                  message: API key is not scoped to the requested company
                  userMessages:
                    - API key is not scoped to the requested company
    InternalServerError:
      description: Internal Server Error - Unexpected error occurred
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            internalError:
              summary: Unexpected server error
              value:
                error:
                  code: UncaughtActionError
                  message: Uncaught error occurred in <actionName>
                  userMessages:
                    - An unexpected error occurred. Please try again later.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        API key authentication. Send your raw API key as the `Authorization`
        header value with NO scheme prefix — `Authorization: YOUR-API-KEY`. Do
        NOT prefix it with `Bearer ` or `ApiKey `, and do not use an `X-API-Key`
        header; those are not accepted.

````