The Collection model

Example Collection Object

{
  "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"
    }
  }
}

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.

Object Models

Collection

Field	Type	Description
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. For multilingual collections, this will be the name of the default language's content.
description	string	The description of the collection. For multilingual help centers, this will be the description of the collection for the default language.
created_at	integer	The time when the article was created. For multilingual articles, this will be the timestamp of creation of the default language's content.
updated_at	integer	The time when the article was last updated. For multilingual articles, this will be the timestamp of last update of the default language's content.
url	string	The URL of the collection. For multilingual help centers, this will be the URL of the collection for the default language.
icon	string	The icon of the collection.
order	integer	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_locale	string	The default locale of the help center. This field is only returned for multilingual help centers.
translated_content	object	The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group.
type	string	The type of object - `collection`.

Group Translated Content

Field	Type	Description
type	string	The type of object - group_translated_content.
ar	object	The Content of a Group.
bg	object	The Content of a Group.
bs	object	The Content of a Group.
ca	object	The Content of a Group.
cs	object	The Content of a Group.
da	object	The Content of a Group.
de	object	The Content of a Group.
el	object	The Content of a Group.
en	object	The Content of a Group.
es	object	The Content of a Group.
et	object	The Content of a Group.
fi	object	The Content of a Group.
fr	object	The Content of a Group.
he	object	The Content of a Group.
hr	object	The Content of a Group.
hu	object	The Content of a Group.
id	object	The Content of a Group.
it	object	The Content of a Group.
ja	object	The Content of a Group.
ko	object	The Content of a Group.
lt	object	The Content of a Group.
lv	object	The Content of a Group.
mn	object	The Content of a Group.
nb	object	The Content of a Group.
nl	object	The Content of a Group.
pl	object	The Content of a Group.
pt	object	The Content of a Group.
ro	object	The Content of a Group.
ru	object	The Content of a Group.
sl	object	The Content of a Group.
sr	object	The Content of a Group.
sv	object	The Content of a Group.
tr	object	The Content of a Group.
vi	object	The Content of a Group.
pt-BR	object	The Content of a Group.
zh-CN	object	The Content of a Group.
zh-TW	object	The Content of a Group.