POST/folders

Create a folder

Creates a folder for organizing content. Include a folder object with a name; optionally provide a description, emoji, or parent folder ID.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter ยท 1 body field
Intercom-Versionstringoptional
The Intercom API version to use. Defaults to 2.17 when omitted.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

Folder creation details. Include the folder object and its required name field.

folderobjectrequired
The folder details to create.

3 status codes
200Returns the created folder object, including its ID, name, parent folder, content count, and creation and update times.
idintegeroptional
The unique identifier for the folder
namestringoptional
The name of the folder
descriptionstringoptional
The description of the folder
emojistringoptional
An emoji associated with the folder
parent_folder_idintegeroptional
The ID of the parent folder, or null if this is a root folder
content_countintegeroptional
The number of content items in this folder
created_atintegeroptional
The time when the folder was created (seconds)
updated_atintegeroptional
The time when the folder was last updated (seconds)
400Returned when the request is invalid, including when the required folder details or folder name are missing.
typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
401Returned when the request is not authorized.
typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 400 is returned when the request is invalid; include the required folder object and its required name field. A 401 is returned when the request is not authorized.