Skip to content

Create External Page Payload

You can add an External Page to your Fin Content Library.

titlestringrequired

The title of the external page.

Example:"Getting started with..."
htmlstringrequired

The body of the external page in HTML.

Example:"<p>Hello world!</p>"
urlstring

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.

Example:"https://help.example.com/en/articles/1234-getting-started"
ai_agent_availabilityboolean

Whether the external page should be used to answer questions by AI Agent. Will not default when updating an existing external page.

Default:false
Example:true
ai_copilot_availabilityboolean

Whether the external page should be used to answer questions by AI Copilot. Will not default when updating an existing external page.

Default:false
Example:true
localestringrequired

Always en

Default:"en"
Value:"en"
Example:"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.

Example:1234
external_idstringrequired

The identifier for the external page which was given by the source. Must be unique for the source.

Example:"5678"
{ "title": "Getting started with...", "html": "<p>Hello world!</p>", "url": "https://help.example.com/en/articles/1234-getting-started", "ai_agent_availability": true, "ai_copilot_availability": true, "locale": "en", "source_id": 1234, "external_id": "5678" }