Collections
Create Collection
Creates a collection: the folder that groups articles in a help center's navigation. Collections can nest via parentId, up to 3 levels deep.
Authorization
Authorization AuthorizationBearer <token>
In: header
Path Parameters
projectIdrequiredstring
ID of the project that will own the collection.
Request Body
application/json
helpCenterIdrequiredstring
namerequiredstring
descriptionstring | null
urlstring | null
iconstring | null
parentIdstring | null
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://www.saasco.com/api/v2/projects/string/knowledge/collections" \ -H "Content-Type: application/json" \ -d '{ "helpCenterId": "string", "name": "string" }'{
"id": "string",
"createdAt": "string",
"updatedAt": "string",
"projectId": "string",
"helpCenterId": "string",
"name": "string",
"description": "string",
"url": "string",
"icon": "string",
"order": -9007199254740991,
"parentId": "string"
}{
"code": "BAD_REQUEST",
"message": "Invalid input data",
"issues": []
}{
"code": "UNAUTHORIZED",
"message": "Authorization not provided",
"issues": []
}{
"code": "FORBIDDEN",
"message": "Insufficient access",
"issues": []
}{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}Get Collection
Fetches a single collection by ID. Returns `null` rather than 404 when nothing matches.
Update Collection
Updates a collection's name, description, icon, or position. Only the fields present in the body are written. Re-parent it by setting `parentId`, keeping within the 3-level nesting limit.