Custom Object Instances
Everything about your Custom Object instances. {% admonition type="warning" name="Permission Requirements" %} From now on, to access this endpoint, you need additional permissions. Please head over to the Developer Hub app package authentication settings to configure the required permissions. {% /admonition %}
Operations
| Method | Endpoint | Description |
|---|---|---|
PUT | /contacts/{contact_id} | Update a contact |
PUT | /conversations/{conversation_id} | Update a conversation |
GET | /custom_object_instances/{custom_object_type_identifier} | List Custom Object Instances |
POST | /custom_object_instances/{custom_object_type_identifier} | Create or Update a Custom Object Instance |
DELETE | /custom_object_instances/{custom_object_type_identifier} | Delete a Custom Object Instance by External ID |
GET | /custom_object_instances/{custom_object_type_identifier}/{custom_object_instance_id} | Get Custom Object Instance by ID |
DELETE | /custom_object_instances/{custom_object_type_identifier}/{custom_object_instance_id} | Delete a Custom Object Instance by ID |
Example
List Custom Object Instances, with the TypeScript SDK:
ts
import { Intercom } from "@octridev/intercom";
const client = new Intercom({
// Optional: replaces the default server and any server an operation declares.
baseUrl: "https://api.intercom.io",
auth: { bearerAuth: process.env.API_TOKEN! },
});
const result = await client.customObjectInstances.list({
customObjectTypeIdentifier: "customObjectTypeIdentifier",
});
console.log(result);Nine more languages
The same call exists in every SDK. See SDKs for the other nine.