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

idstring required

Query parameters

sandboxboolean

Dashboard mode. API keys always use their authenticated mode.

Request body

namestring
descriptionstring nullable
metadataobject

Replaces metadata. JSON object, at most 16 KiB of UTF-8 JSON.

Response

idstring uuid required
organizationIdstring uuid required
sandboxboolean required
namestring required
descriptionstring nullable required
externalIdstring nullable required
metadataobject required
archivedAtstring date-time nullable required
createdAtstring date-time required
updatedAtstring date-time required
documentCountnumber required
templateCountnumber required
signingRequestCountnumber required

Signing requests started from this collection.

Changes

No recorded changes to this operation across all 1 revision of this API.