Intercom API (unofficial showcase)
POST/help_center/collections

Create a help center collection

Creates a collection in a help center. Supply name and optionally provide a description, translated content, or a parent collection; omitting help_center_id creates the collection in the default help center. Use parent_id to place the collection under another collection, or leave it null to create a top-level collection.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 5 body fields
Intercom-Versionstringoptional
The Intercom API version to use. Defaults to 2.17 when omitted; listed supported values include 1.0 through 1.4 and 2.0 through 2.6.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

Collection details. name is required; other fields can be used to set a description, translations, parent collection, or help center.

namestringrequired
The name of the collection. For multilingual collections, this will be the name of the default language's content.
descriptionstringoptional
The description of the collection. For multilingual collections, this will be the description of the default language's content.
translated_contentobjectoptional
The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group.
parent_idstringoptional
The id of the parent collection. If `null` then it will be created as the first level collection.
help_center_idintegeroptional
The id of the help center where the collection will be created. If `null` then it will be created in the default help center.

3 status codes
200Returns the created collection, including its identifier, name, description, URL, hierarchy, timestamps, and translated content.
idstringoptional
The unique identifier for the collection which is given by Intercom.
workspace_idstringoptional
The id of the workspace which the collection belongs to.
namestringoptional
The name of the collection. For multilingual collections, this will be the name of the default language's content.
descriptionstringoptional
The description of the collection. For multilingual help centers, this will be the description of the collection for the default language.
created_atintegeroptional
The time when the article was created (seconds). For multilingual articles, this will be the timestamp of creation of the default language's content.
updated_atintegeroptional
The time when the article was last updated (seconds). For multilingual articles, this will be the timestamp of last update of the default language's content.
urlstringoptional
The URL of the collection. For multilingual help centers, this will be the URL of the collection for the default language.
iconstringoptional
The icon of the collection.
orderintegeroptional
The order of the section in relation to others sections within a collection. Values go from `0` upwards. `0` is the default if there's no order.
default_localestringoptional
The default locale of the help center. This field is only returned for multilingual help centers.
translated_contentobjectoptional
The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group.
parent_idstringoptional
The id of the parent collection. If `null` then it is the first level collection.
help_center_idintegeroptional
The id of the help center the collection is in.
400Returned when the request is invalid, including when the required collection name is missing.

One documented failure

  • parameter_not_found

    Name is a required parameter.

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 400 is returned when the request is invalid, including when name is missing. A 401 is returned when the request is unauthorized. If supplied, translated_content can provide localized collection content, and parent_id identifies the parent collection.