The intercom API reference.
URL https://developers.intercom.com
License MIT
The intercom API reference.
With the AI Content APIs, you can create and manage External Pages and Content Import Sources for your Fin Content Library.
Â
External Pages are pages that you want Fin to be able to answer questions about. The API for External Pages is a great way to ingest into your Fin Content Library pages that are not publicly accessible and hence can't be crawled by Intercom.
Â
Content Import Sources are the sources of those pages, and they are used to determine the default audience for the pages (configured via the UI). You should create a Content Import Source for each source of External Pages that you want to ingest into your Fin Content Library.
Â
You can then iterate through the content from that source via its API and POST it to the External Pages endpoint. That endpoint has an external_id parameter which allows you to specify the identifier from the source. The endpoint will then either create a new External Page or update an existing one as appropriate.",
A Custom Object Instance represents an instance of a custom object type. This allows you to create and set custom attributes to store data about your customers that is not already captured by Intercom. The parent object includes recommended default attributes and you can add your own custom attributes.
The Intercom defined id representing the custom object instance.
The id you have defined for the custom object instance.
The identifier of the custom object type that defines the structure of the custom object instance.
{ "id": "5a7a19e9f59ae20001d1c1e6", "external_id": "0001d1c1e65a7a19e9f59ae2", "type": "Order", "custom_attributes": { "property1": "string", "property2": "string" } }
A unique identifier for the Custom Object instance in the external system it originated from.
The time when the Custom Object instance was created in the external system it originated from.
The time when the Custom Object instance was last updated in the external system it originated from.
curl -i -X POST \ 'https://api.intercom.io/custom_object_instances/{custom_object_type_identifier}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -H 'Intercom-Version: Unstable' \ -d '{ "external_id": "123", "external_created_at": 1392036272, "external_updated_at": 1392036272 }'
successful
The Intercom defined id representing the custom object instance.
The id you have defined for the custom object instance.
The identifier of the custom object type that defines the structure of the custom object instance.
{ "id": "6", "type": "object_type_identifier_1", "custom_attributes": {}, "external_id": "123", "external_created_at": 1392036272, "external_updated_at": 1392036272, "created_at": 1727857226, "updated_at": 1727857226 }
curl -i -X GET \ 'https://api.intercom.io/custom_object_instances/{custom_object_type_identifier}?external_id=string' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Intercom-Version: Unstable'
successful
The Intercom defined id representing the custom object instance.
The id you have defined for the custom object instance.
The identifier of the custom object type that defines the structure of the custom object instance.
{ "id": "8", "type": "object_type_identifier_4", "custom_attributes": {}, "external_id": "123", "external_created_at": null, "external_updated_at": null, "created_at": 1727857228, "updated_at": 1727857228 }
curl -i -X GET \ 'https://api.intercom.io/custom_object_instances/{custom_object_type_identifier}/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Intercom-Version: Unstable'
successful
The Intercom defined id representing the custom object instance.
The id you have defined for the custom object instance.
The identifier of the custom object type that defines the structure of the custom object instance.
{ "id": "9", "type": "object_type_identifier_6", "custom_attributes": {}, "external_id": "123", "external_created_at": null, "external_updated_at": null, "created_at": 1727857229, "updated_at": 1727857229 }
curl -i -X DELETE \ 'https://api.intercom.io/custom_object_instances/{custom_object_type_identifier}/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Intercom-Version: Unstable'
{ "id": "10", "object": "object_type_identifier_8", "deleted": true }