Skip to content
Home/
REST API Reference
/
/
Update a content import s...

Update a content import source

Request

You can update an existing content import source.

Security
bearerAuth
Path
source_idstringrequired

The unique identifier for the content import source which is given by Intercom.

Headers
Intercom-Versionstring(intercom_version)

Intercom API version.
By default, it's equal to the version set in the app package.

Default:"2.16"
Enum:"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example:2.16
Bodyapplication/json
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.

Enum:"api""automated""manual"
Example:"api"
statusstring

The status of the content import source.

Default:"active"
Enum:"active""deactivated"
Example:"active"
urlstringrequired

The URL of the content import source. This may only be different from the existing value if the sync behavior is API.

Example:"https://help.example.com"
audience_ids(integer or null) or (Array of integers or null)
Example:
[
  5678
]
One of:

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.

integer or null
apply_audience_to_existing_contentboolean

When true, the audience will be applied to all existing external pages belonging to this content import source.

Default:false
Example:false
curl -i -X PUT \
  'https://api.intercom.io/ai/content_import_sources/{source_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Intercom-Version: 2.16' \
  -d '{
    "sync_behavior": "api",
    "url": "https://www.example.com"
  }'

Responses

successful

Bodyapplication/json
typestringrequired

Always external_page

Default:"content_import_source"
Value:"content_import_source"
Example:"content_import_source"
idintegerrequired

The unique identifier for the content import source which is given by Intercom.

Example:1234
last_synced_atinteger, (date-time)required

The time when the content import source was last synced.

Example:1672928610
sync_behaviorstringrequired

If you intend to create or update External Pages via the API, this should be set to api.

Enum:"api""automatic""manual"
Example:"api"
statusstringrequired

The status of the content import source.

Default:"active"
Enum:"active""deactivated"
Example:"active"
urlstringrequired

The URL of the root of the external source.

Example:"https://help.example.com/"
created_atinteger, (date-time)required

The time when the content import source was created.

Example:1672928359
updated_atinteger, (date-time)required

The time when the content import source was last updated.

Example:1672928610
audience_idsArray of integers or null

The unique identifiers for the audiences associated with this content import source.

Example:
[
  5678
]
Response
{
  "id": 39,
  "type": "content_import_source",
  "last_synced_at": 1734537267,
  "status": "active",
  "url": "https://www.example.com",
  "sync_behavior": "api",
  "created_at": 1734537267,
  "updated_at": 1734537267,
  "audience_ids": []
}