Update a collection

You can update the details of a single collection by making a PUT request to https://api.intercom.io/collections/<id>.

SecurityHTTP: bearerAuth

Request

path Parameters

required

integer

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

Example: 123

header Parameters

Intercom-Version

string (intercom_version)

Default: 2.11

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

Enum: "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" "Unstable"

Example: 2.11

Request Body schema: application/json

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 collections, this will be the description of the default language's content.
	object or null (Group Translated Content) The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group.
parent_id	string or null The id of the parent collection. If `null` then it will be updated as the first level collection.

put

/help_center/collections/{id}

Request samples
Payload
curl
Node.js
Ruby
PHP
Python
Java
Go
C#
R
5 more
application/json
successful
{
"name": "Update collection name"
}

Responses

200

successful

Response Schema: application/json

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 or null The description of the collection. For multilingual help centers, this will be the description of the collection for the default language.
created_at	integer <date-time> 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_at	integer <date-time> 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.
url	string or null The URL of the collection. For multilingual help centers, this will be the URL of the collection for the default language.
icon	string or null 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.
	object or null (Group Translated Content) The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group.
parent_id	string or null The id of the parent collection. If `null` then it is the first level collection.
help_center_id	integer or null The id of the help center the collection is in.

401

Unauthorized

404

Collection Not Found

Response samples
200
401
404
application/json
successful
{
"id": "750",
"workspace_id": "this_is_an_id70_that_should_be_at_least_4",
"name": "Update collection name",
"url": "http://help-center.test/myapp-70/collection-25",
"order": 25,
"created_at": 1715077769,
"updated_at": 1715077769,
"description": "english collection description",
"icon": "folder",
"parent_id": null,
"help_center_id": 365
}