> ## 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 Article

> Update an Intercom Help Center article's title, body, author, state or collection. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

Update an Intercom Help Center article's title, body, author, state or collection.

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

## 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_article',
  {
    "article_id": 123
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute intercom_update_article --input '{
  "article_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": {
    "type": "article",
    "id": "id_123",
    "workspace_id": "workspace_123"
  }
}
```

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

## Input reference

You can Update an Article

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.article_id` | `integer` | Yes | — | The unique identifier for the article which is given by Intercom. |
| `payload.title` | `string` | No | — | The title of the article.For multilingual articles, this will be the title of the default language's content. |
| `payload.description` | `string` | No | — | The description of the article. For multilingual articles, this will be the description of the default language's content. |
| `payload.body` | `string` | No | — | The content of the article. For multilingual articles, this will be the body of the default language's content. |
| `payload.author_id` | `integer` | No | — | The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace. |
| `payload.state` | `"published" \| "draft"` | No | — | Whether the article will be `published` or will be a `draft`. Defaults to draft. For multilingual articles, this will be the state of the default language's content. Allowed: `published`, `draft`. |
| `payload.parent_id` | `string` | No | — | The id of the article's parent collection or section. An article without this field stands alone. |
| `payload.parent_type` | `string` | No | — | The type of parent, which can either be a `collection` or `section`. |
| `payload.translated_content` | `object` | No | — | The Translated Content of an Article. The keys are the locale codes and the values are the translated content of the article. |

> [!NOTE]
>
> This input schema is too large for an inline display. Read the complete live contract with `deepline describe intercom_update_article --json`.

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | The data returned about your articles when you list them. |
| `result.data.type` | `"article"` | No | `"article"` | The type of object - `article`. Allowed: `article`. |
| `result.data.id` | `string` | No | — | The unique identifier for the article which is given by Intercom. |
| `result.data.workspace_id` | `string` | No | — | The id of the workspace which the article belongs to. |
| `result.data.title` | `string` | No | — | The title of the article. For multilingual articles, this will be the title of the default language's content. |
| `result.data.description` | `string \| null` | No | — | The description of the article. For multilingual articles, this will be the description of the default language's content. |
| `result.data.body` | `string \| null` | No | — | The body of the article in HTML. For multilingual articles, this will be the body of the default language's content. |
| `result.data.author_id` | `integer` | No | — | The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace. |
| `result.data.state` | `"published" \| "draft"` | No | `"draft"` | Whether the article is `published` or is a `draft`. For multilingual articles, this will be the state of the default language's content. Allowed: `published`, `draft`. |
| `result.data.created_at` | `integer` | No | — | The time when the article was created. For multilingual articles, this will be the timestamp of creation of the default language's content in seconds. Format: `date-time`. |
| `result.data.updated_at` | `integer` | No | — | The time when the article was last updated. For multilingual articles, this will be the timestamp of last update of the default language's content in seconds. Format: `date-time`. |
| `result.data.url` | `string \| null` | No | — | The URL of the article. For multilingual articles, this will be the URL of the default language's content. |
| `result.data.parent_id` | `integer \| null` | No | — | The id of the article's parent collection or section. An article without this field stands alone. |
| `result.data.parent_ids` | `array` | No | — | The ids of the article's parent collections or sections. An article without this field stands alone. |
| `result.data.parent_type` | `string \| null` | No | — | The type of parent, which can either be a `collection` or `section`. |
| `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 Article. The keys are the locale codes and the values are the translated content of the article. |
| `result.data.translated_content.type` | `null \| "article_translated_content"` | No | — | The type of object - article\_translated\_content. Allowed: `null`, `article_translated_content`. |
| `result.data.translated_content.ar` | `object \| null` | No | — | The Content of an Article. |
| `result.data.translated_content.ar.type` | `null \| "article_content"` | No | — | The type of object - `article_content` . Allowed: `null`, `article_content`. |
| `result.data.translated_content.ar.title` | `string` | No | — | The title of the article. |
| `result.data.translated_content.ar.description` | `string` | No | — | The description of the article. |
| `result.data.translated_content.ar.body` | `string` | No | — | The body of the article. |
| `result.data.translated_content.ar.author_id` | `integer` | No | — | The ID of the author of the article. |
| `result.data.translated_content.ar.state` | `"published" \| "draft"` | No | — | Whether the article is `published` or is a `draft` . Allowed: `published`, `draft`. |
| `result.data.translated_content.ar.created_at` | `integer` | No | — | The time when the article was created (seconds). Format: `date-time`. |
| `result.data.translated_content.ar.updated_at` | `integer` | No | — | The time when the article was last updated (seconds). Format: `date-time`. |
| `result.data.translated_content.ar.url` | `string` | No | — | The URL of the article. |
| `result.data.translated_content.bg` | `object \| null` | No | — | The Content of an Article. |
| `result.data.translated_content.bg.type` | `null \| "article_content"` | No | — | The type of object - `article_content` . Allowed: `null`, `article_content`. |
| `result.data.translated_content.bg.title` | `string` | No | — | The title of the article. |
| `result.data.translated_content.bg.description` | `string` | No | — | The description of the article. |
| `result.data.translated_content.bg.body` | `string` | No | — | The body of the article. |
| `result.data.translated_content.bg.author_id` | `integer` | No | — | The ID of the author of the article. |
| `result.data.translated_content.bg.state` | `"published" \| "draft"` | No | — | Whether the article is `published` or is a `draft` . Allowed: `published`, `draft`. |
| `result.data.translated_content.bg.created_at` | `integer` | No | — | The time when the article was created (seconds). Format: `date-time`. |
| `result.data.translated_content.bg.updated_at` | `integer` | No | — | The time when the article was last updated (seconds). Format: `date-time`. |
| `result.data.translated_content.bg.url` | `string` | No | — | The URL of the article. |
| `result.data.translated_content.bs` | `object \| null` | No | — | The Content of an Article. |
| `result.data.translated_content.bs.type` | `null \| "article_content"` | No | — | The type of object - `article_content` . Allowed: `null`, `article_content`. |
| `result.data.translated_content.bs.title` | `string` | No | — | The title of the article. |
| `result.data.translated_content.bs.description` | `string` | No | — | The description of the article. |
| `result.data.translated_content.bs.body` | `string` | No | — | The body of the article. |
| `result.data.translated_content.bs.author_id` | `integer` | No | — | The ID of the author of the article. |
| `result.data.translated_content.bs.state` | `"published" \| "draft"` | No | — | Whether the article is `published` or is a `draft` . Allowed: `published`, `draft`. |
| `result.data.translated_content.bs.created_at` | `integer` | No | — | The time when the article was created (seconds). Format: `date-time`. |
| `result.data.translated_content.bs.updated_at` | `integer` | No | — | The time when the article was last updated (seconds). Format: `date-time`. |
| `result.data.translated_content.bs.url` | `string` | No | — | The URL of the article. |
| `result.data.translated_content.ca` | `object \| null` | No | — | The Content of an Article. |
| `result.data.translated_content.ca.type` | `null \| "article_content"` | No | — | The type of object - `article_content` . Allowed: `null`, `article_content`. |

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_article --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.