The intercom API reference.
URL https://developers.intercom.com
License MIT
The intercom API reference.
The name of the collection. For multilingual collections, this will be the name of the default language's content.
The description of the collection. For multilingual collections, this will be the description of the default language's content.
The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group.
curl -i -X POST \
https://api.intercom.io/help_center/collections \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-H 'Intercom-Version: 2.9' \
-d '{
"name": "Thanks for everything"
}'collection created
The name of the collection. For multilingual collections, this will be the name of the default language's content.
The description of the collection. For multilingual help centers, this will be the description of the collection for the default language.
The time when the article was created (seconds). For multilingual articles, this will be the timestamp of creation of the default language's content.
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.
The URL of the collection. For multilingual help centers, this will be the URL of the collection for the default language.
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.
The default locale of the help center. This field is only returned for multilingual help centers.
The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group.
{ "id": "167", "workspace_id": "this_is_an_id67_that_should_be_at_least_4", "name": "Thanks for everything", "url": "http://help-center.test/myapp-67/", "order": 1, "created_at": 1717021354, "updated_at": 1717021354, "description": "", "icon": "book-bookmark", "help_center_id": 91, "type": "collection" }
curl -i -X GET \
https://api.intercom.io/help_center/collections/123 \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Intercom-Version: 2.9'Collection found
The name of the collection. For multilingual collections, this will be the name of the default language's content.
The description of the collection. For multilingual help centers, this will be the description of the collection for the default language.
The time when the article was created (seconds). For multilingual articles, this will be the timestamp of creation of the default language's content.
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.
The URL of the collection. For multilingual help centers, this will be the URL of the collection for the default language.
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.
The default locale of the help center. This field is only returned for multilingual help centers.
The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group.
{ "id": "172", "workspace_id": "this_is_an_id73_that_should_be_at_least_4", "name": "English collection title", "url": "http://help-center.test/myapp-73/collection-22", "order": 22, "created_at": 1717021355, "updated_at": 1717021355, "description": "english collection description", "icon": "bookmark", "help_center_id": 94, "type": "collection" }
The name of the collection. For multilingual collections, this will be the name of the default language's content.
The description of the collection. For multilingual collections, this will be the description of the default language's content.
curl -i -X PUT \
https://api.intercom.io/help_center/collections/123 \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-H 'Intercom-Version: 2.9' \
-d '{
"name": "Update collection name"
}'successful
The name of the collection. For multilingual collections, this will be the name of the default language's content.
The description of the collection. For multilingual help centers, this will be the description of the collection for the default language.
The time when the article was created (seconds). For multilingual articles, this will be the timestamp of creation of the default language's content.
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.
The URL of the collection. For multilingual help centers, this will be the URL of the collection for the default language.
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.
The default locale of the help center. This field is only returned for multilingual help centers.
The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group.
{ "id": "178", "workspace_id": "this_is_an_id79_that_should_be_at_least_4", "name": "Update collection name", "url": "http://help-center.test/myapp-79/collection-25", "order": 25, "created_at": 1717021357, "updated_at": 1717021357, "description": "english collection description", "icon": "folder", "help_center_id": 97, "type": "collection" }