Skip to content
Home/
REST API Reference
/
/
Update External Page Payl...

Update External Page Payload

You can update an External Page in 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. If omitted, the page's existing URL is removed.

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.

Example:true
ai_copilot_availabilityboolean

Whether the external page should be used to answer questions by AI Copilot.

Example:true
ai_sales_agent_availabilityboolean

Whether the external page should be used to answer questions by AI Sales Agent.

Example:true
localestringrequired

The language code of the external page, for example en or fr. It must be a language supported by the workspace.

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"
audience_idsArray of integers or null

The list of audience IDs to target this external page to for Fin AI Agent. Replaces all existing audience memberships. Omitting the field leaves existing audience memberships unchanged. Pass [] to clear all audience memberships. Unknown audience IDs return a 404 error.

Example:
[
  1,
  2
]
{
  "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,
  "ai_sales_agent_availability": true,
  "locale": "en",
  "source_id": 1234,
  "external_id": "5678",
  "audience_ids": [
    1,
    2
  ]
}