POST /ai/external_pages
You can create a new external page by sending a POST request to this endpoint. If an external page already exists with the specified source_id and external_id, it will be updated instead.
Servers
- https://api.intercom.io
- https://api.eu.intercom.io
- https://api.au.intercom.io
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Intercom-Version |
String | No |
Possible values:
Default value: "2.12" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
source_id |
Integer | Yes |
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. |
html |
String | Yes |
The body of the external page in HTML. |
external_id |
String | Yes |
The identifier for the external page which was given by the source. Must be unique for the source. |
ai_copilot_availability |
Boolean | No |
Whether the external page should be used to answer questions by AI Copilot. Will not default when updating an existing external page. Default value: false |
ai_agent_availability |
Boolean | No |
Whether the external page should be used to answer questions by AI Agent. Will not default when updating an existing external page. Default value: false |
url |
String | No |
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. |
title |
String | Yes |
The title of the external page. |
locale |
String | Yes |
Always en Possible values:
Default value: "en" |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.