REST API Reference

Get Custom Object Instance by ID

Intercom API (2.13)

The Intercom API reference.

Download OpenAPI description

api.intercom.io.json

api.intercom.io.yaml

Overview

URL

https://developers.intercom.com

License

MIT

Servers

The production API server

https://api.intercom.io/

The european API server

https://api.eu.intercom.io/

The australian API server

https://api.au.intercom.io/

Admins

Everything about your Admins

Operations

AI Content

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.",

Operations

Articles

Everything about your Articles

Operations

Companies

Everything about your Companies

Operations

Contacts

Everything about your contacts

Operations

Conversations

Everything about your Conversations

Operations

Custom Object Instances

Everything about your Custom Object instances.

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.

Operations

Custom Object Instance

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.

idstring

The Intercom defined id representing the custom object instance.

Example: 16032025

external_idstring

The id you have defined for the custom object instance.

Example: "0001d1c1e65a7a19e9f59ae2"

external_created_atinteger or null(date-time)

The time when the Custom Object instance was created in the external system it originated from.

Example: 1571672154

external_updated_atinteger or null(date-time)

The time when the Custom Object instance was last updated in the external system it originated from.

Example: 1571672154

created_atinteger(date-time)

The time the attribute was created as a UTC Unix timestamp

Example: 1671028894

updated_atinteger(date-time)

The time the attribute was last updated as a UTC Unix timestamp

Example: 1671028894

typestring

The identifier of the custom object type that defines the structure of the custom object instance.

Example: "Order"

custom_attributesobject

The custom attributes you have set on the custom object instance.

{
  "id": 16032025,
  "external_id": "0001d1c1e65a7a19e9f59ae2",
  "external_created_at": 1571672154,
  "external_updated_at": 1571672154,
  "created_at": 1671028894,
  "updated_at": 1671028894,
  "type": "Order",
  "custom_attributes": {
    "property1": "string",
    "property2": "string"
  }
}

Update a contact

Request

You can update an existing contact (ie. user or lead).

This endpoint handles both contact updates and custom object associations.

See update a contact with an association to a custom object instance in the request/response examples to see the custom object association format.

Path

idstringrequired

Example: 63a07ddf05a32042dffac965

Headers

Intercom-Versionstring(intercom_version)

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

Default 2.13

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

Example: 2.13

Bodyapplication/json

One of:

You can update a contact

rolestring

The role of the contact.

external_idstring

A unique identifier for the contact which is given to Intercom

emailstring

The contacts email

Example: "jdoe@example.com"

phonestring or null

The contacts phone

Example: "+353871234567"

namestring or null

The contacts name

Example: "John Doe"

avatarstring or null

An image URL containing the avatar of a contact

Example: "https://www.example.com/avatar_image.jpg"

signed_up_atinteger or null(date-time)

The time specified for when a contact signed up

Example: 1571672154

last_seen_atinteger or null(date-time)

The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually)

Example: 1571672154

owner_idinteger or null

The id of an admin that has been assigned account ownership of the contact

Example: 123

unsubscribed_from_emailsboolean or null

Whether the contact is unsubscribed from emails

Example: true

custom_attributesobject or null

The custom attributes which are set for the contact

curl -i -X PUT \
  https://api.intercom.io/contacts/63a07ddf05a32042dffac965 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Intercom-Version: 2.13' \
  -d '{
    "email": "joebloggs@intercom.io",
    "name": "joe bloggs"
  }'

Responses

successful

Bodyapplication/json

enabled_push_messagingboolean or null

If the user has enabled push messaging.

Example: true

typestring

The type of object.

Example: "contact"

idstring

The unique identifier for the contact which is given by Intercom.

Example: "5ba682d23d7cf92bef87bfd4"

external_idstring or null

The unique identifier for the contact which is provided by the Client.

Example: "70"

workspace_idstring

The id of the workspace which the contact belongs to.

Example: "ecahpwf5"

rolestring

The role of the contact.

Example: "user"

emailstring

The contact's email.

Example: "joe@example.com"

email_domainstring

The contact's email domain.

Example: "example.com"

phonestring or null

The contacts phone.

Example: "+1123456789"

namestring or null

The contacts name.

Example: "John Doe"

owner_idinteger or null

The id of an admin that has been assigned account ownership of the contact.

Example: 123

has_hard_bouncedboolean

Whether the contact has had an email sent to them hard bounce.

Example: true

marked_email_as_spamboolean

Whether the contact has marked an email sent to them as spam.

Example: true

unsubscribed_from_emailsboolean

Whether the contact is unsubscribed from emails.

Example: true

created_atinteger(date-time)

(UNIX timestamp) The time when the contact was created.

Example: 1571672154

updated_atinteger(date-time)

(UNIX timestamp) The time when the contact was last updated.

Example: 1571672154

signed_up_atinteger or null(date-time)

(UNIX timestamp) The time specified for when a contact signed up.

Example: 1571672154

last_seen_atinteger or null(date-time)

(UNIX timestamp) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually).

Example: 1571672154

last_replied_atinteger or null(date-time)

(UNIX timestamp) The time when the contact last messaged in.

Example: 1571672154

last_contacted_atinteger or null(date-time)

(UNIX timestamp) The time when the contact was last messaged.

Example: 1571672154

last_email_opened_atinteger or null(date-time)

(UNIX timestamp) The time when the contact last opened an email.

Example: 1571672154

last_email_clicked_atinteger or null(date-time)

(UNIX timestamp) The time when the contact last clicked a link in an email.

Example: 1571672154

language_overridestring or null

A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change.

Example: "en"

browserstring or null

The name of the browser which the contact is using.

Example: "Chrome"

browser_versionstring or null

The version of the browser which the contact is using.

Example: "80.0.3987.132"

browser_languagestring or null

The language set by the browser which the contact is using.

Example: "en-US"

osstring or null

The operating system which the contact is using.

Example: "Mac OS X"

android_app_namestring or null

The name of the Android app which the contact is using.

Example: "Intercom"

android_app_versionstring or null

The version of the Android app which the contact is using.

Example: "5.0.0"

android_devicestring or null

The Android device which the contact is using.

Example: "Pixel 3"

android_os_versionstring or null

The version of the Android OS which the contact is using.

Example: "10"

android_sdk_versionstring or null

The version of the Android SDK which the contact is using.

Example: "28"

android_last_seen_atinteger or null(date-time)

(UNIX timestamp) The time when the contact was last seen on an Android device.

Example: 1571672154

ios_app_namestring or null

The name of the iOS app which the contact is using.

Example: "Intercom"

ios_app_versionstring or null

The version of the iOS app which the contact is using.

Example: "5.0.0"

ios_devicestring or null

The iOS device which the contact is using.

Example: "iPhone 11"

ios_os_versionstring or null

The version of iOS which the contact is using.

Example: "13.3.1"

ios_sdk_versionstring or null

The version of the iOS SDK which the contact is using.

Example: "13.3.1"

ios_last_seen_atinteger or null(date-time)

(UNIX timestamp) The last time the contact used the iOS app.

Example: 1571672154

custom_attributesobject

The custom attributes which are set for the contact.

avatarobject or null

tagsobject or null(Contact Tags)

An object containing tags meta data about the tags that a contact has. Up to 10 will be displayed here. Use the url to get more.

notesobject(Contact notes)

An object containing notes meta data about the notes that a contact has. Up to 10 will be displayed here. Use the url to get more.

companiesobject(Contact companies)

An object containing companies meta data about the companies that a contact has. Up to 10 will be displayed here. Use the url to get more.

locationobject(Contact Location)

An object containing location meta data about a Intercom contact.

social_profilesobject(Social Profile)

An object containing social profiles that a contact has.

Response

application/json

{
  "type": "contact",
  "id": "677c55486abd011ad17ff4eb",
  "workspace_id": "this_is_an_id279_that_should_be_at_least_",
  "external_id": "70",
  "role": "user",
  "email": "joebloggs@intercom.io",
  "phone": null,
  "name": "joe bloggs",
  "avatar": null,
  "owner_id": null,
  "social_profiles": {
    "type": "list",
    "data": []
  },
  "has_hard_bounced": false,
  "marked_email_as_spam": false,
  "unsubscribed_from_emails": false,
  "created_at": 1736201544,
  "updated_at": 1736201545,
  "signed_up_at": 1736201544,
  "last_seen_at": null,
  "last_replied_at": null,
  "last_contacted_at": null,
  "last_email_opened_at": null,
  "last_email_clicked_at": null,
  "language_override": null,
  "browser": null,
  "browser_version": null,
  "browser_language": null,
  "os": null,
  "location": {
    "type": "location",
    "country": null,
    "region": null,
    "city": null,
    "country_code": null,
    "continent_code": null
  },
  "android_app_name": null,
  "android_app_version": null,
  "android_device": null,
  "android_os_version": null,
  "android_sdk_version": null,
  "android_last_seen_at": null,
  "ios_app_name": null,
  "ios_app_version": null,
  "ios_device": null,
  "ios_os_version": null,
  "ios_sdk_version": null,
  "ios_last_seen_at": null,
  "custom_attributes": {},
  "tags": {
    "type": "list",
    "data": [],
    "url": "/contacts/677c55486abd011ad17ff4eb/tags",
    "total_count": 0,
    "has_more": false
  },
  "notes": {
    "type": "list",
    "data": [],
    "url": "/contacts/677c55486abd011ad17ff4eb/notes",
    "total_count": 0,
    "has_more": false
  },
  "companies": {
    "type": "list",
    "data": [],
    "url": "/contacts/677c55486abd011ad17ff4eb/companies",
    "total_count": 0,
    "has_more": false
  },
  "opted_out_subscription_types": {
    "type": "list",
    "data": [],
    "url": "/contacts/677c55486abd011ad17ff4eb/subscriptions",
    "total_count": 0,
    "has_more": false
  },
  "opted_in_subscription_types": {
    "type": "list",
    "data": [],
    "url": "/contacts/677c55486abd011ad17ff4eb/subscriptions",
    "total_count": 0,
    "has_more": false
  },
  "utm_campaign": null,
  "utm_content": null,
  "utm_medium": null,
  "utm_source": null,
  "utm_term": null,
  "referrer": null,
  "enabled_push_messaging": null
}

Update a conversation

Request

You can update an existing conversation.

Replying and other actions

If you want to reply to a coveration or take an action such as assign, unassign, open, close or snooze, take a look at the reply and manage endpoints.

This endpoint handles both conversation updates and custom object associations.

See update a conversation with an association to a custom object instance in the request/response examples to see the custom object association format.

Path

idintegerrequired

The id of the conversation to target

Example: 123

Query

display_asstring

Set to plaintext to retrieve conversation messages in plain text.

Example: display_as=plaintext

Headers

Intercom-Versionstring(intercom_version)

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

Default 2.13

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

Example: 2.13

Bodyapplication/json

readboolean

Mark a conversation as read within Intercom.

Example: true

titlestring

The title given to the conversation

Example: "Conversation Title"

custom_attributesobject(Custom Attributes)

An object containing the different custom attributes associated to the conversation as key-value pairs. For relationship attributes the value will be a list of custom object instance models.

curl -i -X PUT \
  'https://api.intercom.io/conversations/123?display_as=plaintext' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Intercom-Version: 2.13' \
  -d '{
    "read": true,
    "title": "new conversation title",
    "custom_attributes": {
      "issue_type": "Billing",
      "priority": "High"
    }
  }'

Responses

update a conversation with an association to a custom object instance

Bodyapplication/json

typestring

Always conversation.

Example: "conversation"

idstring

The id representing the conversation.

Example: "1295"

titlestring or null

The title given to the conversation.

Example: "Conversation Title"

created_atinteger(date-time)

The time the conversation was created.

Example: 1663597223

updated_atinteger(date-time)

The last time the conversation was updated.

Example: 1663597260

waiting_sinceinteger or null(date-time)

The last time a Contact responded to an Admin. In other words, the time a customer started waiting for a response. Set to null if last reply is from an Admin.

Example: 1663597260

snoozed_untilinteger or null(date-time)

If set this is the time in the future when this conversation will be marked as open. i.e. it will be in a snoozed state until this time. i.e. it will be in a snoozed state until this time.

Example: 1663597260

openboolean

Indicates whether a conversation is open (true) or closed (false).

Example: true

statestring

Can be set to "open", "closed" or "snoozed".

Enum"open""closed""snoozed"

Example: "open"

readboolean

Indicates whether a conversation has been read.

Example: true

prioritystring

If marked as priority, it will return priority or else not_priority.

Enum"priority""not_priority"

Example: "priority"

admin_assignee_idinteger or null

The id of the admin assigned to the conversation. If it's not assigned to an admin it will return null.

Example: 0

team_assignee_idstring or null

The id of the team assigned to the conversation. If it's not assigned to a team it will return null.

Example: "5017691"

tagsobject(Tags)

A list of tags objects associated with a conversation

conversation_ratingobject or null(Conversation Rating)

The Conversation Rating object which contains information on the rating and/or remark added by a Contact and the Admin assigned to the conversation.

sourceobject(Conversation source)

The type of the conversation part that started this conversation. Can be Contact, Admin, Campaign, Automated or Operator initiated.

contactsobject(Contacts)

The list of contacts (users or leads) involved in this conversation. This will only contain one customer unless more were added via the group conversation feature.

teammatesobject or null(Conversation teammates)

The list of teammates who participated in the conversation (wrote at least one conversation part).

first_contact_replyobject or null(First contact reply)

An object containing information on the first users message. For a contact initiated message this will represent the users original message.

sla_appliedobject or null(Applied SLA)

The SLA Applied object contains the details for which SLA has been applied to this conversation. Important: if there are any canceled sla_events for the conversation - meaning an SLA has been manually removed from a conversation, the sla_status will always be returned as null.

statisticsobject or null(Conversation statistics)

A Statistics object containing all information required for reporting, with timestamps and calculated metrics.

conversation_partsobject(Conversation Parts)

A list of Conversation Part objects for each part message in the conversation. This is only returned when Retrieving a Conversation, and ignored when Listing all Conversations. There is a limit of 500 parts.

linked_objectsobject(Linked Objects)

An object containing metadata about linked conversations and linked tickets. Up to 1000 can be returned.

ai_agent_participatedboolean

Indicates whether the AI Agent participated in the conversation.

Example: true

ai_agentobject(AI Agent)

Data related to AI Agent involvement in the conversation.

Response

application/json

{
  "type": "conversation",
  "id": "507",
  "created_at": 1734537521,
  "updated_at": 1734537523,
  "waiting_since": null,
  "snoozed_until": null,
  "source": {
    "type": "conversation",
    "id": "403918338",
    "delivered_as": "admin_initiated",
    "subject": "",
    "body": "<p>this is the message body</p>",
    "author": { … },
    "attachments": [],
    "url": null,
    "redacted": false
  },
  "contacts": {
    "type": "contact.list",
    "contacts": [ … ]
  },
  "first_contact_reply": null,
  "admin_assignee_id": null,
  "team_assignee_id": null,
  "open": false,
  "state": "closed",
  "read": true,
  "tags": {
    "type": "tag.list",
    "tags": []
  },
  "priority": "not_priority",
  "sla_applied": null,
  "statistics": null,
  "conversation_rating": null,
  "teammates": null,
  "title": null,
  "custom_attributes": {
    "issue_type": "Billing",
    "priority": "High"
  },
  "topics": {},
  "ticket": null,
  "linked_objects": {
    "type": "list",
    "data": [],
    "total_count": 0,
    "has_more": false
  },
  "ai_agent": null,
  "ai_agent_participated": false,
  "conversation_parts": {
    "type": "conversation_part.list",
    "conversation_parts": [ … ],
    "total_count": 2
  }
}

Create or Update a Custom Object Instance

Request

Create or update a custom object instance

Path

custom_object_type_identifierstringrequired

The unique identifier of the custom object type that defines the structure of the custom object instance.

Example: Order

Headers

Intercom-Versionstring(intercom_version)

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

Default 2.13

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

Example: 2.13

Bodyapplication/json

external_idstring

A unique identifier for the Custom Object instance in the external system it originated from.

external_created_atinteger or null(date-time)

The time when the Custom Object instance was created in the external system it originated from.

Example: 1571672154

external_updated_atinteger or null(date-time)

The time when the Custom Object instance was last updated in the external system it originated from.

Example: 1571672154

custom_attributesobject or null

The custom attributes which are set for the Custom Object instance.

curl -i -X POST \
  https://api.intercom.io/custom_object_instances/Order \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Intercom-Version: 2.13' \
  -d '{
    "external_id": "123",
    "external_created_at": 1392036272,
    "external_updated_at": 1392036272,
    "custom_attributes": {
      "order_number": "ORDER-12345",
      "total_amount": 99.99
    }
  }'

Responses

successful

Bodyapplication/json

idstring

The Intercom defined id representing the custom object instance.

Example: 16032025

external_idstring

The id you have defined for the custom object instance.

Example: "0001d1c1e65a7a19e9f59ae2"

external_created_atinteger or null(date-time)

The time when the Custom Object instance was created in the external system it originated from.

Example: 1571672154

external_updated_atinteger or null(date-time)

The time when the Custom Object instance was last updated in the external system it originated from.

Example: 1571672154

created_atinteger(date-time)

The time the attribute was created as a UTC Unix timestamp

Example: 1671028894

updated_atinteger(date-time)

The time the attribute was last updated as a UTC Unix timestamp

Example: 1671028894

typestring

The identifier of the custom object type that defines the structure of the custom object instance.

Example: "Order"

custom_attributesobject

The custom attributes you have set on the custom object instance.

Response

application/json

{
  "id": "22",
  "type": "Order",
  "custom_attributes": {
    "order_number": "ORDER-12345",
    "total_amount": 99.99
  },
  "external_id": "123",
  "external_created_at": 1392036272,
  "external_updated_at": 1392036272,
  "created_at": 1734537745,
  "updated_at": 1734537745
}

Get Custom Object Instance by External ID

Request

Fetch a Custom Object Instance by external_id.

Path

custom_object_type_identifierstringrequired

The unique identifier of the custom object type that defines the structure of the custom object instance.

Example: Order

Query

external_idstring(Find by external_id)required

The unique identifier for the instance in the external system it originated from.

Headers

Intercom-Versionstring(intercom_version)

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

Default 2.13

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

Example: 2.13

curl -i -X GET \
  'https://api.intercom.io/custom_object_instances/Order?external_id=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.13'

Responses

successful

Bodyapplication/json

idstring

The Intercom defined id representing the custom object instance.

Example: 16032025

external_idstring

The id you have defined for the custom object instance.

Example: "0001d1c1e65a7a19e9f59ae2"

external_created_atinteger or null(date-time)

The time when the Custom Object instance was created in the external system it originated from.

Example: 1571672154

external_updated_atinteger or null(date-time)

The time when the Custom Object instance was last updated in the external system it originated from.

Example: 1571672154

created_atinteger(date-time)

The time the attribute was created as a UTC Unix timestamp

Example: 1671028894

updated_atinteger(date-time)

The time the attribute was last updated as a UTC Unix timestamp

Example: 1671028894

typestring

The identifier of the custom object type that defines the structure of the custom object instance.

Example: "Order"

custom_attributesobject

The custom attributes you have set on the custom object instance.

Response

application/json

{
  "id": "24",
  "type": "Order",
  "custom_attributes": {
    "order_number": "ORDER-12345",
    "total_amount": 99.99
  },
  "external_id": "123",
  "external_created_at": null,
  "external_updated_at": null,
  "created_at": 1734537748,
  "updated_at": 1734537748
}

Delete a Custom Object Instance by External ID

Request

Delete a single Custom Object instance by external_id.

Path

custom_object_type_identifierstringrequired

The unique identifier of the custom object type that defines the structure of the custom object instance.

Example: Order

Query

external_idstring(Find by external_id)required

The unique identifier for the instance in the external system it originated from.

Headers

Intercom-Versionstring(intercom_version)

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

Default 2.13

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

Example: 2.13

curl -i -X DELETE \
  'https://api.intercom.io/custom_object_instances/Order?external_id=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.13'

Responses

successful

Bodyapplication/json

objectstring

The unique identifier of the Custom Object type that defines the structure of the Custom Object instance.

Example: "Order"

idstring

The Intercom defined id representing the Custom Object instance.

Example: "123"

deletedboolean

Whether the Custom Object instance is deleted or not.

Example: true

Response

application/json

{
  "id": "26",
  "object": "Order",
  "deleted": true
}

Get Custom Object Instance by ID

Request

Fetch a Custom Object Instance by id.

Path

custom_object_type_identifierstringrequired

The unique identifier of the custom object type that defines the structure of the custom object instance.

Example: Order

idstringrequired

The id or external_id of the custom object instance

Headers

Intercom-Versionstring(intercom_version)

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

Default 2.13

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

Example: 2.13

curl -i -X GET \
  'https://api.intercom.io/custom_object_instances/Order/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.13'

Responses

successful

Bodyapplication/json

idstring

The Intercom defined id representing the custom object instance.

Example: 16032025

external_idstring

The id you have defined for the custom object instance.

Example: "0001d1c1e65a7a19e9f59ae2"

external_created_atinteger or null(date-time)

The time when the Custom Object instance was created in the external system it originated from.

Example: 1571672154

external_updated_atinteger or null(date-time)

The time when the Custom Object instance was last updated in the external system it originated from.

Example: 1571672154

created_atinteger(date-time)

The time the attribute was created as a UTC Unix timestamp

Example: 1671028894

updated_atinteger(date-time)

The time the attribute was last updated as a UTC Unix timestamp

Example: 1671028894

typestring

The identifier of the custom object type that defines the structure of the custom object instance.

Example: "Order"

custom_attributesobject

The custom attributes you have set on the custom object instance.

Response

application/json

{
  "id": "25",
  "type": "Order",
  "custom_attributes": {
    "order_number": "ORDER-12345",
    "total_amount": 99.99
  },
  "external_id": "123",
  "external_created_at": null,
  "external_updated_at": null,
  "created_at": 1734537750,
  "updated_at": 1734537750
}

Delete a Custom Object Instance by ID

Request

Delete a single Custom Object instance using the Intercom defined id.

Path

custom_object_type_identifierstringrequired

The unique identifier of the custom object type that defines the structure of the custom object instance.

Example: Order

idstringrequired

The Intercom defined id of the custom object instance

Headers

Intercom-Versionstring(intercom_version)

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

Default 2.13

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

Example: 2.13

curl -i -X DELETE \
  'https://api.intercom.io/custom_object_instances/Order/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.13'

Responses

successful

Bodyapplication/json

objectstring

The unique identifier of the Custom Object type that defines the structure of the Custom Object instance.

Example: "Order"

idstring

The Intercom defined id representing the Custom Object instance.

Example: "123"

deletedboolean

Whether the Custom Object instance is deleted or not.

Example: true

Response

application/json

{
  "id": "26",
  "object": "Order",
  "deleted": true
}

Data Attributes

Everything about your Data Attributes

Operations

Data Events

Everything about your Data Events

Operations

Data Export

Everything about your Data Exports

Operations

Help Center

Everything about your Help Center

Operations

Messages

Everything about your messages

Operations

News

Everything about your News

Operations

Notes

Everything about your Notes

Operations

Segments

Everything about your Segments

Operations

Subscription Types

Everything about subscription types

Operations

Switch

Everything about Switch

Operations

Teams

Everything about your Teams

Operations

Ticket States

Everything about your ticket states

Operations

Ticket Type Attributes

Everything about your ticket type attributes

Operations

Ticket Types

Everything about your ticket types

Operations

Tickets

Everything about your tickets

Operations

Visitors

Everything about your Visitors

Operations

Intercom API (2.13)

Admins

AI Content

Articles

Companies

Contacts

Conversations

Custom Object Instances

Custom Object Instance

Update a contact

Request

Responses

Was this page helpful?

Update a conversation

RequestExpand all

Responses

Was this page helpful?

Create or Update a Custom Object Instance

RequestExpand all

Responses

Was this page helpful?

Get Custom Object Instance by External ID

Request

Responses

Was this page helpful?

Delete a Custom Object Instance by External ID

Request

Responses

Was this page helpful?

Get Custom Object Instance by ID

Request

Responses

Was this page helpful?

Delete a Custom Object Instance by ID

Request

Responses

Was this page helpful?

Data Attributes

Data Events

Data Export

Help Center

Messages

News

Notes

Segments

Subscription Types

Switch

Tags

Teams

Ticket States

Ticket Type Attributes

Ticket Types

Tickets

Visitors

Models

Request

Request