PATCH
/
collections
/
{collectionId}
Update a collection
curl --request PATCH \
  --url https://helpcenter.thena.ai/collections/{collectionId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "name": "Getting Started Guide",
  "description": "Learn how to get started with our platform",
  "icon": "book",
  "isProtected": false,
  "meta": {
    "title": "SEO Title",
    "description": "SEO Description",
    "image": "https://example.com/image.jpg"
  }
}'
{
  "data": {
    "_id": "671b855619d8f51c01c0d28f",
    "orgId": "667d37bb3a401eba4a609426",
    "uid": 3115095248,
    "helpCenterId": "671a2ddbccca6b1c3dc0d3b6",
    "name": "General",
    "description": "Description of the collection",
    "slug": "3115095248-general",
    "parentId": null,
    "order": 0,
    "createdBy": "66d9652332a786110182e40c",
    "isProtected": false,
    "createdAt": "2024-10-25T11:47:35.005Z",
    "updatedAt": "2024-11-18T07:37:11.001Z",
    "articles": [
      "6735b68c2baad6fe6f6da745"
    ],
    "icon": "AnnotationIcon",
    "meta": {
      "title": null,
      "description": null,
      "image": null
    }
  },
  "message": "Collection updated successfully."
}

Authorizations

x-api-key
string
header
required

Enter your API key (format: keyId.keySecret)

Path Parameters

collectionId
string
required

Collection ID

Example:

"507f1f77bcf86cd799439011"

Body

application/json

Response

200
application/json

Collection updated successfully.

The response is of type object.