PUT/ai/content_import_sources/{source_id}

Update a content import source

Replaces the settings for a content import source in your Fin Content Library. Provide sync_behavior and url; you can also change its status, update its audiences, and apply an audience to existing external pages.

2 parameters · 5 body fields
source_idstringrequired
The unique identifier of the content import source to update.
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 settings. 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`. You can not change the value to or from api.
Allowed:apiautomatedmanual
statusstringoptional
The status of the content import source.
Allowed:activedeactivatedDefault:active
urlstringrequired
The URL of the content import source. This may only be different from the existing value if the sync behavior is API.
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. Set to null or an empty array to remove all audiences.
apply_audience_to_existing_contentbooleanoptional
When true, the audience will be applied to all existing external pages belonging to this content import source.
Default:false

2 status codes
200Returns the updated 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 and url are required, and sync_behavior must be api, automated, or manual; you cannot change the value to or from api.