Intercom: Create Collection

Create a collection.

Tool ID: intercom_create_collection

Run this action

Use the TypeScript SDK for a single call. Put ctx.tools.execute(...) inside a Play when the call should be durable, scheduled, or run across a CSV.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'intercom_create_collection',
  {
    "name": "Example"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute intercom_create_collection --input '{
  "name": "Example"
}' --json

Example response

The SDK exposes this shape at result.toolResponse.raw. Values below are representative.

{
  "data": {
    "id": "id_123",
    "workspace_id": "workspace_123",
    "name": "Example"
  }
}

Use deepline tools get intercom_create_collection --json for the latest machine-readable contract.

Input reference

You can create a collection

Name	Type	Required	Default	Details
`payload.name`	`string`	Yes	—	The name of the collection. For multilingual collections, this will be the name of the default language’s content.
`payload.description`	`string`	No	—	The description of the collection. For multilingual collections, this will be the description of the default language’s content.
`payload.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.
`payload.parent_id`	`string`	No	—	The id of the parent collection. If `null` then it will be created as the first level collection.
`payload.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.

This input schema is too large to embed without slowing the page. Get the complete live contract with deepline tools get intercom_create_collection --json.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Collections are top level containers for Articles within the Help Center.
`result.data.id`	`string`	No	—	The unique identifier for the collection which is given by Intercom.
`result.data.workspace_id`	`string`	No	—	The id of the workspace which the collection belongs to.
`result.data.name`	`string`	No	—	The name of the collection. For multilingual collections, this will be the name of the default language’s content.
`result.data.description`	`string \| null`	No	—	The description of the collection. For multilingual help centers, this will be the description of the collection for the default language.
`result.data.created_at`	`integer`	No	—	The time when the article was created (seconds). For multilingual articles, this will be the timestamp of creation of the default language’s content. Format: `date-time`.
`result.data.updated_at`	`integer`	No	—	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. Format: `date-time`.
`result.data.url`	`string \| null`	No	—	The URL of the collection. For multilingual help centers, this will be the URL of the collection for the default language.
`result.data.icon`	`string \| null`	No	—	The icon of the collection.
`result.data.order`	`integer`	No	—	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.
`result.data.default_locale`	`string`	No	—	The default locale of the help center. This field is only returned for multilingual help centers.
`result.data.translated_content`	`object \| null`	No	—	The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group.
`result.data.translated_content.type`	`null \| "group_translated_content"`	No	—	The type of object - group_translated_content. Allowed: `null`, `group_translated_content`.
`result.data.translated_content.ar`	`object \| null`	No	—	The Content of a Group.
`result.data.translated_content.ar.type`	`null \| "group_content"`	No	—	The type of object - `group_content` . Allowed: `null`, `group_content`.
`result.data.translated_content.ar.name`	`string`	No	—	The name of the collection or section.
`result.data.translated_content.ar.description`	`string`	No	—	The description of the collection. Only available for collections.
`result.data.translated_content.bg`	`object \| null`	No	—	The Content of a Group.
`result.data.translated_content.bg.type`	`null \| "group_content"`	No	—	The type of object - `group_content` . Allowed: `null`, `group_content`.
`result.data.translated_content.bg.name`	`string`	No	—	The name of the collection or section.
`result.data.translated_content.bg.description`	`string`	No	—	The description of the collection. Only available for collections.
`result.data.translated_content.bs`	`object \| null`	No	—	The Content of a Group.
`result.data.translated_content.bs.type`	`null \| "group_content"`	No	—	The type of object - `group_content` . Allowed: `null`, `group_content`.
`result.data.translated_content.bs.name`	`string`	No	—	The name of the collection or section.
`result.data.translated_content.bs.description`	`string`	No	—	The description of the collection. Only available for collections.
`result.data.translated_content.ca`	`object \| null`	No	—	The Content of a Group.
`result.data.translated_content.ca.type`	`null \| "group_content"`	No	—	The type of object - `group_content` . Allowed: `null`, `group_content`.
`result.data.translated_content.ca.name`	`string`	No	—	The name of the collection or section.
`result.data.translated_content.ca.description`	`string`	No	—	The description of the collection. Only available for collections.
`result.data.translated_content.cs`	`object \| null`	No	—	The Content of a Group.
`result.data.translated_content.cs.type`	`null \| "group_content"`	No	—	The type of object - `group_content` . Allowed: `null`, `group_content`.
`result.data.translated_content.cs.name`	`string`	No	—	The name of the collection or section.
`result.data.translated_content.cs.description`	`string`	No	—	The description of the collection. Only available for collections.
`result.data.translated_content.da`	`object \| null`	No	—	The Content of a Group.
`result.data.translated_content.da.type`	`null \| "group_content"`	No	—	The type of object - `group_content` . Allowed: `null`, `group_content`.
`result.data.translated_content.da.name`	`string`	No	—	The name of the collection or section.
`result.data.translated_content.da.description`	`string`	No	—	The description of the collection. Only available for collections.
`result.data.translated_content.de`	`object \| null`	No	—	The Content of a Group.
`result.data.translated_content.de.type`	`null \| "group_content"`	No	—	The type of object - `group_content` . Allowed: `null`, `group_content`.
`result.data.translated_content.de.name`	`string`	No	—	The name of the collection or section.
`result.data.translated_content.de.description`	`string`	No	—	The description of the collection. Only available for collections.
`result.data.translated_content.el`	`object \| null`	No	—	The Content of a Group.
`result.data.translated_content.el.type`	`null \| "group_content"`	No	—	The type of object - `group_content` . Allowed: `null`, `group_content`.
`result.data.translated_content.el.name`	`string`	No	—	The name of the collection or section.
`result.data.translated_content.el.description`	`string`	No	—	The description of the collection. Only available for collections.
`result.data.translated_content.en`	`object \| null`	No	—	The Content of a Group.
`result.data.translated_content.en.type`	`null \| "group_content"`	No	—	The type of object - `group_content` . Allowed: `null`, `group_content`.
`result.data.translated_content.en.name`	`string`	No	—	The name of the collection or section.
`result.data.translated_content.en.description`	`string`	No	—	The description of the collection. Only available for collections.
`result.data.translated_content.es`	`object \| null`	No	—	The Content of a Group.

The table shows the first 50 fields. Use the live contract below for every field.

This output schema is too large to embed without slowing the page. Get the complete live contract with deepline tools get intercom_create_collection --json.

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

Get started

Build and automate

Common workflows

Data and integrations

Reference

Intercom: Create Collection

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation