Sign in

v51

latestOpenAPI 3.0.1MITraw.githubusercontent.com2026-08-01150230854.3 KB
Help Center

Create a collection

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

post/help_center/collections

Headers

Intercom-Version'1.0' | '1.1' | '1.2' | '1.3' | '1.4' | '2.0' | '2.1' | '2.2' | '2.3' | '2.4' | '2.5' | '2.6' | '2.7' | '2.8' | '2.9' | '2.10' | '2.11' | '2.12' | '2.13' | '2.14'

Intercom API version.</br>By default, it's equal to the version set in the app package.

Example:2.14

Request body

namestring required

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

descriptionstring

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

parent_idstring nullable

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

help_center_idinteger nullable

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

Example request

{
  "name": "collection 51",
  "description": "English description",
  "translated_content": {
    "type": "group_translated_content",
    "ar": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "bg": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "bs": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "ca": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "cs": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "da": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "de": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "el": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "en": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "es": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "et": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "fi": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "fr": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "he": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "hr": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "hu": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "id": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "it": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "ja": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "ko": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "lt": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "lv": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "mn": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "nb": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "nl": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "pl": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "pt": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "ro": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "ru": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "sl": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "sr": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "sv": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "tr": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "vi": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "pt-BR": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "zh-CN": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "zh-TW": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    }
  },
  "parent_id": "6871118"
}

Response

collection created

idstring

The unique identifier for the collection which is given by Intercom.

workspace_idstring

The id of the workspace which the collection belongs to.

namestring

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

descriptionstring nullable

The description of the collection. For multilingual help centers, this will be the description of the collection for the default language.

created_atinteger

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_atinteger

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.

urlstring nullable

The URL of the collection. For multilingual help centers, this will be the URL of the collection for the default language.

iconstring nullable

The icon of the collection.

orderinteger

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_localestring

The default locale of the help center. This field is only returned for multilingual help centers.

parent_idstring nullable

The id of the parent collection. If null then it is the first level collection.

help_center_idinteger nullable

The id of the help center the collection is in.

Example response

{
  "id": "6871119",
  "workspace_id": "hfi1bx4l",
  "name": "Default language name",
  "description": "Default language description",
  "created_at": 1672928359,
  "updated_at": 1672928610,
  "url": "http://intercom.test/help/collection/name",
  "icon": "book-bookmark",
  "default_locale": "en",
  "translated_content": {
    "type": "group_translated_content",
    "ar": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "bg": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "bs": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "ca": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "cs": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "da": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "de": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "el": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "en": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "es": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "et": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "fi": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "fr": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "he": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "hr": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "hu": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "id": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "it": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "ja": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "ko": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "lt": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "lv": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "mn": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "nb": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "nl": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "pl": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "pt": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "ro": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "ru": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "sl": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "sr": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "sv": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "tr": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "vi": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "pt-BR": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "zh-CN": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    },
    "zh-TW": {
      "type": "group_content",
      "name": "Collection name",
      "description": " Collection description"
    }
  },
  "parent_id": "6871118"
}