---
title: "Update collection metadata"
method: PATCH
path: "/api/v1/collections/{id}"
tags: ["Collections"]
---

# Update collection metadata

`PATCH /api/v1/collections/{id}`

## Request

- Base URL: `https://api.korala.ai`
- URL: `https://api.korala.ai/api/v1/collections/{id}`
- Auth: one of:
  - API key in header `X-API-Key`
  - `bearer` (a scheme the document does not define)

## Path parameters

- `id` string, required

## Query parameters

- `sandbox` boolean

## Request body

- UpdateCollectionDto
  - `name` string
  - `description` string, nullable
  - `metadata` object: Replaces metadata. JSON object, at most 16 KiB of UTF-8 JSON.

## Response `200`

- CollectionDto
  - `id` string, uuid, required
  - `organizationId` string, uuid, required
  - `sandbox` boolean, required
  - `name` string, required
  - `description` string, nullable, required
  - `externalId` string, nullable, required
  - `metadata` object, required
  - `archivedAt` string, date-time, nullable, required
  - `createdAt` string, date-time, required
  - `updatedAt` string, date-time, required
  - `documentCount` number, required
  - `templateCount` number, required
  - `signingRequestCount` number, required: Signing requests started from this collection.

## Other responses

- `400`: Malformed UUID in path parameter (`id`).

---

[API](https://skmtc.dev/korala/apis/korala-public-api.md) · [All operations](https://skmtc.dev/korala/apis/korala-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/korala/apis/korala-public-api/revisions/5c4d7810c507?raw)