Skip to content

Internal Article

idinteger

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

Example:6871119
titlestring

The title of the article.

bodystring or null

The body of the article in HTML.

Example:"Default language body in html"
body_markdownstring or null

The body of the article in markdown.

Example:"# Internal Guide\n\nBody of the article in markdown\n"
owner_idinteger

The id of the owner of the article.

Example:5017691
author_idinteger

The id of the author of the article.

Example:5017691
created_atinteger, (date-time)

The time when the article was created.

Example:1672928359
updated_atinteger, (date-time)

The time when the article was last updated.

Example:1672928610
localestring

The default locale of the article.

folder_idinteger or null

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

Example:6
audience_idsArray of integers or null

The list of audience IDs this internal article is targeted to for Fin AI Agent. Empty array means no audience targeting is set.

Example:
[ 1, 2 ]
ai_chatbot_availabilityboolean

Whether the internal article is available for AI Chatbot (Fin).

Example:true
ai_copilot_availabilityboolean

Whether the internal article is available for AI Copilot.

Example:true
ai_sales_agent_availabilityboolean

Whether the internal article is available for AI Sales Agent.

Example:true
tagsobject(Tags)

A list of tags objects associated with a conversation, article or internal article

{ "id": 6871119, "title": "string", "body": "Default language body in html", "body_markdown": "# Internal Guide\n\nBody of the article in markdown\n", "owner_id": 5017691, "author_id": 5017691, "created_at": 1672928359, "updated_at": 1672928610, "locale": "string", "folder_id": 6, "audience_ids": [ 1, 2 ], "ai_chatbot_availability": true, "ai_copilot_availability": true, "ai_sales_agent_availability": true, "tags": { "type": "tag.list", "tags": [ … ] } }