{
"id": 1,
"type": "collection",
"workspace_id": "abcdef",
"name": "Default language name",
"description": "Default language description",
"created_at": 123456,
"updated_at": 123456,
"url": "http://intercom.test/help/collection/name",
"icon": "http://intercom/help_center/icon-1",
"order": 0,
"default_locale": "en",
"translated_content": {
"type": "group_translated_content",
"fr": {
"type": "group_content",
"name": "French name",
"description": "French description"
}
}
}
{
"id": 1,
"type": "section",
"workspace_id": "abcdef",
"name": "Default language name",
"created_at": 123456,
"updated_at": 123456,
"url": "http://intercom.test/help/section/name",
"icon": "http://intercom/help_center/icon-1",
"order": 0,
"collection_id": "1",
"default_locale": "en",
"translated_content": {
"type": "group_translated_content",
"fr": {
"type": "group_content",
"name": "French name"
}
}
}
The Help Center API is a central place to gather all information and take actions on those elements within a Help Center - namely the collections and sections. Collections are top level containers for Articles within the Help Center. Sections are subdivisions of a collection, with a collection potentially having multiple sections.
For articles you should refer to the Articles endpoint.
Collection Object
Key | Type | Description |
---|---|---|
type | String | The type of object - |
id | String | The unique identifier for the collection which is given by Intercom. |
workspace_id | String | The id of the workspace which the collection belongs to. |
name | String | The name of the collection. |
description | String | The description of the collection. |
created_at | Timestamp | The time when the article was created. |
updated_at | Timestamp | The time when the article was last updated. |
url | String | The URL of the collection. |
icon | String | The icon for the collection. |
order | Integer | The order of the section in relation to others sections within a collection. |
default_locale | String | The default locale of the help center. |
translated_content | Object | An Group Translated Content Object for multilingual articles. |
Section Object
Key | Type | Description |
---|---|---|
type | String | The type of object - |
id | String | The unique identifier for the section which is given by Intercom. |
workspace_id | String | The id of the workspace which the section belongs to. |
name | String | The name of the section. |
created_at | Timestamp | The time when the section was created. |
updated_at | Timestamp | The time when the section was last updated. |
url | String | The URL of the section. |
icon | String | The icon for the section. |
order | Integer | The order of the section in relation to others sections within a collection. |
collection_id | String | The id of the collection to which this section belongs to. |
default_locale | String | The default locale of the help center. |
translated_content | Object | An Group Translated Content Object for multilingual articles. |
Group Translated Content Object
Key | Type | Writeable? | Description |
---|---|---|---|
type | String | No | The type of object - |
<locale>
| Object | Yes | An Group Content Object for each supported locale of the multilingual help center. |
Group Content Object
Key | Type | Writeable? | Description |
---|---|---|---|
type | String | No | The type of object - |
name | String | Yes | The name of the collection or section. |
description | String | Yes | The description of the collection. |