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

Authorizations

​
x-api-key
string
header
required

Enter your API key

Body

application/json
​
helpCenterId
string
required

Help Center ID

Example:

"507f1f77bcf86cd799439011"

​
name
string
required

Name of the collection

Minimum string length: 1
Example:

"Getting Started Guide"

​
description
string

Description of the collection

Minimum string length: 1
Example:

"Learn how to get started with our platform"

​
icon
string

Icon identifier for the collection

Minimum string length: 1
Example:

"book"

​
isProtected
boolean

Whether the collection requires authentication to access

Example:

false

​
parentId
string

Parent collection ID

Example:

"507f1f77bcf86cd799439013"

Response

Collection created successfully.

​
data
object
​
message
string
Example:

"Collection created successfully."