Intercom API (unofficial showcase)
POST/ai/external_pages

Create or update an external page

Creates an external page in your Fin Content Library, or updates the existing page with the same source and external identifiers. Provide the page title, HTML body, locale, source ID, and source-assigned external ID.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 9 body fields
Intercom-Versionstringoptional
The Intercom API version to use. Defaults to 2.17 when omitted.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

External page details. title, html, locale, source_id, and external_id are required.

titlestringrequired
The title of the external page.
htmlstringrequired
The body of the external page in HTML.
urlstringoptional
The URL of the external page. This will be used by Fin to link end users to the page it based its answer on. When a URL is not present, Fin will not reference the source.
ai_agent_availabilitybooleanoptional
Whether the external page should be used to answer questions by AI Agent. Will not default when updating an existing external page.
Default:false
ai_copilot_availabilitybooleanoptional
Whether the external page should be used to answer questions by AI Copilot. Will not default when updating an existing external page.
Default:false
localestringrequired
Always en
Allowed:enDefault:en
source_idintegerrequired
The unique identifier for the source of the external page which was given by Intercom. Every external page must be associated with a Content Import Source which represents the place it comes from and from which it inherits a default audience (configured in the UI). For a new source, make a POST request to the Content Import Source endpoint and an ID for the source will be returned in the response.
external_idstringrequired
The identifier for the external page which was given by the source. Must be unique for the source.
audience_idsarray<integer>optional
The list of audience IDs to target this external page to for Fin AI Agent. Omitting the field keeps the default audience inherited from the source. Pass `[]` to clear all audience memberships, including the inherited ones. If an external page already exists with the specified source_id and external_id, omitting the field leaves its audience memberships unchanged. Unknown audience IDs return a `404` error.

2 status codes
200Returns the external page, including its identifier, title, HTML, URL, availability settings, locale, source and audience IDs, and timestamps.
typestringrequired
Always external_page
Allowed:external_pageDefault:external_page
idstringrequired
The unique identifier for the external page which is given by Intercom.
titlestringrequired
The title of the external page.
htmlstringrequired
The body of the external page in HTML.
urlstringoptional
The URL of the external page. This will be used by Fin to link end users to the page it based its answer on.
ai_agent_availabilitybooleanrequired
Whether the external page should be used to answer questions by AI Agent.
ai_copilot_availabilitybooleanrequired
Whether the external page should be used to answer questions by AI Copilot.
ai_sales_agent_availabilitybooleanoptional
Whether the external page should be used to answer questions by AI Sales Agent.
fin_availabilitybooleanoptional
Deprecated. Use ai_agent_availability and ai_copilot_availability instead.
localestringrequired
Always en
Allowed:enDefault:en
source_idintegerrequired
The unique identifier for the source of the external page which was given by Intercom. Every external page must be associated with a Content Import Source which represents the place it comes from and from which it inherits a default audience (configured in the UI). For a new source, make a POST request to the Content Import Source endpoint and an ID for the source will be returned in the response.
external_idstringrequired
The identifier for the external page which was given by the source. Must be unique for the source.
audience_idsarray<integer>optional
The list of audience IDs that this external page is targeted to for Fin AI Agent. Empty when the external page has no audience targeting.
created_atintegerrequired
The time when the external page was created.
updated_atintegerrequired
The time when the external page was last updated.
last_ingested_atintegerrequired
The time when the external page was last ingested.
401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 401 is returned when the request is unauthorized. title, html, locale, source_id, and external_id are required; locale must be en, and external_id must be unique for its source.