Stage Article Draft

Stage an article draft

PUT/articles/{id}/draft

Use it in a workflow

Add a step and choose the Intercom connector.
Pick the Stage Article Draft action (under Articles).
Fill in the fields below, then reference the result from later steps as {{stageArticleDraft.response.data}}.

Request

Path parameters

idintegerrequired

The unique identifier for the article which is given by Intercom.

Headers

Intercom-Versionstring

Intercom API version.</br>By default, it's equal to the version set in the app package.

One of1.01.11.21.31.42.02.12.22.32.42.52.62.72.82.92.102.112.122.132.142.152.16Default "2.16"

Request body

Enter the body as JSON in the step's Body field.

titlestring

The title of the article.For multilingual articles, this will be the title of the default language's content.

descriptionstring

The description of the article. For multilingual articles, this will be the description of the default language's content.

bodystring

The content of the article in HTML. For multilingual articles, this will be the body of the default language's content. Mutually exclusive with `body_markdown`.

body_markdownstring

The content of the article in markdown. For multilingual articles, this will be the body of the default language's content. An alternative to `body` — you can provide content as markdown instead of HTML. Mutually exclusive with `body`.

author_idinteger

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.

statestring

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.

One ofpublisheddraft

parent_idstring

The id of the article's parent collection or section. An article without this field stands alone.

parent_typestring

The type of parent, which can either be a `collection` or `section`.

translated_contentobject

The Translated Content of an Article. The keys are the locale codes and the values are the translated content of the article.

typestring

The type of object - article_translated_content.

One ofnullarticle_translated_content

arobject18 fields

The Content of an Article.

bgobject18 fields

The Content of an Article.

bsobject18 fields

The Content of an Article.

caobject18 fields

The Content of an Article.

csobject18 fields

The Content of an Article.

daobject18 fields

The Content of an Article.

deobject18 fields

The Content of an Article.

elobject18 fields

The Content of an Article.

enobject18 fields

The Content of an Article.

esobject18 fields

The Content of an Article.

etobject18 fields

The Content of an Article.

fiobject18 fields

The Content of an Article.

frobject18 fields

The Content of an Article.

heobject18 fields

The Content of an Article.

hrobject18 fields

The Content of an Article.

huobject18 fields

The Content of an Article.

idobject18 fields

The Content of an Article.

itobject18 fields

The Content of an Article.

jaobject18 fields

The Content of an Article.

koobject18 fields

The Content of an Article.

ltobject18 fields

The Content of an Article.

lvobject18 fields

The Content of an Article.

mnobject18 fields

The Content of an Article.

nbobject18 fields

The Content of an Article.

nlobject18 fields

The Content of an Article.

plobject18 fields

The Content of an Article.

ptobject18 fields

The Content of an Article.

roobject18 fields

The Content of an Article.

ruobject18 fields

The Content of an Article.

slobject18 fields

The Content of an Article.

srobject18 fields

The Content of an Article.

svobject18 fields

The Content of an Article.

trobject18 fields

The Content of an Article.

viobject18 fields

The Content of an Article.

pt-BRobject18 fields

The Content of an Article.

zh-CNobject18 fields

The Content of an Article.

zh-TWobject18 fields

The Content of an Article.

audience_idsarray<integer>

The list of audience IDs to assign to this article for Fin AI Agent targeting. Sending a top-level `audience_ids` broadcasts the same set to every locale. Sending `audience_ids: []` clears all audience memberships from every locale. For per-locale targeting, use `translated_content.<locale>.audience_ids` instead. Sending both top-level and per-locale in the same request causes top-level to win. Unknown audience IDs return a 404 error. No partial commit occurs.

ai_chatbot_availabilityboolean

Whether the article should be available for AI Chatbot (Fin). For multilingual articles, this sets the default language's availability.

ai_copilot_availabilityboolean

Whether the article should be available for AI Copilot. For multilingual articles, this sets the default language's availability.

ai_sales_agent_availabilityboolean

Whether the article should be available for AI Sales Agent. For multilingual articles, this sets the default language's availability.

scheduled_publish_atstring (date-time)

ISO 8601 timestamp at which to schedule a future publish of the article. When set together with `state: "published"`, the article is scheduled instead of published immediately. Setting `null` cancels a pending publish schedule. Timestamps in the past or equal to the current time are rejected with 400 `parameter_invalid` — the value must be strictly in the future. Combining with `state: "draft"` returns 400 `parameter_invalid`. Sending in the same request as `scheduled_unpublish_at` returns 400 — only one pending schedule per article. Empty string returns 400 `parameter_invalid`.

scheduled_unpublish_atstring (date-time)

ISO 8601 timestamp at which to schedule a future unpublish of the article. Setting `null` cancels a pending unpublish schedule. Timestamps in the past or equal to the current time are rejected with 400 `parameter_invalid` — the value must be strictly in the future. Rejected with 400 `parameter_invalid` if the article has never been published. Sending in the same request as `scheduled_publish_at` returns 400 — only one pending schedule per article. Empty string returns 400 `parameter_invalid`.

json

{
  "title": "Thanks for everything",
  "description": "Description of the Article",
  "body": "<p>This is the body in html</p>",
  "body_markdown": "## Updated heading\n\nNew content.\n",
  "author_id": 1295,
  "state": "draft",
  "parent_id": "18",
  "parent_type": "collection",
  "translated_content": {
    "type": "article_translated_content",
    "ar": {
      "type": "article_content",
      "title": "How to create a new article",
      "description": "This article will show you how to create a new article.",
      "body": "This is the body of the article.",
      "body_markdown": "# How to create a new article\n\nThis is the body of the article.\n",
      "author_id": "5017691",
      "state": "draft",
      "created_at": 1663597223,
      "updated_at": 1663597260,
      "has_unpublished_changes": false,
      "draft_updated_at": 1663597260,
      "url": "string"
    },
    "bg": {
      "type": "article_content",
      "title": "How to create a new article",
      "description": "This article will show you how to create a new article.",
      "body": "This is the body of the article.",
      "body_markdown": "# How to create a new article\n\nThis is the body of the article.\n",
      "author_id": "5017691",
      "state": "draft",
      "created_at": 1663597223,
      "updated_at": 1663597260,
      "has_unpublished_changes": false,
      "draft_updated_at": 1663597260,
      "url": "string"
    },
    "bs": {
      "type": "article_content",
      "title": "How to create a new article",
      "description": "This article will show you how to create a new article.",
      "body": "This is the body of the article.",
      "body_markdown": "# How to create a new article\n\nThis is the body of the article.\n",
      "author_id": "5017691",
      "state": "draft",
      "created_at": 1663597223,
      "updated_at": 1663597260,
      "has_unpublished_changes": false,
      "draft_updated_at": 1663597260,
      "url": "string"
    },
    "ca": {
      "type": "article_content",
      "title": "How to create a new article",
      "description": "This article will show you how to create a new article.",
      "body": "This is the body of the article.",
      "body_markdown": "# How to create a new article\n\nThis is the body of the article.\n",
      "author_id": "5017691",
      "state": "draft",
      "created_at": 1663597223,
      "updated_at": 1663597260,
      "has_unpublished_changes": false,
      "draft_updated_at": 1663597260,
      "url": "string"
    },
    "cs": {
      "type": "article_content",
      "title": "How to create a new article",
      "description": "This article will show you how to create a new article.",
      "body": "This is the body of the article.",
      "body_markdown": "# How to create a new article\n\nThis is the body of the article.\n",
      "author_id": "5017691",
      "state": "draft",
      "created_at": 1663597223,
      "updated_at": 1663597260,
      "has_unpublished_changes": false,
      "draft_updated_at": 1663597260,
      "url": "string"
    },
    "da": {
      "type": "article_content",
      "title": "How to create a new article",
      "description": "This article will show you how to create a new article.",
      "body": "This is the body of the article.",
      "body_markdown": "# How to create a new article\n\nThis is the body of the article.\n",
      "author_id": "5017691",
      "state": "draft",
      "created_at": 1663597223,
      "updated_at": 1663597260,
      "has_unpublished_changes": false,
      "draft_updated_at": 1663597260,
      "url": "string"
    },
    "de": {
      "type": "article_content",
      "title": "How to create a new article",
      "description": "This article will show you how to create a new article.",
      "body": "This is the body of the article.",
      "body_markdown": "# How to create a new article\n\nThis is the body of the article.\n",
      "author_id": "5017691",
      "state": "draft",
      "created_at": 1663597223,
      "updated_at": 1663597260,
      "has_unpublished_changes": false,
      "draft_updated_at": 1663597260,
      "url": "string"
    },
    "el": {
      "type": "article_content",
      "title": "How to create a new article",
      "description": "This article will show you how to create a new article.",
      "body": "This is the body of the article.",
      "body_markdown": "# How to create a new article\n\nThis is the body of the article.\n",
      "author_id": "5017691",
      "state": "draft",
      "created_at": 1663597223,
      "updated_at": 1663597260,
      "has_unpublished_changes": false,
      "draft_updated_at": 1663597260,
      "url": "string"
    },
    "en": {
      "type": "article_content",
      "title": "How to create a new article",
      "description": "This article will show you how to create a new article.",
      "body": "This is the body of the article.",
      "body_markdown": "# How to create a new article\n\nThis is the body of the article.\n",
      "author_id": "5017691",
      "state": "draft",
      "created_at": 1663597223,
      "updated_at": 1663597260,
      "has_unpublished_changes": false,
      "draft_updated_at": 1663597260,
      "url": "string"
    },
    "es": {
      "type": "article_content",
      "title": "How to create a new article",
      "description": "This article will show you how to create a new article.",
      "body": "This is the body of the article.",
      "body_markdown": "# How to create a new article\n\nThis is the body of the article.\n",
      "author_id": "5017691",
      "state": "draft",
      "created_at": 1663597223,
      "updated_at": 1663597260,
      "has_unpublished_changes": false,
      "draft_updated_at": 1663597260,
      "url": "string"
    },
    "et": {
      "type": "article_content",
      "title": "How to create a new article",
      "description": "This article will show you how to create a new article.",
      "body": "This is the body of the article.",
      "body_markdown": "# How to create a new article\n\nThis is the body of the article.\n",
      "author_id": "5017691",
      "state": "draft",
      "created_at": 1663597223,
      "updated_at": 1663597260,
      "has_unpublished_changes": false,
      "draft_updated_at": 1663597260,
      "url": "string"
    }
  },
  "audience_ids": [
    1,
    2
  ],
  "ai_chatbot_availability": true,
  "ai_copilot_availability": true
}

Response

Returns 200 with an object. Read it in later steps with {{stageArticleDraft.response.data.<field>}}.

statisticsobject

The statistics of an article.

typestring

The type of object - `article_statistics`.

One ofarticle_statisticsDefault "article_statistics"

viewsinteger

The number of total views the article has received.

conversionsinteger

The number of conversations started from the article.

reactionsinteger

The number of total reactions the article has received.

happy_reaction_percentagenumber (float)

The percentage of happy reactions the article has received against other types of reaction.

neutral_reaction_percentagenumber (float)

The percentage of neutral reactions the article has received against other types of reaction.

sad_reaction_percentagenumber (float)

The percentage of sad reactions the article has received against

fin_involvementsinteger

The number of conversations in which Fin AI Agent used this article, summed across all of the article's locales.

fin_resolutionsinteger

The number of conversations Fin AI Agent resolved using this article, summed across all of the article's locales.

fin_resolution_ratenumber (float)

The percentage of Fin AI Agent involvements that resulted in a resolution (fin_resolutions / fin_involvements * 100).

json

{
  "statistics": {
    "type": "article_statistics",
    "views": 10,
    "conversions": 0,
    "reactions": 10,
    "happy_reaction_percentage": 40,
    "neutral_reaction_percentage": 40,
    "sad_reaction_percentage": 0,
    "fin_involvements": 10,
    "fin_resolutions": 8,
    "fin_resolution_rate": 80
  }
}

Need more? See the Intercom guide for connection setup and behaviour shared by every action.

Was this page helpful?