POST /help_center/collections

You can create a new collection by making a POST request to https://api.intercom.io/help_center/collections.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Intercom-Version String No

Possible values:

  • "1.1"
  • "2.0"
  • "1.0"
  • "2.9"
  • "Unstable"
  • "1.3"
  • "2.2"
  • "2.12"
  • "1.2"
  • "2.1"
  • "2.4"
  • "1.4"
  • "2.3"
  • "2.6"
  • "2.5"
  • "2.8"
  • "2.10"
  • "2.7"
  • "2.11"

Default value: "2.12"

Request body fields

Name Type Required Description
help_center_id Integer No

The id of the help center where the collection will be created. If null then it will be created in the default help center.

name String Yes

The name of the collection. For multilingual collections, this will be the name of the default language's content.

parent_id String No

The id of the parent collection. If null then it will be created as the first level collection.

description String No

The description of the collection. For multilingual collections, this will be the description of the default language's content.

translated_content Object No

The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group.

translated_content.fr Object No

The Content of a Group.

translated_content.fr.name String No

The name of the collection or section.

translated_content.fr.description String No

The description of the collection. Only available for collections.

translated_content.fr.type String No

The type of object - group_content .

Possible values:

  • "group_content"
  • null
translated_content.hu Object No

The Content of a Group.

translated_content.hu.name String No

The name of the collection or section.

translated_content.hu.description String No

The description of the collection. Only available for collections.

translated_content.hu.type String No

The type of object - group_content .

Possible values:

  • "group_content"
  • null
translated_content.bs Object No

The Content of a Group.

translated_content.bs.name String No

The name of the collection or section.

translated_content.bs.description String No

The description of the collection. Only available for collections.

translated_content.bs.type String No

The type of object - group_content .

Possible values:

  • "group_content"
  • null
translated_content.sl Object No

The Content of a Group.

translated_content.sl.name String No

The name of the collection or section.

translated_content.sl.description String No

The description of the collection. Only available for collections.

translated_content.sl.type String No

The type of object - group_content .

Possible values:

  • "group_content"
  • null
translated_content.id Object No

The Content of a Group.

translated_content.id.name String No

The name of the collection or section.

translated_content.id.description String No

The description of the collection. Only available for collections.

translated_content.id.type String No

The type of object - group_content .

Possible values:

  • "group_content"
  • null
translated_content.zh-TW Object No

The Content of a Group.

translated_content.zh-TW.name String No

The name of the collection or section.

translated_content.zh-TW.description String No

The description of the collection. Only available for collections.

translated_content.zh-TW.type String No

The type of object - group_content .

Possible values:

  • "group_content"
  • null
translated_content.ca Object No

The Content of a Group.

translated_content.ca.name String No

The name of the collection or section.

translated_content.ca.description String No

The description of the collection. Only available for collections.

translated_content.ca.type String No

The type of object - group_content .

Possible values:

  • "group_content"
  • null
translated_content.sr Object No

The Content of a Group.

translated_content.sr.name String No

The name of the collection or section.

translated_content.sr.description String No

The description of the collection. Only available for collections.

translated_content.sr.type String No

The type of object - group_content .

Possible values:

  • "group_content"
  • null
translated_content.mn Object No

The Content of a Group.

translated_content.mn.name String No

The name of the collection or section.

translated_content.mn.description String No

The description of the collection. Only available for collections.

translated_content.mn.type String No

The type of object - group_content .

Possible values:

  • "group_content"
  • null
translated_content.sv Object No

The Content of a Group.

translated_content.sv.name String No

The name of the collection or section.

translated_content.sv.description String No

The description of the collection. Only available for collections.

translated_content.sv.type String No

The type of object - group_content .

Possible values:

  • "group_content"
  • null
translated_content.type String No

The type of object - group_translated_content.

Possible values:

  • "group_translated_content"
  • null
translated_content.ko Object No

The Content of a Group.

translated_content.ko.name String No

The name of the collection or section.

translated_content.ko.description String No

The description of the collection. Only available for collections.

translated_content.ko.type String No

The type of object - group_content .

Possible values:

  • "group_content"
  • null
translated_content.el Object No

The Content of a Group.

translated_content.el.name String No

The name of the collection or section.

translated_content.el.description String No

The description of the collection. Only available for collections.

translated_content.el.type String No

The type of object - group_content .

Possible values:

  • "group_content"
  • null
translated_content.en Object No

The Content of a Group.

translated_content.en.name String No

The name of the collection or section.

translated_content.en.description String No

The description of the collection. Only available for collections.

translated_content.en.type String No

The type of object - group_content .

Possible values:

  • "group_content"
  • null
translated_content.it Object No

The Content of a Group.

translated_content.it.name String No

The name of the collection or section.

translated_content.it.description String No

The description of the collection. Only available for collections.

translated_content.it.type String No

The type of object - group_content .

Possible values:

  • "group_content"
  • null
translated_content.es Object No

The Content of a Group.

translated_content.es.name String No

The name of the collection or section.

translated_content.es.description String No

The description of the collection. Only available for collections.

translated_content.es.type String No

The type of object - group_content .

Possible values:

  • "group_content"
  • null
translated_content.et Object No

The Content of a Group.

translated_content.et.name String No

The name of the collection or section.

translated_content.et.description String No

The description of the collection. Only available for collections.

translated_content.et.type String No

The type of object - group_content .

Possible values:

  • "group_content"
  • null
translated_content.cs Object No

The Content of a Group.

translated_content.cs.name String No

The name of the collection or section.

translated_content.cs.description String No

The description of the collection. Only available for collections.

translated_content.cs.type String No

The type of object - group_content .

Possible values:

  • "group_content"
  • null
translated_content.ar Object No

The Content of a Group.

translated_content.ar.name String No

The name of the collection or section.

translated_content.ar.description String No

The description of the collection. Only available for collections.

translated_content.ar.type String No

The type of object - group_content .

Possible values:

  • "group_content"
  • null
translated_content.vi Object No

The Content of a Group.

translated_content.vi.name String No

The name of the collection or section.

translated_content.vi.description String No

The description of the collection. Only available for collections.

translated_content.vi.type String No

The type of object - group_content .

Possible values:

  • "group_content"
  • null
translated_content.nb Object No

The Content of a Group.

translated_content.nb.name String No

The name of the collection or section.

translated_content.nb.description String No

The description of the collection. Only available for collections.

translated_content.nb.type String No

The type of object - group_content .

Possible values:

  • "group_content"
  • null
translated_content.ja Object No

The Content of a Group.

translated_content.ja.name String No

The name of the collection or section.

translated_content.ja.description String No

The description of the collection. Only available for collections.

translated_content.ja.type String No

The type of object - group_content .

Possible values:

  • "group_content"
  • null
translated_content.pl Object No

The Content of a Group.

translated_content.pl.name String No

The name of the collection or section.

translated_content.pl.description String No

The description of the collection. Only available for collections.

translated_content.pl.type String No

The type of object - group_content .

Possible values:

  • "group_content"
  • null
translated_content.pt-BR Object No

The Content of a Group.

translated_content.pt-BR.name String No

The name of the collection or section.

translated_content.pt-BR.description String No

The description of the collection. Only available for collections.

translated_content.pt-BR.type String No

The type of object - group_content .

Possible values:

  • "group_content"
  • null
translated_content.da Object No

The Content of a Group.

translated_content.da.name String No

The name of the collection or section.

translated_content.da.description String No

The description of the collection. Only available for collections.

translated_content.da.type String No

The type of object - group_content .

Possible values:

  • "group_content"
  • null
translated_content.he Object No

The Content of a Group.

translated_content.he.name String No

The name of the collection or section.

translated_content.he.description String No

The description of the collection. Only available for collections.

translated_content.he.type String No

The type of object - group_content .

Possible values:

  • "group_content"
  • null
translated_content.ro Object No

The Content of a Group.

translated_content.ro.name String No

The name of the collection or section.

translated_content.ro.description String No

The description of the collection. Only available for collections.

translated_content.ro.type String No

The type of object - group_content .

Possible values:

  • "group_content"
  • null
translated_content.nl Object No

The Content of a Group.

translated_content.nl.name String No

The name of the collection or section.

translated_content.nl.description String No

The description of the collection. Only available for collections.

translated_content.nl.type String No

The type of object - group_content .

Possible values:

  • "group_content"
  • null
translated_content.tr Object No

The Content of a Group.

translated_content.tr.name String No

The name of the collection or section.

translated_content.tr.description String No

The description of the collection. Only available for collections.

translated_content.tr.type String No

The type of object - group_content .

Possible values:

  • "group_content"
  • null
translated_content.de Object No

The Content of a Group.

translated_content.de.name String No

The name of the collection or section.

translated_content.de.description String No

The description of the collection. Only available for collections.

translated_content.de.type String No

The type of object - group_content .

Possible values:

  • "group_content"
  • null
translated_content.fi Object No

The Content of a Group.

translated_content.fi.name String No

The name of the collection or section.

translated_content.fi.description String No

The description of the collection. Only available for collections.

translated_content.fi.type String No

The type of object - group_content .

Possible values:

  • "group_content"
  • null
translated_content.ru Object No

The Content of a Group.

translated_content.ru.name String No

The name of the collection or section.

translated_content.ru.description String No

The description of the collection. Only available for collections.

translated_content.ru.type String No

The type of object - group_content .

Possible values:

  • "group_content"
  • null
translated_content.zh-CN Object No

The Content of a Group.

translated_content.zh-CN.name String No

The name of the collection or section.

translated_content.zh-CN.description String No

The description of the collection. Only available for collections.

translated_content.zh-CN.type String No

The type of object - group_content .

Possible values:

  • "group_content"
  • null
translated_content.pt Object No

The Content of a Group.

translated_content.pt.name String No

The name of the collection or section.

translated_content.pt.description String No

The description of the collection. Only available for collections.

translated_content.pt.type String No

The type of object - group_content .

Possible values:

  • "group_content"
  • null
translated_content.bg Object No

The Content of a Group.

translated_content.bg.name String No

The name of the collection or section.

translated_content.bg.description String No

The description of the collection. Only available for collections.

translated_content.bg.type String No

The type of object - group_content .

Possible values:

  • "group_content"
  • null
translated_content.lt Object No

The Content of a Group.

translated_content.lt.name String No

The name of the collection or section.

translated_content.lt.description String No

The description of the collection. Only available for collections.

translated_content.lt.type String No

The type of object - group_content .

Possible values:

  • "group_content"
  • null
translated_content.hr Object No

The Content of a Group.

translated_content.hr.name String No

The name of the collection or section.

translated_content.hr.description String No

The description of the collection. Only available for collections.

translated_content.hr.type String No

The type of object - group_content .

Possible values:

  • "group_content"
  • null
translated_content.lv Object No

The Content of a Group.

translated_content.lv.name String No

The name of the collection or section.

translated_content.lv.description String No

The description of the collection. Only available for collections.

translated_content.lv.type String No

The type of object - group_content .

Possible values:

  • "group_content"
  • null

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.