> ## 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, Move, or Categorize File

> Renames a file (`displayName`), moves it to a different folder
(`folderId`), and/or sets its free-text category label (`category`).
Send only the fields you want to change — at least one must be present.

Set `folderId` to a folder id to move the file into that folder, or to
`null` to move it to the owner's top level. The target folder must
belong to the same owner as the file. Renames change the display
identity only — the stored bytes and the immutable original `fileName`
never change.

Set `category` to any non-blank string (max 255 characters; leading and
trailing whitespace is trimmed) or to `null` to clear it. Categories are
free-text — there is no configured category list to match against.

`folderId` and `category` live on a placement, and a file shared to
several entities has one placement per owner — so on a shared file this
endpoint can only change `displayName` (which lives on the file itself);
a `folderId`/`category` update returns `409 Conflict` because the
placement to change is ambiguous. Re-folder or re-categorize a shared
file per placement with
[Update File Placement](#tag/Company-Files/PATCH/api/v1/companies/{companyId}/files/{fileId}/placements/{placementId}).

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




## OpenAPI

````yaml /openapi/generated-external-api.yaml patch /api/v1/companies/{companyId}/files/{fileId}
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}/files/{fileId}:
    patch:
      tags:
        - Company Files
      summary: Rename, Move, or Categorize File
      description: >
        Renames a file (`displayName`), moves it to a different folder

        (`folderId`), and/or sets its free-text category label (`category`).

        Send only the fields you want to change — at least one must be present.


        Set `folderId` to a folder id to move the file into that folder, or to

        `null` to move it to the owner's top level. The target folder must

        belong to the same owner as the file. Renames change the display

        identity only — the stored bytes and the immutable original `fileName`

        never change.


        Set `category` to any non-blank string (max 255 characters; leading and

        trailing whitespace is trimmed) or to `null` to clear it. Categories are

        free-text — there is no configured category list to match against.


        `folderId` and `category` live on a placement, and a file shared to

        several entities has one placement per owner — so on a shared file this

        endpoint can only change `displayName` (which lives on the file itself);

        a `folderId`/`category` update returns `409 Conflict` because the

        placement to change is ambiguous. Re-folder or re-categorize a shared

        file per placement with

        [Update File
        Placement](#tag/Company-Files/PATCH/api/v1/companies/{companyId}/files/{fileId}/placements/{placementId}).


        **Required permission:** `company.file:update`
      operationId: updateCompanyFile
      parameters:
        - $ref: '#/components/parameters/companyId'
        - $ref: '#/components/parameters/fileId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                displayName:
                  type: string
                  description: New display name (must be non-empty)
                folderId:
                  type: string
                  format: uuid
                  nullable: true
                  description: New folder id, or null for the owner's top level
                category:
                  type: string
                  nullable: true
                  maxLength: 255
                  description: >-
                    Free-text category label (max 255 characters), or null to
                    clear it
            examples:
              rename:
                summary: Rename file
                value:
                  displayName: master-agreement-final.pdf
              moveToFolder:
                summary: Move file into a folder
                value:
                  folderId: 550e8400-e29b-41d4-a716-446655440001
              moveToTopLevel:
                summary: Move file to the owner's top level
                value:
                  folderId: null
              setCategory:
                summary: Set the file's category
                value:
                  category: Loss Runs
              clearCategory:
                summary: Clear the file's category
                value:
                  category: null
      responses:
        '200':
          description: File updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                    description: Id of the updated file
              examples:
                success:
                  summary: File updated
                  value:
                    id: 550e8400-e29b-41d4-a716-446655440020
        '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 displayName, folderId, and/or
                        category
                wrongOwnerFolder:
                  summary: Target folder belongs to a different owner
                  value:
                    error:
                      code: BadRequest
                      message: Folder does not belong to the file owner
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: File or target folder not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                notFound:
                  summary: File does not exist
                  value:
                    error:
                      code: NotFound
                      message: 'File not found: 550e8400-e29b-41d4-a716-446655440020'
        '409':
          description: >-
            The file has multiple placements, so an owner-less
            `folderId`/`category` update is ambiguous — use [Update File
            Placement](#tag/Company-Files/PATCH/api/v1/companies/{companyId}/files/{fileId}/placements/{placementId})
            to address one placement
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                sharedFile:
                  summary: Shared file — placement to update is ambiguous
                  value:
                    error:
                      code: Conflict
                      message: >-
                        File has multiple placements:
                        550e8400-e29b-41d4-a716-446655440020. Update one
                        placement instead: PATCH
                        /files/{fileId}/placements/{placementId} (enumerate them
                        with GET /files/{fileId}/placements)
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    companyId:
      name: companyId
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: Company identifier
    fileId:
      name: fileId
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: File 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.

````