Intercom API (2.9)
The intercom API reference.
https://api.intercom.io/
https://api.eu.intercom.io/
https://api.au.intercom.io/
- The production API server
https://api.intercom.io/help_center/sections/{id}
- The european API server
https://api.eu.intercom.io/help_center/sections/{id}
- The australian API server
https://api.au.intercom.io/help_center/sections/{id}
- curl
- Node.js
- Ruby
- PHP
- Python
- Java
- Go
- C#
- R
curl -i -X GET \
https://api.intercom.io/help_center/sections/123 \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Intercom-Version: 2.9'
Section found
The name of the section. For multilingual sections, this will be the name of the default language's content.
The time when the section was created. For multilingual sections, this will be the timestamp of creation of the default language's content.
The time when the section was last updated. For multilingual sections, this will be the timestamp of last update of the default language's content.
The URL of the section. For multilingual help centers, this will be the URL of the section for the default language.
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.
The id of the parent section.
The id of the parent section.
The id of the parent section.
The default locale of the help center. This field is only returned for multilingual help centers.
{ "id": "200", "workspace_id": "this_is_an_id109_that_should_be_at_least_", "name": "English section title", "url": "http://help-center.test/myapp-109/section-19", "order": 19, "created_at": 1717021365, "updated_at": 1717021365, "type": "section", "parent_id": 199 }
The name of the collection. For multilingual collections, this will be the name of the default language's content.
- The production API server
https://api.intercom.io/help_center/sections/{id}
- The european API server
https://api.eu.intercom.io/help_center/sections/{id}
- The australian API server
https://api.au.intercom.io/help_center/sections/{id}
- curl
- Node.js
- Ruby
- PHP
- Python
- Java
- Go
- C#
- R
curl -i -X PUT \
https://api.intercom.io/help_center/sections/123 \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-H 'Intercom-Version: 2.9' \
-d '{
"name": "Update section name",
"parent_id": 205
}'
successful
The name of the section. For multilingual sections, this will be the name of the default language's content.
The time when the section was created. For multilingual sections, this will be the timestamp of creation of the default language's content.
The time when the section was last updated. For multilingual sections, this will be the timestamp of last update of the default language's content.
The URL of the section. For multilingual help centers, this will be the URL of the section for the default language.
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.
The id of the parent section.
The id of the parent section.
The id of the parent section.
The default locale of the help center. This field is only returned for multilingual help centers.
{ "id": "206", "workspace_id": "this_is_an_id115_that_should_be_at_least_", "name": "Update section name", "url": "http://help-center.test/myapp-115/section-22", "order": 22, "created_at": 1717021366, "updated_at": 1717021367, "type": "section", "parent_id": "205" }
- The production API server
https://api.intercom.io/help_center/sections/{id}
- The european API server
https://api.eu.intercom.io/help_center/sections/{id}
- The australian API server
https://api.au.intercom.io/help_center/sections/{id}
- curl
- Node.js
- Ruby
- PHP
- Python
- Java
- Go
- C#
- R
curl -i -X DELETE \
https://api.intercom.io/help_center/sections/123 \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Intercom-Version: 2.9'
{ "id": "212", "object": "section", "deleted": true }