POST/ai/content_import_sources

Create a content import source

Creates a content import source for external pages in your Fin Content Library. Supply sync_behavior as api and provide the source url; you can also set its status and associate audiences.

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

1 parameter · 4 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

Content import source details. sync_behavior and url are required.

sync_behaviorstringrequired
If you intend to create or update External Pages via the API, this should be set to `api`.
Allowed:api
statusstringoptional
The status of the content import source.
Allowed:activedeactivatedDefault:active
urlstringrequired
The URL of the content import source.
audience_idsintegeroptional
The unique identifiers for the audiences to associate with this content import source. Can be a single integer or an array of integers.

2 status codes
200Returns the created content import source, including its identifier, URL, sync behavior, status, audience IDs, and timestamps.
typestringrequired
Always external_page
Allowed:content_import_sourceDefault:content_import_source
idintegerrequired
The unique identifier for the content import source which is given by Intercom.
last_synced_atintegerrequired
The time when the content import source was last synced.
sync_behaviorstringrequired
If you intend to create or update External Pages via the API, this should be set to `api`.
Allowed:apiautomaticmanual
statusstringrequired
The status of the content import source.
Allowed:activedeactivatedDefault:active
urlstringrequired
The URL of the root of the external source.
created_atintegerrequired
The time when the content import source was created.
updated_atintegerrequired
The time when the content import source was last updated.
audience_idsarray<integer>optional
The unique identifiers for the audiences associated with this content import source.
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. sync_behavior must be api, and url must be provided.