Article

The Articles API is a central place to gather all information and take actions on your articles. Articles can live within collections and sections, or alternatively they can stand alone.

typestring

The type of object - article.

Default:"article"

Value:"article"

Example:"article"

idstring

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

Example:"6871119"

workspace_idstring

The id of the workspace which the article belongs to.

Example:"hfi1bx4l"

titlestring

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

Example:"Default language title"

descriptionstring or null

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

Example:"Default language description"

bodystring or null

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

Example:"Default language body in html"

body_markdownstring or null

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

Example:"# Default language title\n\nDefault language body in markdown\n"

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.

Example:"5017691"

statestring

Whether the article is published or is a draft. For multilingual articles, this will be the state of the default language's content.

Default:"draft"

Enum:"published""draft"

Example:"published"

created_atinteger, (date-time)

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.

Example:1672928359

updated_atinteger, (date-time)

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.

Example:1672928610

has_unpublished_changesboolean

Whether the published article has unpublished changes staged as a draft on top of its live content. Only returned on the Preview API version. For multilingual articles this reflects the default language's content; a pure draft (never published) reports false.

Example:false

draft_updated_atinteger or null, (date-time)

The time, in seconds, when the staged draft was last edited, or null when there is no staged draft. Only returned on the Preview API version.

Example:1672928610

urlstring or null

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

Example:"http://intercom.test/help/en/articles/3-default-language"

parent_idsArray of integers

The ids of the article's parent collections or sections. An article without this field stands alone.

Example:

[
  18,
  19
]

default_localestring

The default locale of the help center. This field is only returned for multilingual help centers.

Example:"en"

translated_contentobject or null(Article Translated Content)

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

tagsobject(Tags)

A list of tags objects associated with a conversation

folder_idinteger or null

The ID of the folder this article belongs to, or null if not in a folder.

Example:6

ai_chatbot_availabilityboolean

Whether the article is available for AI Chatbot. For multilingual articles, this will be the value of the default language's content.

Example:true

ai_copilot_availabilityboolean

Whether the article is available for AI Copilot. For multilingual articles, this will be the value of the default language's content.

Example:true

ai_sales_agent_availabilityboolean

Whether the article is available for AI Sales Agent. For multilingual articles, this will be the value of the default language's content.

Example:true

created_by_idinteger or nullread-only

The ID of the teammate who created the article. For multilingual articles, this will be the creator of the default language's content.

Example:5017691

updated_by_idinteger or nullread-only

The ID of the teammate who last updated the article. For multilingual articles, this will be the last editor of the default language's content.

Example:5017691

exclude_from_article_suggestionsbooleanread-only

Whether the article is excluded from Fin AI Agent article suggestions.

Example:false

help_center_audiencestring or nullread-only

The audience that can view this article in the Help Center. everyone means all users and visitors can view it; restricted indicates a custom audience ruleset. For multilingual articles, this is the article-level audience.

Enum:"everyone""all_users""all_visitors""all_leads""all_visitors_and_leads""restricted"

Example:"everyone"

scheduled_publish_atinteger or null, (date-time)read-only

The Unix timestamp (in seconds) at which the article is scheduled to be published. null when no publish is scheduled. Mutually exclusive with scheduled_unpublish_at — at most one pending schedule exists per article.

Example:1769443200

scheduled_unpublish_atinteger or null, (date-time)read-only

The Unix timestamp (in seconds) at which the article is scheduled to be unpublished. null when no unpublish is scheduled. Mutually exclusive with scheduled_publish_at — at most one pending schedule exists per article.

Example:1769443200

statisticsobject or null(Article Statistics)

The statistics of an article.

{
  "statistics": {
    "type": "article_statistics",
    "views": 10,
    "conversions": 0,
    "reactions": 10,
    "happy_reaction_percentage": 40,
    "neutral_reaction_percentage": 40,
    "sad_reaction_percentage": 20,
    "fin_involvements": 10,
    "fin_resolutions": 8,
    "fin_resolution_rate": 80
  },
  "type": "article",
  "id": "6871119",
  "workspace_id": "hfi1bx4l",
  "title": "Default language title",
  "description": "Default language description",
  "body": "Default language body in html",
  "body_markdown": "# Default language title\n\nDefault language body in markdown\n",
  "author_id": "5017691",
  "state": "published",
  "created_at": 1672928359,
  "updated_at": 1672928610,
  "has_unpublished_changes": false,
  "draft_updated_at": 1672928610,
  "url": "http://intercom.test/help/en/articles/3-default-language",
  "parent_ids": [
    18,
    19
  ],
  "default_locale": "en",
  "translated_content": {
    "type": "article_translated_content",
    "ar": { … },
    "bg": { … },
    "bs": { … },
    "ca": { … },
    "cs": { … },
    "da": { … },
    "de": { … },
    "el": { … },
    "en": { … },
    "es": { … },
    "et": { … },
    "fi": { … },
    "fr": { … },
    "he": { … },
    "hr": { … },
    "hu": { … },
    "id": { … },
    "it": { … },
    "ja": { … },
    "ko": { … },
    "lt": { … },
    "lv": { … },
    "mn": { … },
    "nb": { … },
    "nl": { … },
    "pl": { … },
    "pt": { … },
    "ro": { … },
    "ru": { … },
    "sl": { … },
    "sr": { … },
    "sv": { … },
    "tr": { … },
    "vi": { … },
    "pt-BR": { … },
    "zh-CN": { … },
    "zh-TW": { … }
  },
  "tags": {
    "type": "tag.list",
    "tags": [ … ]
  },
  "folder_id": 6,
  "ai_chatbot_availability": true,
  "ai_copilot_availability": true,
  "ai_sales_agent_availability": true,
  "created_by_id": 5017691,
  "updated_by_id": 5017691,
  "exclude_from_article_suggestions": false,
  "help_center_audience": "everyone",
  "scheduled_publish_at": 1769443200,
  "scheduled_unpublish_at": 1769443200
}