> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Intercom: Update Collection

> Update an Intercom Help Center collection's name, description or parent. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Update an Intercom Help Center collection's name, description or parent.

> [!NOTE]
>
> Tool ID: `intercom_update_collection`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'intercom_update_collection',
  {
    "collection_id": 123
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute intercom_update_collection --input '{
  "collection_id": 123
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "id": "id_123",
    "workspace_id": "workspace_123",
    "name": "Example"
  }
}
```

Use `deepline describe intercom_update_collection --json` for the latest machine-readable contract.

## Input reference

You can update a collection

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.collection_id` | `integer` | Yes | — | The unique identifier for the collection which is given by Intercom. |
| `payload.name` | `string` | No | — | 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 updated as the first level collection. |

> [!NOTE]
>
> This input schema is too large for an inline display. Read the complete live contract with `deepline describe intercom_update_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.

> [!NOTE]
>
> This output schema is too large for an inline display. Read the complete live contract with `deepline describe intercom_update_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.

## Related documentation

* [Intercom provider guide](https://deepline.com/docs/providers/intercom/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.