PATCH
/
collections
/
{collectionId}
curl --request PATCH \
  --url https://getunblocked.com/api/v1/collections/{collectionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Apollo",
  "description": "Documents from the Apollo customer support tool including support responses.",
  "iconUrl": "https://my.company.com/apollo/logo.svg"
}'
This response does not have an example.

Authorizations

Authorization
string
header
required

The API key to authenticate requests. Obtainable from the web dashboard.

Path Parameters

collectionId
string
required

The ID of the collection.

Body

application/json
name
string

A brief identifier for the collection.

Example:

"Apollo"

description
string

A sentence defining the document type within this collection, aiding the language model in grasping the content's essence.

Example:

"Documents from the Apollo customer support tool including support responses."

iconUrl
string

A URL of a square image used to visually represent document references from the collection in the Unblocked UI. Preferred image formats are SVG, PNG, and JPG.

Example:

"https://my.company.com/apollo/logo.svg"

Response

200
_mintlify/placeholder

OK