Skip to main content
PATCH
/
v1
/
collections
/
{readable_id}
Update Collection
curl --request PATCH \
  --url https://api.example.com/v1/collections/{readable_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "sync_config": {
    "handlers": {
      "enable_vector_handlers": true,
      "enable_postgres_handler": true
    }
  }
}
'
{
  "id": "<string>",
  "name": "<string>",
  "readable_id": "<string>",
  "modified_at": "<string>",
  "modified_by_email": "<string>"
}

​
Overview

Update a collection’s display name or sync configuration. The readable_id cannot be changed after creation to maintain stable API endpoints.

​
Path Parameters

​
readable_id
string
required
The unique readable identifier of the collection to update

​
Request Body

All fields are optional. Only include fields you want to change.
​
name
string
Updated display name for the collection (4-64 characters)
​
sync_config
object
Default sync configuration for all syncs in this collection

​
Response

Returns the updated collection object.
​
id
string
required
Unique UUID identifier for the collection
​
name
string
required
Updated display name
​
readable_id
string
required
URL-safe identifier (unchanged)
​
modified_at
string
required
ISO 8601 timestamp when last modified
​
modified_by_email
string
Email of the user who made this update

​
Example Request

curl -X PATCH https://api.airweave.ai/v1/collections/finance-data-ab123 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Updated Finance Data"}'

​
Example Response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Updated Finance Data",
  "readable_id": "finance-data-ab123",
  "vector_size": 3072,
  "embedding_model_name": "text-embedding-3-large",
  "sync_config": null,
  "created_at": "2024-01-15T09:30:00Z",
  "modified_at": "2024-01-15T16:45:00Z",
  "organization_id": "org12345-6789-abcd-ef01-234567890abc",
  "created_by_email": "admin@company.com",
  "modified_by_email": "admin@company.com",
  "status": "ACTIVE"
}

​
Error Responses

​
404 Not Found
Collection with the specified readable_id does not exist
​
422 Validation Error
Invalid request body (e.g., name too short)