contact_social_profiles
{
"type": "object",
"title": "Social Profile",
"nullable": false,
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/social_profile"
},
"description": "A list of social profiles objects associated with the contact."
}
},
"description": "An object containing social profiles that a contact has."
}
contact_subscription_types
{
"type": "object",
"title": "Contact Subscription Types",
"nullable": false,
"properties": {
"url": {
"type": "string",
"format": "uri",
"example": "/contacts/5ba682d23d7cf92bef87bfd4/subscriptions",
"description": "Url to get more subscription type resources for this contact"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/addressable_list"
},
"description": "This object represents the subscriptions attached to a contact."
},
"has_more": {
"type": "boolean",
"example": true,
"description": "Whether there's more Addressable Objects to be viewed. If true, use the url to view all"
},
"total_count": {
"type": "integer",
"example": 100,
"description": "Int representing the total number of subscription types attached to this contact"
}
},
"description": "An object containing Subscription Types meta data about the SubscriptionTypes that a contact has."
}
contact_tags
{
"type": "object",
"title": "Contact Tags",
"nullable": true,
"properties": {
"url": {
"type": "string",
"format": "uri",
"example": "/contacts/5ba682d23d7cf92bef87bfd4/tags",
"description": "url to get more tag resources for this contact"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/addressable_list"
},
"description": "This object represents the tags attached to a contact."
},
"has_more": {
"type": "boolean",
"example": true,
"description": "Whether there's more Addressable Objects to be viewed. If true, use the url to view all"
},
"total_count": {
"type": "integer",
"example": 100,
"description": "Int representing the total number of tags attached to this contact"
}
},
"description": "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."
}
contact_unarchived
{
"type": "object",
"title": "Contact Unarchived",
"properties": {
"id": {
"type": "string",
"example": "5ba682d23d7cf92bef87bfd4",
"description": "The unique identifier for the contact which is given by Intercom."
},
"type": {
"enum": [
"contact"
],
"type": "string",
"example": "contact",
"description": "always contact"
},
"archived": {
"type": "boolean",
"example": false,
"description": "Whether the contact is archived or not."
},
"external_id": {
"type": "string",
"example": "f3b87a2e09d514c6c2e79b9a",
"nullable": true,
"description": "The unique identifier for the contact which is provided by the Client."
}
},
"description": "unarchived contact object"
}
conversation
{
"type": "object",
"title": "Conversation",
"x-tags": [
"Conversations"
],
"properties": {
"id": {
"type": "string",
"example": "1295",
"description": "The id representing the conversation."
},
"open": {
"type": "boolean",
"example": true,
"description": "Indicates whether a conversation is open (true) or closed (false)."
},
"read": {
"type": "boolean",
"example": true,
"description": "Indicates whether a conversation has been read."
},
"tags": {
"$ref": "#/components/schemas/tags"
},
"type": {
"type": "string",
"example": "conversation",
"description": "Always conversation."
},
"state": {
"enum": [
"open",
"closed",
"snoozed"
],
"type": "string",
"example": "open",
"description": "Can be set to \"open\", \"closed\" or \"snoozed\"."
},
"title": {
"type": "string",
"example": "Conversation Title",
"nullable": true,
"description": "The title given to the conversation."
},
"source": {
"$ref": "#/components/schemas/conversation_source"
},
"contacts": {
"$ref": "#/components/schemas/conversation_contacts"
},
"priority": {
"enum": [
"priority",
"not_priority"
],
"type": "string",
"example": "priority",
"description": "If marked as priority, it will return priority or else not_priority."
},
"teammates": {
"$ref": "#/components/schemas/conversation_teammates"
},
"created_at": {
"type": "integer",
"format": "date-time",
"example": 1663597223,
"description": "The time the conversation was created."
},
"statistics": {
"$ref": "#/components/schemas/conversation_statistics"
},
"updated_at": {
"type": "integer",
"format": "date-time",
"example": 1663597260,
"description": "The last time the conversation was updated."
},
"sla_applied": {
"$ref": "#/components/schemas/sla_applied"
},
"snoozed_until": {
"type": "integer",
"format": "date-time",
"example": 1663597260,
"nullable": true,
"description": "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."
},
"waiting_since": {
"type": "integer",
"format": "date-time",
"example": 1663597260,
"nullable": true,
"description": "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."
},
"team_assignee_id": {
"type": "string",
"example": "5017691",
"nullable": true,
"description": "The id of the team assigned to the conversation. If it's not assigned to a team it will return null."
},
"admin_assignee_id": {
"type": "integer",
"example": 0,
"nullable": true,
"description": "The id of the admin assigned to the conversation. If it's not assigned to an admin it will return null."
},
"custom_attributes": {
"$ref": "#/components/schemas/custom_attributes"
},
"conversation_parts": {
"$ref": "#/components/schemas/conversation_parts"
},
"conversation_rating": {
"$ref": "#/components/schemas/conversation_rating"
},
"first_contact_reply": {
"$ref": "#/components/schemas/conversation_first_contact_reply"
}
},
"description": "Conversations are how you can communicate with users in Intercom. They are created when a contact replies to an outbound message, or when one admin directly sends a message to a single contact."
}
conversation_attachment_files
{
"type": "object",
"title": "Conversation attachment files",
"properties": {
"data": {
"type": "string",
"example": "ewogICJ0ZXN0IjogMQp9",
"description": "The base64 encoded file data."
},
"name": {
"type": "string",
"example": "test.json",
"description": "The name of the file."
},
"content_type": {
"type": "string",
"example": "application/json",
"description": "The content type of the file"
}
},
"description": "Properties of the attachment files in a conversation part"
}
conversation_contacts
{
"type": "object",
"title": "Contacts",
"properties": {
"type": {
"enum": [
"contact.list"
],
"type": "string",
"example": "contact.list",
"description": ""
},
"contacts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/contact_reference"
},
"description": "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."
}
},
"description": "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."
}
conversation_first_contact_reply
{
"type": "object",
"title": "First contact reply",
"nullable": true,
"properties": {
"url": {
"type": "string",
"example": "https://developers.intercom.com/",
"nullable": true,
"description": ""
},
"type": {
"type": "string",
"example": "conversation",
"description": ""
},
"created_at": {
"type": "integer",
"format": "date-time",
"example": 1663597223,
"description": ""
}
},
"description": "An object containing information on the first users message. For a contact initiated message this will represent the users original message."
}
conversation_list
{
"type": "object",
"title": "Conversation List",
"properties": {
"type": {
"enum": [
"conversation.list"
],
"type": "string",
"example": "conversation.list",
"description": "Always conversation.list"
},
"pages": {
"$ref": "#/components/schemas/cursor_pages"
},
"total_count": {
"type": "integer",
"example": 12345,
"description": "A count of the total number of objects."
},
"conversations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/conversation"
},
"description": "The list of conversation objects"
}
},
"description": "Conversations are how you can communicate with users in Intercom. They are created when a contact replies to an outbound message, or when one admin directly sends a message to a single contact."
}
conversation_part
{
"type": "object",
"title": "Conversation Part",
"properties": {
"id": {
"type": "string",
"example": "3",
"description": "The id representing the conversation part."
},
"body": {
"type": "string",
"example": "<p>Okay!</p>",
"nullable": true,
"description": "The message body, which may contain HTML. For Twitter, this will show a generic message regarding why the body is obscured."
},
"type": {
"type": "string",
"example": "conversation_part",
"description": "Always conversation_part"
},
"author": {
"$ref": "#/components/schemas/conversation_part_author"
},
"redacted": {
"type": "boolean",
"example": false,
"description": "Whether or not the conversation part has been redacted."
},
"part_type": {
"type": "string",
"example": "comment",
"description": "The type of conversation part."
},
"created_at": {
"type": "integer",
"format": "date-time",
"example": 1663597223,
"description": "The time the conversation part was created."
},
"updated_at": {
"type": "integer",
"format": "date-time",
"example": 1663597260,
"description": "The last time the conversation part was updated."
},
"assigned_to": {
"$ref": "#/components/schemas/reference",
"nullable": true,
"description": "The id of the admin that was assigned the conversation by this conversation_part (null if there has been no change in assignment.)"
},
"attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/part_attachment"
},
"title": "Conversation part attachments",
"description": "A list of attachments for the part."
},
"external_id": {
"type": "string",
"example": "abcd1234",
"nullable": true,
"description": "The external id of the conversation part"
},
"notified_at": {
"type": "integer",
"format": "date-time",
"example": 1663597260,
"description": "The time the user was notified with the conversation part."
}
},
"description": "A Conversation Part represents a message in the conversation."
}
conversation_part_author
{
"type": "object",
"title": "Conversation part author",
"properties": {
"id": {
"type": "string",
"example": "274",
"description": "The id of the author"
},
"name": {
"type": "string",
"example": "Operator",
"description": "The name of the author"
},
"type": {
"type": "string",
"example": "admin",
"description": "The type of the author"
},
"email": {
"type": "string",
"format": "email",
"example": "operator+abcd1234@intercom.io",
"description": "The email of the author"
}
},
"description": "The object who initiated the conversation, which can be a Contact, Admin or Team. Bots and campaigns send messages on behalf of Admins or Teams. For Twitter, this will be blank."
}
conversation_parts
{
"type": "object",
"title": "Conversation Parts",
"properties": {
"type": {
"enum": [
"conversation_part.list"
],
"type": "string",
"example": "conversation_part.list",
"description": ""
},
"total_count": {
"type": "integer",
"example": 2,
"description": ""
},
"conversation_parts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/conversation_part"
},
"title": "Conversation Parts",
"description": "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."
}
},
"description": "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."
}
conversation_rating
{
"type": "object",
"title": "Conversation Rating",
"nullable": true,
"properties": {
"rating": {
"type": "integer",
"example": 5,
"description": "The rating, between 1 and 5, for the conversation."
},
"remark": {
"type": "string",
"example": "",
"description": "An optional field to add a remark to correspond to the number rating"
},
"contact": {
"$ref": "#/components/schemas/contact_reference"
},
"teammate": {
"$ref": "#/components/schemas/reference"
},
"created_at": {
"type": "integer",
"format": "date-time",
"example": 1671028894,
"description": "The time the rating was requested in the conversation being rated."
}
},
"description": "The Conversation Rating object which contains information on the rating and/or remark added by a Contact and the Admin assigned to the conversation."
}
conversation_source
{
"type": "object",
"title": "Conversation source",
"properties": {
"id": {
"type": "string",
"example": "3",
"description": "The id representing the message."
},
"url": {
"type": "string",
"example": null,
"nullable": true,
"description": "The URL where the conversation was started. For Twitter, Email, and Bots, this will be blank."
},
"body": {
"type": "string",
"example": "<p>Hey there!</p>",
"description": "The message body, which may contain HTML. For Twitter, this will show a generic message regarding why the body is obscured."
},
"type": {
"type": "string",
"example": "conversation",
"description": "This includes conversation, email, facebook, instagram, phone_call, phone_switch, push, sms, twitter and whatsapp."
},
"author": {
"$ref": "#/components/schemas/conversation_part_author"
},
"subject": {
"type": "string",
"example": "",
"description": "Optional. The message subject. For Twitter, this will show a generic message regarding why the subject is obscured."
},
"redacted": {
"type": "boolean",
"example": false,
"description": "Whether or not the source message has been redacted. Only applicable for contact initiated messages."
},
"attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/part_attachment"
},
"description": "A list of attachments for the part."
},
"delivered_as": {
"type": "string",
"example": "operator_initiated",
"description": "The conversation's initiation type. Possible values are customer_initiated, campaigns_initiated (legacy campaigns), operator_initiated (Custom bot), automated (Series and other outbounds with dynamic audience message) and admin_initiated (fixed audience message, ticket initiated by an admin, group email)."
}
},
"description": "The Conversation Part that originated this conversation, which can be Contact, Admin, Campaign, Automated or Operator initiated."
}
conversation_statistics
{
"type": "object",
"title": "Conversation statistics",
"nullable": true,
"properties": {
"type": {
"type": "string",
"example": "conversation_statistics",
"description": ""
},
"count_reopens": {
"type": "integer",
"example": 1,
"description": "Number of reopens after first_contact_reply_at."
},
"last_close_at": {
"type": "integer",
"format": "date-time",
"example": 1663597233,
"description": "Time of the last conversation close."
},
"first_close_at": {
"type": "integer",
"format": "date-time",
"example": 1663597233,
"description": "Time of first close after first_contact_reply_at."
},
"count_assignments": {
"type": "integer",
"example": 1,
"description": "Number of assignments after first_contact_reply_at."
},
"last_closed_by_id": {
"type": "string",
"example": "c3po",
"description": "The last admin who closed the conversation. Returns a reference to an Admin object."
},
"last_assignment_at": {
"type": "integer",
"format": "date-time",
"example": 1663597233,
"description": "Time of last assignment after first_contact_reply_at."
},
"time_to_assignment": {
"type": "integer",
"example": 2310,
"description": "Duration until last assignment before first admin reply. In seconds."
},
"time_to_last_close": {
"type": "integer",
"example": 2310,
"description": "Duration until conversation was closed last time. Subtracts out of business hours. In seconds."
},
"first_assignment_at": {
"type": "integer",
"format": "date-time",
"example": 1663597233,
"description": "Time of first assignment after first_contact_reply_at."
},
"last_admin_reply_at": {
"type": "integer",
"format": "date-time",
"example": 1663597233,
"description": "Time of the last conversation part from an admin."
},
"time_to_admin_reply": {
"type": "integer",
"example": 2310,
"description": "Duration until first admin reply. Subtracts out of business hours. In seconds."
},
"time_to_first_close": {
"type": "integer",
"example": 2310,
"description": "Duration until conversation was closed first time. Subtracts out of business hours. In seconds."
},
"first_admin_reply_at": {
"type": "integer",
"format": "date-time",
"example": 1663597233,
"description": "Time of first admin reply after first_contact_reply_at."
},
"median_time_to_reply": {
"type": "integer",
"example": 2310,
"description": "Median based on all admin replies after a contact reply. Subtracts out of business hours. In seconds."
},
"last_contact_reply_at": {
"type": "integer",
"format": "date-time",
"example": 1663597233,
"description": "Time of the last conversation part from a contact."
},
"first_contact_reply_at": {
"type": "integer",
"format": "date-time",
"example": 1663597233,
"description": "Time of first text conversation part from a contact."
},
"count_conversation_parts": {
"type": "integer",
"example": 1,
"description": "Total number of conversation parts."
},
"last_assignment_admin_reply_at": {
"type": "integer",
"format": "date-time",
"example": 1663597233,
"description": "Time of first admin reply since most recent assignment."
}
},
"description": "A Statistics object containing all information required for reporting, with timestamps and calculated metrics."
}
conversation_teammates
{
"type": "object",
"title": "Conversation teammates",
"nullable": true,
"properties": {
"type": {
"type": "string",
"example": "admin.list",
"description": "The type of the object - `admin.list`."
},
"teammates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/reference"
},
"description": "The list of teammates who participated in the conversation (wrote at least one conversation part)."
}
},
"description": "The list of teammates who participated in the conversation (wrote at least one conversation part)."
}
convert_visitor_request
{
"type": "object",
"title": "Convert Visitor Request Payload",
"required": [
"type",
"user",
"visitor"
],
"properties": {
"type": {
"type": "string",
"example": "user",
"description": "Represents the role of the Contact model. Accepts `lead` or `user`."
},
"user": {
"type": "object",
"anyOf": [
{
"required": [
"id"
]
},
{
"required": [
"user_id"
]
}
],
"properties": {
"id": {
"type": "string",
"example": "8a88a590-e1c3-41e2-a502-e0649dbf721c",
"description": "The unique identifier for the contact which is given by Intercom."
},
"email": {
"type": "string",
"example": "winstonsmith@truth.org",
"description": "The contact's email, retained by default if one is present."
},
"user_id": {
"type": "string",
"example": "8a88a590-e1c3-41e2-a502-e0649dbf721c",
"description": "A unique identifier for the contact which is given to Intercom, which will be represented as external_id."
}
},
"description": "The unique identifiers retained after converting or merging."
},
"visitor": {
"type": "object",
"anyOf": [
{
"required": [
"id"
]
},
{
"required": [
"user_id"
]
},
{
"required": [
"email"
]
}
],
"properties": {
"id": {
"type": "string",
"example": "8a88a590-e1c3-41e2-a502-e0649dbf721c",
"description": "The unique identifier for the contact which is given by Intercom."
},
"email": {
"type": "string",
"example": "winstonsmith@truth.org",
"description": "The visitor's email."
},
"user_id": {
"type": "string",
"example": "8a88a590-e1c3-41e2-a502-e0649dbf721c",
"description": "A unique identifier for the contact which is given to Intercom."
}
},
"description": "The unique identifiers to convert a single Visitor."
}
},
"description": "You can merge a Visitor to a Contact of role type lead or user."
}
create_article_request
{
"type": "object",
"title": "Create Article Request Payload",
"nullable": true,
"required": [
"title",
"author_id"
],
"properties": {
"body": {
"type": "string",
"example": "<p>This is the body in html</p>",
"description": "The content of the article. For multilingual articles, this will be the body of the default language's content."
},
"state": {
"enum": [
"published",
"draft"
],
"type": "string",
"example": "draft",
"description": "Whether the article will be `published` or will be a `draft`. Defaults to draft. For multilingual articles, this will be the state of the default language's content."
},
"title": {
"type": "string",
"example": "Thanks for everything",
"description": "The title of the article.For multilingual articles, this will be the title of the default language's content."
},
"author_id": {
"type": "integer",
"example": 1295,
"description": "The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace."
},
"parent_id": {
"type": "integer",
"example": 18,
"description": "The id of the article's parent collection or section. An article without this field stands alone."
},
"description": {
"type": "string",
"example": "Description of the Article",
"description": "The description of the article. For multilingual articles, this will be the description of the default language's content."
},
"parent_type": {
"type": "string",
"example": "collection",
"description": "The type of parent, which can either be a `collection` or `section`."
},
"translated_content": {
"$ref": "#/components/schemas/article_translated_content"
}
},
"description": "You can create an Article"
}
create_collection_request
{
"type": "object",
"title": "Create Collection Request Payload",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"example": "collection 51",
"description": "The name of the collection. For multilingual collections, this will be the name of the default language's content."
},
"description": {
"type": "string",
"example": "English description",
"description": "The description of the collection. For multilingual collections, this will be the description of the default language's content."
},
"help_center_id": {
"type": "integer",
"example": 123,
"nullable": true,
"description": "The id of the help center where the collection will be created. If `null` then it will be created in the default help center."
},
"translated_content": {
"$ref": "#/components/schemas/group_translated_content",
"nullable": true
}
},
"description": "You can create a collection"
}
create_contact_request
{
"type": "object",
"anyOf": [
{
"title": "Create contact with email",
"required": [
"email"
]
},
{
"title": "Create contact with external_id",
"required": [
"external_id"
]
},
{
"title": "Create contact with role",
"required": [
"role"
]
}
],
"title": "Create Contact Request Payload",
"properties": {
"name": {
"type": "string",
"example": "John Doe",
"nullable": true,
"description": "The contacts name"
},
"role": {
"type": "string",
"description": "The role of the contact."
},
"email": {
"type": "string",
"example": "jdoe@example.com",
"description": "The contacts email"
},
"phone": {
"type": "string",
"example": "+353871234567",
"nullable": true,
"description": "The contacts phone"
},
"avatar": {
"type": "string",
"example": "https://www.example.com/avatar_image.jpg",
"nullable": true,
"description": "An image URL containing the avatar of a contact"
},
"owner_id": {
"type": "integer",
"example": 123,
"nullable": true,
"description": "The id of an admin that has been assigned account ownership of the contact"
},
"external_id": {
"type": "string",
"description": "A unique identifier for the contact which is given to Intercom"
},
"last_seen_at": {
"type": "integer",
"format": "date-time",
"example": 1571672154,
"nullable": true,
"description": "The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually)"
},
"signed_up_at": {
"type": "integer",
"format": "date-time",
"example": 1571672154,
"nullable": true,
"description": "The time specified for when a contact signed up"
},
"custom_attributes": {
"type": "object",
"nullable": true,
"description": "The custom attributes which are set for the contact"
},
"unsubscribed_from_emails": {
"type": "boolean",
"example": true,
"nullable": true,
"description": "Whether the contact is unsubscribed from emails"
}
},
"description": "Payload to create a contact"
}
create_conversation_request
{
"type": "object",
"title": "Create Conversation Request Payload",
"required": [
"from",
"body"
],
"properties": {
"body": {
"type": "string",
"example": "Hello",
"description": "The content of the message. HTML is not supported."
},
"from": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "536e564f316c83104c000020",
"maxLength": 24,
"minLength": 24,
"description": "The identifier for the contact which is given by Intercom."
},
"type": {
"enum": [
"lead",
"user",
"contact"
],
"type": "string",
"example": "user",
"description": "The role associated to the contact - user or lead."
}
}
}
},
"description": "Conversations are how you can communicate with users in Intercom. They are created when a contact replies to an outbound message, or when one admin directly sends a message to a single contact."
}
create_data_attribute_request
{
"type": "object",
"title": "Create Data Attribute Request",
"required": [
"name",
"model",
"data_type"
],
"properties": {
"name": {
"type": "string",
"example": "My Data Attribute",
"description": "The name of the data attribute."
},
"model": {
"enum": [
"contact",
"company"
],
"type": "string",
"example": "contact",
"description": "The model that the data attribute belongs to."
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"option1",
"option2"
],
"description": "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`."
},
"data_type": {
"enum": [
"string",
"integer",
"float",
"boolean",
"datetime",
"date"
],
"type": "string",
"example": "string",
"description": "The type of data stored for this attribute."
},
"description": {
"type": "string",
"example": "My Data Attribute Description",
"description": "The readable description you see in the UI for the attribute."
},
"messenger_writable": {
"type": "boolean",
"example": false,
"description": "Can this attribute be updated by the Messenger"
}
},
"description": ""
}
create_data_event_request
{
"type": "object",
"anyOf": [
{
"title": "id required",
"required": [
"event_name",
"created_at",
"id"
]
},
{
"title": "user_id required",
"required": [
"event_name",
"created_at",
"user_id"
]
},
{
"title": "email required",
"required": [
"event_name",
"created_at",
"email"
]
}
],
"title": "Create Data Event Request",
"properties": {
"id": {
"type": "string",
"example": "8a88a590-e1c3-41e2-a502-e0649dbf721c",
"description": "The unique identifier for the contact (lead or user) which is given by Intercom."
},
"email": {
"type": "string",
"example": "frodo.baggins@example.com",
"description": "An email address for your user. An email should only be used where your application uses email to uniquely identify users."
},
"user_id": {
"type": "string",
"example": "314159",
"description": "Your identifier for the user."
},
"metadata": {
"type": "object",
"example": {
"invite_code": "ADDAFRIEND"
},
"description": "Optional metadata about the event.",
"additionalProperties": {
"type": "string"
}
},
"created_at": {
"type": "integer",
"format": "date-time",
"example": 1671028894,
"description": "The time the event occurred as a UTC Unix timestamp"
},
"event_name": {
"type": "string",
"example": "invited-friend",
"description": "The name of the event that occurred. This is presented to your App's admins when filtering and creating segments - a good event name is typically a past tense 'verb-noun' combination, to improve readability, for example `updated-plan`."
}
},
"description": ""
}
create_data_event_summaries_request
{
"type": "object",
"title": "Create Data Event Summaries Request",
"properties": {
"user_id": {
"type": "string",
"example": "314159",
"description": "Your identifier for the user."
},
"event_summaries": {
"type": "object",
"properties": {
"last": {
"type": "integer",
"format": "date-time",
"example": 1671028894,
"description": "The last time the event was sent"
},
"count": {
"type": "integer",
"example": 1,
"description": "The number of times the event occurred."
},
"first": {
"type": "integer",
"format": "date-time",
"example": 1671028894,
"description": "The first time the event was sent"
},
"event_name": {
"type": "string",
"example": "invited-friend",
"description": "The name of the event that occurred. A good event name is typically a past tense 'verb-noun' combination, to improve readability, for example `updated-plan`."
}
},
"description": "A list of event summaries for the user. Each event summary should contain the event name, the time the event occurred, and the number of times the event occurred. The event name should be a past tense 'verb-noun' combination, to improve readability, for example `updated-plan`."
}
},
"description": "You can send a list of event summaries for a user. Each event summary should contain the event name, the time the event occurred, and the number of times the event occurred. The event name should be a past tense \"verb-noun\" combination, to improve readability, for example `updated-plan`."
}
create_data_exports_request
{
"type": "object",
"title": "Create Data Export Request",
"required": [
"created_at_after",
"created_at_before"
],
"properties": {
"created_at_after": {
"type": "integer",
"example": 1527811200,
"description": "The start date that you request data for. It must be formatted as a unix timestamp."
},
"created_at_before": {
"type": "integer",
"example": 1527811200,
"description": "The end date that you request data for. It must be formatted as a unix timestamp."
}
},
"description": "Request for creating a data export"
}
create_message_request
{
"type": "object",
"anyOf": [
{
"title": "message_type: `email`.",
"required": [
"message_type",
"subject",
"body",
"template",
"from",
"to"
]
},
{
"title": "message_type: `inapp`.",
"required": [
"message_type",
"body",
"from",
"to"
]
}
],
"title": "Create Message Request Payload",
"nullable": true,
"properties": {
"to": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"type": "string",
"example": "536e564f316c83104c000020",
"description": "The identifier for the contact which is given by Intercom."
},
"type": {
"enum": [
"user",
"lead"
],
"type": "string",
"example": "user",
"description": "The role associated to the contact - `user` or `lead`."
}
},
"description": "The sender of the message. If not provided, the default sender will be used."
},
"body": {
"type": "string",
"example": "Hello there",
"description": "The content of the message. HTML and plaintext are supported."
},
"from": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"type": "integer",
"example": 394051,
"description": "The identifier for the admin which is given by Intercom."
},
"type": {
"enum": [
"admin"
],
"type": "string",
"example": "admin",
"description": "Always `admin`."
}
},
"description": "The sender of the message. If not provided, the default sender will be used."
},
"subject": {
"type": "string",
"example": "Thanks for everything",
"description": "The title of the email."
},
"template": {
"type": "string",
"example": "plain",
"description": "The style of the outgoing message. Possible values `plain` or `personal`."
},
"message_type": {
"enum": [
"in_app",
"email"
],
"type": "string",
"example": "in_app",
"description": "The kind of message being created. Values: `in_app` or `email`."
},
"create_conversation_without_contact_reply": {
"type": "boolean",
"default": false,
"example": true,
"description": "Whether a conversation should be opened in the inbox for the message without the contact replying. Defaults to false if not provided."
}
},
"description": "You can create a message"
}
create_or_update_company_request
{
"type": "object",
"title": "Create Or Update Company Request Payload",
"nullable": true,
"properties": {
"name": {
"type": "string",
"example": "Intercom",
"description": "The name of the Company"
},
"plan": {
"type": "string",
"example": "Enterprise",
"description": "The name of the plan you have associated with the company."
},
"size": {
"type": "integer",
"example": 100,
"description": "The number of employees in this company."
},
"website": {
"type": "string",
"example": "https://www.example.com",
"description": "The URL for this company's website. Please note that the value specified here is not validated. Accepts any string."
},
"industry": {
"type": "string",
"example": "Manufacturing",
"description": "The industry that this company operates in."
},
"company_id": {
"type": "string",
"example": "625e90fc55ab113b6d92175f",
"description": "The company id you have defined for the company. Can't be updated"
},
"monthly_spend": {
"type": "integer",
"example": 1000,
"description": "How much revenue the company generates for your business. Note that this will truncate floats. i.e. it only allow for whole integers, 155.98 will be truncated to 155. Note that this has an upper limit of 2**31-1 or 2147483647.."
},
"custom_attributes": {
"type": "object",
"example": {
"team_mates": 9,
"monthly_spend": 155.5,
"paid_subscriber": true
},
"description": "A hash of key/value pairs containing any other data about the company you want Intercom to store.",
"additionalProperties": {
"type": "string"
}
},
"remote_created_at": {
"type": "integer",
"example": 1394531169,
"description": "The time the company was created by you."
}
},
"description": "You can create or update a Company"
}
create_or_update_tag_request
{
"type": "object",
"title": "Create or Update Tag Request Payload",
"required": [
"name"
],
"properties": {
"id": {
"type": "string",
"example": "656452352",
"description": "The id of tag to updates."
},
"name": {
"type": "string",
"example": "Independent",
"description": "The name of the tag, which will be created if not found, or the new name for the tag if this is an update request. Names are case insensitive."
}
},
"description": "You can create or update an existing tag."
}
create_phone_switch_request
{
"type": "object",
"title": "Create Phone Switch Request Payload",
"nullable": true,
"required": [
"phone"
],
"properties": {
"phone": {
"type": "string",
"example": "+1 1234567890",
"description": "Phone number in E.164 format, that will receive the SMS to continue the conversation in the Messenger."
},
"custom_attributes": {
"$ref": "#/components/schemas/custom_attributes"
}
},
"description": "You can create an phone switch"
}
create_section_request
{
"type": "object",
"title": "Create Section Request Payload",
"required": [
"name",
"parent_id"
],
"properties": {
"name": {
"type": "string",
"example": "Section 51",
"description": "The name of the collection. For multilingual collections, this will be the name of the default language's content."
},
"parent_id": {
"type": "integer",
"example": 18,
"description": "The id for the collection this section will be within."
},
"translated_content": {
"$ref": "#/components/schemas/group_translated_content",
"nullable": true
}
},
"description": "You can create a Section"
}
create_ticket_reply_request
{
"type": "object",
"title": "Create Ticket Reply Request Payload",
"required": [
"body",
"admin_id"
],
"properties": {
"body": {
"type": "string",
"example": "<p>Okay!</p>",
"description": "The message body of the note, which may contain HTML."
},
"admin_id": {
"type": "string",
"example": "1234",
"description": "The id of the admin who is making the note."
},
"message_type": {
"type": "string",
"default": "note",
"example": "note",
"description": "The type of the reply. Only `note` is supported at the moment."
}
}
}
create_ticket_request
{
"type": "object",
"title": "Create Ticket Request Payload",
"required": [
"ticket_type_id",
"contacts"
],
"properties": {
"contacts": {
"type": "array",
"items": {
"type": "object",
"oneOf": [
{
"title": "ID",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The identifier for the contact as given by Intercom."
}
}
},
{
"title": "External ID",
"required": [
"external_id"
],
"properties": {
"external_id": {
"type": "string",
"description": "The external_id you have defined for the contact who is being added as a participant."
}
}
},
{
"title": "Email",
"required": [
"email"
],
"properties": {
"email": {
"type": "string",
"description": "The email you have defined for the contact who is being added as a participant. If a contact with this email does not exist, one will be created."
}
}
}
]
},
"example": [
{
"id": "1234"
}
],
"description": "The list of contacts (users or leads) affected by this ticket. Currently only one is allowed"
},
"ticket_type_id": {
"type": "string",
"example": "1234",
"description": "The ID of the type of ticket you want to create"
},
"ticket_attributes": {
"$ref": "#/components/schemas/ticket_request_custom_attributes"
}
},
"description": "You can create a Ticket"
}
create_ticket_type_attribute_request
{
"type": "object",
"title": "Create Ticket Type Attribute Request Payload",
"required": [
"name",
"description",
"data_type"
],
"properties": {
"name": {
"type": "string",
"example": "Bug Priority",
"description": "The name of the ticket type attribute"
},
"data_type": {
"enum": [
"string",
"list",
"integer",
"decimal",
"boolean",
"datetime",
"files"
],
"type": "string",
"example": "string",
"description": "The data type of the attribute"
},
"multiline": {
"type": "boolean",
"example": false,
"description": "Whether the attribute allows multiple lines of text (only applicable to string attributes)"
},
"list_items": {
"type": "string",
"example": "Low Priority,Medium Priority,High Priority",
"description": "A comma delimited list of items for the attribute value (only applicable to list attributes)"
},
"description": {
"type": "string",
"example": "Priority level of the bug",
"description": "The description of the attribute presented to the teammate or contact"
},
"visible_on_create": {
"type": "boolean",
"default": true,
"example": true,
"description": "Whether the attribute is visible to teammates when creating a ticket in Inbox."
},
"required_to_create": {
"type": "boolean",
"default": false,
"example": false,
"description": "Whether the attribute is required to be filled in when teammates are creating the ticket in Inbox."
},
"visible_to_contacts": {
"type": "boolean",
"default": true,
"example": true,
"description": "Whether the attribute is visible to contacts when creating a ticket in Messenger."
},
"allow_multiple_values": {
"type": "boolean",
"example": false,
"description": "Whether the attribute allows multiple files to be attached to it (only applicable to file attributes)"
},
"required_to_create_for_contacts": {
"type": "boolean",
"default": false,
"example": false,
"description": "Whether the attribute is required to be filled in when contacts are creating the ticket in Messenger."
}
},
"description": "You can create a Ticket Type Attribute"
}
create_ticket_type_request
{
"type": "object",
"title": "Create Ticket Type Request Payload",
"nullable": true,
"required": [
"name"
],
"properties": {
"icon": {
"type": "string",
"default": "🎟️",
"example": "🐞",
"description": "The icon of the ticket type."
},
"name": {
"type": "string",
"example": "Bug",
"description": "The name of the ticket type."
},
"description": {
"type": "string",
"example": "Used for tracking bugs",
"description": "The description of the ticket type."
},
"is_internal": {
"type": "boolean",
"default": false,
"example": false,
"description": "Whether the tickets associated with this ticket type are intended for internal use only or will be shared with customers. This is currently a limited attribute."
}
},
"description": "The request payload for creating a ticket type.\n You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n"
}
cursor_pages
{
"type": "object",
"title": "Cursor based pages",
"nullable": true,
"properties": {
"next": {
"$ref": "#/components/schemas/starting_after_paging"
},
"page": {
"type": "integer",
"example": 1,
"description": "The current page"
},
"type": {
"enum": [
"pages"
],
"type": "string",
"example": "pages",
"description": "the type of object `pages`."
},
"per_page": {
"type": "integer",
"example": 2,
"description": "Number of results per page"
},
"total_pages": {
"type": "integer",
"example": 13,
"description": "Total number of pages"
}
},
"description": "Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data.\nA \"cursor\" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or \"pages\" as needed.\n"
}
custom_attributes
{
"type": "object",
"title": "Custom Attributes",
"description": "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.",
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/custom_object_instance"
}
]
}
}
custom_object_instance
{
"type": "object",
"title": "Custom Object Instance",
"x-tags": [
"Custom Object Instances"
],
"nullable": true,
"properties": {
"id": {
"type": "string",
"example": "5a7a19e9f59ae20001d1c1e6",
"description": "The Intercom defined id representing the custom object instance."
},
"type": {
"type": "string",
"example": "Order",
"description": "The identifier of the custom object type that defines the structure of the custom object instance."
},
"external_id": {
"type": "string",
"example": "0001d1c1e65a7a19e9f59ae2",
"description": "The id you have defined for the custom object instance."
},
"custom_attributes": {
"type": "object",
"description": "The custom attributes you have set on the custom object instance.",
"additionalProperties": {
"type": "string"
}
}
},
"description": "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."
}
customer_request
{
"type": "object",
"oneOf": [
{
"title": "Intercom User ID",
"required": [
"intercom_user_id"
],
"properties": {
"intercom_user_id": {
"type": "string",
"example": "6329bd9ffe4e2e91dac76188",
"description": "The identifier for the contact as given by Intercom."
}
}
},
{
"title": "User ID",
"required": [
"user_id"
],
"properties": {
"user_id": {
"type": "string",
"example": "2e91dac761886329bd9ffe4e",
"description": "The external_id you have defined for the contact who is being added as a participant."
}
}
},
{
"title": "Email",
"required": [
"email"
],
"properties": {
"email": {
"type": "string",
"example": "sam.sung@example.com",
"description": "The email you have defined for the contact who is being added as a participant."
}
}
}
],
"nullable": true
}
data_attribute
{
"type": "object",
"title": "Data Attribute",
"x-tags": [
"Data Attributes"
],
"properties": {
"id": {
"type": "integer",
"example": 12878,
"description": "The unique identifier for the data attribute which is given by Intercom. Only available for custom attributes."
},
"name": {
"type": "string",
"example": "paid_subscriber",
"description": "Name of the attribute."
},
"type": {
"enum": [
"data_attribute"
],
"type": "string",
"example": "data_attribute",
"description": "Value is `data_attribute`."
},
"label": {
"type": "string",
"example": "Paid Subscriber",
"description": "Readable name of the attribute (i.e. name you see in the UI)"
},
"model": {
"enum": [
"contact",
"company"
],
"type": "string",
"example": "contact",
"description": "Value is `contact` for user/lead attributes and `company` for company attributes."
},
"custom": {
"type": "boolean",
"example": true,
"description": "Set to true if this is a CDA"
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"true",
"false"
],
"description": "List of predefined options for attribute value."
},
"admin_id": {
"type": "string",
"example": "5712945",
"description": "Teammate who created the attribute. Only applicable to CDAs"
},
"archived": {
"type": "boolean",
"example": false,
"description": "Is this attribute archived. (Only applicable to CDAs)"
},
"data_type": {
"enum": [
"string",
"integer",
"float",
"boolean",
"date"
],
"type": "string",
"example": "boolean",
"description": "The data type of the attribute."
},
"full_name": {
"type": "string",
"example": "custom_attributes.paid_subscriber",
"description": "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."
},
"created_at": {
"type": "integer",
"format": "date-time",
"example": 1671028894,
"description": "The time the attribute was created as a UTC Unix timestamp"
},
"updated_at": {
"type": "integer",
"format": "date-time",
"example": 1671028894,
"description": "The time the attribute was last updated as a UTC Unix timestamp"
},
"description": {
"type": "string",
"example": "Whether the user is a paid subscriber.",
"description": "Readable description of the attribute."
},
"ui_writable": {
"type": "boolean",
"example": true,
"description": "Can this attribute be updated in the UI"
},
"api_writable": {
"type": "boolean",
"example": true,
"description": "Can this attribute be updated through API"
},
"messenger_writable": {
"type": "boolean",
"example": false,
"description": "Can this attribute be updated by the Messenger"
}
},
"description": "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."
}
data_attribute_list
{
"type": "object",
"title": "Data Attribute List",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/data_attribute"
},
"description": "A list of data attributes"
},
"type": {
"enum": [
"list"
],
"type": "string",
"example": "list",
"description": "The type of the object"
}
},
"description": "A list of all data attributes belonging to a workspace for contacts, companies or conversations."
}
data_event
{
"type": "object",
"title": "Data Event",
"x-tags": [
"Data Events"
],
"required": [
"event_name",
"created_at"
],
"properties": {
"id": {
"type": "string",
"example": "8a88a590-e1c3-41e2-a502-e0649dbf721c",
"description": "Your identifier for a lead or a user."
},
"type": {
"enum": [
"event"
],
"type": "string",
"example": "event",
"description": "The type of the object"
},
"email": {
"type": "string",
"example": "frodo.baggins@example.com",
"description": "An email address for your user. An email should only be used where your application uses email to uniquely identify users."
},
"user_id": {
"type": "string",
"example": "314159",
"description": "Your identifier for the user."
},
"metadata": {
"type": "object",
"example": {
"invite_code": "ADDAFRIEND"
},
"description": "Optional metadata about the event.",
"additionalProperties": {
"type": "string"
}
},
"created_at": {
"type": "integer",
"format": "date-time",
"example": 1671028894,
"description": "The time the event occurred as a UTC Unix timestamp"
},
"event_name": {
"type": "string",
"example": "invited-friend",
"description": "The name of the event that occurred. This is presented to your App's admins when filtering and creating segments - a good event name is typically a past tense 'verb-noun' combination, to improve readability, for example `updated-plan`."
},
"intercom_user_id": {
"type": "string",
"example": "63a0979a5eeebeaf28dd56ba",
"description": "The Intercom identifier for the user."
}
},
"description": "Data events are used to notify Intercom of changes to your data."
}
data_event_list
{
"type": "object",
"title": "Data Event List",
"properties": {
"type": {
"enum": [
"event.list"
],
"type": "string",
"example": "event.list",
"description": "The type of the object"
},
"pages": {
"type": "object",
"properties": {
"next": {
"type": "string",
"example": "https://api.intercom.io/events?per_page=2&before=1389913941064&intercom_user_id=63a0979a5eeebeaf28dd56ba&type=user\""
},
"since": {
"type": "string",
"example": "https://api.intercom.io/events?intercom_user_id=63a0979a5eeebeaf28dd56ba&type=user&since=1389913941065"
}
},
"description": "Pagination"
},
"events": {
"type": "array",
"items": {
"$ref": "#/components/schemas/data_event"
},
"description": "A list of data events"
}
},
"description": "This will return a list of data events for the App."
}
data_event_summary
{
"type": "object",
"title": "Data Event Summary",
"properties": {
"type": {
"enum": [
"event.summary"
],
"type": "string",
"example": "event.summary",
"description": "The type of the object"
},
"email": {
"type": "string",
"example": "Sam.Sung@example.com",
"description": "The email address of the user"
},
"events": {
"type": "array",
"items": {
"$ref": "#/components/schemas/data_event_summary_item"
},
"description": "A summary of data events"
},
"user_id": {
"type": "string",
"example": "62b997f288e14803c5006932",
"description": "The user ID of the user"
},
"intercom_user_id": {
"type": "string",
"example": "63a0979a5eeebeaf28dd56ba",
"description": "The Intercom user ID of the user"
}
},
"description": "This will return a summary of data events for the App."
}
data_event_summary_item
{
"type": "object",
"title": "Data Event Summary Item",
"nullable": true,
"properties": {
"last": {
"type": "string",
"example": "2014-01-16T23:12:21.000+00:00 ",
"description": "The last time the event was sent"
},
"name": {
"type": "string",
"example": "placed-order",
"description": "The name of the event"
},
"count": {
"type": "integer",
"example": 1,
"description": "The number of times the event was sent"
},
"first": {
"type": "string",
"example": "2014-01-16T23:12:21.000+00:00",
"description": "The first time the event was sent"
},
"description": {
"type": "string",
"example": "A user placed an order",
"description": "The description of the event"
}
},
"description": "This will return a summary of a data event for the App."
}
data_export
{
"type": "object",
"title": "Data Export",
"x-tags": [
"Data Export"
],
"properties": {
"status": {
"enum": [
"pending",
"in_progress",
"failed",
"completed",
"no_data",
"canceled"
],
"type": "string",
"example": "pending",
"description": "The current state of your job."
},
"download_url": {
"type": "string",
"example": "https://api.intercom.test/download/messages/data/example",
"description": "The location where you can download your data."
},
"job_identfier": {
"type": "string",
"example": "orzzsbd7hk67xyu",
"description": "The identifier for your job."
},
"download_expires_at": {
"type": "string",
"example": "1674917488",
"description": "The time after which you will not be able to access the data."
}
},
"description": "The data export api is used to view all message sent & viewed in a given timeframe."
}
data_export_csv
{
"type": "object",
"title": "Data Export CSV",
"properties": {
"name": {
"type": "string",
"description": "The full name of the user receiving the message"
},
"email": {
"type": "string",
"description": "The users email who was sent the message."
},
"node_id": {
"type": "string",
"description": "The id of the series node that this ruleset is associated with. Each block in a series has a corresponding node_id."
},
"user_id": {
"type": "string",
"description": "The user_id of the user who was sent the message."
},
"series_id": {
"type": "string",
"description": "The id of the series that this content is part of. Will return -1 if not part of a series."
},
"company_id": {
"type": "string",
"description": "The company ID of the user in relation to the message that was sent. Will return -1 if no company is present."
},
"content_id": {
"type": "string",
"description": "The specific content that was received. In an A/B test each version has its own Content ID."
},
"first_open": {
"type": "integer",
"description": "The first time the user opened this message."
},
"receipt_id": {
"type": "string",
"description": "ID for this receipt. Will be included with any related stats in other files to identify this specific delivery of a message."
},
"ruleset_id": {
"type": "string",
"description": "The id of the message."
},
"first_click": {
"type": "integer",
"description": "The first time the series the user clicked on a link within this message."
},
"first_reply": {
"type": "integer",
"description": "The first time a user replied to this message if the content was able to receive replies."
},
"received_at": {
"type": "integer",
"description": "Timestamp for when the receipt was recorded."
},
"content_type": {
"type": "string",
"description": "Email, Chat, Post etc."
},
"series_title": {
"type": "string",
"description": "The title of the series that this content is part of."
},
"content_title": {
"type": "string",
"description": "The title of the content you see in your Intercom workspace."
},
"first_dismisall": {
"type": "integer",
"description": "The first time the series the user dismissed this message."
},
"first_completion": {
"type": "integer",
"description": "The first time a user completed this message if the content was able to be completed e.g. Tours, Surveys."
},
"user_external_id": {
"type": "string",
"description": "The external_user_id of the user who was sent the message"
},
"first_hard_bounce": {
"type": "integer",
"description": "The first time this message hard bounced for this user"
},
"first_series_exit": {
"type": "integer",
"description": "The first time the series this message was a part of was exited by the user."
},
"first_unsubscribe": {
"type": "integer",
"description": "The first time the user unsubscribed from this message."
},
"first_goal_success": {
"type": "integer",
"description": "The first time the user met this messages associated goal if one exists."
},
"ruleset_version_id": {
"type": "string",
"description": "As you edit content we record new versions. This ID can help you determine which version of a piece of content that was received."
},
"first_series_completion": {
"type": "integer",
"description": "The first time the series this message was a part of was completed by the user."
},
"first_series_disengagement": {
"type": "integer",
"description": "The first time the series this message was a part of was disengaged by the user."
}
},
"description": "A CSV output file"
}
deleted_article_object
{
"type": "object",
"title": "Deleted Article Object",
"properties": {
"id": {
"type": "string",
"example": "6890762",
"description": "The unique identifier for the article which you provided in the URL."
},
"object": {
"enum": [
"article"
],
"type": "string",
"example": "article",
"description": "The type of object which was deleted. - article"
},
"deleted": {
"type": "boolean",
"example": true,
"description": "Whether the article was deleted successfully or not."
}
},
"description": "Response returned when an object is deleted"
}
deleted_collection_object
{
"type": "object",
"title": "Deleted Collection Object",
"properties": {
"id": {
"type": "string",
"example": "6890762",
"description": "The unique identifier for the collection which you provided in the URL."
},
"object": {
"enum": [
"collection"
],
"type": "string",
"example": "collection",
"description": "The type of object which was deleted. - `collection`"
},
"deleted": {
"type": "boolean",
"example": true,
"description": "Whether the collection was deleted successfully or not."
}
},
"description": "Response returned when an object is deleted"
}
deleted_company_object
{
"type": "object",
"title": "Deleted Company Object",
"properties": {
"id": {
"type": "string",
"example": "5b7e8b2f-7a1a-4e6c-8e1b-4f9d4f4c4d4f",
"description": "The unique identifier for the company which is given by Intercom."
},
"object": {
"enum": [
"company"
],
"type": "string",
"example": "company",
"description": "The type of object which was deleted. - `company`"
},
"deleted": {
"type": "boolean",
"example": true,
"description": "Whether the company was deleted successfully or not."
}
},
"description": "Response returned when an object is deleted"
}
deleted_object
{
"type": "object",
"title": "Deleted Object",
"properties": {
"id": {
"type": "string",
"example": "6890762",
"description": "The unique identifier for the news item which you provided in the URL."
},
"object": {
"enum": [
"news-item"
],
"type": "string",
"example": "news-item",
"description": "The type of object which was deleted - news-item."
},
"deleted": {
"type": "boolean",
"example": true,
"description": "Whether the news item was deleted successfully or not."
}
},
"description": "Response returned when an object is deleted"
}