Body of the Article
author_id: 991281345 state: published created_at: 1712222213 updated_at: 1712222213 url: http://help-center.test/myapp-26/en/articles/589-thanks-for-everything schema: "$ref": "#/components/schemas/article" '400': description: Bad Request content: application/json: examples: Bad Request: value: type: error.list request_id: 60119000-28e1-460a-8151-ff350b1cb4ca errors: - code: parameter_not_found message: author_id must be in the main body or default locale translated_content object schema: "$ref": "#/components/schemas/error" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: 16edaf99-20a4-470c-b2c0-84903cf6dce0 errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: content: application/json: schema: "$ref": "#/components/schemas/create_article_request" examples: article_created: summary: article created value: title: Thanks for everything description: Description of the Article body: Body of the Article author_id: 991281345 state: published parent_id: 2372 parent_type: collection translated_content: fr: title: Merci pour tout description: Description de l'article body: Corps de l'article author_id: 991281345 state: published bad_request: summary: Bad Request value: title: Thanks for everything description: Description of the Article body: Body of the Article state: published "/articles/{id}": get: summary: Retrieve an article parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" - name: id in: path required: true description: The unique identifier for the article which is given by Intercom. example: 123 schema: type: integer tags: - Articles operationId: retrieveArticle description: You can fetch the details of a single article by making a GET request to `https://api.intercom.io/articles/New gifts in store for the jolly season
author_id: 991281356 state: published created_at: 1712222218 updated_at: 1712222218 url: http://help-center.test/myapp-38/en/articles/595-christmas-is-here schema: "$ref": "#/components/schemas/article" '404': description: Article Not Found content: application/json: examples: Article Not Found: value: type: error.list request_id: 3d6a702c-2ec4-4a23-a242-23d7c343b08f errors: - code: not_found message: Resource Not Found schema: "$ref": "#/components/schemas/error" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: 3c847647-4324-42d4-9a43-961fdbd20e20 errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: content: application/json: schema: "$ref": "#/components/schemas/update_article_request" examples: successful: summary: successful value: title: Christmas is here! body: "New gifts in store for the jolly season
" article_not_found: summary: Article Not Found value: title: Christmas is here! body: "New gifts in store for the jolly season
" delete: summary: Delete an article parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" - name: id in: path required: true description: The unique identifier for the article which is given by Intercom. example: 123 schema: type: integer tags: - Articles operationId: deleteArticle description: You can delete a single article by making a DELETE request to `https://api.intercom.io/articles/This is a note.
" - type: note id: '412' created_at: 1711531064 contact: type: contact id: 660e70386abd01b9d19042f9 author: type: admin id: '991281438' name: Ciaran110 Lee email: admin110@email.com away_mode_enabled: false away_mode_reassign: false body: "This is a note.
" - type: note id: '411' created_at: 1711531064 contact: type: contact id: 660e70386abd01b9d19042f9 author: type: admin id: '991281438' name: Ciaran110 Lee email: admin110@email.com away_mode_enabled: false away_mode_reassign: false body: "This is a note.
" total_count: 3 pages: type: pages next: page: 1 per_page: 50 total_pages: 1 schema: "$ref": "#/components/schemas/note_list" '404': description: Contact not found content: application/json: examples: Contact not found: value: type: error.list request_id: 92196629-e3b0-420a-974b-e63358cb212e errors: - code: not_found message: User Not Found schema: "$ref": "#/components/schemas/error" post: summary: Create a note parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" - name: id in: path required: true description: The unique identifier of a given contact. example: '123' schema: type: integer tags: - Notes - Contacts operationId: createNote description: You can add a note to a single contact. responses: '200': description: Successful response content: application/json: examples: Successful response: value: type: note id: '418' created_at: 1712222266 contact: type: contact id: 660e70396abd01b9d19042fb author: type: admin id: '991281440' name: Ciaran112 Lee email: admin112@email.com away_mode_enabled: false away_mode_reassign: false body: "Hello
" schema: "$ref": "#/components/schemas/note" '404': description: Contact not found content: application/json: examples: Admin not found: value: type: error.list request_id: 95ea745f-62fb-4d25-8156-0965f329fc7f errors: - code: not_found message: Resource Not Found Contact not found: value: type: error.list request_id: 1ad380bf-756e-4afd-97d1-855b8ed3f852 errors: - code: not_found message: User Not Found schema: "$ref": "#/components/schemas/error" requestBody: content: application/json: schema: type: object required: - body properties: body: type: string description: The text of the note. example: New note contact_id: type: string description: The unique identifier of a given contact. example: '123' admin_id: type: string description: The unique identifier of a given admin. example: '123' examples: successful_response: summary: Successful response value: contact_id: 660e70396abd01b9d19042fb admin_id: 991281440 body: Hello admin_not_found: summary: Admin not found value: contact_id: 660e703a6abd01b9d19042fc admin_id: 123 body: Hello contact_not_found: summary: Contact not found value: contact_id: 123 admin_id: 991281442 body: Hello "/contacts/{contact_id}/segments": get: summary: List attached segments for contact parameters: - name: contact_id in: path description: The unique identifier for the contact which is given by Intercom example: 63a07ddf05a32042dffac965 required: true schema: type: string - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" tags: - Contacts - Segments operationId: listSegmentsForAContact description: You can fetch a list of segments that are associated to a contact. responses: '200': description: successful content: application/json: examples: successful: value: type: list data: - type: segment id: 660e703b6abd01b9d19042fe name: segment created_at: 1712222267 updated_at: 1712222267 person_type: user schema: "$ref": "#/components/schemas/contact_segments" '404': description: Contact not found content: application/json: examples: Contact not found: value: type: error.list request_id: d80e241b-f614-4f36-ab58-778d331cb335 errors: - code: not_found message: User Not Found schema: "$ref": "#/components/schemas/error" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: 0e703a88-744f-4ab1-aabc-336496422297 errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" "/contacts/{contact_id}/subscriptions": get: summary: List subscriptions for a contact parameters: - name: contact_id in: path description: The unique identifier for the contact which is given by Intercom example: 63a07ddf05a32042dffac965 required: true schema: type: string - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" tags: - Contacts - Subscription Types operationId: listSubscriptionsForAContact description: | You can fetch a list of subscription types that are attached to a contact. These can be subscriptions that a user has 'opted-in' to or has 'opted-out' from, depending on the subscription type. This will return a list of Subscription Type objects that the contact is associated with. The data property will show a combined list of: 1.Opt-out subscription types that the user has opted-out from. 2.Opt-in subscription types that the user has opted-in to receiving. responses: '200': description: Successful content: application/json: examples: Successful: value: type: list data: - type: subscription id: '1469' state: live consent_type: opt_out default_translation: name: Newsletters description: Lorem ipsum dolor sit amet locale: en translations: - name: Newsletters description: Lorem ipsum dolor sit amet locale: en content_types: - email - type: subscription id: '1471' state: live consent_type: opt_in default_translation: name: Newsletters description: Lorem ipsum dolor sit amet locale: en translations: - name: Newsletters description: Lorem ipsum dolor sit amet locale: en content_types: - sms_message schema: "$ref": "#/components/schemas/subscription_type_list" '404': description: Contact not found content: application/json: examples: Contact not found: value: type: error.list request_id: b09327f9-e7f4-47e8-8589-45283d06e5bb errors: - code: not_found message: User Not Found schema: "$ref": "#/components/schemas/error" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: 2b375369-ef9d-4695-859b-d8d2451ebe89 errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" post: summary: Add subscription to a contact tags: - Subscription Types - Contacts parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" - name: contact_id in: path description: The unique identifier for the contact which is given by Intercom example: 63a07ddf05a32042dffac965 required: true schema: type: string operationId: attachSubscriptionTypeToContact description: | You can add a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in: 1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type. 2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type. This will return a subscription type model for the subscription type that was added to the contact. responses: '200': description: Successful content: application/json: examples: Successful: value: type: subscription id: '1484' state: live consent_type: opt_in default_translation: name: Newsletters description: Lorem ipsum dolor sit amet locale: en translations: - name: Newsletters description: Lorem ipsum dolor sit amet locale: en content_types: - sms_message schema: "$ref": "#/components/schemas/subscription_type" '404': description: Resource not found content: application/json: examples: Contact not found: value: type: error.list request_id: d34f81e7-bc3c-4e33-b6be-3b73505dcb75 errors: - code: not_found message: User Not Found Resource not found: value: type: error.list request_id: 60d42cc3-443e-4341-ae5b-d3d9f7a23c70 errors: - code: not_found message: Resource Not Found schema: "$ref": "#/components/schemas/error" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: d9e2de02-d114-40e6-b11e-71f7c336d3df errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: content: application/json: schema: type: object required: - id - consent_type properties: id: type: string description: The unique identifier for the subscription which is given by Intercom example: '37846' consent_type: type: string description: The consent_type of a subscription, opt_out or opt_in. example: opt_in examples: successful: summary: Successful value: id: 1484 consent_type: opt_in contact_not_found: summary: Contact not found value: id: 1488 consent_type: opt_in resource_not_found: summary: Resource not found value: id: invalid_id consent_type: opt_in "/contacts/{contact_id}/subscriptions/{id}": delete: summary: Remove subscription from a contact tags: - Subscription Types - Contacts parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" - name: contact_id in: path description: The unique identifier for the contact which is given by Intercom example: 63a07ddf05a32042dffac965 required: true schema: type: string - name: id in: path description: The unique identifier for the subscription type which is given by Intercom example: '37846' required: true schema: type: string operationId: detachSubscriptionTypeToContact description: You can remove a specific subscription from a contact. This will return a subscription type model for the subscription type that was removed from the contact. responses: '200': description: Successful content: application/json: examples: Successful: value: type: subscription id: '1500' state: live consent_type: opt_in default_translation: name: Newsletters description: Lorem ipsum dolor sit amet locale: en translations: - name: Newsletters description: Lorem ipsum dolor sit amet locale: en content_types: - sms_message schema: "$ref": "#/components/schemas/subscription_type" '404': description: Resource not found content: application/json: examples: Contact not found: value: type: error.list request_id: a9db6326-c5d1-4d1f-8c2f-cfe0c73748ba errors: - code: not_found message: User Not Found Resource not found: value: type: error.list request_id: d66a2a6f-9099-4f16-8c84-79c11832df48 errors: - code: not_found message: Resource Not Found schema: "$ref": "#/components/schemas/error" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: 967b9180-03c9-4cf8-b5a8-af3b13a2a70c errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" "/contacts/{contact_id}/tags": get: summary: List tags attached to a contact tags: - Contacts - Tags parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" - name: contact_id in: path description: The unique identifier for the contact which is given by Intercom example: 63a07ddf05a32042dffac965 required: true schema: type: string operationId: listTagsForAContact description: You can fetch a list of all tags that are attached to a specific contact. responses: '200': description: successful content: application/json: examples: successful: value: type: list data: - type: tag id: '1317' name: Manual tag schema: "$ref": "#/components/schemas/tag_list" '404': description: Contact not found content: application/json: examples: Contact not found: value: type: error.list request_id: d2138791-d60f-42f6-8f4c-8c146d243377 errors: - code: not_found message: User Not Found schema: "$ref": "#/components/schemas/error" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: 2bc59912-e70f-4aef-92cf-75313363ce2b errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" post: summary: Add tag to a contact tags: - Tags - Contacts parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" - name: contact_id in: path description: The unique identifier for the contact which is given by Intercom example: 63a07ddf05a32042dffac965 required: true schema: type: string operationId: attachTagToContact description: You can tag a specific contact. This will return a tag object for the tag that was added to the contact. responses: '200': description: successful content: application/json: examples: successful: value: type: tag id: '1318' name: Manual tag schema: "$ref": "#/components/schemas/tag" '404': description: Tag not found content: application/json: examples: Contact not found: value: type: error.list request_id: 5295dc47-1c6d-4d65-95ad-486c3eb4a98e errors: - code: not_found message: User Not Found Tag not found: value: type: error.list request_id: e2d7a875-ef16-4aed-aa87-5781f3829967 errors: - code: not_found message: Resource Not Found schema: "$ref": "#/components/schemas/error" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: 66586d13-1002-48b1-8ce0-58f4483c63e0 errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: content: application/json: schema: type: object required: - id properties: id: type: string description: The unique identifier for the tag which is given by Intercom example: '7522907' examples: successful: summary: successful value: id: 1318 contact_not_found: summary: Contact not found value: id: 1319 tag_not_found: summary: Tag not found value: id: '123' "/contacts/{contact_id}/tags/{id}": delete: summary: Remove tag from a contact tags: - Tags - Contacts parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" - name: contact_id in: path description: The unique identifier for the contact which is given by Intercom example: 63a07ddf05a32042dffac965 required: true schema: type: string - name: id in: path description: The unique identifier for the tag which is given by Intercom example: '7522907' required: true schema: type: string operationId: detachTagFromContact description: You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact. responses: '200': description: successful content: application/json: examples: successful: value: type: tag id: '1321' name: Manual tag schema: "$ref": "#/components/schemas/tag" '404': description: Tag not found content: application/json: examples: Contact not found: value: type: error.list request_id: '03346029-d4a1-45a2-a14e-b9a9687db72e' errors: - code: not_found message: User Not Found Tag not found: value: type: error.list request_id: 1891cc99-938d-417c-b10e-f8fb975f32fd errors: - code: not_found message: Resource Not Found schema: "$ref": "#/components/schemas/error" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: 316948d2-6c47-4940-86b2-a66724f27343 errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" "/contacts/{id}": put: summary: Update a contact parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" - name: id in: path description: id example: 63a07ddf05a32042dffac965 required: true schema: type: string tags: - Contacts operationId: UpdateContact description: You can update an existing contact (ie. user or lead). responses: '200': description: successful content: application/json: examples: successful: value: type: contact id: 660e704a6abd01b9d1904315 workspace_id: this_is_an_id248_that_should_be_at_least_ external_id: '70' role: user email: joebloggs@intercom.io phone: name: joe bloggs avatar: owner_id: social_profiles: type: list data: [] has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false created_at: 1712222282 updated_at: 1712222282 signed_up_at: 1712222282 last_seen_at: last_replied_at: last_contacted_at: last_email_opened_at: last_email_clicked_at: language_override: browser: browser_version: browser_language: os: location: type: location country: region: city: country_code: continent_code: android_app_name: android_app_version: android_device: android_os_version: android_sdk_version: android_last_seen_at: ios_app_name: ios_app_version: ios_device: ios_os_version: ios_sdk_version: ios_last_seen_at: custom_attributes: {} tags: type: list data: [] url: "/contacts/660e704a6abd01b9d1904315/tags" total_count: 0 has_more: false notes: type: list data: [] url: "/contacts/660e704a6abd01b9d1904315/notes" total_count: 0 has_more: false companies: type: list data: [] url: "/contacts/660e704a6abd01b9d1904315/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] url: "/contacts/660e704a6abd01b9d1904315/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] url: "/contacts/660e704a6abd01b9d1904315/subscriptions" total_count: 0 has_more: false utm_campaign: utm_content: utm_medium: utm_source: utm_term: referrer: schema: "$ref": "#/components/schemas/contact" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: e88dd45f-e186-46e7-8dc0-b198b7226ae0 errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: content: application/json: schema: oneOf: - "$ref": "#/components/schemas/update_contact_request" examples: successful: summary: successful value: email: joebloggs@intercom.io name: joe bloggs get: summary: Get a contact parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" - name: id in: path description: id example: 63a07ddf05a32042dffac965 required: true schema: type: string tags: - Contacts operationId: ShowContact description: You can fetch the details of a single contact. responses: '200': description: successful content: application/json: examples: successful: value: type: contact id: 660e704b6abd01b9d1904316 workspace_id: this_is_an_id252_that_should_be_at_least_ external_id: '70' role: user email: joe@bloggs.com phone: name: Joe Bloggs avatar: owner_id: social_profiles: type: list data: [] has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false created_at: 1712222283 updated_at: 1712222283 signed_up_at: 1712222283 last_seen_at: last_replied_at: last_contacted_at: last_email_opened_at: last_email_clicked_at: language_override: browser: browser_version: browser_language: os: location: type: location country: region: city: country_code: continent_code: android_app_name: android_app_version: android_device: android_os_version: android_sdk_version: android_last_seen_at: ios_app_name: ios_app_version: ios_device: ios_os_version: ios_sdk_version: ios_last_seen_at: custom_attributes: {} tags: type: list data: [] url: "/contacts/660e704b6abd01b9d1904316/tags" total_count: 0 has_more: false notes: type: list data: [] url: "/contacts/660e704b6abd01b9d1904316/notes" total_count: 0 has_more: false companies: type: list data: [] url: "/contacts/660e704b6abd01b9d1904316/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] url: "/contacts/660e704b6abd01b9d1904316/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] url: "/contacts/660e704b6abd01b9d1904316/subscriptions" total_count: 0 has_more: false utm_campaign: utm_content: utm_medium: utm_source: utm_term: referrer: schema: "$ref": "#/components/schemas/contact" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: e2d43e82-aa25-47ad-a4d6-beaebbf95367 errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" delete: summary: Delete a contact parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" - name: id in: path description: id required: true schema: type: string tags: - Contacts operationId: DeleteContact description: You can delete a single contact. responses: '200': description: successful content: application/json: examples: successful: value: id: 660e704c6abd01b9d1904317 object: contact deleted: true schema: "$ref": "#/components/schemas/contact_deleted" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: 73e68e79-c3de-48b4-8f8b-36d6e2eee0af errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" "/contacts/merge": post: summary: Merge a lead and a user parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" tags: - Contacts operationId: MergeContact description: You can merge a contact with a `role` of `lead` into a contact with a `role` of `user`. responses: '200': description: successful content: application/json: examples: successful: value: type: contact id: 660e704d6abd01b9d1904319 workspace_id: this_is_an_id260_that_should_be_at_least_ external_id: '70' role: user email: joe@bloggs.com phone: name: Joe Bloggs avatar: owner_id: social_profiles: type: list data: [] has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false created_at: 1712222285 updated_at: 1712222286 signed_up_at: 1712222285 last_seen_at: last_replied_at: last_contacted_at: last_email_opened_at: last_email_clicked_at: language_override: browser: browser_version: browser_language: os: location: type: location country: region: city: country_code: continent_code: android_app_name: android_app_version: android_device: android_os_version: android_sdk_version: android_last_seen_at: ios_app_name: ios_app_version: ios_device: ios_os_version: ios_sdk_version: ios_last_seen_at: custom_attributes: {} tags: type: list data: [] url: "/contacts/660e704d6abd01b9d1904319/tags" total_count: 0 has_more: false notes: type: list data: [] url: "/contacts/660e704d6abd01b9d1904319/notes" total_count: 0 has_more: false companies: type: list data: [] url: "/contacts/660e704d6abd01b9d1904319/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] url: "/contacts/660e704d6abd01b9d1904319/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] url: "/contacts/660e704d6abd01b9d1904319/subscriptions" total_count: 0 has_more: false utm_campaign: utm_content: utm_medium: utm_source: utm_term: referrer: schema: "$ref": "#/components/schemas/contact" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: 923d3f0b-c575-4b95-b2d8-dd85e94d9b8e errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: content: application/json: schema: "$ref": "#/components/schemas/merge_contacts_request" examples: successful: summary: successful value: from: 660e704d6abd01b9d1904318 into: 660e704d6abd01b9d1904319 "/contacts/search": post: summary: Search contacts parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" tags: - Contacts operationId: SearchContacts description: | You can search for multiple contacts by the value of their attributes in order to fetch exactly who you want. To search for contacts, you need to send a `POST` request to `https://api.intercom.io/contacts/search`. This will accept a query object in the body which will define your filters in order to search for contacts. ### Contact Creation Delay If a contact has recently been created, there is a possibility that it will not yet be available when searching. This means that it may not appear in the response. This delay can take a few minutes. If you need to be instantly notified it is recommended to use webhooks and iterate to see if they match your search filters. ### Nesting & Limitations You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). There are some limitations to the amount of multiple's there can be: * There's a limit of max 2 nested filters * There's a limit of max 15 filters for each AND or OR group ### Searching for Timestamp Fields All timestamp fields (created_at, updated_at etc.) are indexed as Dates for Contact Search queries; Datetime queries are not currently supported. This means you can only query for timestamp fields by day - not hour, minute or second. For example, if you search for all Contacts with a created_at value greater (>) than 1577869200 (the UNIX timestamp for January 1st, 2020 9:00 AM), that will be interpreted as 1577836800 (January 1st, 2020 12:00 AM). The search results will then include Contacts created from January 2nd, 2020 12:00 AM onwards. If you'd like to get contacts created on January 1st, 2020 you should search with a created_at value equal (=) to 1577836800 (January 1st, 2020 12:00 AM). This behaviour applies only to timestamps used in search queries. The search results will still contain the full UNIX timestamp and be sorted accordingly. ### Accepted Fields Most key listed as part of the Contacts Model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `"foorbar"`). | Field | Type | | ---------------------------------- | ------------------------------ | | id | String | | role | Stringthis is the message body
" author: type: admin id: '991281483' name: Ciaran152 Lee email: admin152@email.com attachments: [] url: redacted: false contacts: type: contact.list contacts: - type: contact id: 660e705d6abd01b9d1904324 first_contact_reply: admin_assignee_id: team_assignee_id: open: false state: closed read: false tags: type: tag.list tags: [] priority: not_priority sla_applied: statistics: conversation_rating: teammates: title: custom_attributes: {} topics: {} schema: "$ref": "#/components/schemas/paginated_response" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: 2a4dfaa9-40f8-42a5-9d47-f93a2a22aba2 errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" '403': description: API plan restricted content: application/json: examples: API plan restricted: value: type: error.list request_id: 19349505-882d-4de4-99f5-53144c7bfa34 errors: - code: api_plan_restricted message: Active subscription needed. schema: "$ref": "#/components/schemas/error" post: summary: Creates a conversation parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" tags: - Conversations operationId: createConversation description: |+ You can create a conversation that has been initiated by a contact (ie. user or lead). The conversation can be an in-app message only. {% admonition type="info" name="Sending for visitors" %} You can also send a message from a visitor by specifying their `user_id` or `id` value in the `from` field, along with a `type` field value of `contact`. This visitor will be automatically converted to a contact with a lead role once the conversation is created. {% /admonition %} This will return the Message model that has been created. responses: '200': description: conversation created content: application/json: examples: conversation created: value: type: user_message id: '403920675' created_at: 1712222319 body: Hello there message_type: inapp conversation_id: '4500' schema: "$ref": "#/components/schemas/message" '404': description: Contact Not Found content: application/json: examples: Contact Not Found: value: type: error.list request_id: cfe4cb04-fa63-406e-ac39-602a66448a7d errors: - code: not_found message: User Not Found schema: "$ref": "#/components/schemas/error" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: c008639e-13bc-4d70-8e07-1224155e56f3 errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" '403': description: API plan restricted content: application/json: examples: API plan restricted: value: type: error.list request_id: 057f2c4c-8b02-4d8d-bd8f-c2faef68f35e errors: - code: api_plan_restricted message: Active subscription needed. schema: "$ref": "#/components/schemas/error" requestBody: content: application/json: schema: "$ref": "#/components/schemas/create_conversation_request" examples: conversation_created: summary: conversation created value: from: type: user id: 660e706f6abd01b9d1904339 body: Hello there contact_not_found: summary: Contact Not Found value: from: type: user id: 123_doesnt_exist body: Hello there "/conversations/{id}": get: summary: Retrieve a conversation parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" - name: id in: path required: true description: The id of the conversation to target example: 123 schema: type: integer - name: display_as in: query required: false description: Set to plaintext to retrieve conversation messages in plain text. example: plaintext schema: type: string tags: - Conversations operationId: retrieveConversation description: |2 You can fetch the details of a single conversation. This will return a single Conversation model with all its conversation parts. {% admonition type="warning" name="Hard limit of 500 parts" %} The maximum number of conversation parts that can be returned via the API is 500. If you have more than that we will return the 500 most recent conversation parts. {% /admonition %} ### Bot Name in Conversation Parts For conversation parts generated by a bot, bot name will depend on the following: - Customers that never turned on AI answers will have `operator` as the bot name - Customers that have turned on AI answers at some point will have `fin` as the bot name responses: '200': description: conversation found content: application/json: examples: conversation found: value: type: conversation id: '4504' created_at: 1712222324 updated_at: 1712222324 waiting_since: snoozed_until: source: type: conversation id: '403920679' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin id: '991281494' name: Ciaran159 Lee email: admin159@email.com attachments: [] url: redacted: false contacts: type: contact.list contacts: - type: contact id: 660e70746abd01b9d190433d first_contact_reply: admin_assignee_id: team_assignee_id: open: false state: closed read: false tags: type: tag.list tags: [] priority: not_priority sla_applied: statistics: conversation_rating: teammates: title: custom_attributes: {} topics: {} conversation_parts: type: conversation_part.list conversation_parts: [] total_count: 0 schema: "$ref": "#/components/schemas/conversation" '404': description: Not found content: application/json: examples: Not found: value: type: error.list request_id: 0544e553-4221-48b4-abd2-01e7aa65819d errors: - code: not_found message: Resource Not Found schema: "$ref": "#/components/schemas/error" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: 604769a3-ccc5-43bb-8108-a81e4037ad24 errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" '403': description: API plan restricted content: application/json: examples: API plan restricted: value: type: error.list request_id: 89806ed3-791e-46a6-97e9-7ba165c5ab81 errors: - code: api_plan_restricted message: Active subscription needed. schema: "$ref": "#/components/schemas/error" put: summary: Update a conversation parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" - name: id in: path required: true description: The id of the conversation to target example: 123 schema: type: integer - name: display_as in: query required: false description: Set to plaintext to retrieve conversation messages in plain text. example: plaintext schema: type: string tags: - Conversations operationId: updateConversation description: |2+ You can update an existing conversation. {% admonition type="info" name="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. {% /admonition %} responses: '200': description: conversation found content: application/json: examples: conversation found: value: type: conversation id: '4508' created_at: 1712222329 updated_at: 1712222331 waiting_since: snoozed_until: source: type: conversation id: '403920683' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin id: '991281498' name: Ciaran163 Lee email: admin163@email.com attachments: [] url: redacted: false contacts: type: contact.list contacts: - type: contact id: 660e70796abd01b9d1904341 first_contact_reply: admin_assignee_id: team_assignee_id: open: false state: closed read: true tags: type: tag.list tags: [] priority: not_priority sla_applied: statistics: conversation_rating: teammates: title: custom_attributes: issue_type: Billing priority: High topics: {} conversation_parts: type: conversation_part.list conversation_parts: - type: conversation_part id: '1051' part_type: conversation_attribute_updated_by_admin body: created_at: 1712222330 updated_at: 1712222330 notified_at: 1712222330 assigned_to: author: id: '991281503' type: bot name: Operator email: operator+this_is_an_id318_that_should_be_at_least_@intercom.io attachments: [] external_id: redacted: false - type: conversation_part id: '1052' part_type: conversation_attribute_updated_by_admin body: created_at: 1712222331 updated_at: 1712222331 notified_at: 1712222331 assigned_to: author: id: '991281503' type: bot name: Operator email: operator+this_is_an_id318_that_should_be_at_least_@intercom.io attachments: [] external_id: redacted: false total_count: 2 schema: "$ref": "#/components/schemas/conversation" '404': description: Not found content: application/json: examples: Not found: value: type: error.list request_id: ac76b019-8527-4347-bc82-efa342bdfe97 errors: - code: not_found message: Resource Not Found schema: "$ref": "#/components/schemas/error" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: 32e1d8b8-3ed2-4467-bb85-6bda0d9bb372 errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" '403': description: API plan restricted content: application/json: examples: API plan restricted: value: type: error.list request_id: f737d77e-fc72-4136-94ce-b12a5a565c57 errors: - code: api_plan_restricted message: Active subscription needed. schema: "$ref": "#/components/schemas/error" requestBody: content: application/json: schema: "$ref": "#/components/schemas/update_conversation_request" examples: conversation_found: summary: conversation found value: read: true custom_attributes: issue_type: Billing priority: High not_found: summary: Not found value: read: true custom_attributes: issue_type: Billing priority: High "/conversations/search": post: summary: Search conversations parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" tags: - Conversations operationId: searchConversations description: | You can search for multiple conversations by the value of their attributes in order to fetch exactly which ones you want. To search for conversations, you need to send a `POST` request to `https://api.intercom.io/conversations/search`. This will accept a query object in the body which will define your filters in order to search for conversations. ### Nesting & Limitations You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). There are some limitations to the amount of multiple's there can be: - There's a limit of max 2 nested filters - There's a limit of max 15 filters for each AND or OR group ### Accepted Fields Most keys listed as part of the The conversation model is searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `"foorbar"`). | Field | Type | | :---------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------- | | id | String | | created_at | Date (UNIX timestamp) | | updated_at | Date (UNIX timestamp) | | source.type | Stringthis is the message body
" author: type: admin id: '991281522' name: Ciaran186 Lee email: admin186@email.com attachments: [] url: redacted: false contacts: type: contact.list contacts: - type: contact id: 660e70836abd01b9d1904348 first_contact_reply: admin_assignee_id: team_assignee_id: open: false state: closed read: false tags: type: tag.list tags: [] priority: not_priority sla_applied: statistics: conversation_rating: teammates: title: custom_attributes: {} topics: {} schema: "$ref": "#/components/schemas/conversation_list" requestBody: content: application/json: schema: "$ref": "#/components/schemas/search_request" examples: successful: summary: successful value: query: operator: AND value: - field: id operator: "=" value: '4515' - operator: OR value: - field: id operator: "=" value: '4515' - field: id operator: "=" value: '4515' "/conversations/{id}/reply": post: summary: Reply to a conversation parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" - name: id in: path required: true description: The Intercom provisioned identifier for the conversation or the string "last" to reply to the last part of the conversation example: 123 or "last" schema: type: string tags: - Conversations operationId: replyConversation description: You can reply to a conversation with a message from an admin or on behalf of a contact, or with a note for admins. responses: '200': description: User last conversation reply content: application/json: examples: User reply: value: type: conversation id: '4523' created_at: 1712222345 updated_at: 1712222346 waiting_since: 1712222346 snoozed_until: source: type: conversation id: '403920693' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin id: '991281524' name: Ciaran187 Lee email: admin187@email.com attachments: [] url: redacted: false contacts: type: contact.list contacts: - type: contact id: 660e70896abd01b9d190434f first_contact_reply: created_at: 1712222346 type: conversation url: admin_assignee_id: team_assignee_id: open: true state: open read: false tags: type: tag.list tags: [] priority: not_priority sla_applied: statistics: conversation_rating: teammates: title: custom_attributes: {} topics: {} conversation_parts: type: conversation_part.list conversation_parts: - type: conversation_part id: '1054' part_type: open body: "Thanks again :)
" created_at: 1712222346 updated_at: 1712222346 notified_at: 1712222346 assigned_to: author: id: 660e70896abd01b9d190434f type: user name: Joe Bloggs email: joe@bloggs.com attachments: [] external_id: redacted: false total_count: 1 Admin note reply: value: type: conversation id: '4524' created_at: 1712222347 updated_at: 1712222348 waiting_since: snoozed_until: source: type: conversation id: '403920694' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin id: '991281526' name: Ciaran188 Lee email: admin188@email.com attachments: [] url: redacted: false contacts: type: contact.list contacts: - type: contact id: 660e708b6abd01b9d1904350 first_contact_reply: admin_assignee_id: team_assignee_id: open: false state: closed read: false tags: type: tag.list tags: [] priority: not_priority sla_applied: statistics: conversation_rating: teammates: title: custom_attributes: {} topics: {} conversation_parts: type: conversation_part.list conversation_parts: - type: conversation_part id: '1055' part_type: note body: |-this is the message body
" author: type: admin id: '991281528' name: Ciaran190 Lee email: admin190@email.com attachments: [] url: redacted: false contacts: type: contact.list contacts: - type: contact id: 660e708d6abd01b9d1904352 first_contact_reply: created_at: 1712222350 type: conversation url: admin_assignee_id: team_assignee_id: open: true state: open read: false tags: type: tag.list tags: [] priority: not_priority sla_applied: statistics: conversation_rating: teammates: title: custom_attributes: {} topics: {} conversation_parts: type: conversation_part.list conversation_parts: - type: conversation_part id: '1056' part_type: open body: "Thanks again :)
" created_at: 1712222350 updated_at: 1712222350 notified_at: 1712222350 assigned_to: author: id: 660e708d6abd01b9d1904352 type: user name: Joe Bloggs email: joe@bloggs.com attachments: [] external_id: redacted: false total_count: 1 schema: "$ref": "#/components/schemas/conversation" '404': description: Not found content: application/json: examples: Not found: value: type: error.list request_id: 5c54e252-13bc-41c6-9b0e-6c830429daff errors: - code: not_found message: Resource Not Found schema: "$ref": "#/components/schemas/error" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: ee7c80e5-bf35-4168-96f9-d9c9f41e5e7c errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" '403': description: API plan restricted content: application/json: examples: API plan restricted: value: type: error.list request_id: 157d01b4-bce1-4fa4-8182-daf9518dbc15 errors: - code: api_plan_restricted message: Active subscription needed. schema: "$ref": "#/components/schemas/error" requestBody: content: application/json: schema: "$ref": "#/components/schemas/reply_conversation_request" examples: user_reply: summary: User reply value: message_type: comment type: user intercom_user_id: 660e70896abd01b9d190434f body: Thanks again :) admin_note_reply: summary: Admin note reply value: message_type: note type: admin admin_id: 991281526 body: "this is the message body
" author: type: admin id: '991281533' name: Ciaran194 Lee email: admin194@email.com attachments: [] url: redacted: false contacts: type: contact.list contacts: - type: contact id: 660e70936abd01b9d1904356 first_contact_reply: admin_assignee_id: team_assignee_id: open: false state: closed read: false tags: type: tag.list tags: [] priority: not_priority sla_applied: statistics: conversation_rating: teammates: title: custom_attributes: {} topics: {} conversation_parts: type: conversation_part.list conversation_parts: - type: conversation_part id: '1057' part_type: close body: "Goodbye :)
" created_at: 1712222355 updated_at: 1712222355 notified_at: 1712222355 assigned_to: author: id: '991281533' type: admin name: Ciaran194 Lee email: admin194@email.com attachments: [] external_id: redacted: false total_count: 1 Snooze a conversation: value: type: conversation id: '4531' created_at: 1712222357 updated_at: 1712222357 waiting_since: snoozed_until: 1712225957 source: type: conversation id: '403920701' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin id: '991281534' name: Ciaran195 Lee email: admin195@email.com attachments: [] url: redacted: false contacts: type: contact.list contacts: - type: contact id: 660e70946abd01b9d1904357 first_contact_reply: admin_assignee_id: team_assignee_id: open: true state: snoozed read: false tags: type: tag.list tags: [] priority: not_priority sla_applied: statistics: conversation_rating: teammates: title: custom_attributes: {} topics: {} conversation_parts: type: conversation_part.list conversation_parts: - type: conversation_part id: '1058' part_type: snoozed body: created_at: 1712222357 updated_at: 1712222357 notified_at: 1712222357 assigned_to: author: id: '991281534' type: admin name: Ciaran195 Lee email: admin195@email.com attachments: [] external_id: redacted: false total_count: 1 Open a conversation: value: type: conversation id: '4536' created_at: 1712222356 updated_at: 1712222364 waiting_since: snoozed_until: source: type: conversation id: '403920702' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin id: '991281535' name: Ciaran196 Lee email: admin196@email.com attachments: [] url: redacted: false contacts: type: contact.list contacts: - type: contact id: 660e70976abd01b9d190435c first_contact_reply: admin_assignee_id: team_assignee_id: open: true state: open read: true tags: type: tag.list tags: [] priority: not_priority sla_applied: statistics: conversation_rating: teammates: title: '' custom_attributes: {} topics: {} conversation_parts: type: conversation_part.list conversation_parts: - type: conversation_part id: '1060' part_type: open body: created_at: 1712222364 updated_at: 1712222364 notified_at: 1712222364 assigned_to: author: id: '991281535' type: admin name: Ciaran196 Lee email: admin196@email.com attachments: [] external_id: redacted: false total_count: 1 Assign a conversation: value: type: conversation id: '4540' created_at: 1712222365 updated_at: 1712222366 waiting_since: snoozed_until: source: type: conversation id: '403920705' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin id: '991281537' name: Ciaran197 Lee email: admin197@email.com attachments: [] url: redacted: false contacts: type: contact.list contacts: - type: contact id: 660e709d6abd01b9d190435f first_contact_reply: admin_assignee_id: 991281537 team_assignee_id: open: true state: open read: false tags: type: tag.list tags: [] priority: not_priority sla_applied: statistics: conversation_rating: teammates: title: custom_attributes: {} topics: {} conversation_parts: type: conversation_part.list conversation_parts: - type: conversation_part id: '1061' part_type: assign_and_reopen body: created_at: 1712222366 updated_at: 1712222366 notified_at: 1712222366 assigned_to: type: admin id: '991281537' author: id: '991281537' type: admin name: Ciaran197 Lee email: admin197@email.com attachments: [] external_id: redacted: false total_count: 1 schema: "$ref": "#/components/schemas/conversation" '404': description: Not found content: application/json: examples: Not found: value: type: error.list request_id: f63fbea4-8cd2-46e3-827c-d0c94838872d errors: - code: not_found message: Resource Not Found schema: "$ref": "#/components/schemas/error" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: 6f750190-3bbb-446b-b73e-06d5642aa8f9 errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" '403': description: API plan restricted content: application/json: examples: API plan restricted: value: type: error.list request_id: 20067280-1622-45ea-b59f-b1f1534382be errors: - code: api_plan_restricted message: Active subscription needed. schema: "$ref": "#/components/schemas/error" requestBody: content: application/json: schema: oneOf: - "$ref": "#/components/schemas/close_conversation_request" - "$ref": "#/components/schemas/snooze_conversation_request" - "$ref": "#/components/schemas/open_conversation_request" - "$ref": "#/components/schemas/assign_conversation_request" examples: close_a_conversation: summary: Close a conversation value: message_type: close type: admin admin_id: 991281533 body: Goodbye :) snooze_a_conversation: summary: Snooze a conversation value: message_type: snoozed admin_id: 991281534 snoozed_until: 1712225957 open_a_conversation: summary: Open a conversation value: message_type: open admin_id: 991281535 assign_a_conversation: summary: Assign a conversation value: message_type: assignment type: admin admin_id: 991281537 assignee_id: 991281537 not_found: summary: Not found value: message_type: close type: admin admin_id: 991281539 body: Goodbye :) "/conversations/{id}/run_assignment_rules": post: summary: Run Assignment Rules on a conversation parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" - name: id in: path required: true description: The identifier for the conversation as given by Intercom. example: '123' schema: type: string tags: - Conversations operationId: autoAssignConversation description: | You can let a conversation be automatically assigned following assignment rules. {% admonition type="attention" name="When using workflows" %} It is not possible to use this endpoint with Workflows. {% /admonition %} responses: '200': description: Assign a conversation using assignment rules content: application/json: examples: Assign a conversation using assignment rules: value: type: conversation id: '4544' created_at: 1712222370 updated_at: 1712222371 waiting_since: snoozed_until: source: type: conversation id: '403920709' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin id: '991281542' name: Ciaran201 Lee email: admin201@email.com attachments: [] url: redacted: false contacts: type: contact.list contacts: - type: contact id: 660e70a26abd01b9d1904363 first_contact_reply: admin_assignee_id: team_assignee_id: open: false state: closed read: false tags: type: tag.list tags: [] priority: not_priority sla_applied: statistics: conversation_rating: teammates: title: custom_attributes: {} topics: {} conversation_parts: type: conversation_part.list conversation_parts: - type: conversation_part id: '1062' part_type: default_assignment body: created_at: 1712222371 updated_at: 1712222371 notified_at: 1712222371 assigned_to: type: nobody_admin id: author: id: '991281543' type: bot name: Operator email: operator+this_is_an_id359_that_should_be_at_least_@intercom.io attachments: [] external_id: redacted: false total_count: 1 schema: "$ref": "#/components/schemas/conversation" '404': description: Not found content: application/json: examples: Not found: value: type: error.list request_id: 3a997fb9-7413-4916-aadf-05d39250b822 errors: - code: not_found message: Resource Not Found schema: "$ref": "#/components/schemas/error" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: 2a2b4477-6e9b-474e-86ce-011aa39e9add errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" '403': description: API plan restricted content: application/json: examples: API plan restricted: value: type: error.list request_id: 20188c3c-577f-40bb-b7fd-55a989c25667 errors: - code: api_plan_restricted message: Active subscription needed. schema: "$ref": "#/components/schemas/error" "/conversations/{id}/customers": post: summary: Attach a contact to a conversation parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" - name: id in: path required: true description: The identifier for the conversation as given by Intercom. example: '123' schema: type: string tags: - Conversations operationId: attachContactToConversation description: |+ You can add participants who are contacts to a conversation, on behalf of either another contact or an admin. {% admonition type="attention" name="Contacts without an email" %} If you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with `role` set to `lead`. {% /admonition %} responses: '200': description: Attach a contact to a conversation content: application/json: examples: Attach a contact to a conversation: value: customers: - type: user id: 660e70a76abd01b9d1904367 schema: "$ref": "#/components/schemas/conversation" '404': description: Not found content: application/json: examples: Not found: value: type: error.list request_id: 80f69016-d9a0-4578-a54c-3b60883a1ea6 errors: - code: not_found message: Resource Not Found schema: "$ref": "#/components/schemas/error" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: 57f166f2-2c76-4b65-a615-0f5e42be24a4 errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" '403': description: API plan restricted content: application/json: examples: API plan restricted: value: type: error.list request_id: 66dc913a-6fab-4e99-be41-7c0e30164303 errors: - code: api_plan_restricted message: Active subscription needed. schema: "$ref": "#/components/schemas/error" requestBody: content: application/json: schema: "$ref": "#/components/schemas/attach_contact_to_conversation_request" examples: attach_a_contact_to_a_conversation: summary: Attach a contact to a conversation value: admin_id: 991281547 customer: intercom_user_id: 660e70a76abd01b9d1904367 not_found: summary: Not found value: admin_id: 991281548 customer: intercom_user_id: 660e70a96abd01b9d1904368 "/conversations/{conversation_id}/customers/{contact_id}": delete: summary: Detach a contact from a group conversation parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" - name: conversation_id in: path required: true description: The identifier for the conversation as given by Intercom. example: '123' schema: type: string - name: contact_id in: path required: true description: The identifier for the contact as given by Intercom. example: '123' schema: type: string tags: - Conversations operationId: detachContactFromConversation description: |+ You can add participants who are contacts to a conversation, on behalf of either another contact or an admin. {% admonition type="attention" name="Contacts without an email" %} If you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with `role` set to `lead`. {% /admonition %} responses: '200': description: Detach a contact from a group conversation content: application/json: examples: Detach a contact from a group conversation: value: customers: - type: user id: 660e70b26abd01b9d1904372 schema: "$ref": "#/components/schemas/conversation" '404': description: Contact not found content: application/json: examples: Conversation not found: value: type: error.list request_id: ac355ab7-7451-4721-9529-081bfd99db12 errors: - code: not_found message: Resource Not Found Contact not found: value: type: error.list request_id: 69836b07-a76b-499a-a679-2029a852e3d9 errors: - code: not_found message: User Not Found schema: "$ref": "#/components/schemas/error" '422': description: Last customer content: application/json: examples: Last customer: value: type: error.list request_id: dd571eb9-2eb2-458a-beef-fedbb3a5a96a errors: - code: parameter_invalid message: Removing the last customer is not allowed schema: "$ref": "#/components/schemas/error" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: c221c591-b4a3-4a20-b9cc-9a2d3caff395 errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" '403': description: API plan restricted content: application/json: examples: API plan restricted: value: type: error.list request_id: 1be0a2c7-efd4-402e-9bb3-e3251ec8c7ac errors: - code: api_plan_restricted message: Active subscription needed. schema: "$ref": "#/components/schemas/error" requestBody: content: application/json: schema: "$ref": "#/components/schemas/detach_contact_from_conversation_request" examples: detach_a_contact_from_a_group_conversation: summary: Detach a contact from a group conversation value: admin_id: 991281551 customer: intercom_user_id: 660e70ac6abd01b9d190436b conversation_not_found: summary: Conversation not found value: admin_id: 991281553 customer: intercom_user_id: 660e70b36abd01b9d1904373 contact_not_found: summary: Contact not found value: admin_id: 991281555 customer: intercom_user_id: 660e70b86abd01b9d190437a last_customer: summary: Last customer value: admin_id: 991281557 customer: intercom_user_id: 660e70be6abd01b9d1904381 "/conversations/redact": post: summary: Redact a conversation part parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" tags: - Conversations operationId: redactConversation description: |+ You can redact a conversation part or the source message of a conversation (as seen in the source object). {% admonition type="info" name="Redacting parts and messages" %} If you are redacting a conversation part, it must have a `body`. If you are redacting a source message, it must have been created by a contact. We will return a `conversation_part_not_redactable` error if these criteria are not met. {% /admonition %} responses: '200': description: Redact a conversation part content: application/json: examples: Redact a conversation part: value: type: conversation id: '4600' created_at: 1712222415 updated_at: 1712222417 waiting_since: 1712222416 snoozed_until: source: type: conversation id: '403920735' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin id: '991281563' name: Ciaran215 Lee email: admin215@email.com attachments: [] url: redacted: false contacts: type: contact.list contacts: - type: contact id: 660e70cf6abd01b9d1904396 first_contact_reply: created_at: 1712222416 type: conversation url: admin_assignee_id: team_assignee_id: open: true state: open read: true tags: type: tag.list tags: [] priority: not_priority sla_applied: statistics: conversation_rating: teammates: title: custom_attributes: {} topics: {} conversation_parts: type: conversation_part.list conversation_parts: - type: conversation_part id: '1070' part_type: open body: "This message was deleted
" created_at: 1712222416 updated_at: 1712222417 notified_at: 1712222416 assigned_to: author: id: 660e70cf6abd01b9d1904396 type: user name: Joe Bloggs email: joe@bloggs.com attachments: [] external_id: redacted: true total_count: 1 schema: "$ref": "#/components/schemas/conversation" '404': description: Not found content: application/json: examples: Not found: value: type: error.list request_id: e6093446-5e19-4cd0-b3e0-e221453de823 errors: - code: conversation_part_or_message_not_found message: Conversation part or message not found schema: "$ref": "#/components/schemas/error" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: 5f7b7f92-8501-4fb3-a7be-5111d4d42f19 errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: content: application/json: schema: "$ref": "#/components/schemas/redact_conversation_request" examples: redact_a_conversation_part: summary: Redact a conversation part value: type: conversation_part conversation_id: 4600 conversation_part_id: 1070 not_found: summary: Not found value: type: conversation_part conversation_id: really_123_doesnt_exist conversation_part_id: really_123_doesnt_exist "/data_attributes": get: summary: List all data attributes parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" - name: model in: query required: false description: Specify the data attribute model to return. schema: type: string enum: - contact - company - conversation example: company - name: include_archived in: query required: false description: Include archived attributes in the list. By default we return only non archived data attributes. example: false schema: type: boolean tags: - Data Attributes operationId: lisDataAttributes description: You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations. responses: '200': description: Successful response content: application/json: examples: Successful response: value: type: list data: - type: data_attribute name: name full_name: name label: Company name description: The name of a company data_type: string api_writable: true ui_writable: false messenger_writable: true custom: false archived: false model: company - type: data_attribute name: company_id full_name: company_id label: Company ID description: A number identifying a company data_type: string api_writable: false ui_writable: false messenger_writable: true custom: false archived: false model: company - type: data_attribute name: last_request_at full_name: last_request_at label: Company last seen description: The last day anyone from a company visited your site or app data_type: date api_writable: false ui_writable: false messenger_writable: true custom: false archived: false model: company - type: data_attribute name: remote_created_at full_name: remote_created_at label: Company created at description: The day a company was added to Intercom data_type: date api_writable: true ui_writable: false messenger_writable: true custom: false archived: false model: company - type: data_attribute name: user_count full_name: user_count label: People description: The number of people in a company data_type: integer api_writable: false ui_writable: false messenger_writable: true custom: false archived: false model: company - type: data_attribute name: session_count full_name: session_count label: Company web sessions description: All visits from anyone in a company to your product's site or app data_type: integer api_writable: false ui_writable: false messenger_writable: true custom: false archived: false model: company - type: data_attribute name: name full_name: plan.name label: Plan description: A specific plan or level within your product that companies have signed up to data_type: string api_writable: false ui_writable: false messenger_writable: true custom: false archived: false model: company - type: data_attribute name: monthly_spend full_name: monthly_spend label: Monthly Spend description: The monthly revenue you receive from a company data_type: float api_writable: true ui_writable: false messenger_writable: true custom: false archived: false model: company - type: data_attribute name: size full_name: size label: Company size description: The number of people employed in this company, expressed as a single number data_type: integer api_writable: true ui_writable: false messenger_writable: true custom: false archived: false model: company - type: data_attribute name: industry full_name: industry label: Company industry description: The category or domain this company belongs to e.g. 'ecommerce' or 'SaaS' data_type: string api_writable: true ui_writable: false messenger_writable: true custom: false archived: false model: company - type: data_attribute name: website full_name: website label: Company website description: The web address for the company's primary marketing site data_type: string api_writable: true ui_writable: false messenger_writable: true custom: false archived: false model: company - id: 485 type: data_attribute name: The One Ring full_name: custom_attributes.The One Ring label: The One Ring description: One ring to rule them all, one ring to find them, One ring to bring them all and in the darkness bind them. data_type: string api_writable: true ui_writable: false messenger_writable: true custom: true archived: false admin_id: '991281587' created_at: 1712222429 updated_at: 1712222429 model: company - type: data_attribute name: id full_name: id label: ID description: The Intercom defined id representing the company data_type: string api_writable: false ui_writable: false messenger_writable: true custom: false archived: false model: company - type: data_attribute name: created_at full_name: created_at label: Created at description: The time the company was added to Intercom data_type: date api_writable: false ui_writable: false messenger_writable: true custom: false archived: false model: company - type: data_attribute name: updated_at full_name: updated_at label: Updated at description: The last time the company was updated data_type: date api_writable: false ui_writable: false messenger_writable: true custom: false archived: false model: company - type: data_attribute name: id full_name: plan.id label: Plan ID description: The Intercom defined id representing the plan data_type: string api_writable: false ui_writable: false messenger_writable: true custom: false archived: false model: company - type: data_attribute name: app_id full_name: app_id label: App ID description: The Intercom defined id representing the app data_type: string api_writable: false ui_writable: false messenger_writable: true custom: false archived: false model: company schema: "$ref": "#/components/schemas/data_attribute_list" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: fed82ddc-feff-48ed-92a5-a1fbfc622775 errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" post: summary: Create a data attribute parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" tags: - Data Attributes operationId: createDataAttribute description: You can create a data attributes for a `contact` or a `company`. responses: '200': description: Successful content: application/json: examples: Successful: value: id: 488 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: true custom: true archived: false admin_id: '991281589' created_at: 1712222430 updated_at: 1712222430 model: company schema: "$ref": "#/components/schemas/data_attribute" '400': description: Too few options for list content: application/json: examples: Same name already exists: value: type: error.list request_id: 1519b515-4499-46d3-828d-f8143514170a errors: - code: parameter_invalid message: You already have 'The One Ring' in your company data. To save this as new people data, use a different name. Invalid name: value: type: error.list request_id: 3e7e0f82-08dd-444d-bbe7-23ae8005181e errors: - code: parameter_invalid message: Your name for this attribute must only contain alphanumeric characters, currency symbols, and hyphens Attribute already exists: value: type: error.list request_id: 699d3723-4f1a-4ca7-a38e-a88f0609b194 errors: - code: parameter_invalid message: You already have 'The One Ring' in your company data. To save this as new company data, use a different name. Invalid Data Type: value: type: error.list request_id: 6777f6d3-f3b4-4044-87f0-32a901ce77a5 errors: - code: parameter_invalid message: Data Type isn't an option Too few options for list: value: type: error.list request_id: 40e0c1db-092d-441f-8741-b27dae580a4b errors: - code: parameter_invalid message: The Data Attribute model field must be either contact or company schema: "$ref": "#/components/schemas/error" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: 553340ce-dc68-4c91-a7f1-7c5e761b53e0 errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: content: application/json: schema: "$ref": "#/components/schemas/create_data_attribute_request" examples: successful: summary: Successful value: name: Mithril Shirt model: company data_type: string same_name_already_exists: summary: Same name already exists value: name: The One Ring model: contact data_type: integer invalid_name: summary: Invalid name value: name: "!nv@l!d n@me" model: company data_type: string attribute_already_exists: summary: Attribute already exists value: name: The One Ring model: company data_type: string invalid_data_type: summary: Invalid Data Type value: name: The Second Ring model: company data_type: mithril too_few_options_for_list: summary: Too few options for list value: description: Just a plain old ring options: - value: 1-10 archived: false "/data_attributes/{id}": put: summary: Update a data attribute parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" - name: id in: path required: true description: The data attribute id example: 1 schema: type: integer tags: - Data Attributes operationId: updateDataAttribute description: "\nYou can update a data attribute.\n\n> \U0001F6A7 Updating the data type is not possible\n>\n> It is currently a dangerous action to execute changing a data attribute's type via the API. You will need to update the type via the UI instead.\n" responses: '200': description: Successful content: application/json: examples: Successful: value: id: 495 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: '991281596' created_at: 1712222433 updated_at: 1712222434 model: company schema: "$ref": "#/components/schemas/data_attribute" '400': description: Too few options in list content: application/json: examples: Too few options in list: value: type: error.list request_id: 95133d56-234d-41b2-b05a-3b5fa1f0aaa3 errors: - code: parameter_invalid message: Options isn't an array schema: "$ref": "#/components/schemas/error" '404': description: Attribute Not Found content: application/json: examples: Attribute Not Found: value: type: error.list request_id: 491cc4d0-e8be-49a9-aa95-8791db6b6f47 errors: - code: field_not_found message: We couldn't find that data attribute to update schema: "$ref": "#/components/schemas/error" '422': description: Has Dependant Object content: application/json: examples: Has Dependant Object: value: type: error.list request_id: 00306ada-7289-4d6f-a5d2-0be6c9fd3af1 errors: - code: data_invalid message: The Data Attribute you are trying to archive has a dependant object schema: "$ref": "#/components/schemas/error" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: e6878c4b-8709-4552-b888-3e85969dd09b errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: content: application/json: schema: "$ref": "#/components/schemas/update_data_attribute_request" examples: successful: summary: Successful value: description: Just a plain old ring options: - value: 1-10 - value: 11-20 archived: false too_few_options_in_list: summary: Too few options in list value: description: Too few options options: value: 1-10 archived: false attribute_not_found: summary: Attribute Not Found value: description: Just a plain old ring options: - value: 1-10 - value: 11-20 archived: false has_dependant_object: summary: Has Dependant Object value: description: Trying to archieve archived: true "/events": post: summary: Submit a data event parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" tags: - Data Events operationId: createDataEvent description: |2+ You will need an Access Token that has write permissions to send Events. Once you have a key you can submit events via POST to the Events resource, which is located at https://api.intercom.io/events, or you can send events using one of the client libraries. When working with the HTTP API directly a client should send the event with a `Content-Type` of `application/json`. When using the JavaScript API, [adding the code to your app](http://docs.intercom.io/configuring-Intercom/tracking-user-events-in-your-app) makes the Events API available. Once added, you can submit an event using the `trackEvent` method. This will associate the event with the Lead or currently logged-in user or logged-out visitor/lead and send it to Intercom. The final parameter is a map that can be used to send optional metadata about the event. With the Ruby client you pass a hash describing the event to `Intercom::Event.create`, or call the `track_user` method directly on the current user object (e.g. `user.track_event`). **NB: For the JSON object types, please note that we do not currently support nested JSON structure.** | Type | Description | Example | | :-------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------- | | String | The value is a JSON String | `"source":"desktop"` | | Number | The value is a JSON Number | `"load": 3.67` | | Date | The key ends with the String `_date` and the value is a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time), assumed to be in the [UTC](http://en.wikipedia.org/wiki/Coordinated_Universal_Time) timezone. | `"contact_date": 1392036272` | | Link | The value is a HTTP or HTTPS URI. | `"article": "https://example.org/ab1de.html"` | | Rich Link | The value is a JSON object that contains `url` and `value` keys. | `"article": {"url": "https://example.org/ab1de.html", "value":"the dude abides"}` | | Monetary Amount | The value is a JSON object that contains `amount` and `currency` keys. The `amount` key is a positive integer representing the amount in cents. The price in the example to the right denotes €349.99. | `"price": {"amount": 34999, "currency": "eur"}` | **Lead Events** When submitting events for Leads, you will need to specify the Lead's `id`. **Metadata behaviour** - We currently limit the number of tracked metadata keys to 10 per event. Once the quota is reached, we ignore any further keys we receive. The first 10 metadata keys are determined by the order in which they are sent in with the event. - It is not possible to change the metadata keys once the event has been sent. A new event will need to be created with the new keys and you can archive the old one. - There might be up to 24 hrs delay when you send a new metadata for an existing event. **Event de-duplication** The API may detect and ignore duplicate events. Each event is uniquely identified as a combination of the following data - the Workspace identifier, the Contact external identifier, the Data Event name and the Data Event created time. As a result, it is **strongly recommended** to send a second granularity Unix timestamp in the `created_at` field. Duplicated events are responded to using the normal `202 Accepted` code - an error is not thrown, however repeat requests will be counted against any rate limit that is in place. ### HTTP API Responses - Successful responses to submitted events return `202 Accepted` with an empty body. - Unauthorised access will be rejected with a `401 Unauthorized` or `403 Forbidden` response code. - Events sent about users that cannot be found will return a `404 Not Found`. - Event lists containing duplicate events will have those duplicates ignored. - Server errors will return a `500` response code and may contain an error message in the body. responses: '202': description: successful '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: a9017097-c21a-46ec-a84f-6576d8bf6ed5 errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: content: application/json: schema: "$ref": "#/components/schemas/create_data_event_request" get: summary: List all data events parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" - in: query name: filter required: true style: form explode: true schema: type: object oneOf: - title: user_id query parameter properties: user_id: type: string required: - user_id additionalProperties: false - title: intercom_user_id query parameter properties: intercom_user_id: type: string required: - intercom_user_id additionalProperties: false - title: email query parameter properties: email: type: string required: - email additionalProperties: false - name: type in: query required: true description: The value must be user schema: type: string - name: summary in: query required: false description: summary flag schema: type: boolean tags: - Data Events operationId: lisDataEvents description: "\n> \U0001F6A7\n>\n> Please note that you can only 'list' events that are less than 90 days old. Event counts and summaries will still include your events older than 90 days but you cannot 'list' these events individually if they are older than 90 days\n\nThe events belonging to a customer can be listed by sending a GET request to `https://api.intercom.io/events` with a user or lead identifier along with a `type` parameter. The identifier parameter can be one of `user_id`, `email` or `intercom_user_id`. The `type` parameter value must be `user`.\n\n- `https://api.intercom.io/events?type=user&user_id={user_id}`\n- `https://api.intercom.io/events?type=user&email={email}`\n- `https://api.intercom.io/events?type=user&intercom_user_id={id}` (this call can be used to list leads)\n\nThe `email` parameter value should be [url encoded](http://en.wikipedia.org/wiki/Percent-encoding) when sending.\n\nYou can optionally define the result page size as well with the `per_page` parameter.\n" responses: '200': description: Successful response content: application/json: examples: Successful response: value: type: event.summary events: [] pages: next: http://api.intercom.test/events?next page email: user26@email.com intercom_user_id: 660e70e66abd01b9d190439f user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 schema: "$ref": "#/components/schemas/data_event_summary" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: 829923f2-edb3-4231-b3d4-428bb0c16ab7 errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" "/events/summaries": post: summary: Create event summaries parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" tags: - Data Events operationId: dataEventSummaries description: "Create event summaries for a user. Event summaries are used to track the number of times an event has occurred, the first time it occurred and the last time it occurred.\n\n" responses: '200': description: successful '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: e09337bd-1891-40b2-b208-d24897d009aa errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: content: application/json: schema: "$ref": "#/components/schemas/create_data_event_summaries_request" "/export/content/data": post: summary: Create content data export parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" tags: - Data Export operationId: createDataExport description: "To create your export job, you need to send a `POST` request to the export endpoint `https://api.intercom.io/export/content/data`.\n\nThe only parameters you need to provide are the range of dates that you want exported.\n\n>\U0001F6A7 Limit of one active job\n>\n> You can only have one active job per workspace. You will receive a HTTP status code of 429 with the message Exceeded rate limit of 1 pending message data export jobs if you attempt to create a second concurrent job.\n\n>❗️ Updated_at not included\n>\n> It should be noted that the timeframe only includes messages sent during the time period and not messages that were only updated during this period. For example, if a message was updated yesterday but sent two days ago, you would need to set the created_at_after date before the message was sent to include that in your retrieval job.\n\n>\U0001F4D8 Date ranges are inclusive\n>\n> Requesting data for 2018-06-01 until 2018-06-30 will get all data for those days including those specified - e.g. 2018-06-01 00:00:00 until 2018-06-30 23:59:99.\n" responses: '200': description: successful content: application/json: examples: successful: value: job_identifier: gcwhklmoqhj3cb9f status: pending download_url: '' download_expires_at: '' schema: "$ref": "#/components/schemas/data_export" requestBody: content: application/json: schema: "$ref": "#/components/schemas/create_data_exports_request" examples: successful: summary: successful value: created_at_after: 1712204440 created_at_before: 1712222440 "/export/content/data/{job_identifier}": get: summary: Show content data export parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" - name: job_identifier in: path description: job_identifier required: true schema: type: string tags: - Data Export operationId: getDataExport description: "You can view the status of your job by sending a `GET` request to the URL\n`https://api.intercom.io/export/content/data/{job_identifier}` - the `{job_identifier}` is the value returned in the response when you first created the export job. More on it can be seen in the Export Job Model.\n\n> \U0001F6A7 Jobs expire after two days\n> All jobs that have completed processing (and are thus available to download from the provided URL) will have an expiry limit of two days from when the export ob completed. After this, the data will no longer be available.\n" responses: '200': description: successful content: application/json: examples: successful: value: job_identifier: 5mtuk5dah079hs94 status: pending download_url: '' download_expires_at: '' schema: "$ref": "#/components/schemas/data_export" "/export/cancel/{job_identifier}": post: summary: Cancel content data export parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" - name: job_identifier in: path description: job_identifier required: true schema: type: string tags: - Data Export operationId: cancelDataExport description: You can cancel your job responses: '200': description: successful content: application/json: examples: successful: value: job_identifier: q8iynd54l2j1xln7 status: canceled download_url: '' download_expires_at: '' schema: "$ref": "#/components/schemas/data_export" "/download/content/data/{job_identifier}": get: summary: Download content data export parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" - name: job_identifier in: path description: job_identifier required: true schema: type: string tags: - Data Export operationId: downloadDataExport description: "When a job has a status of complete, and thus a filled download_url, you can download your data by hitting that provided URL, formatted like so: https://api.intercom.io/download/content/data/xyz1234.\n\nYour exported message data will be streamed continuously back down to you in a gzipped CSV format.\n\n> \U0001F4D8 Octet header required\n>\n> You will have to specify the header Accept: `application/octet-stream` when hitting this endpoint.\n" responses: '200': description: successful "/messages": post: summary: Create a message parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" tags: - Messages operationId: createMessage description: "You can create a message that has been initiated by an admin. The conversation can be either an in-app message or an email.\n\n> \U0001F6A7 Sending for visitors\n>\n> There can be a short delay between when a contact is created and when a contact becomes available to be messaged through the API. A 404 Not Found error will be returned in this case.\n\nThis will return the Message model that has been created.\n\n> \U0001F6A7 Retrieving Associated Conversations\n>\n> As this is a message, there will be no conversation present until the contact responds. Once they do, you will have to search for a contact's conversations with the id of the message.\n" responses: '200': description: admin message created content: application/json: examples: user message created: value: type: user_message id: '403920740' created_at: 1712222443 body: heyy message_type: inapp conversation_id: '4605' lead message created: value: type: user_message id: '403920741' created_at: 1712222444 body: heyy message_type: inapp conversation_id: '4606' admin message created: value: type: admin_message id: '155' created_at: 1712222445 subject: heyy body: heyy message_type: inapp owner: type: admin id: '991281619' name: Ciaran265 Lee email: admin265@email.com away_mode_enabled: false away_mode_reassign: false schema: "$ref": "#/components/schemas/message" '400': description: No body supplied for email message content: application/json: examples: No body supplied for message: value: type: error.list request_id: d9a19087-0e5d-416f-bf64-2561bf983692 errors: - code: parameter_invalid message: Body is required No body supplied for email message: value: type: error.list request_id: d347c7a4-3eb9-409e-9349-31a8ea4c36b9 errors: - code: parameter_invalid message: Body is required schema: "$ref": "#/components/schemas/error" '422': description: No subject supplied for email message content: application/json: examples: No subject supplied for email message: value: type: error.list request_id: 350ae999-7b24-4dd8-8c5a-3aca98d2e086 errors: - code: parameter_not_found message: No subject supplied for email message schema: "$ref": "#/components/schemas/error" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: 5fe21ec4-ec1c-4867-bc70-846cb94e043b errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" '403': description: API plan restricted content: application/json: examples: API plan restricted: value: type: error.list request_id: f9185688-5aba-450c-b932-f81e96b686b3 errors: - code: api_plan_restricted message: Active subscription needed. schema: "$ref": "#/components/schemas/error" requestBody: content: application/json: schema: "$ref": "#/components/schemas/create_message_request" examples: user_message_created: summary: user message created value: from: type: user id: 660e70eb6abd01b9d19043a4 body: heyy referer: https://twitter.com/bob lead_message_created: summary: lead message created value: from: type: lead id: 660e70ec6abd01b9d19043a5 body: heyy referer: https://twitter.com/bob admin_message_created: summary: admin message created value: from: type: admin id: '991281619' to: type: user id: 660e70ed6abd01b9d19043a6 message_type: conversation body: heyy no_body_supplied_for_message: summary: No body supplied for message value: from: type: admin id: '991281621' to: type: user id: 660e70ee6abd01b9d19043a7 message_type: inapp body: subject: heyy no_subject_supplied_for_email_message: summary: No subject supplied for email message value: from: type: admin id: '991281622' to: type: user user_id: '70' message_type: email body: hey there no_body_supplied_for_email_message: summary: No body supplied for email message value: from: type: admin id: '991281623' to: type: user id: 660e70ef6abd01b9d19043a9 message_type: email body: subject: heyy "/news/news_items": get: summary: List all news items parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" tags: - News operationId: listNewsItems description: You can fetch a list of all news items responses: '200': description: successful content: application/json: examples: successful: value: type: list pages: page: 1 per_page: 10 total_pages: 1 type: pages data: - id: '421' type: news-item workspace_id: this_is_an_id481_that_should_be_at_least_ title: We have news body: "Hello there,
" sender_id: 991281628 state: draft labels: [] cover_image_url: reactions: - - - - deliver_silently: false created_at: 1712222449 updated_at: 1712222449 newsfeed_assignments: [] - id: '422' type: news-item workspace_id: this_is_an_id481_that_should_be_at_least_ title: We have news body: "Hello there,
" sender_id: 991281630 state: draft labels: [] cover_image_url: reactions: - - - - deliver_silently: false created_at: 1712222449 updated_at: 1712222449 newsfeed_assignments: [] total_count: 2 schema: "$ref": "#/components/schemas/paginated_response" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: d7c9ad0d-9d99-4d08-81a1-93503c51af36 errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" post: summary: Create a news item parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" tags: - News operationId: createNewsItem description: You can create a news item responses: '200': description: successful content: application/json: examples: successful: value: id: '425' type: news-item workspace_id: this_is_an_id485_that_should_be_at_least_ title: Halloween is here! body: "New costumes in store for this spooky season
" sender_id: 991281637 state: live labels: - New - Product - Update cover_image_url: reactions: - "\U0001F606" - "\U0001F605" deliver_silently: true created_at: 1712222451 updated_at: 1712222451 newsfeed_assignments: - newsfeed_id: 753 published_at: 1664638214 schema: "$ref": "#/components/schemas/news_item" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: 3eee6295-8a37-4cad-a62b-a9bac86d4d0b errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: content: application/json: schema: "$ref": "#/components/schemas/news_item_request" examples: successful: summary: successful value: title: Halloween is here! body: "New costumes in store for this spooky season
" labels: - Product - Update - New sender_id: 991281637 deliver_silently: true reactions: - "\U0001F606" - "\U0001F605" state: live newsfeed_assignments: - newsfeed_id: 753 published_at: 1664638214 "/news/news_items/{id}": get: summary: Retrieve a news item parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" - name: id in: path required: true description: The unique identifier for the news item which is given by Intercom. example: 123 schema: type: integer tags: - News operationId: retrieveNewsItem description: You can fetch the details of a single news item. responses: '200': description: successful content: application/json: examples: successful: value: id: '426' type: news-item workspace_id: this_is_an_id489_that_should_be_at_least_ title: We have news body: "Hello there,
" sender_id: 991281640 state: live labels: [] cover_image_url: reactions: - - - - deliver_silently: false created_at: 1712222452 updated_at: 1712222452 newsfeed_assignments: - newsfeed_id: 755 published_at: 1712222452 schema: "$ref": "#/components/schemas/news_item" '404': description: News Item Not Found content: application/json: examples: News Item Not Found: value: type: error.list request_id: 8742c698-75f0-4589-bf31-62d5c272b2d8 errors: - code: not_found message: Resource Not Found schema: "$ref": "#/components/schemas/error" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: 956c27d1-3ba0-4e2f-bf5a-8c0417f3e9fd errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" put: summary: Update a news item parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" - name: id in: path required: true description: The unique identifier for the news item which is given by Intercom. example: 123 schema: type: integer tags: - News operationId: updateNewsItem responses: '200': description: successful content: application/json: examples: successful: value: id: '429' type: news-item workspace_id: this_is_an_id495_that_should_be_at_least_ title: Christmas is here! body: "New gifts in store for the jolly season
" sender_id: 991281648 state: live labels: [] cover_image_url: reactions: - "\U0001F61D" - "\U0001F602" deliver_silently: false created_at: 1712222454 updated_at: 1712222455 newsfeed_assignments: [] schema: "$ref": "#/components/schemas/news_item" '404': description: News Item Not Found content: application/json: examples: News Item Not Found: value: type: error.list request_id: 17383b62-5b18-4af6-a221-e374fdb87466 errors: - code: not_found message: Resource Not Found schema: "$ref": "#/components/schemas/error" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: c35a3c52-be69-4ac4-8c9f-f55b79e0a28e errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: content: application/json: schema: "$ref": "#/components/schemas/news_item_request" examples: successful: summary: successful value: title: Christmas is here! body: "New gifts in store for the jolly season
" sender_id: 991281648 reactions: - "\U0001F61D" - "\U0001F602" news_item_not_found: summary: News Item Not Found value: title: Christmas is here! body: "New gifts in store for the jolly season
" sender_id: 991281651 reactions: - "\U0001F61D" - "\U0001F602" delete: summary: Delete a news item parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" - name: id in: path required: true description: The unique identifier for the news item which is given by Intercom. example: 123 schema: type: integer tags: - News operationId: deleteNewsItem description: You can delete a single news item. responses: '200': description: successful content: application/json: examples: successful: value: id: '432' object: news-item deleted: true schema: "$ref": "#/components/schemas/deleted_object" '404': description: News Item Not Found content: application/json: examples: News Item Not Found: value: type: error.list request_id: d4ca58fd-f0d7-4a69-87e1-2b4de5d81a42 errors: - code: not_found message: Resource Not Found schema: "$ref": "#/components/schemas/error" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: a8ee9e41-32cd-43a6-9bc6-819fdc1ab30f errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" "/news/newsfeeds/{id}/items": get: summary: List all live newsfeed items parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" - name: id in: path required: true description: The unique identifier for the news feed item which is given by Intercom. example: '123' schema: type: string tags: - News operationId: listLiveNewsfeedItems description: You can fetch a list of all news items that are live on a given newsfeed responses: '200': description: successful content: application/json: examples: successful: value: type: list pages: page: 1 per_page: 20 total_pages: 0 type: pages data: [] total_count: 0 schema: "$ref": "#/components/schemas/paginated_response" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: 041e3ea1-e840-407c-a96c-f7eaf062beff errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" "/news/newsfeeds": get: summary: List all newsfeeds parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" tags: - News operationId: listNewsfeeds description: You can fetch a list of all newsfeeds responses: '200': description: successful content: application/json: examples: successful: value: type: list pages: page: 1 per_page: 10 total_pages: 1 type: pages data: - id: '768' type: newsfeed name: Visitor Feed created_at: 1712222459 updated_at: 1712222459 - id: '769' type: newsfeed name: Visitor Feed created_at: 1712222459 updated_at: 1712222459 total_count: 2 schema: "$ref": "#/components/schemas/paginated_response" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: 45da78aa-ac1f-4224-a85e-037eccf2d811 errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" "/news/newsfeeds/{id}": get: summary: Retrieve a newsfeed parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" - name: id in: path required: true description: The unique identifier for the news feed item which is given by Intercom. example: '123' schema: type: string tags: - News operationId: retrieveNewsfeed description: You can fetch the details of a single newsfeed responses: '200': description: successful content: application/json: examples: successful: value: id: '772' type: newsfeed name: Visitor Feed created_at: 1712222460 updated_at: 1712222460 schema: "$ref": "#/components/schemas/newsfeed" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: 536d1c3e-9f2d-42a2-b2bf-8bc19ac54482 errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" "/notes/{id}": get: summary: Retrieve a note parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" - name: id in: path required: true description: The unique identifier of a given note example: 1 schema: type: integer tags: - Notes operationId: retrieveNote description: You can fetch the details of a single note. responses: '200': description: Note found content: application/json: examples: Note found: value: type: note id: '421' created_at: 1711531261 contact: type: contact id: 660e70fd6abd01b9d19043ac author: type: admin id: '991281667' name: Ciaran312 Lee email: admin312@email.com away_mode_enabled: false away_mode_reassign: false body: "This is a note.
" schema: "$ref": "#/components/schemas/note" '404': description: Note not found content: application/json: examples: Note not found: value: type: error.list request_id: 6b623d66-e7c9-4209-80a1-164064adc722 errors: - code: not_found message: Resource Not Found schema: "$ref": "#/components/schemas/error" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: d67411fa-5f7e-4d99-81ee-75c2de756438 errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" "/segments": get: summary: List all segments parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" - name: include_count in: query required: false description: It includes the count of contacts that belong to each segment. example: true schema: type: boolean tags: - Segments operationId: listSegments description: You can fetch a list of all segments. responses: '200': description: Successful response content: application/json: examples: Successful response: value: type: segment.list segments: - type: segment id: 660e70ff6abd01b9d19043af name: John segment created_at: 1712222463 updated_at: 1712222463 person_type: user - type: segment id: 660e70ff6abd01b9d19043b0 name: Jane segment created_at: 1712222463 updated_at: 1712222463 person_type: user schema: "$ref": "#/components/schemas/segment_list" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: 46a7a758-bf10-402d-bb69-55f1d868311a errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" "/segments/{id}": get: summary: Retrieve a segment parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" - name: id in: path required: true description: The unique identified of a given segment. example: '123' schema: type: string tags: - Segments operationId: retrieveSegment description: You can fetch the details of a single segment. responses: '200': description: Successful response content: application/json: examples: Successful response: value: type: segment id: 660e71006abd01b9d19043b3 name: John segment created_at: 1712222464 updated_at: 1712222464 person_type: user schema: "$ref": "#/components/schemas/segment" '404': description: Segment not found content: application/json: examples: Segment not found: value: type: error.list request_id: de937942-5245-470e-be5a-91e39d8c8ab6 errors: - code: not_found message: Resource Not Found schema: "$ref": "#/components/schemas/error" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: 7faac641-d1f5-4272-91b5-415a91aecdb5 errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" "/subscription_types": get: summary: List subscription types parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" tags: - Subscription Types operationId: listSubscriptionTypes description: You can list all subscription types. A list of subscription type objects will be returned. responses: '200': description: Successful content: application/json: examples: Successful: value: type: list data: - type: subscription id: '1513' state: live consent_type: opt_out default_translation: name: Newsletters description: Lorem ipsum dolor sit amet locale: en translations: - name: Newsletters description: Lorem ipsum dolor sit amet locale: en content_types: - email schema: "$ref": "#/components/schemas/subscription_type_list" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: e0ba699e-845f-4833-a93a-cbff470ed032 errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" "/phone_call_redirects": post: summary: Create a phone Switch parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" tags: - Switch operationId: createPhoneSwitch description: | You can use the API to deflect phone calls to the Intercom Messenger. Calling this endpoint will send an SMS with a link to the Messenger to the phone number specified. If custom attributes are specified, they will be added to the user or lead's custom data attributes. responses: '200': description: successful content: application/json: examples: successful: value: url: http://via.intercom.io/msgr/6f80c9f2-a85a-45c2-afdf-f041c3202972 type: phone_call_redirect schema: "$ref": "#/components/schemas/phone_switch" '400': description: bad request - invalid number content: application/json: examples: bad request - exception sending sms: value: error_key: sms_failed message: SMS was not sent due to an unknown error bad request - invalid number: value: error_key: invalid_phone_number message: Invalid phone number '422': description: unprocessable entity content: application/json: examples: unprocessable entity: value: error_key: some_error '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: 573a76cf-ee52-4ac4-bdf7-37b7e898ee11 errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: content: application/json: schema: "$ref": "#/components/schemas/create_phone_switch_request" examples: successful: summary: successful value: phone: "+353832345678" custom_attributes: issue_type: Billing priority: High bad_request_-_exception_sending_sms: summary: bad request - exception sending sms value: phone: "+353832345678" custom_attributes: issue_type: Billing priority: High bad_request_-_invalid_number: summary: bad request - invalid number value: phone: "+353832345678" custom_attributes: issue_type: Billing priority: High unprocessable_entity: summary: unprocessable entity value: phone: "+40241100100" custom_attributes: issue_type: Billing priority: High "/tags": get: summary: List all tags parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" tags: - Tags operationId: listTags description: "You can fetch a list of all tags for a given workspace.\n\n" responses: '200': description: successful content: application/json: examples: successful: value: type: list data: - type: tag id: '1339' name: Manual tag 1 schema: "$ref": "#/components/schemas/tag_list" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: 7fda19cf-a0b3-44ba-8d55-335e2325a311 errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" post: summary: Create or update a tag, Tag or untag companies, Tag contacts parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" tags: - Tags operationId: createTag description: | You can use this endpoint to perform the following operations: **1. Create a new tag:** You can create a new tag by passing in the tag name as specified in "Create or Update Tag Request Payload" described below. **2. Update an existing tag:** You can update an existing tag by passing the id of the tag as specified in "Create or Update Tag Request Payload" described below. **3. Tag Companies:** You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in "Tag Company Request Payload" described below. Also, if the tag doesn't exist then a new one will be created automatically. **4. Untag Companies:** You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in "Untag Company Request Payload" described below. **5. Tag Multiple Users:** You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in "Tag Users Request Payload" described below. Each operation will return a tag object. responses: '200': description: Action successful content: application/json: examples: Action successful: value: type: tag id: '1342' name: test schema: "$ref": "#/components/schemas/tag" '400': description: Invalid parameters content: application/json: examples: Invalid parameters: value: type: error.list request_id: 548289dc-e642-430e-9c01-4a5320f6a35f errors: - code: parameter_invalid message: invalid tag parameters schema: "$ref": "#/components/schemas/error" '404': description: User not found content: application/json: examples: Company not found: value: type: error.list request_id: e1ab371e-8f0d-4ced-a8bd-e36d32dfe70c errors: - code: company_not_found message: Company Not Found User not found: value: type: error.list request_id: b360c476-c787-4851-af8a-b4ba42170894 errors: - code: not_found message: User Not Found schema: "$ref": "#/components/schemas/error" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: c93558ac-b4c3-4e50-a170-81a3c7600fda errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: content: application/json: schema: oneOf: - "$ref": "#/components/schemas/create_or_update_tag_request" - "$ref": "#/components/schemas/tag_company_request" - "$ref": "#/components/schemas/untag_company_request" - "$ref": "#/components/schemas/tag_multiple_users_request" examples: action_successful: summary: Action successful value: name: test invalid_parameters: summary: Invalid parameters value: test: invalid company_not_found: summary: Company not found value: name: test companies: - company_id: '123' user_not_found: summary: User not found value: name: test users: - id: '123' "/tags/{id}": get: summary: Find a specific tag parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" - name: id in: path description: The unique identifier of a given tag example: '123' required: true schema: type: string tags: - Tags operationId: findTag description: | You can fetch the details of tags that are on the workspace by their id. This will return a tag object. responses: '200': description: Tag found content: application/json: examples: Tag found: value: type: tag id: '1350' name: Manual tag schema: "$ref": "#/components/schemas/tag" '404': description: Tag not found content: application/json: examples: Tag not found: value: type: error.list request_id: 9022b0b8-8023-4dc3-836d-82ea23671b40 errors: - code: not_found message: Resource Not Found schema: "$ref": "#/components/schemas/error" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: a05c5761-67e2-4216-865a-3d9f045f3750 errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" delete: summary: Delete tag parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" - name: id in: path description: The unique identifier of a given tag example: '123' required: true schema: type: string tags: - Tags operationId: deleteTag description: You can delete the details of tags that are on the workspace by passing in the id. responses: '200': description: Successful '404': description: Resource not found content: application/json: examples: Resource not found: value: type: error.list request_id: c32964a1-27a2-446d-8701-437cbe67b32a errors: - code: not_found message: Resource Not Found schema: "$ref": "#/components/schemas/error" '400': description: Tag has dependent objects content: application/json: examples: Tag has dependent objects: value: type: error.list request_id: 2b40287b-88c5-418b-84b4-53a810b76187 errors: - code: tag_has_dependent_objects message: 'Unable to delete Tag with dependent objects. Segments: Seg 1.' schema: "$ref": "#/components/schemas/error" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: 7d392ae9-423f-4f6b-a400-ff54d7cc9a0a errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" "/teams": get: summary: List all teams parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" tags: - Teams operationId: listTeams description: This will return a list of team objects for the App. responses: '200': description: successful content: application/json: examples: successful: value: type: team.list teams: [] schema: "$ref": "#/components/schemas/team_list" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: 40615fb0-b680-4a9b-aeb0-750a33ad90b9 errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" "/teams/{id}": get: summary: Retrieve a team parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" - name: id in: path required: true description: The unique identifier of a given team. example: '123' schema: type: string tags: - Teams operationId: retrieveTeam description: You can fetch the details of a single team, containing an array of admins that belong to this team. responses: '200': description: successful content: application/json: examples: successful: value: type: team id: '991281705' name: team 1 admin_ids: [] schema: "$ref": "#/components/schemas/team" '404': description: Team not found content: application/json: examples: Team not found: value: type: error.list request_id: ef73a509-4b85-4fdf-ae06-0d11a5d07571 errors: - code: team_not_found message: Team not found schema: "$ref": "#/components/schemas/error" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: e03cd85f-2af6-4314-9014-a3d15b231e0f errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" "/visitors": put: summary: Update a visitor parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" tags: - Visitors operationId: updateVisitor description: | Sending a PUT request to `/visitors` will result in an update of an existing Visitor. **Option 1.** You can update a visitor by passing in the `user_id` of the visitor in the Request body. **Option 2.** You can update a visitor by passing in the `id` of the visitor in the Request body. responses: '200': description: successful content: application/json: examples: successful: value: type: visitor id: 660e711f6abd01b9d19043d7 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' phone: name: Gareth Bale pseudonym: Charcoal Knight avatar: type: avatar image_url: https://static.intercomassets.com/app/pseudonym_avatars_2019/charcoal-knight.png app_id: this_is_an_id611_that_should_be_at_least_ companies: type: company.list companies: [] location_data: {} last_request_at: created_at: 1712222495 remote_created_at: 1712222495 signed_up_at: 1712222495 updated_at: 1712222495 session_count: 0 social_profiles: type: social_profile.list social_profiles: [] owner_id: unsubscribed_from_emails: false marked_email_as_spam: false has_hard_bounced: false tags: type: tag.list tags: [] segments: type: segment.list segments: [] custom_attributes: {} referrer: utm_campaign: utm_content: utm_medium: utm_source: utm_term: do_not_track: schema: "$ref": "#/components/schemas/visitor" '404': description: visitor Not Found content: application/json: examples: visitor Not Found: value: type: error.list request_id: 49fe698e-466f-440b-a616-6455c14e2de7 errors: - code: not_found message: Visitor Not Found schema: "$ref": "#/components/schemas/error" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: bbe7204f-5e2b-4bc9-8e4e-5de5e5ab3583 errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: content: application/json: schema: "$ref": "#/components/schemas/update_visitor_request" examples: successful: summary: successful value: id: 660e711f6abd01b9d19043d7 name: Gareth Bale visitor_not_found: summary: visitor Not Found value: user_id: fail name: Christian Fail get: summary: Retrieve a visitor with User ID parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" - name: user_id in: query description: The user_id of the Visitor you want to retrieve. required: true schema: type: string tags: - Visitors operationId: retrieveVisitorWithUserId description: You can fetch the details of a single visitor. responses: '200': description: successful content: application/json: examples: successful: value: type: visitor id: 660e71216abd01b9d19043dd user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' phone: name: pseudonym: avatar: type: avatar image_url: app_id: this_is_an_id617_that_should_be_at_least_ companies: type: company.list companies: [] location_data: {} last_request_at: created_at: 1712222497 remote_created_at: 1712222497 signed_up_at: 1712222497 updated_at: 1712222497 session_count: 0 social_profiles: type: social_profile.list social_profiles: [] owner_id: unsubscribed_from_emails: false marked_email_as_spam: false has_hard_bounced: false tags: type: tag.list tags: [] segments: type: segment.list segments: [] custom_attributes: {} referrer: utm_campaign: utm_content: utm_medium: utm_source: utm_term: do_not_track: schema: "$ref": "#/components/schemas/visitor" '404': description: Visitor not found content: application/json: examples: Visitor not found: value: type: error.list request_id: 89472d56-c695-4a0e-9716-ba329acede46 errors: - code: not_found message: Visitor Not Found schema: "$ref": "#/components/schemas/error" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: c167e427-c89a-42e2-b762-cc911f8d3d3a errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" "/visitors/{id}": get: summary: Retrieve a visitor with ID parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" - name: id in: path required: true description: Id provided by Intercom. example: 5e1c4c1c-7b1e-4b5d-8c1c-5e1c4c1c7b1e schema: type: string tags: - Visitors operationId: retrieveVisitor description: You can fetch the details of a single visitor. responses: '200': description: successful content: application/json: examples: successful: value: type: visitor id: 660e71236abd01b9d19043e3 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' phone: name: pseudonym: avatar: type: avatar image_url: app_id: this_is_an_id623_that_should_be_at_least_ companies: type: company.list companies: [] location_data: {} last_request_at: created_at: 1712222499 remote_created_at: 1712222499 signed_up_at: 1712222499 updated_at: 1712222499 session_count: 0 social_profiles: type: social_profile.list social_profiles: [] owner_id: unsubscribed_from_emails: false marked_email_as_spam: false has_hard_bounced: false tags: type: tag.list tags: [] segments: type: segment.list segments: [] custom_attributes: {} referrer: utm_campaign: utm_content: utm_medium: utm_source: utm_term: do_not_track: schema: "$ref": "#/components/schemas/visitor" '404': description: Visitor not found content: application/json: examples: Visitor not found: value: type: error.list request_id: 1eae1999-15fc-4549-80b8-f038892bd3f6 errors: - code: not_found message: Visitor Not Found schema: "$ref": "#/components/schemas/error" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: 143e9493-d2d9-40cd-9a14-3c9d5d518a3b errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" delete: summary: Delete a visitor parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" - name: id in: path required: true description: Id provided by Intercom. example: 5e1c4c1c-7b1e-4b5d-8c1c-5e1c4c1c7b1e schema: type: string tags: - Visitors operationId: deleteVisitor description: You can delete a single visitor. responses: '200': description: successful content: application/json: examples: successful: value: type: visitor id: 660e71256abd01b9d19043e9 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' phone: name: pseudonym: avatar: type: avatar image_url: app_id: this_is_an_id629_that_should_be_at_least_ companies: type: company.list companies: [] location_data: {} last_request_at: created_at: 1712222501 remote_created_at: 1712222501 signed_up_at: 1712222501 updated_at: 1712222501 session_count: 0 social_profiles: type: social_profile.list social_profiles: [] owner_id: unsubscribed_from_emails: false marked_email_as_spam: false has_hard_bounced: false tags: type: tag.list tags: [] segments: type: segment.list segments: [] custom_attributes: {} referrer: utm_campaign: utm_content: utm_medium: utm_source: utm_term: do_not_track: schema: "$ref": "#/components/schemas/visitor_deleted_object" '404': description: Visitor Not Found content: application/json: examples: Visitor Not Found: value: type: error.list request_id: d1e0c2d5-c639-4882-9a76-e656e9d19029 errors: - code: not_found message: User Not Found schema: "$ref": "#/components/schemas/error" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: 7af7bdac-1a61-4b4e-a91f-bd73013a2559 errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" "/visitors/convert": post: summary: Convert a visitor parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" tags: - Visitors operationId: convertVisitor description: "You can merge a Visitor to a Contact of role type `lead` or `user`.\n\n> \U0001F4D8 What happens upon a visitor being converted?\n>\n> If the User exists, then the Visitor will be merged into it, the Visitor deleted and the User returned. If the User does not exist, the Visitor will be converted to a User, with the User identifiers replacing it's Visitor identifiers.\n" responses: '200': description: successful content: application/json: examples: successful: value: type: contact id: 660e71276abd01b9d19043f0 workspace_id: this_is_an_id635_that_should_be_at_least_ external_id: role: user email: foo@bar.com phone: name: avatar: owner_id: social_profiles: type: list data: [] has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false created_at: 1712222503 updated_at: 1712222503 signed_up_at: 1712222503 last_seen_at: last_replied_at: last_contacted_at: last_email_opened_at: last_email_clicked_at: language_override: browser: browser_version: browser_language: os: location: type: location country: region: city: country_code: continent_code: android_app_name: android_app_version: android_device: android_os_version: android_sdk_version: android_last_seen_at: ios_app_name: ios_app_version: ios_device: ios_os_version: ios_sdk_version: ios_last_seen_at: custom_attributes: {} tags: type: list data: [] url: "/contacts/660e71276abd01b9d19043f0/tags" total_count: 0 has_more: false notes: type: list data: [] url: "/contacts/660e71276abd01b9d19043f0/notes" total_count: 0 has_more: false companies: type: list data: [] url: "/contacts/660e71276abd01b9d19043f0/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] url: "/contacts/660e71276abd01b9d19043f0/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] url: "/contacts/660e71276abd01b9d19043f0/subscriptions" total_count: 0 has_more: false utm_campaign: utm_content: utm_medium: utm_source: utm_term: referrer: schema: "$ref": "#/components/schemas/contact" '401': description: Unauthorized content: application/json: examples: Unauthorized: value: type: error.list request_id: 7aa11d0f-8929-4927-b526-e28438bc07b0 errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: content: application/json: schema: "$ref": "#/components/schemas/convert_visitor_request" examples: successful: summary: successful value: visitor: user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 user: email: foo@bar.com type: user components: schemas: activity_log: title: Activity Log type: object description: Activities performed by admins. nullable: true properties: id: type: string description: The id representing the activity. example: '6' performed_by: type: object description: An object representing the admin who performed the activity. properties: type: type: string description: String representing the object's type. Always has the value `admin`. example: admin id: type: string description: The id representing the admin. example: '1295' email: type: string description: The email of the admin. example: john@example.com ip: type: string description: The IP address of the admin. example: 198.51.100.255 metadata: type: object created_at: type: integer format: date-time description: The time the activity was created. example: 1671028894 activity_type: type: string enum: - admin_assignment_limit_change - admin_away_mode_change - admin_deletion - admin_deprovisioned - admin_impersonation_end - admin_impersonation_start - admin_invite_change - admin_invite_creation - admin_invite_deletion - admin_login_failure - admin_login_success - admin_logout - admin_password_reset_request - admin_password_reset_success - admin_permission_change - admin_provisioned - admin_two_factor_auth_change - admin_unauthorized_sign_in_method - app_admin_join - app_authentication_method_change - app_data_deletion - app_data_export - app_google_sso_domain_change - app_identity_verification_change - app_name_change - app_outbound_address_change - app_package_installation - app_package_token_regeneration - app_package_uninstallation - app_team_creation - app_team_deletion - app_team_membership_modification - app_timezone_change - app_webhook_creation - app_webhook_deletion - articles_in_messenger_enabled_change - bulk_delete - bulk_export - campaign_deletion - campaign_state_change - conversation_part_deletion - conversation_topic_change - conversation_topic_creation - conversation_topic_deletion - help_center_settings_change - inbound_conversations_change - inbox_access_change - message_deletion - message_state_change - messenger_look_and_feel_change - messenger_search_required_change - messenger_spaces_change - office_hours_change - role_change - role_creation - role_deletion - ruleset_activation_title_preview - ruleset_creation - ruleset_deletion - search_browse_enabled_change - search_browse_required_change - seat_change - seat_revoke - security_settings_change - temporary_expectation_change - upfront_email_collection_change - welcome_message_change example: app_name_change activity_description: type: string description: A sentence or two describing the activity. example: Admin updated the app's name to "My App". activity_log_list: title: Paginated Response type: object description: A paginated list of activity logs. properties: type: type: string description: String representing the object's type. Always has the value `activity_log.list`. example: activity_log.list pages: "$ref": "#/components/schemas/cursor_pages" activity_logs: type: array description: An array of activity logs items: "$ref": "#/components/schemas/activity_log" addressable_list: title: Addressable List type: object nullable: false description: A list used to access other resources from a parent model. properties: type: type: string format: uri description: The addressable object type example: note id: type: string description: The id of the addressable object example: '123' url: type: string format: uri description: Url to get more company resources for this contact example: "/contacts/5ba682d23d7cf92bef87bfd4/notes" admin: title: Admin type: object x-tags: - Admins description: Admins are teammate accounts that have access to a workspace. nullable: true properties: type: type: string description: String representing the object's type. Always has the value `admin`. example: admin id: type: string description: The id representing the admin. example: '1295' name: type: string description: The name of the admin. example: Hoban Washburne email: type: string description: The email of the admin. example: wash@serenity.io job_title: type: string description: The job title of the admin. example: Philosopher away_mode_enabled: type: boolean description: Identifies if this admin is currently set in away mode. example: false away_mode_reassign: type: boolean description: Identifies if this admin is set to automatically reassign new conversations to the apps default inbox. example: false has_inbox_seat: type: boolean description: Identifies if this admin has a paid inbox seat to restrict/allow features that require them. example: true team_ids: type: array description: This object represents the avatar associated with the admin. example: - 814865 items: type: integer avatar: type: string format: uri nullable: true description: Image for the associated team or teammate example: https://picsum.photos/200/300 team_priority_level: "$ref": "#/components/schemas/team_priority_level" admin_list: title: Admins type: object description: A list of admins associated with a given workspace. properties: type: type: string description: String representing the object's type. Always has the value `admin.list`. example: admin.list admins: type: array description: A list of admins associated with a given workspace. items: "$ref": "#/components/schemas/admin" admin_priority_level: title: Admin Priority Level type: object nullable: true description: Admin priority levels for the team properties: primary_admin_ids: type: array description: The primary admin ids for the team nullable: true example: - 493881 items: type: integer secondary_admin_ids: type: array description: The secondary admin ids for the team nullable: true example: - 814865 items: type: integer admin_reply_conversation_request: title: Admin Reply type: object description: Payload of the request to reply on behalf of an admin properties: message_type: type: string enum: - comment - note type: type: string enum: - admin example: admin body: type: string description: The text body of the reply. Notes accept some HTML formatting. Must be present for comment and note message types. example: Hello there! admin_id: type: string description: The id of the admin who is authoring the comment. example: '3156780' created_at: type: integer description: The time the reply was created. If not provided, the current time will be used. example: 1590000000 attachment_urls: type: array description: A list of image URLs that will be added as attachments. You can include up to 10 URLs. items: type: string format: uri maxItems: 10 attachment_files: type: array description: A list of files that will be added as attachments. You can include up to 10 files items: "$ref": "#/components/schemas/conversation_attachment_files" maxItems: 10 required: - message_type - type - admin_id admin_with_app: title: Admin type: object description: Admins are the teammate accounts that have access to a workspace nullable: true properties: type: type: string description: String representing the object's type. Always has the value `admin`. example: admin id: type: string description: The id representing the admin. example: '1295' name: type: string description: The name of the admin. example: Hoban Washburne email: type: string description: The email of the admin. example: wash@serenity.io job_title: type: string description: The job title of the admin. example: Philosopher away_mode_enabled: type: boolean description: Identifies if this admin is currently set in away mode. example: false away_mode_reassign: type: boolean description: Identifies if this admin is set to automatically reassign new conversations to the apps default inbox. example: false has_inbox_seat: type: boolean description: Identifies if this admin has a paid inbox seat to restrict/allow features that require them. example: true team_ids: type: array description: This is a list of ids of the teams that this admin is part of. example: - 814865 items: type: integer avatar: type: object description: This object represents the avatar associated with the admin. properties: type: type: string description: This is a string that identifies the type of the object. It will always have the value `avatar`. default: avatar example: avatar image_url: type: string format: uri nullable: true description: This object represents the avatar associated with the admin. example: https://example.com/avatar.png email_verified: type: boolean description: Identifies if this admin's email is verified. nullable: true example: true app: "$ref": "#/components/schemas/app" nullable: true description: App that the admin belongs to. app: title: App type: object description: App is a workspace on Intercom nullable: true properties: type: type: string description: '' default: app example: app id_code: type: string description: The id of the app. example: xyz789 name: type: string description: The name of the app. example: ACME region: type: string description: The Intercom region the app is located in. example: US timezone: type: string description: The timezone of the region where the app is located. example: America/Los_Angeles created_at: type: integer description: When the app was created. example: 1671465577 identity_verification: type: boolean description: Whether or not the app uses identity verification. example: false article: title: Article type: object x-tags: - Articles description: The Articles API is a central place to gather all information and take actions on your articles. Articles can live within collections and sections, or alternatively they can stand alone. properties: statistics: nullable: true "$ref": "#/components/schemas/article_statistics" allOf: - "$ref": "#/components/schemas/article_list_item" article_content: title: Article Content type: object description: The Content of an Article. nullable: true properties: type: type: string description: The type of object - `article_content` . enum: - - article_content example: article_content nullable: true title: type: string description: The title of the article. example: How to create a new article description: type: string description: The description of the article. example: This article will show you how to create a new article. body: type: string description: The body of the article. example: This is the body of the article. author_id: type: integer description: The ID of the author of the article. example: '5017691' state: type: string description: Whether the article is `published` or is a `draft` . enum: - published - draft example: draft created_at: type: integer format: date-time description: The time when the article was created (seconds). example: 1663597223 updated_at: type: integer format: date-time description: The time when the article was last updated (seconds). example: 1663597260 url: type: string description: The URL of the article. example: http://intercom.test/help/en/articles/3-default-language article_list: title: Articles type: object description: This will return a list of articles for the App. properties: type: type: string description: The type of the object - `list`. enum: - list example: list pages: "$ref": "#/components/schemas/cursor_pages" total_count: type: integer description: A count of the total number of articles. example: 1 data: type: array description: An array of Article objects items: "$ref": "#/components/schemas/article_list_item" article_list_item: title: Articles type: object x-tags: - Articles description: The data returned about your articles when you list them. properties: type: type: string description: The type of object - `article`. enum: - article default: article example: article id: type: string description: The unique identifier for the article which is given by Intercom. example: '6871119' workspace_id: type: string description: The id of the workspace which the article belongs to. example: hfi1bx4l title: type: string description: The title of the article. For multilingual articles, this will be the title of the default language's content. example: Default language title description: type: string nullable: true description: The description of the article. For multilingual articles, this will be the description of the default language's content. example: Default language description body: type: string nullable: true description: The body of the article in HTML. For multilingual articles, this will be the body of the default language's content. example: Default language body in html author_id: type: integer 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. example: '5017691' state: type: string description: Whether the article is `published` or is a `draft`. For multilingual articles, this will be the state of the default language's content. enum: - published - draft default: draft example: published created_at: type: integer format: date-time description: The time when the article was created. For multilingual articles, this will be the timestamp of creation of the default language's content in seconds. example: 1672928359 updated_at: type: integer format: date-time description: The time when the article was last updated. For multilingual articles, this will be the timestamp of last update of the default language's content in seconds. example: 1672928610 url: type: string nullable: true description: The URL of the article. For multilingual articles, this will be the URL of the default language's content. example: http://intercom.test/help/en/articles/3-default-language parent_id: type: integer nullable: true description: The id of the article's parent collection or section. An article without this field stands alone. example: '125685' parent_ids: type: array description: The ids of the article's parent collections or sections. An article without this field stands alone. items: type: integer example: - 18 - 19 parent_type: type: string nullable: true description: The type of parent, which can either be a `collection` or `section`. example: collection default_locale: type: string description: The default locale of the help center. This field is only returned for multilingual help centers. example: en translated_content: nullable: true "$ref": "#/components/schemas/article_translated_content" article_statistics: title: Article Statistics type: object description: The statistics of an article. nullable: true properties: type: type: string description: The type of object - `article_statistics`. enum: - article_statistics default: article_statistics example: article_statistics views: type: integer description: The number of total views the article has received. example: 10 conversions: type: integer description: The number of conversations started from the article. example: 0 reactions: type: integer description: The number of total reactions the article has received. example: 10 happy_reaction_percentage: type: number format: float description: The percentage of happy reactions the article has received against other types of reaction. example: 40.0 neutral_reaction_percentage: type: number format: float description: The percentage of neutral reactions the article has received against other types of reaction. example: 40.0 sad_reaction_percentage: type: number format: float description: The percentage of sad reactions the article has received against other types of reaction. example: 20.0 article_translated_content: title: Article Translated Content type: object description: The Translated Content of an Article. The keys are the locale codes and the values are the translated content of the article. nullable: true properties: type: type: string description: The type of object - article_translated_content. enum: - - article_translated_content example: article_translated_content nullable: true ar: description: The content of the article in Arabic "$ref": "#/components/schemas/article_content" bg: description: The content of the article in Bulgarian "$ref": "#/components/schemas/article_content" bs: description: The content of the article in Bosnian "$ref": "#/components/schemas/article_content" ca: description: The content of the article in Catalan "$ref": "#/components/schemas/article_content" cs: description: The content of the article in Czech "$ref": "#/components/schemas/article_content" da: description: The content of the article in Danish "$ref": "#/components/schemas/article_content" de: description: The content of the article in German "$ref": "#/components/schemas/article_content" el: description: The content of the article in Greek "$ref": "#/components/schemas/article_content" en: description: The content of the article in English "$ref": "#/components/schemas/article_content" es: description: The content of the article in Spanish "$ref": "#/components/schemas/article_content" et: description: The content of the article in Estonian "$ref": "#/components/schemas/article_content" fi: description: The content of the article in Finnish "$ref": "#/components/schemas/article_content" fr: description: The content of the article in French "$ref": "#/components/schemas/article_content" he: description: The content of the article in Hebrew "$ref": "#/components/schemas/article_content" hr: description: The content of the article in Croatian "$ref": "#/components/schemas/article_content" hu: description: The content of the article in Hungarian "$ref": "#/components/schemas/article_content" id: description: The content of the article in Indonesian "$ref": "#/components/schemas/article_content" it: description: The content of the article in Italian "$ref": "#/components/schemas/article_content" ja: description: The content of the article in Japanese "$ref": "#/components/schemas/article_content" ko: description: The content of the article in Korean "$ref": "#/components/schemas/article_content" lt: description: The content of the article in Lithuanian "$ref": "#/components/schemas/article_content" lv: description: The content of the article in Latvian "$ref": "#/components/schemas/article_content" mn: description: The content of the article in Mongolian "$ref": "#/components/schemas/article_content" nb: description: The content of the article in Norwegian "$ref": "#/components/schemas/article_content" nl: description: The content of the article in Dutch "$ref": "#/components/schemas/article_content" pl: description: The content of the article in Polish "$ref": "#/components/schemas/article_content" pt: description: The content of the article in Portuguese (Portugal) "$ref": "#/components/schemas/article_content" ro: description: The content of the article in Romanian "$ref": "#/components/schemas/article_content" ru: description: The content of the article in Russian "$ref": "#/components/schemas/article_content" sl: description: The content of the article in Slovenian "$ref": "#/components/schemas/article_content" sr: description: The content of the article in Serbian "$ref": "#/components/schemas/article_content" sv: description: The content of the article in Swedish "$ref": "#/components/schemas/article_content" tr: description: The content of the article in Turkish "$ref": "#/components/schemas/article_content" vi: description: The content of the article in Vietnamese "$ref": "#/components/schemas/article_content" pt-BR: description: The content of the article in Portuguese (Brazil) "$ref": "#/components/schemas/article_content" zh-CN: description: The content of the article in Chinese (China) "$ref": "#/components/schemas/article_content" zh-TW: description: The content of the article in Chinese (Taiwan) "$ref": "#/components/schemas/article_content" assign_conversation_request: title: Assign Conversation Request type: object description: Payload of the request to assign a conversation properties: message_type: type: string enum: - assignment example: assignment type: type: string enum: - admin - team example: admin admin_id: type: string description: The id of the admin who is performing the action. example: '12345' assignee_id: type: string description: The `id` of the `admin` or `team` which will be assigned the conversation. A conversation can be assigned both an admin and a team.\nSet `0` if you want this assign to no admin or team (ie. Unassigned). example: '4324241' body: type: string description: Optionally you can send a response in the conversation when it is assigned. example: Let me pass you over to one of my colleagues. required: - message_type - type - admin_id - assignee_id attach_contact_to_conversation_request: title: Assign Conversation Request type: object description: Payload of the request to assign a conversation properties: admin_id: type: string description: The `id` of the admin who is adding the new participant. example: '12345' customer: type: object oneOf: - title: Intercom User ID properties: intercom_user_id: type: string description: The identifier for the contact as given by Intercom. example: 6329bd9ffe4e2e91dac76188 customer: "$ref": "#/components/schemas/customer_request" required: - intercom_user_id - title: User ID properties: user_id: type: string description: The external_id you have defined for the contact who is being added as a participant. example: 6329bd9ffe4e2e91dac76188 customer: "$ref": "#/components/schemas/customer_request" required: - user_id - title: Email properties: email: type: string description: The email you have defined for the contact who is being added as a participant. example: winstonsmith@truth.org customer: "$ref": "#/components/schemas/customer_request" required: - email close_conversation_request: title: Close Conversation Request type: object description: Payload of the request to close a conversation properties: message_type: type: string enum: - close example: close type: type: string enum: - admin example: admin admin_id: type: string description: The id of the admin who is performing the action. example: '12345' body: type: string description: Optionally you can leave a message in the conversation to provide additional context to the user and other teammates. example: " This conversation is now closed!" required: - message_type - type - admin_id collection: title: Collection type: object x-tags: - Help Center description: Collections are top level containers for Articles within the Help Center. properties: id: type: string description: The unique identifier for the collection which is given by Intercom. example: '6871119' workspace_id: type: string description: The id of the workspace which the collection belongs to. example: hfi1bx4l name: type: string description: The name of the collection. For multilingual collections, this will be the name of the default language's content. example: Default language name description: type: string nullable: true description: The description of the collection. For multilingual help centers, this will be the description of the collection for the default language. example: Default language description created_at: type: integer format: date-time description: The time when the article was created (seconds). For multilingual articles, this will be the timestamp of creation of the default language's content. example: 1672928359 updated_at: type: integer format: date-time description: The time when the article was last updated (seconds). For multilingual articles, this will be the timestamp of last update of the default language's content. example: 1672928610 url: type: string nullable: true description: The URL of the collection. For multilingual help centers, this will be the URL of the collection for the default language. example: http://intercom.test/help/collection/name icon: type: string nullable: true description: The icon of the collection. example: book-bookmark order: type: integer description: The order of the section in relation to others sections within a collection. Values go from `0` upwards. `0` is the default if there's no order. example: '1' default_locale: type: string description: The default locale of the help center. This field is only returned for multilingual help centers. example: en translated_content: nullable: true "$ref": "#/components/schemas/group_translated_content" help_center_id: type: integer nullable: true description: The id of the help center the collection is in. example: '123' type: type: string description: The type of object - `collection`. enum: - collection default: collection example: collection collection_list: title: Collections type: object description: This will return a list of Collections for the App. properties: type: type: string description: The type of the object - `list`. enum: - list example: list pages: "$ref": "#/components/schemas/cursor_pages" total_count: type: integer description: A count of the total number of collections. example: 1 data: type: array description: An array of collection objects items: "$ref": "#/components/schemas/collection" company: title: Company type: object x-tags: - Companies description: Companies allow you to represent organizations using your product. Each company will have its own description and be associated with contacts. You can fetch, create, update and list companies. properties: type: type: string description: Value is `company` enum: - company example: company id: type: string description: The Intercom defined id representing the company. example: 531ee472cce572a6ec000006 name: type: string description: The name of the company. example: Blue Sun app_id: type: string description: The Intercom defined code of the workspace the company is associated to. example: ecahpwf5 plan: type: object properties: type: type: string description: Value is always "plan" example: plan id: type: string description: The id of the plan example: '269315' name: type: string description: The name of the plan example: Pro company_id: type: string description: The company id you have defined for the company. example: '6' remote_created_at: type: integer description: The time the company was created by you. example: 1663597223 created_at: type: integer description: The time the company was added in Intercom. example: 1663597223 updated_at: type: integer description: The last time the company was updated. example: 1663597223 last_request_at: type: integer description: The time the company last recorded making a request. example: 1663597223 size: type: integer description: The number of employees in the company. example: 100 website: type: string description: The URL for the company website. example: https://www.intercom.com industry: type: string description: The industry that the company operates in. example: Software monthly_spend: type: integer description: How much revenue the company generates for your business. example: 100 session_count: type: integer description: How many sessions the company has recorded. example: 100 user_count: type: integer description: The number of users in the company. example: 100 custom_attributes: type: object description: The custom attributes you have set on the company. additionalProperties: type: string example: paid_subscriber: true monthly_spend: 155.5 team_mates: 9 tags: type: object description: The list of tags associated with the company properties: type: type: string description: The type of the object enum: - tag.list tags: type: array items: items: "$ref": "#/components/schemas/tag" segments: type: object description: The list of segments associated with the company properties: type: type: string description: The type of the object enum: - segment.list segments: type: array items: "$ref": "#/components/schemas/segment" company_attached_contacts: title: Company Attached Contacts type: object description: A list of Contact Objects properties: type: type: string description: The type of object - `list` enum: - list example: list data: type: array description: An array containing Contact Objects items: "$ref": "#/components/schemas/contact" total_count: type: integer description: The total number of contacts example: 100 pages: "$ref": "#/components/schemas/cursor_pages" company_attached_segments: title: Company Attached Segments type: object description: A list of Segment Objects properties: type: type: string description: The type of object - `list` enum: - list example: list data: type: array description: An array containing Segment Objects items: "$ref": "#/components/schemas/segment" company_list: title: Companies type: object description: This will return a list of companies for the App. properties: type: type: string description: The type of object - `list`. enum: - list example: list pages: "$ref": "#/components/schemas/cursor_pages" total_count: type: integer description: The total number of companies. example: 100 data: type: array description: An array containing Company Objects. items: "$ref": "#/components/schemas/company" company_scroll: title: Company Scroll type: object description: Companies allow you to represent organizations using your product. Each company will have its own description and be associated with contacts. You can fetch, create, update and list companies. nullable: true properties: type: type: string description: The type of object - `list` enum: - list example: list data: type: array items: "$ref": "#/components/schemas/company" pages: "$ref": "#/components/schemas/cursor_pages" total_count: type: integer description: The total number of companies nullable: true example: 100 scroll_param: type: string description: The scroll parameter to use in the next request to fetch the next page of results. example: 25b649f7-4d33-4ef6-88f5-60e5b8244309 contact: title: Contact type: object x-tags: - Contacts description: Contact are the objects that represent your leads and users in Intercom. properties: type: type: string description: The type of object. example: contact id: type: string description: The unique identifier for the contact which is given by Intercom. example: 5ba682d23d7cf92bef87bfd4 external_id: type: string nullable: true description: The unique identifier for the contact which is provided by the Client. example: f3b87a2e09d514c6c2e79b9a workspace_id: type: string description: The id of the workspace which the contact belongs to. example: ecahpwf5 role: type: string description: The role of the contact. example: user email: type: string description: The contact's email. example: joe@example.com email_domain: type: string description: The contact's email domain. example: example.com phone: type: string nullable: true description: The contacts phone. example: "+1123456789" formatted_phone: type: string nullable: true description: The contacts phone number normalized to the E164 format example: "+1123456789" name: type: string nullable: true description: The contacts name. example: John Doe owner_id: type: integer nullable: true description: The id of an admin that has been assigned account ownership of the contact. example: 123 has_hard_bounced: type: boolean description: Whether the contact has had an email sent to them hard bounce. example: true marked_email_as_spam: type: boolean description: Whether the contact has marked an email sent to them as spam. example: true unsubscribed_from_emails: type: boolean description: Whether the contact is unsubscribed from emails. example: true created_at: type: integer format: date-time description: "(UNIX timestamp) The time when the contact was created." example: 1571672154 updated_at: type: integer format: date-time description: "(UNIX timestamp) The time when the contact was last updated." example: 1571672154 signed_up_at: type: integer format: date-time nullable: true description: "(UNIX timestamp) The time specified for when a contact signed up." example: 1571672154 last_seen_at: type: integer format: date-time nullable: true description: "(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_at: type: integer format: date-time nullable: true description: "(UNIX timestamp) The time when the contact last messaged in." example: 1571672154 last_contacted_at: type: integer format: date-time nullable: true description: "(UNIX timestamp) The time when the contact was last messaged." example: 1571672154 last_email_opened_at: type: integer format: date-time nullable: true description: "(UNIX timestamp) The time when the contact last opened an email." example: 1571672154 last_email_clicked_at: type: integer format: date-time nullable: true description: "(UNIX timestamp) The time when the contact last clicked a link in an email." example: 1571672154 language_override: type: string nullable: true description: A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change. example: en browser: type: string nullable: true description: The name of the browser which the contact is using. example: Chrome browser_version: type: string nullable: true description: The version of the browser which the contact is using. example: 80.0.3987.132 browser_language: type: string nullable: true description: The language set by the browser which the contact is using. example: en-US os: type: string nullable: true description: The operating system which the contact is using. example: Mac OS X android_app_name: type: string nullable: true description: The name of the Android app which the contact is using. example: Intercom android_app_version: type: string nullable: true description: The version of the Android app which the contact is using. example: 5.0.0 android_device: type: string nullable: true description: The Android device which the contact is using. example: Pixel 3 android_os_version: type: string nullable: true description: The version of the Android OS which the contact is using. example: '10' android_sdk_version: type: string nullable: true description: The version of the Android SDK which the contact is using. example: '28' android_last_seen_at: type: integer nullable: true format: date-time description: "(UNIX timestamp) The time when the contact was last seen on an Android device." example: 1571672154 ios_app_name: type: string nullable: true description: The name of the iOS app which the contact is using. example: Intercom ios_app_version: type: string nullable: true description: The version of the iOS app which the contact is using. example: 5.0.0 ios_device: type: string nullable: true description: The iOS device which the contact is using. example: iPhone 11 ios_os_version: type: string nullable: true description: The version of iOS which the contact is using. example: 13.3.1 ios_sdk_version: type: string nullable: true description: The version of the iOS SDK which the contact is using. example: 13.3.1 ios_last_seen_at: type: integer nullable: true format: date-time description: "(UNIX timestamp) The last time the contact used the iOS app." example: 1571672154 custom_attributes: type: object description: The custom attributes which are set for the contact. avatar: type: object nullable: true properties: type: type: string description: The type of object example: avatar image_url: type: string format: uri nullable: true description: An image URL containing the avatar of a contact. example: https://example.org/128Wash.jpg tags: "$ref": "#/components/schemas/contact_tags" notes: "$ref": "#/components/schemas/contact_notes" companies: "$ref": "#/components/schemas/contact_companies" location: "$ref": "#/components/schemas/contact_location" social_profiles: "$ref": "#/components/schemas/contact_social_profiles" contact_archived: title: Contact Archived type: object description: archived contact object properties: type: type: string description: always contact enum: - contact example: contact id: type: string description: The unique identifier for the contact which is given by Intercom. example: 5ba682d23d7cf92bef87bfd4 external_id: type: string nullable: true description: The unique identifier for the contact which is provided by the Client. example: f3b87a2e09d514c6c2e79b9a archived: type: boolean description: Whether the contact is archived or not. example: true contact_attached_companies: title: Contact Attached Companies type: object description: A list of Company Objects properties: type: type: string description: The type of object enum: - list example: list companies: type: array description: An array containing Company Objects items: "$ref": "#/components/schemas/company" total_count: type: integer description: The total number of companies associated to this contact example: 100 pages: "$ref": "#/components/schemas/pages_link" contact_companies: title: Contact companies type: object nullable: false description: 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. properties: url: type: string format: uri description: Url to get more company resources for this contact example: "/contacts/5ba682d23d7cf92bef87bfd4/companies" total_count: type: integer description: Int representing the total number of companyies attached to this contact example: 100 has_more: type: boolean description: Whether there's more Addressable Objects to be viewed. If true, use the url to view all example: true contact_deleted: title: Contact Deleted type: object description: deleted contact object properties: type: type: string description: always contact enum: - contact example: contact id: type: string description: The unique identifier for the contact which is given by Intercom. example: 5ba682d23d7cf92bef87bfd4 external_id: type: string nullable: true description: The unique identifier for the contact which is provided by the Client. example: f3b87a2e09d514c6c2e79b9a deleted: type: boolean description: Whether the contact is deleted or not. example: true contact_list: title: Contact List type: object description: Contacts are your users in Intercom. properties: type: type: string description: Always list enum: - list example: list data: type: array description: The list of contact objects items: "$ref": "#/components/schemas/contact" total_count: type: integer description: A count of the total number of objects. example: 100 pages: "$ref": "#/components/schemas/cursor_pages" contact_location: title: Contact Location type: object nullable: false description: An object containing location meta data about a Intercom contact. properties: type: type: string nullable: true description: Always location example: location country: type: string nullable: true description: The country that the contact is located in example: Ireland region: type: string nullable: true description: The overal region that the contact is located in example: Dublin city: type: string nullable: true description: The city that the contact is located in example: Dublin contact_notes: title: Contact notes type: object nullable: false description: 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. properties: data: type: array description: This object represents the notes attached to a contact. items: "$ref": "#/components/schemas/addressable_list" url: type: string format: uri description: Url to get more company resources for this contact example: "/contacts/5ba682d23d7cf92bef87bfd4/notes" total_count: type: integer description: Int representing the total number of companyies attached to this contact example: 100 has_more: type: boolean description: Whether there's more Addressable Objects to be viewed. If true, use the url to view all example: true contact_reference: title: Contact Reference type: object description: reference to contact object properties: type: type: string description: always contact enum: - contact example: contact id: type: string description: The unique identifier for the contact which is given by Intercom. example: 5ba682d23d7cf92bef87bfd4 external_id: type: string nullable: true description: The unique identifier for the contact which is provided by the Client. example: f3b87a2e09d514c6c2e79b9a contact_reply_base_request: title: Contact Reply Base Object type: object properties: message_type: type: string enum: - comment type: type: string enum: - user body: type: string description: The text body of the comment. attachment_urls: title: Attachment URLs type: array description: A list of image URLs that will be added as attachments. You can include up to 10 URLs. items: type: string format: uri maxItems: 10 required: - message_type - type - body contact_reply_conversation_request: title: Contact Reply oneOf: - "$ref": "#/components/schemas/contact_reply_intercom_user_id_request" - "$ref": "#/components/schemas/contact_reply_email_request" - "$ref": "#/components/schemas/contact_reply_user_id_request" contact_reply_email_request: title: Email type: object description: Payload of the request to reply on behalf of a contact using their `email` properties: email: type: string description: The email you have defined for the user. attachment_files: type: array description: A list of files that will be added as attachments. items: "$ref": "#/components/schemas/conversation_attachment_files" allOf: - "$ref": "#/components/schemas/contact_reply_base_request" required: - email contact_reply_intercom_user_id_request: title: Intercom User ID type: object description: Payload of the request to reply on behalf of a contact using their `intercom_user_id` allOf: - "$ref": "#/components/schemas/contact_reply_base_request" properties: intercom_user_id: type: string description: The identifier for the contact as given by Intercom. attachment_files: type: array description: A list of files that will be added as attachments. items: "$ref": "#/components/schemas/conversation_attachment_files" required: - intercom_user_id contact_reply_ticket_email_request: title: Email type: object description: Payload of the request to reply on behalf of a contact using their `email` properties: email: type: string description: The email you have defined for the user. allOf: - "$ref": "#/components/schemas/contact_reply_base_request" required: - email contact_reply_ticket_intercom_user_id_request: title: Intercom User ID type: object description: Payload of the request to reply on behalf of a contact using their `intercom_user_id` allOf: - "$ref": "#/components/schemas/contact_reply_base_request" properties: intercom_user_id: type: string description: The identifier for the contact as given by Intercom. required: - intercom_user_id contact_reply_ticket_user_id_request: title: User ID type: object description: Payload of the request to reply on behalf of a contact using their `user_id` allOf: - "$ref": "#/components/schemas/contact_reply_base_request" properties: user_id: type: string description: The external_id you have defined for the contact. required: - user_id contact_reply_user_id_request: title: User ID type: object description: Payload of the request to reply on behalf of a contact using their `user_id` allOf: - "$ref": "#/components/schemas/contact_reply_base_request" properties: user_id: type: string description: The external_id you have defined for the contact. attachment_files: type: array description: A list of files that will be added as attachments. You can include up to 10 files. items: "$ref": "#/components/schemas/conversation_attachment_files" maxItems: 10 required: - user_id contact_segments: title: Segments type: object description: A list of segments objects attached to a specific contact. properties: type: type: string description: The type of the object enum: - list example: list data: type: array description: Segment objects associated with the contact. items: "$ref": "#/components/schemas/segment" contact_social_profiles: title: Social Profile type: object nullable: false description: An object containing social profiles that a contact has. properties: data: type: array description: A list of social profiles objects associated with the contact. items: "$ref": "#/components/schemas/social_profile" contact_subscription_types: title: Contact Subscription Types type: object nullable: false description: An object containing Subscription Types meta data about the SubscriptionTypes that a contact has. properties: data: type: array description: This object represents the subscriptions attached to a contact. items: "$ref": "#/components/schemas/addressable_list" url: type: string format: uri description: Url to get more subscription type resources for this contact example: "/contacts/5ba682d23d7cf92bef87bfd4/subscriptions" total_count: type: integer description: Int representing the total number of subscription types attached to this contact example: 100 has_more: type: boolean description: Whether there's more Addressable Objects to be viewed. If true, use the url to view all example: true contact_tags: title: Contact Tags type: object nullable: true 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. properties: data: type: array description: This object represents the tags attached to a contact. items: "$ref": "#/components/schemas/addressable_list" url: type: string format: uri description: url to get more tag resources for this contact example: "/contacts/5ba682d23d7cf92bef87bfd4/tags" total_count: type: integer description: Int representing the total number of tags attached to this contact example: 100 has_more: type: boolean description: Whether there's more Addressable Objects to be viewed. If true, use the url to view all example: true contact_unarchived: title: Contact Unarchived type: object description: unarchived contact object properties: type: type: string description: always contact enum: - contact example: contact id: type: string description: The unique identifier for the contact which is given by Intercom. example: 5ba682d23d7cf92bef87bfd4 external_id: type: string nullable: true description: The unique identifier for the contact which is provided by the Client. example: f3b87a2e09d514c6c2e79b9a archived: type: boolean description: Whether the contact is archived or not. example: false conversation: title: Conversation type: object x-tags: - Conversations 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. properties: type: type: string description: Always conversation. example: conversation id: type: string description: The id representing the conversation. example: '1295' title: type: string nullable: true description: The title given to the conversation. example: Conversation Title created_at: type: integer format: date-time description: The time the conversation was created. example: 1663597223 updated_at: type: integer format: date-time description: The last time the conversation was updated. example: 1663597260 waiting_since: type: integer format: date-time 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. example: 1663597260 snoozed_until: type: integer format: date-time 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. example: 1663597260 open: type: boolean description: Indicates whether a conversation is open (true) or closed (false). example: true state: type: string enum: - open - closed - snoozed description: Can be set to "open", "closed" or "snoozed". example: open read: type: boolean description: Indicates whether a conversation has been read. example: true priority: type: string enum: - priority - not_priority description: If marked as priority, it will return priority or else not_priority. example: priority admin_assignee_id: type: integer nullable: true description: 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_id: type: string nullable: true description: The id of the team assigned to the conversation. If it's not assigned to a team it will return null. example: '5017691' tags: "$ref": "#/components/schemas/tags" conversation_rating: "$ref": "#/components/schemas/conversation_rating" source: "$ref": "#/components/schemas/conversation_source" contacts: "$ref": "#/components/schemas/conversation_contacts" teammates: "$ref": "#/components/schemas/conversation_teammates" custom_attributes: "$ref": "#/components/schemas/custom_attributes" first_contact_reply: "$ref": "#/components/schemas/conversation_first_contact_reply" sla_applied: "$ref": "#/components/schemas/sla_applied" statistics: "$ref": "#/components/schemas/conversation_statistics" conversation_parts: "$ref": "#/components/schemas/conversation_parts" conversation_attachment_files: title: Conversation attachment files type: object description: Properties of the attachment files in a conversation part properties: content_type: type: string description: The content type of the file example: application/json data: type: string description: The base64 encoded file data. example: ewogICJ0ZXN0IjogMQp9 name: type: string description: The name of the file. example: test.json conversation_contacts: title: Contacts type: object 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. properties: type: type: string description: '' enum: - contact.list example: contact.list contacts: type: array 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. items: "$ref": "#/components/schemas/contact_reference" conversation_first_contact_reply: title: First contact reply type: object nullable: true description: An object containing information on the first users message. For a contact initiated message this will represent the users original message. properties: created_at: type: integer format: date-time description: '' example: 1663597223 type: type: string description: '' example: conversation url: type: string nullable: true description: '' example: https://developers.intercom.com/ conversation_list: title: Conversation List type: object 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. properties: type: type: string description: Always conversation.list enum: - conversation.list example: conversation.list conversations: type: array description: The list of conversation objects items: "$ref": "#/components/schemas/conversation" total_count: type: integer description: A count of the total number of objects. example: 12345 pages: "$ref": "#/components/schemas/cursor_pages" conversation_part: title: Conversation Part type: object description: A Conversation Part represents a message in the conversation. properties: type: type: string description: Always conversation_part example: conversation_part id: type: string description: The id representing the conversation part. example: '3' part_type: type: string description: The type of conversation part. example: comment body: type: string nullable: true description: The message body, which may contain HTML. For Twitter, this will show a generic message regarding why the body is obscured. example: "Okay!
" created_at: type: integer format: date-time description: The time the conversation part was created. example: 1663597223 updated_at: type: integer format: date-time description: The last time the conversation part was updated. example: 1663597260 notified_at: type: integer format: date-time description: The time the user was notified with the conversation part. example: 1663597260 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.) author: "$ref": "#/components/schemas/conversation_part_author" attachments: title: Conversation part attachments type: array description: A list of attachments for the part. items: "$ref": "#/components/schemas/part_attachment" external_id: type: string nullable: true description: The external id of the conversation part example: abcd1234 redacted: type: boolean description: Whether or not the conversation part has been redacted. example: false conversation_part_author: title: Conversation part author type: object 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. properties: type: type: string description: The type of the author example: admin id: type: string description: The id of the author example: '274' name: type: string description: The name of the author example: Operator email: type: string format: email description: The email of the author example: operator+abcd1234@intercom.io conversation_parts: title: Conversation Parts type: object 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. properties: type: type: string description: '' enum: - conversation_part.list example: conversation_part.list conversation_parts: title: Conversation Parts type: array 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. items: "$ref": "#/components/schemas/conversation_part" total_count: type: integer description: '' example: 2 conversation_rating: title: Conversation Rating type: object nullable: true 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. properties: rating: type: integer description: The rating, between 1 and 5, for the conversation. example: 5 remark: type: string description: An optional field to add a remark to correspond to the number rating example: '' created_at: type: integer format: date-time description: The time the rating was requested in the conversation being rated. example: 1671028894 contact: "$ref": "#/components/schemas/contact_reference" teammate: "$ref": "#/components/schemas/reference" conversation_source: title: Conversation source type: object description: The Conversation Part that originated this conversation, which can be Contact, Admin, Campaign, Automated or Operator initiated. properties: type: type: string description: This includes conversation, email, facebook, instagram, phone_call, phone_switch, push, sms, twitter and whatsapp. example: conversation id: type: string description: The id representing the message. example: '3' delivered_as: type: string 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). example: operator_initiated subject: type: string description: Optional. The message subject. For Twitter, this will show a generic message regarding why the subject is obscured. example: '' body: type: string description: The message body, which may contain HTML. For Twitter, this will show a generic message regarding why the body is obscured. example: "Hey there!
" author: "$ref": "#/components/schemas/conversation_part_author" attachments: type: array description: A list of attachments for the part. items: "$ref": "#/components/schemas/part_attachment" url: type: string nullable: true description: The URL where the conversation was started. For Twitter, Email, and Bots, this will be blank. example: redacted: type: boolean description: Whether or not the source message has been redacted. Only applicable for contact initiated messages. example: false conversation_statistics: title: Conversation statistics type: object nullable: true description: A Statistics object containing all information required for reporting, with timestamps and calculated metrics. properties: type: type: string description: '' example: conversation_statistics time_to_assignment: type: integer description: Duration until last assignment before first admin reply. In seconds. example: 2310 time_to_admin_reply: type: integer description: Duration until first admin reply. Subtracts out of business hours. In seconds. example: 2310 time_to_first_close: type: integer description: Duration until conversation was closed first time. Subtracts out of business hours. In seconds. example: 2310 time_to_last_close: type: integer description: Duration until conversation was closed last time. Subtracts out of business hours. In seconds. example: 2310 median_time_to_reply: type: integer description: Median based on all admin replies after a contact reply. Subtracts out of business hours. In seconds. example: 2310 first_contact_reply_at: type: integer format: date-time description: Time of first text conversation part from a contact. example: 1663597233 first_assignment_at: type: integer format: date-time description: Time of first assignment after first_contact_reply_at. example: 1663597233 first_admin_reply_at: type: integer format: date-time description: Time of first admin reply after first_contact_reply_at. example: 1663597233 first_close_at: type: integer format: date-time description: Time of first close after first_contact_reply_at. example: 1663597233 last_assignment_at: type: integer format: date-time description: Time of last assignment after first_contact_reply_at. example: 1663597233 last_assignment_admin_reply_at: type: integer format: date-time description: Time of first admin reply since most recent assignment. example: 1663597233 last_contact_reply_at: type: integer format: date-time description: Time of the last conversation part from a contact. example: 1663597233 last_admin_reply_at: type: integer format: date-time description: Time of the last conversation part from an admin. example: 1663597233 last_close_at: type: integer format: date-time description: Time of the last conversation close. example: 1663597233 last_closed_by_id: type: string description: The last admin who closed the conversation. Returns a reference to an Admin object. example: c3po count_reopens: type: integer description: Number of reopens after first_contact_reply_at. example: 1 count_assignments: type: integer description: Number of assignments after first_contact_reply_at. example: 1 count_conversation_parts: type: integer description: Total number of conversation parts. example: 1 conversation_teammates: title: Conversation teammates type: object nullable: true description: The list of teammates who participated in the conversation (wrote at least one conversation part). properties: type: type: string description: The type of the object - `admin.list`. example: admin.list teammates: type: array description: The list of teammates who participated in the conversation (wrote at least one conversation part). items: "$ref": "#/components/schemas/reference" convert_visitor_request: description: You can merge a Visitor to a Contact of role type lead or user. type: object title: Convert Visitor Request Payload properties: type: type: string description: Represents the role of the Contact model. Accepts `lead` or `user`. example: user user: type: object description: The unique identifiers retained after converting or merging. properties: id: type: string description: The unique identifier for the contact which is given by Intercom. example: 8a88a590-e1c3-41e2-a502-e0649dbf721c user_id: type: string description: A unique identifier for the contact which is given to Intercom, which will be represented as external_id. example: 8a88a590-e1c3-41e2-a502-e0649dbf721c email: type: string description: The contact's email, retained by default if one is present. example: winstonsmith@truth.org anyOf: - required: - id - required: - user_id visitor: type: object description: The unique identifiers to convert a single Visitor. properties: id: type: string description: The unique identifier for the contact which is given by Intercom. example: 8a88a590-e1c3-41e2-a502-e0649dbf721c user_id: type: string description: A unique identifier for the contact which is given to Intercom. example: 8a88a590-e1c3-41e2-a502-e0649dbf721c email: type: string description: The visitor's email. example: winstonsmith@truth.org anyOf: - required: - id - required: - user_id - required: - email required: - type - user - visitor create_article_request: description: You can create an Article type: object title: Create Article Request Payload nullable: true properties: title: type: string description: The title of the article.For multilingual articles, this will be the title of the default language's content. example: Thanks for everything description: type: string description: The description of the article. For multilingual articles, this will be the description of the default language's content. example: Description of the Article body: type: string description: The content of the article. For multilingual articles, this will be the body of the default language's content. example: "This is the body in html
" author_id: type: integer 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. example: 1295 state: type: string 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. enum: - published - draft example: draft parent_id: type: integer description: The id of the article's parent collection or section. An article without this field stands alone. example: 18 parent_type: type: string description: The type of parent, which can either be a `collection` or `section`. example: collection translated_content: "$ref": "#/components/schemas/article_translated_content" required: - title - author_id create_collection_request: description: You can create a collection type: object title: Create Collection Request Payload properties: name: type: string description: The name of the collection. For multilingual collections, this will be the name of the default language's content. example: collection 51 description: type: string description: The description of the collection. For multilingual collections, this will be the description of the default language's content. example: English description translated_content: nullable: true "$ref": "#/components/schemas/group_translated_content" help_center_id: type: integer 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. example: '123' required: - name create_contact_request: description: Payload to create a contact type: object title: Create Contact Request Payload properties: role: type: string description: The role of the contact. external_id: type: string description: A unique identifier for the contact which is given to Intercom email: type: string description: The contacts email example: jdoe@example.com phone: type: string nullable: true description: The contacts phone example: "+353871234567" name: type: string nullable: true description: The contacts name example: John Doe avatar: type: string nullable: true description: An image URL containing the avatar of a contact example: https://www.example.com/avatar_image.jpg signed_up_at: type: integer format: date-time nullable: true description: The time specified for when a contact signed up example: 1571672154 last_seen_at: type: integer format: date-time nullable: true description: The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually) example: 1571672154 owner_id: type: integer nullable: true description: The id of an admin that has been assigned account ownership of the contact example: 123 unsubscribed_from_emails: type: boolean nullable: true description: Whether the contact is unsubscribed from emails example: true custom_attributes: type: object nullable: true description: The custom attributes which are set for the contact anyOf: - required: - email title: Create contact with email - required: - external_id title: Create contact with external_id - required: - role title: Create contact with role create_conversation_request: 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. type: object title: Create Conversation Request Payload properties: from: type: object properties: type: type: string enum: - lead - user - contact description: The role associated to the contact - user or lead. example: user id: type: string description: The identifier for the contact which is given by Intercom. format: uuid minLength: 24 maxLength: 24 example: 536e564f316c83104c000020 required: - type - id body: type: string description: The content of the message. HTML is not supported. example: Hello required: - from - body create_data_attribute_request: description: '' type: object title: Create Data Attribute Request properties: name: type: string description: The name of the data attribute. example: My Data Attribute model: type: string description: The model that the data attribute belongs to. enum: - contact - company example: contact data_type: type: string description: The type of data stored for this attribute. enum: - string - integer - float - boolean - datetime - date example: string description: type: string description: The readable description you see in the UI for the attribute. example: My Data Attribute Description options: type: array 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`. items: type: string example: - option1 - option2 messenger_writable: type: boolean description: Can this attribute be updated by the Messenger example: false required: - name - model - data_type create_data_event_request: description: '' type: object title: Create Data Event Request properties: event_name: type: string 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`. example: invited-friend created_at: type: integer format: date-time description: The time the event occurred as a UTC Unix timestamp example: 1671028894 user_id: type: string description: Your identifier for the user. example: '314159' id: type: string description: The unique identifier for the contact (lead or user) which is given by Intercom. example: 8a88a590-e1c3-41e2-a502-e0649dbf721c email: type: string description: An email address for your user. An email should only be used where your application uses email to uniquely identify users. example: frodo.baggins@example.com metadata: type: object description: Optional metadata about the event. additionalProperties: type: string example: invite_code: ADDAFRIEND 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 create_data_event_summaries_request: 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`. type: object title: Create Data Event Summaries Request properties: user_id: type: string description: Your identifier for the user. example: '314159' event_summaries: type: object 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`. properties: event_name: type: string 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`. example: invited-friend count: type: integer description: The number of times the event occurred. example: 1 first: type: integer format: date-time description: The first time the event was sent example: 1671028894 last: type: integer format: date-time description: The last time the event was sent example: 1671028894 create_data_exports_request: description: Request for creating a data export type: object title: Create Data Export Request properties: created_at_after: type: integer description: The start date that you request data for. It must be formatted as a unix timestamp. example: 1527811200 created_at_before: type: integer description: The end date that you request data for. It must be formatted as a unix timestamp. example: 1527811200 required: - created_at_after - created_at_before create_message_request: description: You can create a message type: object title: Create Message Request Payload nullable: true properties: message_type: type: string description: 'The kind of message being created. Values: `in_app` or `email`.' enum: - in_app - email example: in_app subject: type: string description: The title of the email. example: Thanks for everything body: type: string description: The content of the message. HTML and plaintext are supported. example: Hello there template: type: string description: The style of the outgoing message. Possible values `plain` or `personal`. example: plain from: type: object description: The sender of the message. If not provided, the default sender will be used. properties: type: type: string description: Always `admin`. enum: - admin example: admin id: type: integer description: The identifier for the admin which is given by Intercom. example: 394051 required: - type - id to: type: object description: The sender of the message. If not provided, the default sender will be used. properties: type: type: string description: The role associated to the contact - `user` or `lead`. enum: - user - lead example: user id: type: string description: The identifier for the contact which is given by Intercom. example: 536e564f316c83104c000020 required: - type - id create_conversation_without_contact_reply: type: boolean description: Whether a conversation should be opened in the inbox for the message without the contact replying. Defaults to false if not provided. default: false example: true anyOf: - title: 'message_type: `email`.' required: - message_type - subject - body - template - from - to - title: 'message_type: `inapp`.' required: - message_type - body - from - to create_or_update_company_request: type: object title: Create Or Update Company Request Payload description: You can create or update a Company nullable: true properties: name: type: string description: The name of the Company example: Intercom company_id: type: string description: The company id you have defined for the company. Can't be updated example: 625e90fc55ab113b6d92175f plan: type: string description: The name of the plan you have associated with the company. example: Enterprise size: type: integer description: The number of employees in this company. example: '100' website: type: string description: The URL for this company's website. Please note that the value specified here is not validated. Accepts any string. example: https://www.example.com industry: type: string description: The industry that this company operates in. example: Manufacturing custom_attributes: type: object description: A hash of key/value pairs containing any other data about the company you want Intercom to store. additionalProperties: type: string example: paid_subscriber: true monthly_spend: 155.5 team_mates: 9 remote_created_at: type: integer description: The time the company was created by you. example: 1394531169 monthly_spend: type: integer 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.. example: 1000 create_or_update_tag_request: description: You can create or update an existing tag. type: object title: Create or Update Tag Request Payload properties: name: type: string 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. example: Independent id: type: string description: The id of tag to updates. example: '656452352' required: - name create_phone_switch_request: description: You can create an phone switch type: object title: Create Phone Switch Request Payload nullable: true properties: phone: type: string description: Phone number in E.164 format, that will receive the SMS to continue the conversation in the Messenger. example: "+1 1234567890" custom_attributes: "$ref": "#/components/schemas/custom_attributes" required: - phone create_section_request: description: You can create a Section type: object title: Create Section Request Payload properties: name: type: string description: The name of the collection. For multilingual collections, this will be the name of the default language's content. example: Section 51 parent_id: type: integer description: The id for the collection this section will be within. example: 18 translated_content: nullable: true "$ref": "#/components/schemas/group_translated_content" required: - name - parent_id cursor_pages: title: Cursor based pages type: object description: | Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "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. nullable: true properties: type: type: string description: the type of object `pages`. example: pages enum: - pages page: type: integer description: The current page example: 1 next: "$ref": "#/components/schemas/starting_after_paging" per_page: type: integer description: Number of results per page example: 2 total_pages: type: integer description: Total number of pages example: 13 custom_attributes: title: Custom Attributes type: object 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: title: Custom Object Instance type: object x-tags: - Custom Object Instances nullable: true 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. properties: id: type: string description: The Intercom defined id representing the custom object instance. example: 5a7a19e9f59ae20001d1c1e6 external_id: type: string description: The id you have defined for the custom object instance. example: 0001d1c1e65a7a19e9f59ae2 type: type: string description: The identifier of the custom object type that defines the structure of the custom object instance. example: Order custom_attributes: type: object description: The custom attributes you have set on the custom object instance. additionalProperties: type: string customer_request: type: object nullable: true oneOf: - title: Intercom User ID properties: intercom_user_id: type: string description: The identifier for the contact as given by Intercom. example: 6329bd9ffe4e2e91dac76188 required: - intercom_user_id - title: User ID properties: user_id: type: string description: The external_id you have defined for the contact who is being added as a participant. example: 2e91dac761886329bd9ffe4e required: - user_id - title: Email properties: email: type: string description: The email you have defined for the contact who is being added as a participant. example: sam.sung@example.com required: - email data_attribute: title: Data Attribute type: object x-tags: - Data Attributes 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. properties: type: type: string description: Value is `data_attribute`. enum: - data_attribute example: data_attribute id: type: integer description: The unique identifier for the data attribute which is given by Intercom. Only available for custom attributes. example: 12878 model: type: string description: Value is `contact` for user/lead attributes and `company` for company attributes. enum: - contact - company example: contact name: type: string description: Name of the attribute. example: paid_subscriber full_name: type: string 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. example: custom_attributes.paid_subscriber label: type: string description: Readable name of the attribute (i.e. name you see in the UI) example: Paid Subscriber description: type: string description: Readable description of the attribute. example: Whether the user is a paid subscriber. data_type: type: string description: The data type of the attribute. enum: - string - integer - float - boolean - date example: boolean options: type: array description: List of predefined options for attribute value. items: type: string example: - 'true' - 'false' api_writable: type: boolean description: Can this attribute be updated through API example: true messenger_writable: type: boolean description: Can this attribute be updated by the Messenger example: false ui_writable: type: boolean description: Can this attribute be updated in the UI example: true custom: type: boolean description: Set to true if this is a CDA example: true archived: type: boolean description: Is this attribute archived. (Only applicable to CDAs) example: false created_at: type: integer format: date-time description: The time the attribute was created as a UTC Unix timestamp example: 1671028894 updated_at: type: integer format: date-time description: The time the attribute was last updated as a UTC Unix timestamp example: 1671028894 admin_id: type: string description: Teammate who created the attribute. Only applicable to CDAs example: '5712945' data_attribute_list: title: Data Attribute List type: object description: A list of all data attributes belonging to a workspace for contacts, companies or conversations. properties: type: type: string description: The type of the object enum: - list example: list data: type: array description: A list of data attributes items: "$ref": "#/components/schemas/data_attribute" data_event: title: Data Event type: object x-tags: - Data Events description: Data events are used to notify Intercom of changes to your data. properties: type: type: string description: The type of the object enum: - event example: event event_name: type: string 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`. example: invited-friend created_at: type: integer format: date-time description: The time the event occurred as a UTC Unix timestamp example: 1671028894 user_id: type: string description: Your identifier for the user. example: '314159' id: type: string description: Your identifier for a lead or a user. example: 8a88a590-e1c3-41e2-a502-e0649dbf721c intercom_user_id: type: string description: The Intercom identifier for the user. example: 63a0979a5eeebeaf28dd56ba email: type: string description: An email address for your user. An email should only be used where your application uses email to uniquely identify users. example: frodo.baggins@example.com metadata: type: object description: Optional metadata about the event. additionalProperties: type: string example: invite_code: ADDAFRIEND required: - event_name - created_at data_event_list: title: Data Event List type: object description: This will return a list of data events for the App. properties: type: type: string description: The type of the object enum: - event.list example: event.list events: type: array description: A list of data events items: "$ref": "#/components/schemas/data_event" pages: type: object description: Pagination 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 data_event_summary: title: Data Event Summary type: object description: This will return a summary of data events for the App. properties: type: type: string description: The type of the object enum: - event.summary example: event.summary email: type: string description: The email address of the user example: Sam.Sung@example.com intercom_user_id: type: string description: The Intercom user ID of the user example: 63a0979a5eeebeaf28dd56ba user_id: type: string description: The user ID of the user example: 62b997f288e14803c5006932 events: type: array description: A summary of data events items: "$ref": "#/components/schemas/data_event_summary_item" data_event_summary_item: title: Data Event Summary Item type: object description: This will return a summary of a data event for the App. nullable: true properties: name: type: string description: The name of the event example: placed-order first: type: string description: The first time the event was sent example: '2014-01-16T23:12:21.000+00:00' last: type: string description: The last time the event was sent example: '2014-01-16T23:12:21.000+00:00 ' count: type: integer description: The number of times the event was sent example: 1 description: type: string description: The description of the event example: A user placed an order data_export: title: Data Export type: object x-tags: - Data Export description: The data export api is used to view all message sent & viewed in a given timeframe. properties: job_identfier: type: string description: The identifier for your job. example: orzzsbd7hk67xyu status: type: string enum: - pending - in_progress - failed - completed - no_data - canceled description: The current state of your job. example: pending download_expires_at: type: string description: The time after which you will not be able to access the data. example: '1674917488' download_url: type: string description: The location where you can download your data. example: https://api.intercom.test/download/messages/data/example data_export_csv: title: Data Export CSV type: object description: A CSV output file properties: user_id: type: string description: The user_id of the user who was sent the message. user_external_id: type: string description: The external_user_id of the user who was sent the message 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. email: type: string description: The users email who was sent the message. name: type: string description: The full name of the user receiving the message ruleset_id: type: string description: The id of the message. content_id: type: string description: The specific content that was received. In an A/B test each version has its own Content ID. content_type: type: string description: Email, Chat, Post etc. content_title: type: string description: The title of the content you see in your Intercom workspace. 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. 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. received_at: type: integer description: Timestamp for when the receipt was recorded. 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. series_title: type: string description: The title of the series that this content is part of. 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. first_reply: type: integer description: The first time a user replied to this message if the content was able to receive replies. 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. 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. first_series_exit: type: integer description: The first time the series this message was a part of was exited by the user. first_goal_success: type: integer description: The first time the user met this messages associated goal if one exists. first_open: type: integer description: The first time the user opened this message. first_click: type: integer description: The first time the series the user clicked on a link within this message. first_dismisall: type: integer description: The first time the series the user dismissed this message. first_unsubscribe: type: integer description: The first time the user unsubscribed from this message. first_hard_bounce: type: integer description: The first time this message hard bounced for this user deleted_article_object: title: Deleted Article Object type: object description: Response returned when an object is deleted properties: id: type: string description: The unique identifier for the article which you provided in the URL. example: '6890762' object: type: string description: The type of object which was deleted. - article enum: - article example: article deleted: type: boolean description: Whether the article was deleted successfully or not. example: true deleted_collection_object: title: Deleted Collection Object type: object description: Response returned when an object is deleted properties: id: type: string description: The unique identifier for the collection which you provided in the URL. example: '6890762' object: type: string description: The type of object which was deleted. - `collection` enum: - collection example: collection deleted: type: boolean description: Whether the collection was deleted successfully or not. example: true deleted_company_object: title: Deleted Company Object type: object description: Response returned when an object is deleted properties: id: type: string description: The unique identifier for the company which is given by Intercom. example: 5b7e8b2f-7a1a-4e6c-8e1b-4f9d4f4c4d4f object: type: string description: The type of object which was deleted. - `company` enum: - company example: company deleted: type: boolean description: Whether the company was deleted successfully or not. example: true deleted_object: title: Deleted Object type: object description: Response returned when an object is deleted properties: id: type: string description: The unique identifier for the news item which you provided in the URL. example: '6890762' object: type: string description: The type of object which was deleted - news-item. enum: - news-item example: news-item deleted: type: boolean description: Whether the news item was deleted successfully or not. example: true deleted_section_object: title: Deleted Section Object type: object description: Response returned when an object is deleted properties: id: type: string description: The unique identifier for the section which you provided in the URL. example: '6890762' object: type: string description: The type of object which was deleted. - `section` enum: - section example: section deleted: type: boolean description: Whether the section was deleted successfully or not. example: true detach_contact_from_conversation_request: properties: admin_id: type: string description: The `id` of the admin who is performing the action. example: '5017690' required: - admin_id error: type: object title: Error description: The API will return an Error List for a failed request, which will contain one or more Error objects. properties: type: type: string description: The type is error.list example: error.list request_id: type: string nullable: true format: uuid description: '' example: f93ecfa8-d08a-4325-8694-89aeb89c8f85 errors: type: array description: An array of one or more error objects items: properties: code: type: string description: A string indicating the kind of error, used to further qualify the HTTP response code example: unauthorized message: type: string nullable: true description: Optional. Human readable description of the error. example: Access Token Invalid field: type: string nullable: true description: Optional. Used to identify a particular field or query parameter that was in error. example: email required: - code required: - type - errors file_attribute: title: File type: object description: The value describing a file upload set for a custom attribute properties: type: type: string example: upload name: type: string description: The name of the file example: Screenshot.png url: type: string description: The url of the file. This is a temporary URL and will expire after 30 minutes. example: https://intercom-attachments-1.com/.../Screenshot.png content_type: type: string description: The type of file example: image/png filesize: type: integer description: The size of the file in bytes example: 11308309 width: type: integer description: The width of the file in pixels, if applicable example: 3024 height: type: integer description: The height of the file in pixels, if applicable example: 1964 group_content: title: Group Content type: object description: The Content of a Group. nullable: true properties: type: type: string description: The type of object - `group_content` . enum: - - group_content example: group_content nullable: true name: type: string description: The name of the collection or section. example: Collection name description: type: string description: The description of the collection. Only available for collections. example: " Collection description" group_translated_content: title: Group Translated Content type: object description: The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group. nullable: true properties: type: type: string description: The type of object - group_translated_content. nullable: true enum: - - group_translated_content example: group_translated_content ar: description: The content of the group in Arabic "$ref": "#/components/schemas/group_content" bg: description: The content of the group in Bulgarian "$ref": "#/components/schemas/group_content" bs: description: The content of the group in Bosnian "$ref": "#/components/schemas/group_content" ca: description: The content of the group in Catalan "$ref": "#/components/schemas/group_content" cs: description: The content of the group in Czech "$ref": "#/components/schemas/group_content" da: description: The content of the group in Danish "$ref": "#/components/schemas/group_content" de: description: The content of the group in German "$ref": "#/components/schemas/group_content" el: description: The content of the group in Greek "$ref": "#/components/schemas/group_content" en: description: The content of the group in English "$ref": "#/components/schemas/group_content" es: description: The content of the group in Spanish "$ref": "#/components/schemas/group_content" et: description: The content of the group in Estonian "$ref": "#/components/schemas/group_content" fi: description: The content of the group in Finnish "$ref": "#/components/schemas/group_content" fr: description: The content of the group in French "$ref": "#/components/schemas/group_content" he: description: The content of the group in Hebrew "$ref": "#/components/schemas/group_content" hr: description: The content of the group in Croatian "$ref": "#/components/schemas/group_content" hu: description: The content of the group in Hungarian "$ref": "#/components/schemas/group_content" id: description: The content of the group in Indonesian "$ref": "#/components/schemas/group_content" it: description: The content of the group in Italian "$ref": "#/components/schemas/group_content" ja: description: The content of the group in Japanese "$ref": "#/components/schemas/group_content" ko: description: The content of the group in Korean "$ref": "#/components/schemas/group_content" lt: description: The content of the group in Lithuanian "$ref": "#/components/schemas/group_content" lv: description: The content of the group in Latvian "$ref": "#/components/schemas/group_content" mn: description: The content of the group in Mongolian "$ref": "#/components/schemas/group_content" nb: description: The content of the group in Norwegian "$ref": "#/components/schemas/group_content" nl: description: The content of the group in Dutch "$ref": "#/components/schemas/group_content" pl: description: The content of the group in Polish "$ref": "#/components/schemas/group_content" pt: description: The content of the group in Portuguese (Portugal) "$ref": "#/components/schemas/group_content" ro: description: The content of the group in Romanian "$ref": "#/components/schemas/group_content" ru: description: The content of the group in Russian "$ref": "#/components/schemas/group_content" sl: description: The content of the group in Slovenian "$ref": "#/components/schemas/group_content" sr: description: The content of the group in Serbian "$ref": "#/components/schemas/group_content" sv: description: The content of the group in Swedish "$ref": "#/components/schemas/group_content" tr: description: The content of the group in Turkish "$ref": "#/components/schemas/group_content" vi: description: The content of the group in Vietnamese "$ref": "#/components/schemas/group_content" pt-BR: description: The content of the group in Portuguese (Brazil) "$ref": "#/components/schemas/group_content" zh-CN: description: The content of the group in Chinese (China) "$ref": "#/components/schemas/group_content" zh-TW: description: The content of the group in Chinese (Taiwan) "$ref": "#/components/schemas/group_content" help_center: title: Help Center type: object x-tags: - Help Center description: Help Centers contain collections properties: id: type: string description: The unique identifier for the Help Center which is given by Intercom. example: '123' workspace_id: type: string description: The id of the workspace which the Help Center belongs to. example: hfi1bx4l created_at: type: integer format: date-time description: The time when the Help Center was created. example: 1672928359 updated_at: type: integer format: date-time description: The time when the Help Center was last updated. example: 1672928610 identifier: type: string description: The identifier of the Help Center. This is used in the URL of the Help Center. example: intercom website_turned_on: type: boolean description: Whether the Help Center is turned on or not. This is controlled in your Help Center settings. example: true display_name: type: string description: The display name of the Help Center only seen by teammates. example: Intercom Help Center help_center_list: title: Help Centers type: object x-tags: - Help Center description: A list of Help Centers belonging to the App properties: type: type: string description: The type of the object - `list`. enum: - list example: list data: type: array description: An array of Help Center objects items: "$ref": "#/components/schemas/help_center" intercom_version: description: Intercom API version.By default, it's equal to the version set in the app package. type: string example: '2.8' default: '2.8' enum: - '1.0' - '1.1' - '1.2' - '1.3' - '1.4' - '2.0' - '2.1' - '2.2' - '2.3' - '2.4' - '2.5' - '2.6' - '2.7' - '2.8' - '2.9' - '2.10' - Unstable merge_contacts_request: description: Merge contact data. type: object title: Merge contact data properties: from: type: string description: The unique identifier for the contact to merge away from. Must be a lead. example: 5d70dd30de4efd54f42fd526 into: type: string description: The unique identifier for the contact to merge into. Must be a user. example: 5ba682d23d7cf92bef87bfd4 message: type: object title: Message x-tags: - Messages description: Message are how you reach out to contacts in Intercom. They are created when an admin sends an outbound message to a contact. properties: type: type: string description: The type of the message example: user_message id: type: string description: The id representing the message. example: '1488971108' created_at: type: integer format: date-time description: The time the conversation was created. example: 1667560812 subject: type: string description: 'The subject of the message. Only present if message_type: email.' example: Greetings body: type: string description: The message body, which may contain HTML. example: Hello message_type: type: string enum: - email - inapp - facebook - twitter description: The type of message that was sent. Can be email, inapp, facebook or twitter. example: inapp conversation_id: type: string description: The associated conversation_id example: '64619700005570' required: - type - id - created_at - body - message_type multiple_filter_search_request: type: object properties: operator: type: string enum: - AND - OR description: An operator to allow boolean inspection between multiple fields. example: AND value: oneOf: - type: array description: Add mutiple filters. title: multiple filter search request items: "$ref": "#/components/schemas/multiple_filter_search_request" - type: array description: Add a single filter field. title: single filter search request items: "$ref": "#/components/schemas/single_filter_search_request" news_item: title: News Item type: object x-tags: - News description: A News Item is a content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers. properties: type: type: string description: The type of object. enum: - news-item example: news-item id: type: string description: The unique identifier for the news item which is given by Intercom. example: '141' workspace_id: type: string description: The id of the workspace which the news item belongs to. example: t74hdn32 title: type: string description: The title of the news item. example: 'New feature: News Items' body: type: string description: The news item body, which may contain HTML. example: We are excited to announce the launch of News Items, a new content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers. sender_id: type: integer description: The id of the sender of the news item. Must be a teammate on the workspace. example: 123 state: type: string description: News items will not be visible to your users in the assigned newsfeeds until they are set live. enum: - draft - live example: live newsfeed_assignments: type: array description: A list of newsfeed_assignments to assign to the specified newsfeed. items: "$ref": "#/components/schemas/newsfeed_assignment" labels: type: array description: Label names displayed to users to categorize the news item. items: type: string nullable: true description: The label name. example: Product Update cover_image_url: type: string format: uri nullable: true description: URL of the image used as cover. Must have .jpg or .png extension. example: https://example.com/cover.jpg reactions: type: array description: Ordered list of emoji reactions to the news item. When empty, reactions are disabled. items: type: string nullable: true description: The emoji reaction to the news item. example: "\U0001F44D" deliver_silently: type: boolean description: When set to true, the news item will appear in the messenger newsfeed without showing a notification badge. example: true created_at: type: integer format: timestamp description: Timestamp for when the news item was created. example: 1610589632 updated_at: type: integer format: timestamp description: Timestamp for when the news item was last updated. example: 1610589632 news_item_request: description: A News Item is a content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers. type: object title: Create News Item Request properties: title: type: string description: The title of the news item. example: Halloween is here! body: type: string description: The news item body, which may contain HTML. example: "New costumes in store for this spooky season
" sender_id: type: integer description: The id of the sender of the news item. Must be a teammate on the workspace. example: 123 state: type: string description: News items will not be visible to your users in the assigned newsfeeds until they are set live. enum: - draft - live example: live deliver_silently: type: boolean description: When set to `true`, the news item will appear in the messenger newsfeed without showing a notification badge. example: true labels: type: array description: Label names displayed to users to categorize the news item. items: type: string example: - Product - Update - New reactions: type: array description: Ordered list of emoji reactions to the news item. When empty, reactions are disabled. items: type: string nullable: true example: - "\U0001F606" - "\U0001F605" newsfeed_assignments: type: array description: A list of newsfeed_assignments to assign to the specified newsfeed. items: "$ref": "#/components/schemas/newsfeed_assignment" required: - title - sender_id newsfeed: title: Newsfeed type: object x-tags: - News description: | A newsfeed is a collection of news items, targeted to a specific audience. Newsfeeds currently cannot be edited through the API, please refer to [this article](https://www.intercom.com/help/en/articles/6362267-getting-started-with-news) to set up your newsfeeds in Intercom. properties: id: type: string description: The unique identifier for the newsfeed which is given by Intercom. example: '12312' type: type: string description: The type of object. enum: - newsfeed example: newsfeed name: type: string description: The name of the newsfeed. This name will never be visible to your users. example: My Newsfeed created_at: type: integer format: timestamp description: Timestamp for when the newsfeed was created. example: 1674917488 updated_at: type: integer format: timestamp description: Timestamp for when the newsfeed was last updated. example: 1674917488 newsfeed_assignment: title: Newsfeed Assignment type: object x-tags: - News description: Assigns a news item to a newsfeed. properties: newsfeed_id: type: integer description: The unique identifier for the newsfeed which is given by Intercom. Publish dates cannot be in the future, to schedule news items use the dedicated feature in app (see this article). example: 198313 published_at: type: integer format: timestamp description: Publish date of the news item on the newsfeed, use this field if you want to set a publish date in the past (e.g. when importing existing news items). On write, this field will be ignored if the news item state is "draft". example: 1674917488 note: title: Note type: object x-tags: - Notes description: Notes allow you to annotate and comment on your contacts. properties: type: type: string description: String representing the object's type. Always has the value `note`. example: note id: type: string description: The id of the note. example: '17495962' created_at: type: integer format: timestamp description: The time the note was created. example: 1674589321 contact: type: object description: Represents the contact that the note was created about. nullable: true properties: type: type: string description: String representing the object's type. Always has the value `contact`. id: type: string description: The id of the contact. example: 214656d0c743eafcfde7f248 author: "$ref": "#/components/schemas/admin" description: Optional. Represents the Admin that created the note. body: type: string description: The body text of the note. example: "Text for the note.
" note_list: title: Paginated Response type: object description: A paginated list of notes associated with a contact. properties: type: type: string description: String representing the object's type. Always has the value `list`. example: list data: type: array description: An array of notes. items: "$ref": "#/components/schemas/note" total_count: type: integer description: A count of the total number of notes. example: 1 pages: "$ref": "#/components/schemas/cursor_pages" open_conversation_request: title: Open Conversation Request type: object description: Payload of the request to open a conversation properties: message_type: type: string enum: - open example: open admin_id: type: string description: The id of the admin who is performing the action. example: '5017690' required: - message_type - admin_id pages_link: title: Pagination Object type: object description: | The majority of list resources in the API are paginated to allow clients to traverse data over multiple requests. Their responses are likely to contain a pages object that hosts pagination links which a client can use to paginate through the data without having to construct a query. The link relations for the pages field are as follows. properties: type: type: string example: pages enum: - pages page: type: integer example: 1 next: type: string format: uri description: A link to the next page of results. A response that does not contain a next link does not have further data to fetch. nullable: true per_page: type: integer example: 50 total_pages: type: integer example: 1 paginated_response: title: Paginated Response type: object description: Paginated Response properties: type: type: string description: The type of object enum: - list - conversation.list example: list pages: "$ref": "#/components/schemas/cursor_pages" total_count: type: integer description: A count of the total number of objects. example: 1 data: type: array description: An array of Objects items: anyOf: - "$ref": "#/components/schemas/news_item" - "$ref": "#/components/schemas/newsfeed" part_attachment: title: Part attachment type: object description: The file attached to a part properties: type: type: string description: The type of attachment example: upload name: type: string description: The name of the attachment example: example.png url: type: string description: The URL of the attachment example: https://picsum.photos/200/300 content_type: type: string description: The content type of the attachment example: image/png filesize: type: integer description: The size of the attachment example: 100 width: type: integer description: The width of the attachment example: 100 height: type: integer description: The height of the attachment example: 100 phone_switch: title: Phone Switch type: object description: Phone Switch Response nullable: true properties: type: type: string description: '' enum: - phone_call_redirect default: phone_call_redirect example: phone_call_redirect phone: type: string description: Phone number in E.164 format, that has received the SMS to continue the conversation in the Messenger. example: "+1 1234567890" redact_conversation_request: oneOf: - title: Redact Conversation Part Request type: object description: Payload of the request to redact a conversation part properties: type: type: string enum: - conversation_part description: The type of resource being redacted. example: conversation_part conversation_id: type: string description: The id of the conversation. example: '19894788788' conversation_part_id: type: string description: The id of the conversation_part. example: '19381789428' required: - type - conversation_id - conversation_part_id - title: Redact Conversation Source Request type: object description: Payload of the request to redact a conversation source properties: type: type: string enum: - source description: The type of resource being redacted. example: source conversation_id: type: string description: The id of the conversation. example: '19894788788' source_id: type: string description: The id of the source. example: '19894781231' required: - type - conversation_id - source_id reference: title: Reference type: object description: reference to another object properties: type: type: string description: '' example: contact id: type: string nullable: true description: '' example: 1a2b3c reply_conversation_request: oneOf: - "$ref": "#/components/schemas/contact_reply_conversation_request" - "$ref": "#/components/schemas/admin_reply_conversation_request" search_request: description: Search using Intercoms Search APIs. type: object title: Search data properties: query: oneOf: - "$ref": "#/components/schemas/single_filter_search_request" title: Single filter search request - "$ref": "#/components/schemas/multiple_filter_search_request" title: multiple filter search request pagination: "$ref": "#/components/schemas/starting_after_paging" required: - query section: title: Section type: object x-tags: - Help Center description: Sections are subdivisions of a collection, with a collection potentially having multiple sections. properties: type: type: string description: The type of object - `section`. enum: - section default: section example: section id: type: string description: The unique identifier for the section which is given by Intercom. example: '6871119' workspace_id: type: string description: The id of the workspace which the section belongs to. example: hfi1bx4l name: type: string description: The name of the section. For multilingual sections, this will be the name of the default language's content. example: Default language name created_at: type: integer format: date-time description: The time when the section was created. For multilingual sections, this will be the timestamp of creation of the default language's content. example: 1672928359 updated_at: type: integer format: date-time description: The time when the section was last updated. For multilingual sections, this will be the timestamp of last update of the default language's content. example: 1672928610 url: type: string nullable: true description: The URL of the section. For multilingual help centers, this will be the URL of the section for the default language. example: http://intercom.test/help/section/name icon: type: string nullable: true description: The icon of the section. example: book-bookmark order: type: integer description: The order of the section in relation to others sections within a collection. Values go from `0` upwards. `0` is the default if there's no order. example: '1' parent_id: oneOf: - type: integer title: Integer - type: string title: String description: The id of the parent section. example: 6871119 default_locale: type: string description: The default locale of the help center. This field is only returned for multilingual help centers. example: en translated_content: nullable: true "$ref": "#/components/schemas/group_translated_content" section_list: title: Sections type: object description: This will return a list of Sections for the App. properties: type: type: string description: The type of the object - `list`. enum: - list example: list pages: "$ref": "#/components/schemas/cursor_pages" total_count: type: integer description: A count of the total number of sections. example: 12 data: type: array description: An array of section objects items: "$ref": "#/components/schemas/section" segment: title: Segment type: object x-tags: - Segments description: A segment is a group of your contacts defined by the rules that you set. properties: type: type: string description: The type of object. enum: - segment example: segment id: type: string description: The unique identifier representing the segment. example: 56203d253cba154d39010062 name: type: string description: The name of the segment. example: Active created_at: type: integer description: The time the segment was created. example: 1394621988 updated_at: type: integer description: The time the segment was updated. example: 1394622004 person_type: type: string description: 'Type of the contact: contact (lead) or user.' enum: - contact - user example: contact count: type: integer description: The number of items in the user segment. It's returned when `include_count=true` is included in the request. example: 3 nullable: true segment_list: title: Segment List type: object description: This will return a list of Segment Objects. The result may also have a pages object if the response is paginated. properties: type: type: string description: The type of the object enum: - segment.list example: segment.list segments: type: array description: A list of Segment objects items: "$ref": "#/components/schemas/segment" pages: type: object description: A pagination object, which may be empty, indicating no further pages to fetch. single_filter_search_request: type: object properties: field: type: string description: The Intercom defined id representing the company. example: custom_attributes.social_network operator: type: string enum: - "=" - "!=" - IN - NIN - "<" - ">" - "~" - "!~" - "^" - "$" description: The Intercom defined id representing the company. example: "=" value: type: string description: The Intercom defined id representing the company. example: facebook sla_applied: title: Applied SLA type: object nullable: true description: | 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. properties: type: type: string description: object type example: conversation_sla_summary sla_name: type: string description: The name of the SLA as given by the teammate when it was created. example: '' sla_status: type: string enum: - hit - missed - cancelled - active description: |- SLA statuses: - `hit`: If there’s at least one hit event in the underlying sla_events table, and no “missed” or “canceled” events for the conversation. - `missed`: If there are any missed sla_events for the conversation and no canceled events. If there’s even a single missed sla event, the status will always be missed. A missed status is not applied when the SLA expires, only the next time a teammate replies. - `active`: An SLA has been applied to a conversation, but has not yet been fulfilled. SLA status is active only if there are no “hit, “missed”, or “canceled” events. example: hit snooze_conversation_request: title: Snooze Conversation Request type: object description: Payload of the request to snooze a conversation properties: message_type: type: string enum: - snoozed example: snoozed admin_id: type: string description: The id of the admin who is performing the action. example: '5017691' snoozed_until: type: integer format: timestamp description: The time you want the conversation to reopen. example: 1673609604 required: - message_type - admin_id - snoozed_until social_profile: title: Social Profile type: object description: A Social Profile allows you to label your contacts, companies, and conversations and list them using that Social Profile. properties: type: type: string description: value is "social_profile" example: social_profile name: type: string description: The name of the Social media profile example: Facebook url: type: string format: uri description: The name of the Social media profile example: http://twitter.com/th1sland starting_after_paging: title: StartingAfterPaging type: object nullable: true properties: page: type: integer example: 2 starting_after: type: string example: 1HaSB+xrOyyMXAkS/c1RteCL7BzOzTvYjmjakgTergIH31eoe2v4/sbLsJWP\nIncfQLD3ouPkZlCwJ86F\n subscription_type: title: Subscription Types type: object x-tags: - Subscription Types description: A subscription type lets customers easily opt out of non-essential communications without missing what's important to them. properties: type: type: string description: The type of the object - subscription example: subscription id: type: string description: The unique identifier representing the subscription type. example: '123456' state: type: string description: The state of the subscription type. enum: - live - draft - archived example: live default_translation: "$ref": "#/components/schemas/translation" translations: type: array description: An array of translations objects with the localised version of the subscription type in each available locale within your translation settings. items: "$ref": "#/components/schemas/translation" consent_type: type: string description: Describes the type of consent. enum: - opt_out - opt_in example: opt_in content_types: type: array description: The message types that this subscription supports - can contain `email` or `sms_message`. items: type: string enum: - email - sms_message example: email subscription_type_list: title: Subscription Types type: object description: A list of subscription type objects. properties: type: type: string description: The type of the object enum: - list example: list data: type: array description: A list of subscription type objects associated with the workspace . items: "$ref": "#/components/schemas/subscription_type" tag: title: Tag type: object x-tags: - Tags description: A tag allows you to label your contacts, companies, and conversations and list them using that tag. properties: type: type: string description: value is "tag" example: tag id: type: string description: The id of the tag example: '123456' name: type: string description: The name of the tag example: Test tag applied_at: type: integer format: date-time description: The time when the tag was applied to the object example: 1663597223 applied_by: "$ref": "#/components/schemas/reference" tag_company_request: description: You can tag a single company or a list of companies. type: object title: Tag Company Request Payload properties: name: type: string description: The name of the tag, which will be created if not found. example: Independent companies: type: array items: properties: id: type: string description: The Intercom defined id representing the company. example: 531ee472cce572a6ec000006 company_id: type: string description: The company id you have defined for the company. example: '6' description: The id or company_id of the company can be passed as input parameters. required: - name - companies tag_list: title: Tags type: object description: A list of tags objects in the workspace. properties: type: type: string description: The type of the object enum: - list example: list data: type: array description: A list of tags objects associated with the workspace . items: "$ref": "#/components/schemas/tag" tag_multiple_users_request: description: You can tag a list of users. type: object title: Tag Users Request Payload properties: name: type: string description: The name of the tag, which will be created if not found. example: Independent users: type: array items: properties: id: type: string description: The Intercom defined id representing the user. example: 5f7f0d217289f8d2f4262080 required: - name - users tags: title: Tags type: object description: A list of tags objects associated with a conversation properties: type: type: string description: The type of the object enum: - tag.list example: tag.list tags: type: array description: A list of tags objects associated with the conversation. items: "$ref": "#/components/schemas/tag" team: title: Team type: object x-tags: - Teams description: Teams are groups of admins in Intercom. properties: type: type: string description: Value is always "team" example: team id: type: string description: The id of the team example: '814865' name: type: string description: The name of the team example: Example Team admin_ids: type: array description: The list of admin IDs that are a part of the team. example: - 493881 items: type: integer admin_priority_level: "$ref": "#/components/schemas/admin_priority_level" team_list: title: Team List type: object description: This will return a list of team objects for the App. properties: type: type: string description: The type of the object enum: - team.list example: team.list teams: type: array description: A list of team objects items: "$ref": "#/components/schemas/team" team_priority_level: title: Team Priority Level type: object nullable: true description: Admin priority levels for teams properties: primary_team_ids: type: array description: The primary team ids for the team nullable: true example: - 814865 items: type: integer secondary_team_ids: type: array description: The secondary team ids for the team nullable: true example: - 493881 items: type: integer translation: title: Translation type: object description: A translation object contains the localised details of a subscription type. properties: name: type: string description: The localised name of the subscription type. example: Announcements description: type: string description: The localised description of the subscription type. example: Offers, product and feature announcements locale: type: string description: The two character identifier for the language of the translation object. example: en untag_company_request: description: You can tag a single company or a list of companies. type: object title: Untag Company Request Payload properties: name: type: string description: The name of the tag which will be untagged from the company example: Independent companies: type: array items: properties: id: type: string description: The Intercom defined id representing the company. example: 531ee472cce572a6ec000006 company_id: type: string description: The company id you have defined for the company. example: '6' untag: type: boolean description: Always set to true example: 'true' description: The id or company_id of the company can be passed as input parameters. required: - name - companies update_article_request: description: You can Update an Article type: object title: Update Article Request Payload nullable: true properties: title: type: string description: The title of the article.For multilingual articles, this will be the title of the default language's content. example: Thanks for everything description: type: string description: The description of the article. For multilingual articles, this will be the description of the default language's content. example: Description of the Article body: type: string description: The content of the article. For multilingual articles, this will be the body of the default language's content. example: "This is the body in html
" author_id: type: integer 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. example: 1295 state: type: string 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. enum: - published - draft example: draft parent_id: type: string description: The id of the article's parent collection or section. An article without this field stands alone. example: '18' parent_type: type: string description: The type of parent, which can either be a `collection` or `section`. example: collection translated_content: "$ref": "#/components/schemas/article_translated_content" update_collection_request: description: You can update a collection type: object title: Update Collection Request Payload properties: name: type: string description: The name of the collection. For multilingual collections, this will be the name of the default language's content. example: collection 51 description: type: string description: The description of the collection. For multilingual collections, this will be the description of the default language's content. example: English description translated_content: nullable: true "$ref": "#/components/schemas/group_translated_content" update_contact_request: description: You can update a contact type: object title: Update Contact Request Payload properties: role: type: string description: The role of the contact. external_id: type: string description: A unique identifier for the contact which is given to Intercom email: type: string description: The contacts email example: jdoe@example.com phone: type: string nullable: true description: The contacts phone example: "+353871234567" name: type: string nullable: true description: The contacts name example: John Doe avatar: type: string nullable: true description: An image URL containing the avatar of a contact example: https://www.example.com/avatar_image.jpg signed_up_at: type: integer format: date-time nullable: true description: The time specified for when a contact signed up example: 1571672154 last_seen_at: type: integer format: date-time nullable: true description: The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually) example: 1571672154 owner_id: type: integer nullable: true description: The id of an admin that has been assigned account ownership of the contact example: 123 unsubscribed_from_emails: type: boolean nullable: true description: Whether the contact is unsubscribed from emails example: true custom_attributes: type: object nullable: true description: The custom attributes which are set for the contact update_conversation_request: title: Update Conversation Request type: object description: Payload of the request to update a conversation properties: read: type: boolean description: Mark a conversation as read within Intercom. example: true custom_attributes: "$ref": "#/components/schemas/custom_attributes" update_data_attribute_request: description: '' type: object title: Update Data Attribute Request properties: archived: type: boolean description: Whether the attribute is to be archived or not. example: false description: type: string description: The readable description you see in the UI for the attribute. example: My Data Attribute Description options: type: array 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`. items: type: string example: - option1 - option2 messenger_writable: type: boolean description: Can this attribute be updated by the Messenger example: false update_section_request: description: You can update a Section type: object title: Update Section Request Payload properties: name: type: string description: The name of the collection. For multilingual collections, this will be the name of the default language's content. example: Section 51 parent_id: type: integer description: The id for the collection this section will be within. example: 18 translated_content: nullable: true "$ref": "#/components/schemas/group_translated_content" update_visitor_request: description: Update an existing visitor. type: object title: Update Visitor Request Payload properties: id: type: string description: A unique identified for the visitor which is given by Intercom. example: 8a88a590-e user_id: type: string description: A unique identified for the visitor which is given by you. example: '123' name: type: string description: The visitor's name. example: Christian Bale custom_attributes: type: object description: The custom attributes which are set for the visitor. additionalProperties: type: string example: paid_subscriber: true monthly_spend: 155.5 team_mates: 9 anyOf: - required: - id - required: - user_id visitor: title: Visitor type: object description: Visitors are useful for representing anonymous people that have not yet been identified. They usually represent website visitors. Visitors are not visible in Intercom platform. The Visitors resource provides methods to fetch, update, convert and delete. nullable: true properties: type: type: string description: Value is 'visitor' default: visitor example: visitor id: type: string description: The Intercom defined id representing the Visitor. example: 530370b477ad7120001d user_id: type: string description: Automatically generated identifier for the Visitor. example: 8a88a590-e1c3-41e2-a502-e0649dbf721c anonymous: type: boolean description: Identifies if this visitor is anonymous. example: false email: type: string format: email description: The email of the visitor. example: jane.doe@example.com phone: type: string nullable: true description: The phone number of the visitor. example: 555-555-5555 name: type: string nullable: true description: The name of the visitor. example: Jane Doe pseudonym: type: string nullable: true description: The pseudonym of the visitor. example: Red Duck from Dublin avatar: type: object properties: type: type: string description: '' default: avatar example: avatar image_url: type: string format: uri nullable: true description: This object represents the avatar associated with the visitor. example: https://example.com/avatar.png app_id: type: string description: The id of the app the visitor is associated with. example: hfi1bx4l companies: type: object properties: type: type: string description: The type of the object enum: - company.list example: company.list companies: type: array items: "$ref": "#/components/schemas/company" location_data: type: object properties: type: type: string description: '' default: location_data example: location_data city_name: type: string description: The city name of the visitor. example: Dublin continent_code: type: string description: The continent code of the visitor. example: EU country_code: type: string description: The country code of the visitor. example: IRL country_name: type: string description: The country name of the visitor. example: Ireland postal_code: type: string description: The postal code of the visitor. example: D02 N960 region_name: type: string description: The region name of the visitor. example: Leinster timezone: type: string description: The timezone of the visitor. example: Europe/Dublin las_request_at: type: integer description: The time the Lead last recorded making a request. example: 1663597260 created_at: type: integer description: The time the Visitor was added to Intercom. example: 1663597223 remote_created_at: type: integer description: The time the Visitor was added to Intercom. example: 1663597223 signed_up_at: type: integer description: The time the Visitor signed up for your product. example: 1663597223 updated_at: type: integer description: The last time the Visitor was updated. example: 1663597260 session_count: type: integer description: The number of sessions the Visitor has had. example: 1 social_profiles: type: object properties: type: type: string description: The type of the object enum: - social_profile.list example: social_profile.list social_profiles: type: array items: type: string owner_id: type: string nullable: true description: The id of the admin that owns the Visitor. example: '5169261' unsubscribed_from_emails: type: boolean description: Whether the Visitor is unsubscribed from emails. example: false marked_email_as_spam: type: boolean description: Identifies if this visitor has marked an email as spam. example: false has_hard_bounced: type: boolean description: Identifies if this visitor has had a hard bounce. example: false tags: type: object properties: type: type: string description: The type of the object enum: - tag.list example: tag.list tags: type: array items: properties: type: type: string description: The type of the object enum: - tag example: tag id: type: string description: The id of the tag. example: '8482' name: type: string description: The name of the tag. example: tag_name segments: type: object properties: type: type: string description: The type of the object enum: - segment.list example: segment.list segments: type: array items: type: string custom_attributes: type: object description: The custom attributes you have set on the Visitor. additionalProperties: type: string referrer: type: string nullable: true description: The referer of the visitor. example: https://www.google.com/ utm_campaign: type: string nullable: true description: The utm_campaign of the visitor. example: intercom-link utm_content: type: string nullable: true description: The utm_content of the visitor. example: banner utm_medium: type: string nullable: true description: The utm_medium of the visitor. example: email utm_source: type: string nullable: true description: The utm_source of the visitor. example: Intercom utm_term: type: string nullable: true description: The utm_term of the visitor. example: messenger do_not_track: type: boolean nullable: true description: Identifies if this visitor has do not track enabled. example: false visitor_deleted_object: title: Visitor Deleted Object type: object description: Response returned when an object is deleted properties: id: type: string description: The unique identifier for the visitor which is given by Intercom. example: 530370b477ad7120001d type: type: string description: The type of object which was deleted enum: - visitor example: visitor user_id: type: string description: Automatically generated identifier for the Visitor. example: 8a88a590-e1c3-41e2-a502-e0649dbf721c securitySchemes: bearerAuth: type: http scheme: bearer servers: - url: https://api.intercom.io description: The production API server - url: https://api.eu.intercom.io description: The european API server - url: https://api.au.intercom.io description: The australian API server security: - bearerAuth: [] tags: - name: Admins description: Everything about your Admins - name: Articles description: Everything about your Articles - name: Companies description: Everything about your Companies - name: Contacts description: Everything about your contacts - name: Conversations description: Everything about your Conversations externalDocs: description: What is a conversation? url: https://www.intercom.com/help/en/articles/4323904-what-is-a-conversation - name: Data Attributes description: Everything about your Data Attributes - name: Data Events description: Everything about your Data Events - name: Data Export description: Everything about your Data Exports - name: Help Center description: Everything about your Help Center - name: Messages description: Everything about your messages - name: News description: Everything about your News externalDocs: description: News explained url: https://www.intercom.com/help/en/articles/6362251-news-explained - name: Notes description: Everything about your Notes - name: Segments description: Everything about your Segments - name: Subscription Types description: Everything about subscription types - name: Switch description: Everything about Switch externalDocs: description: 'Meet Switch: from on hold to messaging in just a few taps' url: https://www.intercom.com/switch - name: Tags description: Everything about tags - name: Teams description: Everything about your Teams - name: Visitors description: Everything about your Visitors