API ReferenceBuilding AppsInstalling IntercomAPI & Webhook ReferenceCanvas Kit Reference
DocsApp StoreCommunityBlogYour Apps

The Section model

Example Section Object

{
  "id": 1,
  "type": "section",
 "parent_id": 123,
 "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.

Object Models

Section

FieldTypeDescription
typestringThe type of object - section.
idstringThe unique identifier for the section which is given by Intercom.
workspace_idstringThe id of the workspace which the section belongs to.
namestringThe name of the section. For multilingual sections, this will be the name of the default language's content.
created_atintegerThe time when the section was created. For multilingual sections, this will be the timestamp of creation of the default language's content.
updated_atintegerThe time when the section was last updated. For multilingual sections, this will be the timestamp of last update of the default language's content.
urlstringThe URL of the section. For multilingual help centers, this will be the URL of the section for the default language.
iconstringThe icon of the section.
orderintegerThe 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.
parent_idThe id of the parent section.
default_localestringThe default locale of the help center. This field is only returned for multilingual help centers.
translated_contentobjectThe Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group.

Group Translated Content

FieldTypeDescription
typestringThe type of object - group_translated_content.
arobjectThe Content of a Group.
bgobjectThe Content of a Group.
bsobjectThe Content of a Group.
caobjectThe Content of a Group.
csobjectThe Content of a Group.
daobjectThe Content of a Group.
deobjectThe Content of a Group.
elobjectThe Content of a Group.
enobjectThe Content of a Group.
esobjectThe Content of a Group.
etobjectThe Content of a Group.
fiobjectThe Content of a Group.
frobjectThe Content of a Group.
heobjectThe Content of a Group.
hrobjectThe Content of a Group.
huobjectThe Content of a Group.
idobjectThe Content of a Group.
itobjectThe Content of a Group.
jaobjectThe Content of a Group.
koobjectThe Content of a Group.
ltobjectThe Content of a Group.
lvobjectThe Content of a Group.
mnobjectThe Content of a Group.
nbobjectThe Content of a Group.
nlobjectThe Content of a Group.
plobjectThe Content of a Group.
ptobjectThe Content of a Group.
roobjectThe Content of a Group.
ruobjectThe Content of a Group.
slobjectThe Content of a Group.
srobjectThe Content of a Group.
svobjectThe Content of a Group.
trobjectThe Content of a Group.
viobjectThe Content of a Group.
pt-BRobjectThe Content of a Group.
zh-CNobjectThe Content of a Group.
zh-TWobjectThe Content of a Group.