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.",
Data Attributes are metadata used to describe your contact, company and conversation models. These include standard and custom attributes. By using the data attributes endpoint, you can get the global list of attributes for your workspace, as well as create and archive custom attributes.
The unique identifier for the data attribute which is given by Intercom. Only available for custom attributes.
Value is contact for user/lead attributes and company for company attributes.
Full name of the attribute. Should match the name unless it's a nested attribute. We can split full_name on . to access nested user object values.
Readable description of the attribute.
The data type of the attribute.
The time the attribute was created as a UTC Unix timestamp
The time the attribute was last updated as a UTC Unix timestamp
{ "type": "data_attribute", "id": 12878, "model": "contact", "name": "paid_subscriber", "full_name": "custom_attributes.paid_subscriber", "label": "Paid Subscriber", "description": "Whether the user is a paid subscriber.", "data_type": "boolean", "options": [ "true", "false" ], "api_writable": true, "messenger_writable": false, "ui_writable": true, "custom": true, "archived": false, "created_at": 1671028894, "updated_at": 1671028894, "admin_id": "5712945" }
curl -i -X GET \ 'https://api.intercom.io/data_attributes?include_archived=true&model=contact' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Intercom-Version: Unstable'
{ "type": "list", "data": [ { … }, { … }, { … }, { … }, { … }, { … }, { … }, { … }, { … }, { … }, { … }, { … }, { … }, { … }, { … }, { … }, { … } ] }
The model that the data attribute belongs to.
The type of data stored for this attribute.
The readable description you see in the UI for the attribute.
To create list attributes. Provide a set of hashes with value as the key of the options you want to make. data_type must be string.
curl -i -X POST \ https://api.intercom.io/data_attributes \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -H 'Intercom-Version: Unstable' \ -d '{ "name": "Mithril Shirt", "model": "company", "data_type": "string" }'
Successful
The unique identifier for the data attribute which is given by Intercom. Only available for custom attributes.
Value is contact for user/lead attributes and company for company attributes.
Full name of the attribute. Should match the name unless it's a nested attribute. We can split full_name on . to access nested user object values.
Readable description of the attribute.
The data type of the attribute.
The time the attribute was created as a UTC Unix timestamp
The time the attribute was last updated as a UTC Unix timestamp
{ "id": 21, "type": "data_attribute", "name": "Mithril Shirt", "full_name": "custom_attributes.Mithril Shirt", "label": "Mithril Shirt", "data_type": "string", "api_writable": true, "ui_writable": false, "messenger_writable": false, "custom": true, "archived": false, "admin_id": "991267149", "created_at": 1727857234, "updated_at": 1727857234, "model": "company" }
The readable description you see in the UI for the attribute.
To create list attributes. Provide a set of hashes with value as the key of the options you want to make. data_type must be string.
curl -i -X PUT \ 'https://api.intercom.io/data_attributes/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -H 'Intercom-Version: Unstable' \ -d '{ "description": "Just a plain old ring", "options": [ { "value": "1-10" }, { "value": "11-20" } ], "archived": false }'
Successful
The unique identifier for the data attribute which is given by Intercom. Only available for custom attributes.
Value is contact for user/lead attributes and company for company attributes.
Full name of the attribute. Should match the name unless it's a nested attribute. We can split full_name on . to access nested user object values.
Readable description of the attribute.
The data type of the attribute.
The time the attribute was created as a UTC Unix timestamp
The time the attribute was last updated as a UTC Unix timestamp
{ "id": 28, "type": "data_attribute", "name": "The One Ring", "full_name": "custom_attributes.The One Ring", "label": "The One Ring", "description": "Just a plain old ring", "data_type": "string", "options": [ "1-10", "11-20" ], "api_writable": true, "ui_writable": false, "messenger_writable": true, "custom": true, "archived": false, "admin_id": "991267156", "created_at": 1727857239, "updated_at": 1727857239, "model": "company" }