Create a content import source

Request

You can create a new content import source by sending a POST request to this endpoint.

OAuth tokens must have the read_write_ai_content scope.

Security

bearerAuth

Headers

Intercom-Versionstring(intercom_version)

Intercom API version.
If you omit the header, the API uses the version set in your app package, and 1.0 if none is set.

Enum:"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example:2.17

Bodyapplication/json

sync_behaviorstringrequired

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

Value:"api"

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. It must be an http or https URL whose host is a valid public domain name.

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.

integer or null

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

Responses

successful

Bodyapplication/json

typestringrequired

Always content_import_source

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. A source that is being deleted has the status deletion_in_progress.

Default:"active"

Enum:"active""deactivated""deletion_in_progress"

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": 36,
  "type": "content_import_source",
  "last_synced_at": 1734537261,
  "status": "active",
  "url": "https://www.example.com",
  "sync_behavior": "api",
  "created_at": 1734537261,
  "updated_at": 1734537261,
  "audience_ids": []
}