Skip to main content
POST
/
api
/
r2r
/
v3
/
collections
/
{id}
Update Collection
curl --request POST \
  --url https://api.intelligence.io.solutions/api/r2r/v3/collections/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "generate_description": true
}'
{
  "results": {
    "id": "id",
    "name": "name",
    "graph_cluster_status": "graph_cluster_status",
    "graph_sync_status": "graph_sync_status",
    "created_at": "2024-01-15T09:30:00Z",
    "updated_at": "2024-01-15T09:30:00Z",
    "user_count": 1,
    "document_count": 1,
    "owner_id": "owner_id",
    "description": "description"
  }
}
This endpoint allows updating the name and description of an existing collection. The user must have appropriate permissions to modify the collection.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

id
string
required

ID of the collection

Body

application/json
name
string

The name of the collection

description
string

An optional description of the collection

generate_description
boolean

Whether to generate a new synthetic description for the collection

Response

200

results
object
I