This is external content
" - url: https://support.example.com/us/3 - ai_agent_availability: true - ai_copilot_availability: true - fin_availability: true - locale: en - source_id: 42 - external_id: '3' - created_at: 1734537269 - updated_at: 1734537269 - last_ingested_at: 1734537269 - - id: '18' - type: external_page - title: My External Content - html: "This is external content
" - url: https://support.example.com/us/2 - ai_agent_availability: true - ai_copilot_availability: true - fin_availability: true - locale: en - source_id: 41 - external_id: '2' - created_at: 1734537269 - updated_at: 1734537269 - last_ingested_at: 1734537269 - - id: '17' - type: external_page - title: My External Content - html: "This is external content
" - url: https://support.example.com/us/1 - ai_agent_availability: true - ai_copilot_availability: true - fin_availability: true - locale: en - source_id: 40 - external_id: '1' - created_at: 1734537269 - updated_at: 1734537269 - last_ingested_at: 1734537269 + - id: '19' + type: external_page + title: My External Content + html: "This is external content
" + url: https://support.example.com/us/3 + ai_agent_availability: true + ai_copilot_availability: true + fin_availability: true + locale: en + source_id: 42 + external_id: '3' + created_at: 1734537269 + updated_at: 1734537269 + last_ingested_at: 1734537269 + - id: '18' + type: external_page + title: My External Content + html: "This is external content
" + url: https://support.example.com/us/2 + ai_agent_availability: true + ai_copilot_availability: true + fin_availability: true + locale: en + source_id: 41 + external_id: '2' + created_at: 1734537269 + updated_at: 1734537269 + last_ingested_at: 1734537269 + - id: '17' + type: external_page + title: My External Content + html: "This is external content
" + url: https://support.example.com/us/1 + ai_agent_availability: true + ai_copilot_availability: true + fin_availability: true + locale: en + source_id: 40 + external_id: '1' + created_at: 1734537269 + updated_at: 1734537269 + last_ingested_at: 1734537269 pages: type: pages page: 1 @@ -698,19 +698,19 @@ paths: type: error.list request_id: bd0c53dd-d3fd-4095-be25-94537a8ba364 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" post: summary: Create an external page (or update an external page by external ID) parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - AI Content + - AI Content operationId: createExternalPage description: You can create a new external page by sending a POST request to this endpoint. If an external page already exists with the specified source_id @@ -749,8 +749,8 @@ paths: type: error.list request_id: 205ffc13-1b25-43b2-a176-cb817af5f899 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: @@ -770,21 +770,21 @@ paths: url: https://www.example.com "/ai/external_pages/{id}": parameters: - - name: id - in: path - description: The unique identifier for the external page which is given by Intercom. - required: true - schema: - type: string + - name: id + in: path + description: The unique identifier for the external page which is given by Intercom. + required: true + schema: + type: string delete: summary: Delete an external page parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - AI Content + - AI Content operationId: deleteExternalPage description: Sending a DELETE request for an external page will remove it from the content library UI and from being used for AI answers. @@ -822,19 +822,19 @@ paths: type: error.list request_id: 2380cdd5-c4a0-451a-b07d-a6f4b720add3 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" get: summary: Retrieve an external page parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - AI Content + - AI Content operationId: getExternalPage description: You can retrieve an external page. responses: @@ -871,19 +871,19 @@ paths: type: error.list request_id: 504cde98-f786-4f64-b373-e26a6a41fd11 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" put: summary: Update an external page parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - AI Content + - AI Content operationId: updateExternalPage description: You can update an existing external page (if it was created via the API). @@ -921,8 +921,8 @@ paths: type: error.list request_id: 8217b189-b908-4562-962d-2a19a7b77f25 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: @@ -944,12 +944,12 @@ paths: get: summary: List all articles parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Articles + - Articles operationId: listArticles description: "You can fetch a list of all articles by making a GET request to `https://api.intercom.io/articles`.\n\n> \U0001F4D8 How are the articles sorted @@ -972,23 +972,23 @@ paths: total_pages: 1 total_count: 1 data: - - id: '39' - type: article - workspace_id: this_is_an_id64_that_should_be_at_least_4 - parent_id: 143 - parent_type: collection - parent_ids: [] - tags: - type: tag.list - tags: [] - title: This is the article title - description: '' - body: '' - author_id: 991267492 - state: published - created_at: 1734537283 - updated_at: 1734537283 - url: http://help-center.test/myapp-64/en/articles/39-this-is-the-article-title + - id: '39' + type: article + workspace_id: this_is_an_id64_that_should_be_at_least_4 + parent_id: 143 + parent_type: collection + parent_ids: [] + tags: + type: tag.list + tags: [] + title: This is the article title + description: '' + body: '' + author_id: 991267492 + state: published + created_at: 1734537283 + updated_at: 1734537283 + url: http://help-center.test/myapp-64/en/articles/39-this-is-the-article-title schema: "$ref": "#/components/schemas/article_list" '401': @@ -1001,19 +1001,19 @@ paths: type: error.list request_id: 2e760b85-9020-471b-89dc-f579ec8a0104 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" post: summary: Create an article parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Articles + - Articles operationId: createArticle description: You can create a new article by making a POST request to `https://api.intercom.io/articles`. responses: @@ -1061,9 +1061,9 @@ paths: type: error.list request_id: e522ca8a-cd15-404e-84b3-7f7536003d4a errors: - - code: parameter_not_found - message: author_id must be in the main body or default locale - translated_content object + - 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': @@ -1076,8 +1076,8 @@ paths: type: error.list request_id: 85e91429-72df-4e69-8a12-b55793dff59f errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: @@ -1114,19 +1114,19 @@ paths: 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 + - 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 + - Articles operationId: retrieveArticle description: You can fetch the details of a single article by making a GET request to `https://api.intercom.io/articles/This is a note.
" - - type: note - id: '25' - created_at: 1733846187 - contact: - type: contact - id: 6762f0ab1bb69f9f2193bb60 - author: - type: admin - id: '991267581' - name: Ciaran122 Lee - email: admin122@email.com - away_mode_enabled: false - away_mode_reassign: false - body: "This is a note.
" - - type: note - id: '24' - created_at: 1733846187 - contact: - type: contact - id: 6762f0ab1bb69f9f2193bb60 - author: - type: admin - id: '991267581' - name: Ciaran122 Lee - email: admin122@email.com - away_mode_enabled: false - away_mode_reassign: false - body: "This is a note.
" + - type: note + id: '26' + created_at: 1733932587 + contact: + type: contact + id: 6762f0ab1bb69f9f2193bb60 + author: + type: admin + id: '991267581' + name: Ciaran122 Lee + email: admin122@email.com + away_mode_enabled: false + away_mode_reassign: false + body: "This is a note.
" + - type: note + id: '25' + created_at: 1733846187 + contact: + type: contact + id: 6762f0ab1bb69f9f2193bb60 + author: + type: admin + id: '991267581' + name: Ciaran122 Lee + email: admin122@email.com + away_mode_enabled: false + away_mode_reassign: false + body: "This is a note.
" + - type: note + id: '24' + created_at: 1733846187 + contact: + type: contact + id: 6762f0ab1bb69f9f2193bb60 + author: + type: admin + id: '991267581' + name: Ciaran122 Lee + email: admin122@email.com + away_mode_enabled: false + away_mode_reassign: false + body: "This is a note.
" total_count: 3 pages: type: pages @@ -3046,27 +3046,27 @@ paths: type: error.list request_id: 57055cde-3d0d-4c67-b5c9-b20b80340bf0 errors: - - code: not_found - message: User Not Found + - 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 + - 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 + - Notes + - Contacts operationId: createNote description: You can add a note to a single contact. responses: @@ -3103,15 +3103,15 @@ paths: type: error.list request_id: 168f1bc3-d198-4797-8422-9f93fe8af5ad errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found Contact not found: value: type: error.list request_id: 6f372239-0259-428f-9943-91b8f7a92162 errors: - - code: not_found - message: User Not Found + - code: not_found + message: User Not Found schema: "$ref": "#/components/schemas/error" requestBody: @@ -3120,7 +3120,7 @@ paths: schema: type: object required: - - body + - body properties: body: type: string @@ -3157,20 +3157,20 @@ paths: 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" + - 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 + - Contacts + - Segments operationId: listSegmentsForAContact description: You can fetch a list of segments that are associated to a contact. responses: @@ -3183,12 +3183,12 @@ paths: value: type: list data: - - type: segment - id: 6762f0b21bb69f9f2193bb65 - name: segment - created_at: 1734537394 - updated_at: 1734537394 - person_type: user + - type: segment + id: 6762f0b21bb69f9f2193bb65 + name: segment + created_at: 1734537394 + updated_at: 1734537394 + person_type: user schema: "$ref": "#/components/schemas/contact_segments" '404': @@ -3201,8 +3201,8 @@ paths: type: error.list request_id: 61c119c7-b2f0-4158-8457-fd53e83f936a errors: - - code: not_found - message: User Not Found + - code: not_found + message: User Not Found schema: "$ref": "#/components/schemas/error" '401': @@ -3215,28 +3215,28 @@ paths: type: error.list request_id: 0273c219-51b7-4938-95d2-19996b2e2734 errors: - - code: unauthorized - message: Access Token Invalid + - 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" + - 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 + - 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. @@ -3256,34 +3256,34 @@ paths: value: type: list data: - - type: subscription - id: '91' - 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: '93' - 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 + - type: subscription + id: '91' + 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: '93' + 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': @@ -3296,8 +3296,8 @@ paths: type: error.list request_id: c9b793ad-ff39-436c-80c9-db6f24d0d444 errors: - - code: not_found - message: User Not Found + - code: not_found + message: User Not Found schema: "$ref": "#/components/schemas/error" '401': @@ -3310,27 +3310,27 @@ paths: type: error.list request_id: 7323b97b-9ba4-4c54-946c-38cecea65b3c errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" post: summary: Add subscription to a contact tags: - - Subscription Types - - Contacts + - 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: 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: @@ -3357,11 +3357,11 @@ paths: description: Lorem ipsum dolor sit amet locale: en translations: - - name: Newsletters - description: Lorem ipsum dolor sit amet - locale: en + - name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en content_types: - - sms_message + - sms_message schema: "$ref": "#/components/schemas/subscription_type" '404': @@ -3374,15 +3374,15 @@ paths: type: error.list request_id: 0c2871af-abed-4bce-a5c5-77efbe721711 errors: - - code: not_found - message: User Not Found + - code: not_found + message: User Not Found Resource not found: value: type: error.list request_id: 2774db46-34d9-4925-a24d-8203d4a39f65 errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found schema: "$ref": "#/components/schemas/error" '401': @@ -3395,8 +3395,8 @@ paths: type: error.list request_id: f615465d-fd5f-4d68-8498-389130b897e4 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: @@ -3405,8 +3405,8 @@ paths: schema: type: object required: - - id - - consent_type + - id + - consent_type properties: id: type: string @@ -3437,28 +3437,28 @@ paths: delete: summary: Remove subscription from a contact tags: - - Subscription Types - - Contacts + - 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 + - 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 @@ -3480,11 +3480,11 @@ paths: description: Lorem ipsum dolor sit amet locale: en translations: - - name: Newsletters - description: Lorem ipsum dolor sit amet - locale: en + - name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en content_types: - - sms_message + - sms_message schema: "$ref": "#/components/schemas/subscription_type" '404': @@ -3497,15 +3497,15 @@ paths: type: error.list request_id: 82b37940-b43f-46ee-a492-11543a317c97 errors: - - code: not_found - message: User Not Found + - code: not_found + message: User Not Found Resource not found: value: type: error.list request_id: c18422ca-5454-42af-9e1d-dd92066e6e9d errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found schema: "$ref": "#/components/schemas/error" '401': @@ -3518,28 +3518,28 @@ paths: type: error.list request_id: c7de741d-dc8f-49b1-8cbe-791668ade76c errors: - - code: unauthorized - message: Access Token Invalid + - 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 + - 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 + - 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. @@ -3553,9 +3553,9 @@ paths: value: type: list data: - - type: tag - id: '80' - name: Manual tag + - type: tag + id: '80' + name: Manual tag schema: "$ref": "#/components/schemas/tag_list" '404': @@ -3568,8 +3568,8 @@ paths: type: error.list request_id: 302049fb-b8c1-4dc8-a327-a8f6e1923484 errors: - - code: not_found - message: User Not Found + - code: not_found + message: User Not Found schema: "$ref": "#/components/schemas/error" '401': @@ -3582,27 +3582,27 @@ paths: type: error.list request_id: ca3c5e6e-c743-428b-aa8a-ac371a50cc39 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" post: summary: Add tag to a contact tags: - - Tags - - Contacts + - 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: 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. @@ -3629,15 +3629,15 @@ paths: type: error.list request_id: f22a7847-ee33-449f-80c0-707efd295a53 errors: - - code: not_found - message: User Not Found + - code: not_found + message: User Not Found Tag not found: value: type: error.list request_id: 8a3e4f88-ae65-433a-b4eb-46780ffc5402 errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found schema: "$ref": "#/components/schemas/error" '401': @@ -3650,8 +3650,8 @@ paths: type: error.list request_id: 9b1c9966-caeb-485a-8419-d707fd472c63 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: @@ -3660,7 +3660,7 @@ paths: schema: type: object required: - - id + - id properties: id: type: string @@ -3684,27 +3684,27 @@ paths: delete: summary: Remove tag from a contact tags: - - Tags - - Contacts + - 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 + - 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. @@ -3731,15 +3731,15 @@ paths: type: error.list request_id: b3d41080-5b35-42b8-8584-31e4660d355f errors: - - code: not_found - message: User Not Found + - code: not_found + message: User Not Found Tag not found: value: type: error.list request_id: '02871f7a-860e-433a-8545-6a73fbbe5e22' errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found schema: "$ref": "#/components/schemas/error" '401': @@ -3752,37 +3752,29 @@ paths: type: error.list request_id: 491beaa4-a452-4940-85e0-498c0ca5528d errors: - - code: unauthorized - message: Access Token Invalid + - 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 + - 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 - - Custom Object Instances + - Contacts operationId: UpdateContact - description: | - You can update an existing contact (ie. user or lead). - - {% admonition type="info" %} - This endpoint handles both **contact updates** and **custom object associations**. - - See _`update a contact with an association to a custom object instance`_ in the request/response examples to see the custom object association format. - {% /admonition %} + description: You can update an existing contact (ie. user or lead). responses: '200': description: successful @@ -3878,109 +3870,9 @@ paths: utm_term: referrer: enabled_push_messaging: - update a contact with an association to a custom object instance: - value: - type: contact - id: 6762f0cd1bb69f9f2193bb7c - workspace_id: this_is_an_id279_that_should_be_at_least_ - external_id: '70' - role: user - email: joebloggs@intercom.io - phone: - formatted_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: 1734537421 - updated_at: 1734537422 - signed_up_at: 1734537421 - 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: - order: - type: Order.list - instances: - - id: '21' - external_id: '123' - external_created_at: 1392036272 - external_updated_at: 1392036272 - custom_attributes: - order_number: ORDER-12345 - total_amount: 99.99 - type: Order - tags: - type: list - data: [] - url: "/contacts/6762f0cd1bb69f9f2193bb7c/tags" - total_count: 0 - has_more: false - notes: - type: list - data: [] - url: "/contacts/6762f0cd1bb69f9f2193bb7c/notes" - total_count: 0 - has_more: false - companies: - type: list - data: [] - url: "/contacts/6762f0cd1bb69f9f2193bb7c/companies" - total_count: 0 - has_more: false - opted_out_subscription_types: - type: list - data: [] - url: "/contacts/6762f0cd1bb69f9f2193bb7c/subscriptions" - total_count: 0 - has_more: false - opted_in_subscription_types: - type: list - data: [] - url: "/contacts/6762f0cd1bb69f9f2193bb7c/subscriptions" - total_count: 0 - has_more: false - utm_campaign: - utm_content: - utm_medium: - utm_source: - utm_term: - referrer: - enabled_push_messaging: schema: allOf: - - "$ref": "#/components/schemas/contact" + - "$ref": "#/components/schemas/contact" properties: enabled_push_messaging: type: boolean @@ -3997,8 +3889,8 @@ paths: type: error.list request_id: 89ce96d9-aae9-4eec-ace2-d68cc4f74879 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: @@ -4006,36 +3898,29 @@ paths: application/json: schema: oneOf: - - "$ref": "#/components/schemas/update_contact_request" + - "$ref": "#/components/schemas/update_contact_request" examples: successful: summary: successful value: email: joebloggs@intercom.io name: joe bloggs - update_a_contact_with_an_association_to_a_custom_object_instance: - summary: update a contact with an association to a custom object - instance - value: - custom_attributes: - order: - - '21' 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 + - 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 + - Contacts operationId: ShowContact description: You can fetch the details of a single contact. responses: @@ -4135,7 +4020,7 @@ paths: enabled_push_messaging: schema: allOf: - - "$ref": "#/components/schemas/contact" + - "$ref": "#/components/schemas/contact" properties: enabled_push_messaging: type: boolean @@ -4152,25 +4037,25 @@ paths: type: error.list request_id: 45b30bd1-75d2-40cc-bb39-74ac133a2836 errors: - - code: unauthorized - message: Access Token Invalid + - 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 + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: id + required: true + schema: + type: string tags: - - Contacts + - Contacts operationId: DeleteContact description: You can delete a single contact. responses: @@ -4178,6 +4063,13 @@ paths: description: successful content: application/json: + examples: + successful: + value: + id: 6762f0d21bb69f9f2193bb7e + external_id: '70' + type: contact + deleted: true schema: "$ref": "#/components/schemas/contact_deleted" '401': @@ -4190,20 +4082,20 @@ paths: type: error.list request_id: a947b2f0-23d3-419d-9ec4-cdd191cea676 errors: - - code: unauthorized - message: Access Token Invalid + - 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" + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Contacts + - Contacts operationId: MergeContact description: You can merge a contact with a `role` of `lead` into a contact with a `role` of `user`. @@ -4304,7 +4196,7 @@ paths: enabled_push_messaging: schema: allOf: - - "$ref": "#/components/schemas/contact" + - "$ref": "#/components/schemas/contact" properties: enabled_push_messaging: type: boolean @@ -4321,8 +4213,8 @@ paths: type: error.list request_id: ff328c7c-6140-48eb-84dd-bb8960b66cd0 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: @@ -4340,12 +4232,12 @@ paths: post: summary: Search contacts parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Contacts + - Contacts operationId: SearchContacts description: | You can search for multiple contacts by the value of their attributes in order to fetch exactly who you want. @@ -4476,8 +4368,8 @@ paths: type: error.list request_id: f0dc95f1-9e46-4e8d-8150-89365c2c5195 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: @@ -4492,21 +4384,21 @@ paths: query: operator: AND value: - - field: created_at - operator: ">" - value: '1306054154' + - field: created_at + operator: ">" + value: '1306054154' pagination: per_page: 5 "/contacts": get: summary: List all contacts parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Contacts + - Contacts operationId: ListContacts description: | You can fetch a list of all contacts (ie. users or leads) in your workspace. @@ -4542,19 +4434,19 @@ paths: type: error.list request_id: e097e446-9ae6-44a8-8e13-2bf3008b87ef errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" post: summary: Create contact parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Contacts + - Contacts operationId: CreateContact description: You can create a new contact (ie. user or lead). responses: @@ -4654,7 +4546,7 @@ paths: enabled_push_messaging: schema: allOf: - - "$ref": "#/components/schemas/contact" + - "$ref": "#/components/schemas/contact" properties: enabled_push_messaging: type: boolean @@ -4671,8 +4563,8 @@ paths: type: error.list request_id: ff2353d3-d3d6-4f20-8268-847869d01e73 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: @@ -4680,7 +4572,7 @@ paths: application/json: schema: oneOf: - - "$ref": "#/components/schemas/create_contact_request" + - "$ref": "#/components/schemas/create_contact_request" examples: successful: summary: successful @@ -4690,19 +4582,19 @@ paths: get: summary: Get a contact by External ID parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - - name: external_id - in: path - required: true - example: cdd29344-5e0c-4ef0-ac56-f9ba2979bc27 - description: The external ID of the user that you want to retrieve - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: external_id + in: path + required: true + example: cdd29344-5e0c-4ef0-ac56-f9ba2979bc27 + description: The external ID of the user that you want to retrieve + schema: + type: string tags: - - Contacts + - Contacts operationId: ShowContactByExternalId description: You can fetch the details of a single contact by external ID. Note that this endpoint only supports users and not leads. @@ -4803,7 +4695,7 @@ paths: enabled_push_messaging: schema: allOf: - - "$ref": "#/components/schemas/contact" + - "$ref": "#/components/schemas/contact" properties: enabled_push_messaging: type: boolean @@ -4820,27 +4712,27 @@ paths: type: error.list request_id: 1fb28be7-cda6-4029-b4da-447ef61cb61a errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" "/contacts/{id}/archive": post: summary: Archive 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 + - 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 + - Contacts operationId: ArchiveContact description: You can archive a single contact. responses: @@ -4848,25 +4740,32 @@ paths: description: successful content: application/json: + examples: + successful: + value: + id: 6762f0e21bb69f9f2193bb86 + external_id: '70' + type: contact + archived: true schema: "$ref": "#/components/schemas/contact_archived" "/contacts/{id}/unarchive": post: summary: Unarchive 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 + - 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 + - Contacts operationId: UnarchiveContact description: You can unarchive a single contact. responses: @@ -4874,52 +4773,33 @@ paths: description: successful content: application/json: + examples: + successful: + value: + id: 6762f0e31bb69f9f2193bb87 + external_id: '70' + type: contact + archived: false schema: "$ref": "#/components/schemas/contact_unarchived" - "/contacts/{id}/block": - post: - summary: Block 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: BlockContact - description: Block a single contact.this is the message body
" - author: - type: admin - id: '991267628' - name: Ciaran166 Lee - email: admin166@email.com - attachments: [] - url: - redacted: false - contacts: - type: contact.list + - type: conversation + id: '471' + created_at: 1734537460 + updated_at: 1734537460 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918320' + delivered_as: admin_initiated + subject: '' + body: "this is the message body
" + author: + type: admin + id: '991267628' + name: Ciaran166 Lee + email: admin166@email.com + attachments: [] + url: + redacted: false contacts: - - type: contact - id: 6762f0f31bb69f9f2193bb8b - external_id: '70' - 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: {} - ticket: - linked_objects: - type: list - data: [] - total_count: 0 - has_more: false - ai_agent: - ai_agent_participated: false + type: contact.list + contacts: + - type: contact + id: 6762f0f31bb69f9f2193bb8b + external_id: '70' + 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: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false schema: - "$ref": "#/components/schemas/conversation_list" + "$ref": "#/components/schemas/paginated_response" '401': description: Unauthorized content: @@ -5208,8 +5088,8 @@ paths: type: error.list request_id: b14d75ab-7d26-4191-b33f-77ca0a4d4ede errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" '403': @@ -5222,19 +5102,19 @@ paths: type: error.list request_id: 591a0c2f-78b3-41bb-bfa7-f1fae15107b9 errors: - - code: api_plan_restricted - message: Active subscription needed. + - 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" + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Conversations + - Conversations operationId: createConversation description: |+ You can create a conversation that has been initiated by a contact (ie. user or lead). @@ -5273,8 +5153,8 @@ paths: type: error.list request_id: d7eb553e-74ae-4341-820b-5d38a94d4a99 errors: - - code: not_found - message: User Not Found + - code: not_found + message: User Not Found schema: "$ref": "#/components/schemas/error" '401': @@ -5287,8 +5167,8 @@ paths: type: error.list request_id: 68e42c33-8220-48ea-906f-75584c3ec440 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" '403': @@ -5301,8 +5181,8 @@ paths: type: error.list request_id: dcf1b373-3e66-4026-a987-98c16f00a908 errors: - - code: api_plan_restricted - message: Active subscription needed. + - code: api_plan_restricted + message: Active subscription needed. schema: "$ref": "#/components/schemas/error" requestBody: @@ -5329,26 +5209,26 @@ paths: 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 + - 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 + - Conversations operationId: retrieveConversation description: |2 @@ -5392,9 +5272,9 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 6762f1261bb69f9f2193bba7 - external_id: '70' + - type: contact + id: 6762f1261bb69f9f2193bba7 + external_id: '70' first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5403,14 +5283,7 @@ paths: read: false tags: type: tag.list - tags: - - type: tag - id: '123456' - name: Test tag - applied_at: 1663597223 - applied_by: - type: contact - id: '1a2b3c' + tags: [] priority: not_priority sla_applied: statistics: @@ -5429,106 +5302,8 @@ paths: ai_agent_participated: false conversation_parts: type: conversation_part.list - conversation_parts: - - type: conversation_part - id: 1 - part_type: comment - body:Okay!
- created_at: 1663597223 - updated_at: 1663597260 - notified_at: 1663597260 - assigned_to: - type: contact - id: '1a2b3c' - author: - type: admin - id: '274' - name: Operator - email: operator+abcd1234@intercom.io - attachments: [] - external_id: 'abcd1234' - redacted: false - email_message_metadata: null - state: open - tags: - - type: tag - id: '123456' - name: Test tag - event_details: - app_package_code: null - - type: conversation_part - id: 2 - part_type: custom_action_started - body: - created_at: 1740141842 - updated_at: 1740141842 - notified_at: 1740141842 - assigned_to: - author: - type: admin - id: '274' - name: Jamie Oliver - email: jamie+abcd1234@intercom.io - attachments: [] - external_id: - redacted: false - email_message_metadata: null - state: open - tags: [] - event_details: - action: - name: Jira Create Issue - app_package_code: test-integration - - type: conversation_part - id: 3 - part_type: conversation_attribute_updated_by_admin - body: - created_at: 1740141851 - updated_at: 1740141851 - notified_at: 1740141851 - assigned_to: - author: - type: bot - id: '278' - name: Fin - email: operator+abcd1234@intercom.io - attachments: [] - external_id: - redacted: false - email_message_metadata: null - state: open - tags: [] - event_details: - attribute: - name: jira_issue_key - value: - name: PROJ-007 - app_package_code: null - - type: conversation_part - id: 4 - part_type: custom_action_finished - body: - created_at: 1740141857 - updated_at: 1740141857 - notified_at: 1740141857 - assigned_to: - author: - type: admin - id: '274' - name: Jamie Oliver - email: jamie+abcd1234@intercom.io - attachments: [] - external_id: - redacted: false - email_message_metadata: null - state: closed - tags: [] - event_details: - action: - name: Jira Create Issue - result: success - app_package_code: null - total_count: 4 + conversation_parts: [] + total_count: 0 schema: "$ref": "#/components/schemas/conversation" '404': @@ -5541,8 +5316,8 @@ paths: type: error.list request_id: 8c288c4f-b699-4209-9de4-064398f02785 errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found schema: "$ref": "#/components/schemas/error" '401': @@ -5555,8 +5330,8 @@ paths: type: error.list request_id: 1350c241-0f22-48ca-bab9-169080340870 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" '403': @@ -5569,34 +5344,33 @@ paths: type: error.list request_id: 8b3deed3-fd8b-43d6-b6a8-428c9e17aabb errors: - - code: api_plan_restricted - message: Active subscription needed. + - 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 + - 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 - - Custom Object Instances + - Conversations operationId: updateConversation description: |2+ @@ -5606,12 +5380,6 @@ paths: 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 %} - {% admonition type="info" %} - This endpoint handles both **conversation updates** and **custom object associations**. - - See _`update a conversation with an association to a custom object instance`_ in the request/response examples to see the custom object association format. - {% /admonition %} - responses: '200': description: update a conversation with an association to a custom object @@ -5644,9 +5412,9 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 6762f1301bb69f9f2193bbab - external_id: '70' + - type: contact + id: 6762f1301bb69f9f2193bbab + external_id: '70' first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5677,44 +5445,42 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '129' - part_type: conversation_attribute_updated_by_admin - body: - created_at: 1734537523 - updated_at: 1734537523 - notified_at: 1734537523 - assigned_to: - author: - id: '991267654' - type: bot - name: Fin - email: operator+this_is_an_id354_that_should_be_at_least_@intercom.io - attachments: [] - external_id: - redacted: false - metadata: {} - email_message_metadata: - app_package_code: null - - type: conversation_part - id: '130' - part_type: conversation_attribute_updated_by_admin - body: - created_at: 1734537523 - updated_at: 1734537523 - notified_at: 1734537523 - assigned_to: - author: - id: '991267654' - type: bot - name: Fin - email: operator+this_is_an_id354_that_should_be_at_least_@intercom.io - attachments: [] - external_id: - redacted: false - metadata: {} - email_message_metadata: - app_package_code: null + - type: conversation_part + id: '129' + part_type: conversation_attribute_updated_by_admin + body: + created_at: 1734537523 + updated_at: 1734537523 + notified_at: 1734537523 + assigned_to: + author: + id: '991267654' + type: bot + name: Fin + email: operator+this_is_an_id354_that_should_be_at_least_@intercom.io + attachments: [] + external_id: + redacted: false + metadata: {} + email_message_metadata: + - type: conversation_part + id: '130' + part_type: conversation_attribute_updated_by_admin + body: + created_at: 1734537523 + updated_at: 1734537523 + notified_at: 1734537523 + assigned_to: + author: + id: '991267654' + type: bot + name: Fin + email: operator+this_is_an_id354_that_should_be_at_least_@intercom.io + attachments: [] + external_id: + redacted: false + metadata: {} + email_message_metadata: total_count: 2 update a conversation with an association to a custom object instance: value: @@ -5741,9 +5507,9 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 6762f1341bb69f9f2193bbac - external_id: '70' + - type: contact + id: 6762f1341bb69f9f2193bbac + external_id: '70' first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5761,16 +5527,11 @@ paths: title: custom_attributes: order: - type: Order.list + type: order.list instances: - - id: '21' - external_id: '123' - external_created_at: 1392036272 - external_updated_at: 1392036272 - custom_attributes: - order_number: ORDER-12345 - total_amount: 99.99 - type: Order + - id: '21' + custom_attributes: {} + type: order topics: {} ticket: linked_objects: @@ -5796,8 +5557,8 @@ paths: type: error.list request_id: de1be01d-a0d3-48a6-9ea6-9789931a6887 errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found schema: "$ref": "#/components/schemas/error" '401': @@ -5810,8 +5571,8 @@ paths: type: error.list request_id: de63ddb2-c525-4ebf-ad38-82ed8b44c896 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" '403': @@ -5824,8 +5585,8 @@ paths: type: error.list request_id: 34072e07-6b70-4f59-96bf-3106a3563a24 errors: - - code: api_plan_restricted - message: Active subscription needed. + - code: api_plan_restricted + message: Active subscription needed. schema: "$ref": "#/components/schemas/error" requestBody: @@ -5838,7 +5599,6 @@ paths: summary: conversation found value: read: true - title: new conversation title custom_attributes: issue_type: Billing priority: High @@ -5848,30 +5608,29 @@ paths: value: custom_attributes: order: - - '21' + - '21' not_found: summary: Not found value: read: true - title: new conversation title custom_attributes: issue_type: Billing priority: High delete: summary: Delete a conversation parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - - name: id - in: path - description: id - required: true - schema: - type: integer + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: id + required: true + schema: + type: integer tags: - - Conversations + - Conversations operationId: deleteConversation description: You can delete a single conversation. responses: @@ -5897,8 +5656,8 @@ paths: type: error.list request_id: 310f55b0-2660-43e8-bed4-7e82b2f40920 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" '403': @@ -5911,20 +5670,20 @@ paths: type: error.list request_id: 7a80b950-b392-499f-85db-ea7c6c424d37 errors: - - code: api_plan_restricted - message: Active subscription needed. + - code: api_plan_restricted + message: Active subscription needed. schema: "$ref": "#/components/schemas/error" "/conversations/search": post: summary: Search conversations parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Conversations + - 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. @@ -5948,8 +5707,7 @@ paths: ### Accepted Fields - Most keys listed in the conversation 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"`). - The `source.body` field is unique as the search will not be performed against the entire value, but instead against every element of the value separately. For example, when searching for a conversation with a `"I need support"` body - the query should contain a `=` operator with the value `"support"` for such conversation to be returned. A query with a `=` operator and a `"need support"` value will not yield a result. + 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 | | :---------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -6042,59 +5800,59 @@ paths: total_pages: 1 total_count: 1 conversations: - - type: conversation - id: '515' - created_at: 1734537546 - updated_at: 1734537546 - waiting_since: - snoozed_until: - source: - type: conversation - id: '403918346' - delivered_as: admin_initiated - subject: '' - body: "this is the message body
" - author: - type: admin - id: '991267691' - name: Ciaran210 Lee - email: admin210@email.com - attachments: [] - url: - redacted: false - contacts: - type: contact.list + - type: conversation + id: '515' + created_at: 1734537546 + updated_at: 1734537546 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918346' + delivered_as: admin_initiated + subject: '' + body: "this is the message body
" + author: + type: admin + id: '991267691' + name: Ciaran210 Lee + email: admin210@email.com + attachments: [] + url: + redacted: false contacts: - - type: contact - id: 6762f14a1bb69f9f2193bbb3 - external_id: '70' - 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: {} - ticket: - linked_objects: - type: list - data: [] - total_count: 0 - has_more: false - ai_agent: - ai_agent_participated: false - schema: - "$ref": "#/components/schemas/conversation_list" + type: contact.list + contacts: + - type: contact + id: 6762f14a1bb69f9f2193bbb3 + external_id: '70' + 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: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + schema: + "$ref": "#/components/schemas/conversation_list" requestBody: content: application/json: @@ -6107,29 +5865,29 @@ paths: query: operator: AND value: - - field: created_at - operator: ">" - value: '1306054154' + - field: created_at + operator: ">" + value: '1306054154' pagination: per_page: 5 "/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 + - 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 + - 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. @@ -6164,9 +5922,9 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 6762f1571bb69f9f2193bbbb - external_id: '70' + - type: contact + id: 6762f1571bb69f9f2193bbbb + external_id: '70' first_contact_reply: created_at: 1734537561 type: conversation @@ -6198,25 +5956,24 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '132' - part_type: open - body: "Thanks again :)
" - created_at: 1734537561 - updated_at: 1734537561 - notified_at: 1734537561 - assigned_to: - author: - id: 6762f1571bb69f9f2193bbbb - type: user - name: Joe Bloggs - email: joe@bloggs.com - attachments: [] - external_id: - redacted: false - metadata: {} - email_message_metadata: - app_package_code: null + - type: conversation_part + id: '132' + part_type: open + body: "Thanks again :)
" + created_at: 1734537561 + updated_at: 1734537561 + notified_at: 1734537561 + assigned_to: + author: + id: 6762f1571bb69f9f2193bbbb + type: user + name: Joe Bloggs + email: joe@bloggs.com + attachments: [] + external_id: + redacted: false + metadata: {} + email_message_metadata: total_count: 1 Admin note reply: value: @@ -6243,9 +6000,9 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 6762f15b1bb69f9f2193bbbc - external_id: '70' + - type: contact + id: 6762f15b1bb69f9f2193bbbc + external_id: '70' first_contact_reply: admin_assignee_id: team_assignee_id: @@ -6274,37 +6031,36 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '133' - part_type: note - body: |- -Thanks again :)
" - created_at: 1734537572 - updated_at: 1734537572 - notified_at: 1734537572 - assigned_to: - author: - id: 6762f1621bb69f9f2193bbbe - type: user - name: Joe Bloggs - email: joe@bloggs.com - attachments: [] - external_id: - redacted: false - metadata: {} - email_message_metadata: - app_package_code: null + - type: conversation_part + id: '135' + part_type: open + body: "Thanks again :)
" + created_at: 1734537572 + updated_at: 1734537572 + notified_at: 1734537572 + assigned_to: + author: + id: 6762f1621bb69f9f2193bbbe + type: user + name: Joe Bloggs + email: joe@bloggs.com + attachments: [] + external_id: + redacted: false + metadata: {} + email_message_metadata: total_count: 1 schema: "$ref": "#/components/schemas/conversation" @@ -6473,8 +6227,8 @@ paths: type: error.list request_id: '06234918-c245-4caa-a2cc-90247983c6ff' errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found schema: "$ref": "#/components/schemas/error" '401': @@ -6487,8 +6241,8 @@ paths: type: error.list request_id: 50f1e8d1-cf1a-450c-a7b5-87a264076241 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" '403': @@ -6501,8 +6255,8 @@ paths: type: error.list request_id: 48ad16d0-525c-40bf-b733-89239feb70e3 errors: - - code: api_plan_restricted - message: Active subscription needed. + - code: api_plan_restricted + message: Active subscription needed. schema: "$ref": "#/components/schemas/error" requestBody: @@ -6535,10 +6289,10 @@ paths: type: admin admin_id: 991267698 reply_options: - - text: 'Yes' - uuid: a5e1c524-5ddd-4c3e-9328-6bca5d6e3edb - - text: 'No' - uuid: f4a98af1-be56-4948-a57e-e1a83f8484c6 + - text: 'Yes' + uuid: a5e1c524-5ddd-4c3e-9328-6bca5d6e3edb + - text: 'No' + uuid: f4a98af1-be56-4948-a57e-e1a83f8484c6 user_last_conversation_reply: summary: User last conversation reply value: @@ -6557,19 +6311,19 @@ paths: post: summary: Manage 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 + - 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 + - Conversations operationId: manageConversation description: | For managing conversations you can: @@ -6608,9 +6362,9 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 6762f16e1bb69f9f2193bbc2 - external_id: '70' + - type: contact + id: 6762f16e1bb69f9f2193bbc2 + external_id: '70' first_contact_reply: admin_assignee_id: team_assignee_id: @@ -6639,25 +6393,24 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '136' - part_type: close - body: "Goodbye :)
" - created_at: 1734537584 - updated_at: 1734537584 - notified_at: 1734537584 - assigned_to: - author: - id: '991267708' - type: admin - name: Ciaran219 Lee - email: admin219@email.com - attachments: [] - external_id: - redacted: false - metadata: {} - email_message_metadata: - app_package_code: null + - type: conversation_part + id: '136' + part_type: close + body: "Goodbye :)
" + created_at: 1734537584 + updated_at: 1734537584 + notified_at: 1734537584 + assigned_to: + author: + id: '991267708' + type: admin + name: Ciaran219 Lee + email: admin219@email.com + attachments: [] + external_id: + redacted: false + metadata: {} + email_message_metadata: total_count: 1 Snooze a conversation: value: @@ -6684,9 +6437,9 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 6762f1711bb69f9f2193bbc3 - external_id: '70' + - type: contact + id: 6762f1711bb69f9f2193bbc3 + external_id: '70' first_contact_reply: admin_assignee_id: team_assignee_id: @@ -6715,25 +6468,24 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '137' - part_type: snoozed - body: - created_at: 1734537587 - updated_at: 1734537587 - notified_at: 1734537587 - assigned_to: - author: - id: '991267710' - type: admin - name: Ciaran220 Lee - email: admin220@email.com - attachments: [] - external_id: - redacted: false - metadata: {} - email_message_metadata: - app_package_code: null + - type: conversation_part + id: '137' + part_type: snoozed + body: + created_at: 1734537587 + updated_at: 1734537587 + notified_at: 1734537587 + assigned_to: + author: + id: '991267710' + type: admin + name: Ciaran220 Lee + email: admin220@email.com + attachments: [] + external_id: + redacted: false + metadata: {} + email_message_metadata: total_count: 1 Open a conversation: value: @@ -6760,9 +6512,9 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 6762f1781bb69f9f2193bbc8 - external_id: '74' + - type: contact + id: 6762f1781bb69f9f2193bbc8 + external_id: '74' first_contact_reply: admin_assignee_id: team_assignee_id: @@ -6791,25 +6543,24 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '139' - part_type: open - body: - created_at: 1734537601 - updated_at: 1734537601 - notified_at: 1734537601 - assigned_to: - author: - id: '991267712' - type: admin - name: Ciaran221 Lee - email: admin221@email.com - attachments: [] - external_id: - redacted: false - metadata: {} - email_message_metadata: - app_package_code: null + - type: conversation_part + id: '139' + part_type: open + body: + created_at: 1734537601 + updated_at: 1734537601 + notified_at: 1734537601 + assigned_to: + author: + id: '991267712' + type: admin + name: Ciaran221 Lee + email: admin221@email.com + attachments: [] + external_id: + redacted: false + metadata: {} + email_message_metadata: total_count: 1 Assign a conversation: value: @@ -6836,9 +6587,9 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 6762f1831bb69f9f2193bbcc - external_id: '70' + - type: contact + id: 6762f1831bb69f9f2193bbcc + external_id: '70' first_contact_reply: admin_assignee_id: 991267715 team_assignee_id: @@ -6867,27 +6618,26 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '140' - part_type: assign_and_reopen - body: - created_at: 1734537605 - updated_at: 1734537605 - notified_at: 1734537605 - assigned_to: - type: admin - id: '991267715' - author: - id: '991267715' - type: admin - name: Ciaran223 Lee - email: admin223@email.com - attachments: [] - external_id: - redacted: false - metadata: {} - email_message_metadata: - app_package_code: null + - type: conversation_part + id: '140' + part_type: assign_and_reopen + body: + created_at: 1734537605 + updated_at: 1734537605 + notified_at: 1734537605 + assigned_to: + type: admin + id: '991267715' + author: + id: '991267715' + type: admin + name: Ciaran223 Lee + email: admin223@email.com + attachments: [] + external_id: + redacted: false + metadata: {} + email_message_metadata: total_count: 1 schema: "$ref": "#/components/schemas/conversation" @@ -6901,8 +6651,8 @@ paths: type: error.list request_id: e056b3c3-fae3-4a3c-9bcf-836b84efa331 errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found schema: "$ref": "#/components/schemas/error" '401': @@ -6915,8 +6665,8 @@ paths: type: error.list request_id: 623bbbb8-f6fb-45f3-a2e2-4106ff3a4349 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" '403': @@ -6929,8 +6679,8 @@ paths: type: error.list request_id: a57737d0-63a7-42bd-aa65-8380ef828124 errors: - - code: api_plan_restricted - message: Active subscription needed. + - code: api_plan_restricted + message: Active subscription needed. schema: "$ref": "#/components/schemas/error" requestBody: @@ -6938,10 +6688,10 @@ paths: 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" + - "$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 @@ -6975,23 +6725,173 @@ paths: type: admin admin_id: 991267717 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="warning" 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: '546' + created_at: 1734537616 + updated_at: 1734537617 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918365' + delivered_as: admin_initiated + subject: '' + body: "this is the message body
" + author: + type: admin + id: '991267723' + name: Ciaran227 Lee + email: admin227@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 6762f18f1bb69f9f2193bbd0 + external_id: '70' + 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: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '141' + part_type: default_assignment + body: + created_at: 1734537617 + updated_at: 1734537617 + notified_at: 1734537617 + assigned_to: + type: nobody_admin + id: + author: + id: '991267724' + type: bot + name: Fin + email: operator+this_is_an_id402_that_should_be_at_least_@intercom.io + attachments: [] + external_id: + redacted: false + metadata: {} + email_message_metadata: + total_count: 1 + schema: + "$ref": "#/components/schemas/conversation" + '404': + description: Not found + content: + application/json: + examples: + Not found: + value: + type: error.list + request_id: b55c4cc0-7511-44cd-965a-2751f3559ba9 + 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: c9fa3789-8f00-4a85-b15b-c9e968d3edac + 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: c1d71d2a-a0fb-43df-82cc-495c051cb1c1 + 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 + - 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 + - Conversations operationId: attachContactToConversation description: |+ You can add participants who are contacts to a conversation, on behalf of either another contact or an admin. @@ -7009,8 +6909,8 @@ paths: Attach a contact to a conversation: value: customers: - - type: user - id: 6762f19b1bb69f9f2193bbd4 + - type: user + id: 6762f19b1bb69f9f2193bbd4 schema: "$ref": "#/components/schemas/conversation" '404': @@ -7023,8 +6923,8 @@ paths: type: error.list request_id: 86fd8b2e-7048-4fbd-9fb0-d73085d7210b errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found schema: "$ref": "#/components/schemas/error" '401': @@ -7037,8 +6937,8 @@ paths: type: error.list request_id: 9dc7c1a0-b818-472c-adf6-3e327f22f541 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" '403': @@ -7051,8 +6951,8 @@ paths: type: error.list request_id: 99f72599-ac98-4b1e-af96-808654b6383e errors: - - code: api_plan_restricted - message: Active subscription needed. + - code: api_plan_restricted + message: Active subscription needed. schema: "$ref": "#/components/schemas/error" requestBody: @@ -7077,26 +6977,26 @@ paths: 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 + - 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 + - Conversations operationId: detachContactFromConversation description: |+ You can add participants who are contacts to a conversation, on behalf of either another contact or an admin. @@ -7114,8 +7014,8 @@ paths: Detach a contact from a group conversation: value: customers: - - type: user - id: 6762f1b41bb69f9f2193bbe0 + - type: user + id: 6762f1b41bb69f9f2193bbe0 schema: "$ref": "#/components/schemas/conversation" '404': @@ -7128,15 +7028,15 @@ paths: type: error.list request_id: 89835b60-6756-4d2a-b148-26ca0cb49f9f errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found Contact not found: value: type: error.list request_id: ab1b9371-3185-417f-a53a-dcae35892980 errors: - - code: not_found - message: User Not Found + - code: not_found + message: User Not Found schema: "$ref": "#/components/schemas/error" '422': @@ -7149,8 +7049,8 @@ paths: type: error.list request_id: 8275e92f-66b7-40f9-82a8-9647ca8d7eb4 errors: - - code: parameter_invalid - message: Removing the last customer is not allowed + - code: parameter_invalid + message: Removing the last customer is not allowed schema: "$ref": "#/components/schemas/error" '401': @@ -7163,8 +7063,8 @@ paths: type: error.list request_id: 89ef64b2-d1f9-40c3-89e9-d39175d3d647 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" '403': @@ -7177,8 +7077,8 @@ paths: type: error.list request_id: 6fe4106b-967a-46ba-b1c9-9996aff6e8c3 errors: - - code: api_plan_restricted - message: Active subscription needed. + - code: api_plan_restricted + message: Active subscription needed. schema: "$ref": "#/components/schemas/error" requestBody: @@ -7215,12 +7115,12 @@ paths: post: summary: Redact a conversation part parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Conversations + - Conversations operationId: redactConversation description: |+ You can redact a conversation part or the source message of a conversation (as seen in the source object). @@ -7260,9 +7160,9 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 6762f1f81bb69f9f2193bc09 - external_id: '70' + - type: contact + id: 6762f1f81bb69f9f2193bc09 + external_id: '70' first_contact_reply: created_at: 1734537722 type: conversation @@ -7294,25 +7194,24 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '149' - part_type: open - body: "This message was deleted
" - created_at: 1734537722 - updated_at: 1734537724 - notified_at: 1734537722 - assigned_to: - author: - id: 6762f1f81bb69f9f2193bc09 - type: user - name: Joe Bloggs - email: joe@bloggs.com - attachments: [] - external_id: - redacted: true - metadata: {} - email_message_metadata: - app_package_code: null + - type: conversation_part + id: '149' + part_type: open + body: "This message was deleted
" + created_at: 1734537722 + updated_at: 1734537724 + notified_at: 1734537722 + assigned_to: + author: + id: 6762f1f81bb69f9f2193bc09 + type: user + name: Joe Bloggs + email: joe@bloggs.com + attachments: [] + external_id: + redacted: true + metadata: {} + email_message_metadata: total_count: 1 schema: "$ref": "#/components/schemas/conversation" @@ -7326,8 +7225,8 @@ paths: type: error.list request_id: 5b7bb755-4031-4bfe-8897-54d0f1872bbc errors: - - code: conversation_part_or_message_not_found - message: Conversation part or message not found + - code: conversation_part_or_message_not_found + message: Conversation part or message not found schema: "$ref": "#/components/schemas/error" '401': @@ -7340,8 +7239,8 @@ paths: type: error.list request_id: 4814668f-5d31-4bf7-8f66-b426aac054db errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: @@ -7366,19 +7265,19 @@ paths: post: summary: Convert a conversation to a ticket 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: 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 tags: - - Conversations + - Conversations description: You can convert a conversation to a ticket. operationId: convertConversationToTicket responses: @@ -7417,9 +7316,9 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 6762f2041bb69f9f2193bc0c - external_id: '70' + - type: contact + id: 6762f2041bb69f9f2193bc0c + external_id: '70' admin_assignee_id: '0' team_assignee_id: '0' created_at: 1734537732 @@ -7427,35 +7326,33 @@ paths: ticket_parts: type: ticket_part.list ticket_parts: - - type: ticket_part - id: '151' - part_type: comment - body: "Comment for message
" - created_at: 1734537732 - updated_at: 1734537732 - author: - id: 6762f2041bb69f9f2193bc0c - type: user - name: Joe Bloggs - email: joe@bloggs.com - attachments: [] - redacted: false - app_package_code: test-integration - - type: ticket_part - id: '152' - part_type: ticket_state_updated_by_admin - ticket_state: submitted - previous_ticket_state: submitted - created_at: 1734537737 - updated_at: 1734537737 - author: - id: '991267767' - type: bot - name: Fin - email: operator+this_is_an_id442_that_should_be_at_least_@intercom.io - attachments: [] - redacted: false - app_package_code: test-integration + - type: ticket_part + id: '151' + part_type: comment + body: "Comment for message
" + created_at: 1734537732 + updated_at: 1734537732 + author: + id: 6762f2041bb69f9f2193bc0c + type: user + name: Joe Bloggs + email: joe@bloggs.com + attachments: [] + redacted: false + - type: ticket_part + id: '152' + part_type: ticket_state_updated_by_admin + ticket_state: submitted + previous_ticket_state: submitted + created_at: 1734537737 + updated_at: 1734537737 + author: + id: '991267767' + type: bot + name: Fin + email: operator+this_is_an_id442_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false total_count: 2 open: true linked_objects: @@ -7477,8 +7374,8 @@ paths: type: error.list request_id: 450e0b22-ccc2-40dd-bf54-bc0faaa28f57 errors: - - code: parameter_invalid - message: Ticket type is not a customer ticket type + - code: parameter_invalid + message: Ticket type is not a customer ticket type schema: "$ref": "#/components/schemas/error" requestBody: @@ -7497,24 +7394,23 @@ paths: ticket_type_id: '54' "/custom_object_instances/{custom_object_type_identifier}": parameters: - - name: custom_object_type_identifier - in: path - description: The unique identifier of the custom object type that defines the - structure of the custom object instance. - example: Order - required: true - schema: - type: string + - name: custom_object_type_identifier + in: path + description: The unique identifier of the custom object type that defines the + structure of the custom object instance. + example: Order + required: true + schema: + type: string post: summary: Create or Update a Custom Object Instance parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Custom Object Instances - operationId: createCustomObjectInstances + - Custom Object Instances description: Create or update a custom object instance responses: '200': @@ -7525,10 +7421,8 @@ paths: successful: value: id: '22' - type: Order - custom_attributes: - order_number: ORDER-12345 - total_amount: 99.99 + type: object_type_identifier_1 + custom_attributes: {} external_id: '123' external_created_at: 1392036272 external_updated_at: 1392036272 @@ -7537,9 +7431,19 @@ paths: schema: "$ref": "#/components/schemas/custom_object_instance" '401': - $ref: "#/components/responses/Unauthorized" - '404': - $ref: "#/components/responses/TypeNotFound" + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 12a938a3-314e-4939-b773-5cd45738bd21 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" requestBody: content: application/json: @@ -7552,33 +7456,39 @@ paths: external_id: '123' external_created_at: 1392036272 external_updated_at: 1392036272 - custom_attributes: - order_number: ORDER-12345 - total_amount: 99.99 get: summary: Get Custom Object Instance by External ID parameters: - - name: external_id - in: query - style: form - required: true - schema: - type: string - description: The unique identifier for the instance in the external system - it originated from. - title: Find by external_id - properties: - external_id: - type: string - required: - - external_id - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" + - name: external_id + in: query + style: form + required: true + schema: + type: object + oneOf: + - description: The Intercom defined id representing the custom object instance. + title: Find by id + properties: + external_id: + type: string + required: + - external_id + additionalProperties: false + - description: The unique identifier for the instance in the external system + it originated from. + title: Find by external_id + properties: + external_id: + type: string + required: + - external_id + additionalProperties: false + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Custom Object Instances - operationId: getCustomObjectInstancesByExternalId + - Custom Object Instances description: Fetch a Custom Object Instance by external_id. responses: '200': @@ -7589,10 +7499,8 @@ paths: successful: value: id: '24' - type: Order - custom_attributes: - order_number: ORDER-12345 - total_amount: 99.99 + type: object_type_identifier_4 + custom_attributes: {} external_id: '123' external_created_at: external_updated_at: @@ -7601,77 +7509,44 @@ paths: schema: "$ref": "#/components/schemas/custom_object_instance" '401': - $ref: "#/components/responses/Unauthorized" - '404': - $ref: "#/components/responses/ObjectNotFound" - delete: - summary: Delete a Custom Object Instance by External ID - parameters: - - name: external_id - in: query - style: form - required: true - schema: - type: string - description: The unique identifier for the instance in the external system - it originated from. - title: Find by external_id - properties: - external_id: - type: string - required: - - external_id - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - tags: - - Custom Object Instances - operationId: deleteCustomObjectInstancesById - description: Delete a single Custom Object instance by external_id. - responses: - '200': - description: successful + description: Unauthorized content: application/json: examples: - successful: + Unauthorized: value: - id: '26' - object: Order - deleted: true + type: error.list + request_id: dae27fda-0f84-43b2-be25-f97697c229af + errors: + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/custom_object_instance_deleted" - '401': - $ref: "#/components/responses/Unauthorized" - '404': - $ref: "#/components/responses/ObjectNotFound" + "$ref": "#/components/schemas/error" "/custom_object_instances/{custom_object_type_identifier}/{id}": parameters: - - name: custom_object_type_identifier - in: path - description: The unique identifier of the custom object type that defines the - structure of the custom object instance. - example: Order - required: true - schema: - type: string - get: - summary: Get Custom Object Instance by ID - parameters: - - name: id + - name: custom_object_type_identifier in: path - description: The id or external_id of the custom object instance + description: The unique identifier of the custom object type that defines the + structure of the custom object instance. + example: Order required: true schema: type: string - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" + get: + summary: Get Custom Object Instance by ID + parameters: + - name: id + in: path + description: The id or external_id of the custom object instance + required: true + schema: + type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Custom Object Instances - operationId: getCustomObjectInstancesById + - Custom Object Instances description: Fetch a Custom Object Instance by id. responses: '200': @@ -7682,10 +7557,8 @@ paths: successful: value: id: '25' - type: Order - custom_attributes: - order_number: ORDER-12345 - total_amount: 99.99 + type: object_type_identifier_6 + custom_attributes: {} external_id: '123' external_created_at: external_updated_at: @@ -7694,25 +7567,34 @@ paths: schema: "$ref": "#/components/schemas/custom_object_instance" '401': - $ref: "#/components/responses/Unauthorized" - '404': - $ref: "#/components/responses/ObjectNotFound" + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 40038755-5b64-4d2b-b71b-48471c1dc79f + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" delete: - summary: Delete a Custom Object Instance by ID + summary: Delete a Custom Object Instance parameters: - - name: id - in: path - description: The Intercom defined id of the custom object instance - required: true - schema: - type: string - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: The Intercom defined id of the custom object instance + required: true + schema: + type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Custom Object Instances - operationId: deleteCustomObjectInstancesByExternalId + - Custom Object Instances description: Delete a single Custom Object instance using the Intercom defined id. responses: @@ -7724,43 +7606,53 @@ paths: successful: value: id: '26' - object: Order + object: object_type_identifier_8 deleted: true schema: "$ref": "#/components/schemas/custom_object_instance_deleted" '401': - $ref: "#/components/responses/Unauthorized" - '404': - $ref: "#/components/responses/ObjectNotFound" + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: b25664a7-86cc-4725-8c95-d9ea339b12b7 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" "/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 + - 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 + - Data Attributes operationId: lisDataAttributes description: You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations. @@ -7774,221 +7666,221 @@ paths: 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: 34 - 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: '991267784' - created_at: 1734537753 - updated_at: 1734537753 - 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 + - 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: 34 + 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: '991267784' + created_at: 1734537753 + updated_at: 1734537753 + 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': @@ -8001,19 +7893,19 @@ paths: type: error.list request_id: 6d231766-b44b-4e78-bc9e-9c268ff19671 errors: - - code: unauthorized - message: Access Token Invalid + - 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" + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Data Attributes + - Data Attributes operationId: createDataAttribute description: You can create a data attributes for a `contact` or a `company`. responses: @@ -8051,40 +7943,40 @@ paths: type: error.list request_id: da2a7037-11f4-4fcc-8d19-27da3b3a4336 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. + - 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: 1c45cfd9-ffd1-4e3e-9f7a-2ac99abdf03d errors: - - code: parameter_invalid - message: Your name for this attribute must only contain alphanumeric - characters, currency symbols, and hyphens + - 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: 55999605-a170-4894-a3d0-090c4fee8d11 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. + - 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: e0a9ccc7-a540-4ef0-8ffc-28ab86658b04 errors: - - code: parameter_invalid - message: Data Type isn't an option + - code: parameter_invalid + message: Data Type isn't an option Too few options for list: value: type: error.list request_id: 6544ccf8-435d-49e1-91ed-e49356f14255 errors: - - code: parameter_invalid - message: The Data Attribute model field must be either contact - or company + - code: parameter_invalid + message: The Data Attribute model field must be either contact + or company schema: "$ref": "#/components/schemas/error" '401': @@ -8097,8 +7989,8 @@ paths: type: error.list request_id: fa71b91c-4a25-4fe6-88a9-884f6950860e errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: @@ -8142,25 +8034,25 @@ paths: value: description: Just a plain old ring options: - - value: 1-10 + - 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 + - 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 + - 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 @@ -8182,8 +8074,8 @@ paths: description: Just a plain old ring data_type: string options: - - 1-10 - - 11-20 + - 1-10 + - 11-20 api_writable: true ui_writable: false messenger_writable: true @@ -8205,8 +8097,8 @@ paths: type: error.list request_id: 37cff4c5-5e1a-4958-a2ba-149b09d1915c errors: - - code: parameter_invalid - message: Options isn't an array + - code: parameter_invalid + message: Options isn't an array schema: "$ref": "#/components/schemas/error" '404': @@ -8219,8 +8111,8 @@ paths: type: error.list request_id: eee16d31-0b0a-4b5f-b95a-25d37528c80f errors: - - code: field_not_found - message: We couldn't find that data attribute to update + - code: field_not_found + message: We couldn't find that data attribute to update schema: "$ref": "#/components/schemas/error" '422': @@ -8233,9 +8125,9 @@ paths: type: error.list request_id: f04b6b14-1c5b-46e1-9c95-4a914557062c errors: - - code: data_invalid - message: The Data Attribute you are trying to archive has a - dependant object + - code: data_invalid + message: The Data Attribute you are trying to archive has a + dependant object schema: "$ref": "#/components/schemas/error" '401': @@ -8248,8 +8140,8 @@ paths: type: error.list request_id: c60ce63d-1c74-4fe2-8e21-31d1f817a0c2 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: @@ -8263,8 +8155,8 @@ paths: value: description: Just a plain old ring options: - - value: 1-10 - - value: 11-20 + - value: 1-10 + - value: 11-20 archived: false too_few_options_in_list: summary: Too few options in list @@ -8278,8 +8170,8 @@ paths: value: description: Just a plain old ring options: - - value: 1-10 - - value: 11-20 + - value: 1-10 + - value: 11-20 archived: false has_dependant_object: summary: Has Dependant Object @@ -8290,12 +8182,12 @@ paths: post: summary: Submit a data event parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Data Events + - Data Events operationId: createDataEvent description: |2+ @@ -8353,8 +8245,8 @@ paths: type: error.list request_id: 212c8206-e7a6-44c8-8f27-5f0ad7f1d243 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: @@ -8365,58 +8257,58 @@ paths: 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 + - 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 @@ -8452,20 +8344,20 @@ paths: type: error.list request_id: e6f50446-be4a-40ac-8c8d-6fb91e1040fd errors: - - code: unauthorized - message: Access Token Invalid + - 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" + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Data Events + - 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 @@ -8483,8 +8375,8 @@ paths: type: error.list request_id: 7a7d8425-2c1b-46ab-8133-c043fc1e5711 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: @@ -8496,12 +8388,12 @@ paths: post: summary: Create content data export parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Data Export + - 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 @@ -8546,18 +8438,18 @@ paths: 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 + - 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 + - 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}` @@ -8585,18 +8477,18 @@ paths: 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 + - 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 + - Data Export operationId: cancelDataExport description: You can cancel your job responses: @@ -8617,18 +8509,18 @@ paths: 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 + - 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 + - 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: @@ -8639,81 +8531,19 @@ paths: responses: '200': description: successful - "/jobs/status/{id}": - get: - summary: Retrieve job status - parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - - name: id - in: path - required: true - description: The unique identifier for the job which is given by Intercom - schema: - type: string - tags: - - Jobs - operationId: jobsStatus - description: Retrieve the status of job execution. - responses: - '200': - description: Job execution status - content: - application/json: - examples: - job status retrieved: - value: - type: job - id: '2' - status: success - resource_type: ticket - resource_id: '20' - resource_url: 'https://api.intercom.io/tickets/20' - schema: - "$ref": "#/components/schemas/jobs" - '404': - description: Job not found - content: - application/json: - examples: - Job not found: - value: - type: error.list - request_id: 123e4567-e89b-12d3-a456-426614174000 - errors: - - code: job_not_found - message: Job Not Found - schema: - "$ref": "#/components/schemas/error" - '401': - description: Unauthorized - content: - application/json: - examples: - Unauthorized: - value: - type: error.list - request_id: 2c8a20ee-ed09-42c0-a31d-a1b4f5d2742d - errors: - - code: unauthorized - message: Access Token Invalid - schema: - "$ref": "#/components/schemas/error" "/messages": post: summary: Create a message parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Messages + - 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, an email or sms.\n\n> \U0001F6A7 + 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 @@ -8770,22 +8600,15 @@ paths: type: error.list request_id: 3f3e74cc-65af-4408-9bf5-9e71b55c8166 errors: - - code: parameter_invalid - message: Body is required + - code: parameter_invalid + message: Body is required No body supplied for email message: value: type: error.list request_id: 2d6abc61-1441-4860-9ef0-777852f8b24f errors: - - code: parameter_invalid - message: Body is required - Invalid body supplied for sms message: - value: - type: error.list - request_id: d7997515-65af-4860-9bf5-777852f8b24f - errors: - - code: parameter_invalid - message: Invalid SMS message body + - code: parameter_invalid + message: Body is required schema: "$ref": "#/components/schemas/error" '422': @@ -8798,8 +8621,8 @@ paths: type: error.list request_id: 97db463e-7070-4ac9-9846-9a5d31933772 errors: - - code: parameter_not_found - message: No subject supplied for email message + - code: parameter_not_found + message: No subject supplied for email message schema: "$ref": "#/components/schemas/error" '401': @@ -8812,8 +8635,8 @@ paths: type: error.list request_id: 2c8a20ee-ed09-42c0-a31d-a1b4f5d2742d errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" '403': @@ -8826,8 +8649,8 @@ paths: type: error.list request_id: 72b6821e-54ff-4a25-adf9-abdfef5fe72b errors: - - code: api_plan_restricted - message: Active subscription needed. + - code: api_plan_restricted + message: Active subscription needed. schema: "$ref": "#/components/schemas/error" requestBody: @@ -8863,17 +8686,6 @@ paths: id: 6762f2391bb69f9f2193bc19 message_type: conversation body: heyy - admin_sms_message_created: - summary: admin sms message created - value: - from: - type: admin - id: '991267817' - to: - type: user - id: 6762f23a1bb69f9f2193bc1a - message_type: sms - body: heyy no_body_supplied_for_message: summary: No body supplied for message value: @@ -8909,27 +8721,16 @@ paths: message_type: email body: subject: heyy - invalid_body_supplied_for_sms_message: - summary: Invalid body supplied for sms message - value: - from: - type: admin - id: '991267821' - to: - type: user - id: 6762f23b1bb69f9f2193bc1d - message_type: sms - body: heyy https://picsum.photos/200/300 "/news/news_items": get: summary: List all news items parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - News + - News operationId: listNewsItems description: You can fetch a list of all news items responses: @@ -8947,42 +8748,42 @@ paths: total_pages: 1 type: pages data: - - id: '29' - type: news-item - workspace_id: this_is_an_id530_that_should_be_at_least_ - title: We have news - body: "Hello there,
" - sender_id: 991267825 - state: draft - labels: [] - cover_image_url: - reactions: - - - - - - - - - deliver_silently: false - created_at: 1734537793 - updated_at: 1734537793 - newsfeed_assignments: [] - - id: '30' - type: news-item - workspace_id: this_is_an_id530_that_should_be_at_least_ - title: We have news - body: "Hello there,
" - sender_id: 991267827 - state: draft - labels: [] - cover_image_url: - reactions: - - - - - - - - - deliver_silently: false - created_at: 1734537793 - updated_at: 1734537793 - newsfeed_assignments: [] + - id: '29' + type: news-item + workspace_id: this_is_an_id530_that_should_be_at_least_ + title: We have news + body: "Hello there,
" + sender_id: 991267825 + state: draft + labels: [] + cover_image_url: + reactions: + - + - + - + - + deliver_silently: false + created_at: 1734537793 + updated_at: 1734537793 + newsfeed_assignments: [] + - id: '30' + type: news-item + workspace_id: this_is_an_id530_that_should_be_at_least_ + title: We have news + body: "Hello there,
" + sender_id: 991267827 + state: draft + labels: [] + cover_image_url: + reactions: + - + - + - + - + deliver_silently: false + created_at: 1734537793 + updated_at: 1734537793 + newsfeed_assignments: [] total_count: 2 schema: "$ref": "#/components/schemas/paginated_response" @@ -8996,19 +8797,19 @@ paths: type: error.list request_id: d7997515-cd92-4fe4-966c-cb1f4bdda1d4 errors: - - code: unauthorized - message: Access Token Invalid + - 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" + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - News + - News operationId: createNewsItem description: You can create a news item responses: @@ -9027,19 +8828,19 @@ paths: sender_id: 991267834 state: live labels: - - New - - Product - - Update + - New + - Product + - Update cover_image_url: reactions: - - "\U0001F606" - - "\U0001F605" + - "\U0001F606" + - "\U0001F605" deliver_silently: true created_at: 1734537797 updated_at: 1734537797 newsfeed_assignments: - - newsfeed_id: 53 - published_at: 1664638214 + - newsfeed_id: 53 + published_at: 1664638214 schema: "$ref": "#/components/schemas/news_item" '401': @@ -9052,8 +8853,8 @@ paths: type: error.list request_id: 5142ad8e-883e-4b71-9adb-6494851e9b77 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: @@ -9068,35 +8869,35 @@ paths: title: Halloween is here! body: "New costumes in store for this spooky season
" labels: - - Product - - Update - - New + - Product + - Update + - New sender_id: 991267834 deliver_silently: true reactions: - - "\U0001F606" - - "\U0001F605" + - "\U0001F606" + - "\U0001F605" state: live newsfeed_assignments: - - newsfeed_id: 53 - published_at: 1664638214 + - newsfeed_id: 53 + 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 + - 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 + - News operationId: retrieveNewsItem description: You can fetch the details of a single news item. responses: @@ -9117,16 +8918,16 @@ paths: labels: [] cover_image_url: reactions: - - - - - - - - + - + - + - + - deliver_silently: false created_at: 1734537800 updated_at: 1734537800 newsfeed_assignments: - - newsfeed_id: 55 - published_at: 1734537800 + - newsfeed_id: 55 + published_at: 1734537800 schema: "$ref": "#/components/schemas/news_item" '404': @@ -9139,8 +8940,8 @@ paths: type: error.list request_id: da84e250-8626-47e8-815c-62b33f0f2c36 errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found schema: "$ref": "#/components/schemas/error" '401': @@ -9153,26 +8954,26 @@ paths: type: error.list request_id: 33ff62c6-ceb7-4bde-93d6-301bed6f24b2 errors: - - code: unauthorized - message: Access Token Invalid + - 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 + - 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 + - News operationId: updateNewsItem responses: '200': @@ -9192,8 +8993,8 @@ paths: labels: [] cover_image_url: reactions: - - "\U0001F61D" - - "\U0001F602" + - "\U0001F61D" + - "\U0001F602" deliver_silently: false created_at: 1734537803 updated_at: 1734537804 @@ -9210,8 +9011,8 @@ paths: type: error.list request_id: 2014d867-b634-495a-9b4f-ce56c4d657a9 errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found schema: "$ref": "#/components/schemas/error" '401': @@ -9224,8 +9025,8 @@ paths: type: error.list request_id: 5838c54e-dd15-460b-82dd-794c4d0e12c5 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: @@ -9241,8 +9042,8 @@ paths: body: "New gifts in store for the jolly season
" sender_id: 991267845 reactions: - - "\U0001F61D" - - "\U0001F602" + - "\U0001F61D" + - "\U0001F602" news_item_not_found: summary: News Item Not Found value: @@ -9250,24 +9051,24 @@ paths: body: "New gifts in store for the jolly season
" sender_id: 991267848 reactions: - - "\U0001F61D" - - "\U0001F602" + - "\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 + - 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 + - News operationId: deleteNewsItem description: You can delete a single news item. responses: @@ -9293,8 +9094,8 @@ paths: type: error.list request_id: 23728e22-7b9f-44a9-9b8d-5028811b9cd0 errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found schema: "$ref": "#/components/schemas/error" '401': @@ -9307,28 +9108,28 @@ paths: type: error.list request_id: e5357876-89be-4a04-80c3-16735b7f53ff errors: - - code: unauthorized - message: Access Token Invalid + - 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 + - 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 + - News operationId: listLiveNewsfeedItems description: You can fetch a list of all news items that are live on a given newsfeed @@ -9360,20 +9161,20 @@ paths: type: error.list request_id: 022ff8b0-d16f-437c-8217-754c13e16dee errors: - - code: unauthorized - message: Access Token Invalid + - 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" + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - News + - News operationId: listNewsfeeds description: You can fetch a list of all newsfeeds responses: @@ -9391,16 +9192,16 @@ paths: total_pages: 1 type: pages data: - - id: '68' - type: newsfeed - name: Visitor Feed - created_at: 1734537813 - updated_at: 1734537813 - - id: '69' - type: newsfeed - name: Visitor Feed - created_at: 1734537813 - updated_at: 1734537813 + - id: '68' + type: newsfeed + name: Visitor Feed + created_at: 1734537813 + updated_at: 1734537813 + - id: '69' + type: newsfeed + name: Visitor Feed + created_at: 1734537813 + updated_at: 1734537813 total_count: 2 schema: "$ref": "#/components/schemas/paginated_response" @@ -9414,28 +9215,28 @@ paths: type: error.list request_id: caa26d8b-6512-445d-9418-9fc5849ca304 errors: - - code: unauthorized - message: Access Token Invalid + - 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 + - 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 + - News operationId: retrieveNewsfeed description: You can fetch the details of a single newsfeed responses: @@ -9463,27 +9264,27 @@ paths: type: error.list request_id: 6d9a1bf5-aa08-4c93-a61a-5a21130b6553 errors: - - code: unauthorized - message: Access Token Invalid + - 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 + - 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 + - Notes operationId: retrieveNote description: You can fetch the details of a single note. responses: @@ -9520,8 +9321,8 @@ paths: type: error.list request_id: bc300b1a-492a-405f-924e-a5881cb72e3a errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found schema: "$ref": "#/components/schemas/error" '401': @@ -9534,27 +9335,27 @@ paths: type: error.list request_id: 81384687-5818-4df9-b421-fba77edd6c17 errors: - - code: unauthorized - message: Access Token Invalid + - 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 + - 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 + - Segments operationId: listSegments description: You can fetch a list of all segments. responses: @@ -9567,18 +9368,18 @@ paths: value: type: segment.list segments: - - type: segment - id: 6762f25c1bb69f9f2193bc22 - name: John segment - created_at: 1734537820 - updated_at: 1734537820 - person_type: user - - type: segment - id: 6762f25c1bb69f9f2193bc23 - name: Jane segment - created_at: 1734537820 - updated_at: 1734537820 - person_type: user + - type: segment + id: 6762f25c1bb69f9f2193bc22 + name: John segment + created_at: 1734537820 + updated_at: 1734537820 + person_type: user + - type: segment + id: 6762f25c1bb69f9f2193bc23 + name: Jane segment + created_at: 1734537820 + updated_at: 1734537820 + person_type: user schema: "$ref": "#/components/schemas/segment_list" '401': @@ -9591,27 +9392,27 @@ paths: type: error.list request_id: b1939528-98f0-4a63-a442-2cc9203fc8c7 errors: - - code: unauthorized - message: Access Token Invalid + - 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 + - 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 + - Segments operationId: retrieveSegment description: You can fetch the details of a single segment. responses: @@ -9640,8 +9441,8 @@ paths: type: error.list request_id: bd697cc6-7757-488c-a89f-16e6feaf7585 errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found schema: "$ref": "#/components/schemas/error" '401': @@ -9654,20 +9455,20 @@ paths: type: error.list request_id: be0d5309-d722-4d2a-aae9-77f4bc0a2cd0 errors: - - code: unauthorized - message: Access Token Invalid + - 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" + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Subscription Types + - Subscription Types operationId: listSubscriptionTypes description: You can list all subscription types. A list of subscription type objects will be returned. @@ -9681,20 +9482,20 @@ paths: value: type: list data: - - type: subscription - id: '135' - 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: '135' + 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': @@ -9707,20 +9508,20 @@ paths: type: error.list request_id: 06d15b1f-19b0-42cc-aff9-a9d9db39402b errors: - - code: unauthorized - message: Access Token Invalid + - 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" + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Switch + - Switch operationId: createPhoneSwitch description: | You can use the API to deflect phone calls to the Intercom Messenger. @@ -9770,8 +9571,8 @@ paths: type: error.list request_id: e1ed4f34-9477-492a-8ddb-22f10af39734 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: @@ -9812,12 +9613,12 @@ paths: get: summary: List all tags parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Tags + - Tags operationId: listTags description: "You can fetch a list of all tags for a given workspace.\n\n" responses: @@ -9830,9 +9631,9 @@ paths: value: type: list data: - - type: tag - id: '102' - name: Manual tag 1 + - type: tag + id: '102' + name: Manual tag 1 schema: "$ref": "#/components/schemas/tag_list" '401': @@ -9845,19 +9646,19 @@ paths: type: error.list request_id: 2859da57-c83f-405c-8166-240a312442a3 errors: - - code: unauthorized - message: Access Token Invalid + - 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" + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Tags + - Tags operationId: createTag description: | You can use this endpoint to perform the following operations: @@ -9896,8 +9697,8 @@ paths: type: error.list request_id: 33a05108-3bf7-411f-a270-72db40b5a31c errors: - - code: parameter_invalid - message: invalid tag parameters + - code: parameter_invalid + message: invalid tag parameters schema: "$ref": "#/components/schemas/error" '404': @@ -9910,15 +9711,15 @@ paths: type: error.list request_id: 23c998cc-32b8-435d-9653-932c15809460 errors: - - code: company_not_found - message: Company Not Found + - code: company_not_found + message: Company Not Found User not found: value: type: error.list request_id: 7358f78d-f122-45dd-a2e1-c2261300c38a errors: - - code: not_found - message: User Not Found + - code: not_found + message: User Not Found schema: "$ref": "#/components/schemas/error" '401': @@ -9931,8 +9732,8 @@ paths: type: error.list request_id: f230e3a7-00a9-456b-bf1c-2ad4b7dc49f6 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: @@ -9940,10 +9741,10 @@ paths: 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" + - "$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 @@ -9958,30 +9759,30 @@ paths: value: name: test companies: - - company_id: '123' + - company_id: '123' user_not_found: summary: User not found value: name: test users: - - id: '123' + - 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 + - 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 + - Tags operationId: findTag description: | You can fetch the details of tags that are on the workspace by their id. @@ -10009,8 +9810,8 @@ paths: type: error.list request_id: e20c89d2-29c6-4abb-aa3d-c860e1cec1ca errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found schema: "$ref": "#/components/schemas/error" '401': @@ -10023,26 +9824,26 @@ paths: type: error.list request_id: c1c0477c-5b80-4874-be65-01ec8a9ffe14 errors: - - code: unauthorized - message: Access Token Invalid + - 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 + - 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 + - Tags operationId: deleteTag description: You can delete the details of tags that are on the workspace by passing in the id. @@ -10059,8 +9860,8 @@ paths: type: error.list request_id: 49536975-bbc5-4a2f-ab8b-7928275cb4d3 errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found schema: "$ref": "#/components/schemas/error" '400': @@ -10073,8 +9874,8 @@ paths: type: error.list request_id: 28960d1e-a056-46c0-bf18-a0d798eb889f errors: - - code: tag_has_dependent_objects - message: 'Unable to delete Tag with dependent objects. Segments: + - code: tag_has_dependent_objects + message: 'Unable to delete Tag with dependent objects. Segments: Seg 1.' schema: "$ref": "#/components/schemas/error" @@ -10088,20 +9889,20 @@ paths: type: error.list request_id: 90a369be-14bb-48d1-8ed6-6287976f6a64 errors: - - code: unauthorized - message: Access Token Invalid + - 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" + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Teams + - Teams operationId: listTeams description: This will return a list of team objects for the App. responses: @@ -10126,27 +9927,27 @@ paths: type: error.list request_id: a77dadbc-1f1e-4875-bac3-f0d09bbc214a errors: - - code: unauthorized - message: Access Token Invalid + - 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 + - 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 + - Teams operationId: retrieveTeam description: You can fetch the details of a single team, containing an array of admins that belong to this team. @@ -10174,8 +9975,8 @@ paths: type: error.list request_id: 3ff156ba-a66e-40d4-93ff-cb6e6afc3c9d errors: - - code: team_not_found - message: Team not found + - code: team_not_found + message: Team not found schema: "$ref": "#/components/schemas/error" '401': @@ -10188,20 +9989,20 @@ paths: type: error.list request_id: fc4b741b-b9f1-4ef9-92c7-eb71e9811df3 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" "/ticket_states": get: summary: List all ticket states parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Ticket States + - Ticket States operationId: listTicketStates description: You can get a list of all ticket states for a workspace. responses: @@ -10214,180 +10015,180 @@ paths: value: type: list data: - - type: ticket_state - id: '8269' - category: submitted - internal_label: Submitted - external_label: Submitted - ticket_types: - type: list - data: - - type: ticket_type - id: '55' - name: my-ticket-type-3 - description: my ticket type description is awesome. - icon: "\U0001F981" - archived: false - is_internal: false - category: Back-office - - type: ticket_type - id: '56' - name: my-ticket-type-4 - description: my ticket type description is awesome. - icon: "\U0001F981" - archived: false - is_internal: false - category: Back-office - - type: ticket_type - id: '58' - name: my-ticket-type-6 - description: my ticket type description is awesome. - icon: "\U0001F981" - archived: false - is_internal: false - category: Back-office - archived: false - - type: ticket_state - id: '8270' - category: in_progress - internal_label: In progress - external_label: In progress - ticket_types: - type: list - data: - - type: ticket_type - id: '55' - name: my-ticket-type-3 - description: my ticket type description is awesome. - icon: "\U0001F981" - archived: false - is_internal: false - category: Back-office - - type: ticket_type - id: '56' - name: my-ticket-type-4 - description: my ticket type description is awesome. - icon: "\U0001F981" - archived: false - is_internal: false - category: Back-office - - type: ticket_type - id: '58' - name: my-ticket-type-6 - description: my ticket type description is awesome. - icon: "\U0001F981" - archived: false - is_internal: false - category: Back-office - archived: false - - type: ticket_state - id: '8271' - category: waiting_on_customer - internal_label: Waiting on customer - external_label: Waiting on you - ticket_types: - type: list - data: - - type: ticket_type - id: '55' - name: my-ticket-type-3 - description: my ticket type description is awesome. - icon: "\U0001F981" - archived: false - is_internal: false - category: Back-office - - type: ticket_type - id: '56' - name: my-ticket-type-4 - description: my ticket type description is awesome. - icon: "\U0001F981" - archived: false - is_internal: false - category: Back-office - - type: ticket_type - id: '58' - name: my-ticket-type-6 - description: my ticket type description is awesome. - icon: "\U0001F981" - archived: false - is_internal: false - category: Back-office - archived: false - - type: ticket_state - id: '8272' - category: resolved - internal_label: Resolved - external_label: Resolved - ticket_types: - type: list - data: - - type: ticket_type - id: '55' - name: my-ticket-type-3 - description: my ticket type description is awesome. - icon: "\U0001F981" - archived: false - is_internal: false - category: Back-office - - type: ticket_type - id: '56' - name: my-ticket-type-4 - description: my ticket type description is awesome. - icon: "\U0001F981" - archived: false - is_internal: false - category: Back-office - - type: ticket_type - id: '58' - name: my-ticket-type-6 - description: my ticket type description is awesome. - icon: "\U0001F981" - archived: false - is_internal: false - category: Back-office - archived: false - - type: ticket_state - id: '8273' - category: submitted - internal_label: Admin label 1 - external_label: User label - ticket_types: - type: list - data: - - type: ticket_type - id: '55' - name: my-ticket-type-3 - description: my ticket type description is awesome. - icon: "\U0001F981" - archived: false - is_internal: false - category: Back-office - - type: ticket_type - id: '56' - name: my-ticket-type-4 - description: my ticket type description is awesome. - icon: "\U0001F981" - archived: false - is_internal: false - category: Back-office - archived: false - - type: ticket_state - id: '8274' - category: submitted - internal_label: Admin label 2 - external_label: User label - ticket_types: - type: list - data: - - type: ticket_type - id: '58' - name: my-ticket-type-6 - description: my ticket type description is awesome. - icon: "\U0001F981" - archived: false - is_internal: false - category: Back-office - archived: false + - type: ticket_state + id: '8269' + category: submitted + internal_label: Submitted + external_label: Submitted + ticket_types: + type: list + data: + - type: ticket_type + id: '55' + name: my-ticket-type-3 + description: my ticket type description is awesome. + icon: "\U0001F981" + archived: false + is_internal: false + category: Back-office + - type: ticket_type + id: '56' + name: my-ticket-type-4 + description: my ticket type description is awesome. + icon: "\U0001F981" + archived: false + is_internal: false + category: Back-office + - type: ticket_type + id: '58' + name: my-ticket-type-6 + description: my ticket type description is awesome. + icon: "\U0001F981" + archived: false + is_internal: false + category: Back-office + archived: false + - type: ticket_state + id: '8270' + category: in_progress + internal_label: In progress + external_label: In progress + ticket_types: + type: list + data: + - type: ticket_type + id: '55' + name: my-ticket-type-3 + description: my ticket type description is awesome. + icon: "\U0001F981" + archived: false + is_internal: false + category: Back-office + - type: ticket_type + id: '56' + name: my-ticket-type-4 + description: my ticket type description is awesome. + icon: "\U0001F981" + archived: false + is_internal: false + category: Back-office + - type: ticket_type + id: '58' + name: my-ticket-type-6 + description: my ticket type description is awesome. + icon: "\U0001F981" + archived: false + is_internal: false + category: Back-office + archived: false + - type: ticket_state + id: '8271' + category: waiting_on_customer + internal_label: Waiting on customer + external_label: Waiting on you + ticket_types: + type: list + data: + - type: ticket_type + id: '55' + name: my-ticket-type-3 + description: my ticket type description is awesome. + icon: "\U0001F981" + archived: false + is_internal: false + category: Back-office + - type: ticket_type + id: '56' + name: my-ticket-type-4 + description: my ticket type description is awesome. + icon: "\U0001F981" + archived: false + is_internal: false + category: Back-office + - type: ticket_type + id: '58' + name: my-ticket-type-6 + description: my ticket type description is awesome. + icon: "\U0001F981" + archived: false + is_internal: false + category: Back-office + archived: false + - type: ticket_state + id: '8272' + category: resolved + internal_label: Resolved + external_label: Resolved + ticket_types: + type: list + data: + - type: ticket_type + id: '55' + name: my-ticket-type-3 + description: my ticket type description is awesome. + icon: "\U0001F981" + archived: false + is_internal: false + category: Back-office + - type: ticket_type + id: '56' + name: my-ticket-type-4 + description: my ticket type description is awesome. + icon: "\U0001F981" + archived: false + is_internal: false + category: Back-office + - type: ticket_type + id: '58' + name: my-ticket-type-6 + description: my ticket type description is awesome. + icon: "\U0001F981" + archived: false + is_internal: false + category: Back-office + archived: false + - type: ticket_state + id: '8273' + category: submitted + internal_label: Admin label 1 + external_label: User label + ticket_types: + type: list + data: + - type: ticket_type + id: '55' + name: my-ticket-type-3 + description: my ticket type description is awesome. + icon: "\U0001F981" + archived: false + is_internal: false + category: Back-office + - type: ticket_type + id: '56' + name: my-ticket-type-4 + description: my ticket type description is awesome. + icon: "\U0001F981" + archived: false + is_internal: false + category: Back-office + archived: false + - type: ticket_state + id: '8274' + category: submitted + internal_label: Admin label 2 + external_label: User label + ticket_types: + type: list + data: + - type: ticket_type + id: '58' + name: my-ticket-type-6 + description: my ticket type description is awesome. + icon: "\U0001F981" + archived: false + is_internal: false + category: Back-office + archived: false schema: "$ref": "#/components/schemas/ticket_state_list" '401': @@ -10400,26 +10201,26 @@ paths: type: error.list request_id: 5e0bd231-7307-42e6-a6ee-babf05bd163b errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" "/ticket_types/{ticket_type_id}/attributes": post: summary: Create a new attribute for a ticket type parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - - name: ticket_type_id - in: path - required: true - description: The unique identifier for the ticket type which is given by Intercom. - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: ticket_type_id + in: path + required: true + description: The unique identifier for the ticket type which is given by Intercom. + schema: + type: string tags: - - Ticket Type Attributes + - Ticket Type Attributes description: You can create a new attribute for a ticket type. operationId: createTicketTypeAttribute responses: @@ -10460,8 +10261,8 @@ paths: type: error.list request_id: 6c9836ed-8485-4f1d-929d-b9d7e153daed errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: @@ -10481,25 +10282,25 @@ paths: put: summary: Update an existing attribute for a ticket type parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - - name: ticket_type_id - in: path - required: true - description: The unique identifier for the ticket type which is given by Intercom. - schema: - type: string - - name: id - in: path - required: true - description: The unique identifier for the ticket type attribute which is - given by Intercom. - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: ticket_type_id + in: path + required: true + description: The unique identifier for the ticket type which is given by Intercom. + schema: + type: string + - name: id + in: path + required: true + description: The unique identifier for the ticket type attribute which is + given by Intercom. + schema: + type: string tags: - - Ticket Type Attributes + - Ticket Type Attributes description: You can update an existing attribute for a ticket type. operationId: updateTicketTypeAttribute responses: @@ -10538,8 +10339,8 @@ paths: type: error.list request_id: cd303186-b33e-4409-8bfc-5814b176d6e1 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: @@ -10556,12 +10357,12 @@ paths: get: summary: List all ticket types parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Ticket Types + - Ticket Types operationId: listTicketTypes description: You can get a list of all ticket types for a workspace. responses: @@ -10574,96 +10375,96 @@ paths: value: type: list data: - - type: ticket_type - id: '67' - name: Bug Report - description: Bug Report Template - icon: "\U0001F39F️" - workspace_id: this_is_an_id648_that_should_be_at_least_ - archived: false - created_at: 1734537866 - updated_at: 1734537866 - is_internal: false - ticket_type_attributes: - type: list - data: - - type: ticket_type_attribute - id: '165' - workspace_id: this_is_an_id648_that_should_be_at_least_ - name: _default_title_ - description: '' - data_type: string - input_options: - multiline: false - order: 0 - required_to_create: false - required_to_create_for_contacts: false - visible_on_create: true - visible_to_contacts: true - default: true - ticket_type_id: 67 - archived: false - created_at: 1734537866 - updated_at: 1734537866 - - type: ticket_type_attribute - id: '167' - workspace_id: this_is_an_id648_that_should_be_at_least_ - name: name - description: description - data_type: string - input_options: - order: 0 - required_to_create: false - required_to_create_for_contacts: false - visible_on_create: false - visible_to_contacts: false - default: false - ticket_type_id: 67 - archived: false - created_at: 1734537866 - updated_at: 1734537866 - - type: ticket_type_attribute - id: '166' - workspace_id: this_is_an_id648_that_should_be_at_least_ - name: _default_description_ - description: '' - data_type: string - input_options: - multiline: true - order: 1 - required_to_create: false - required_to_create_for_contacts: false - visible_on_create: true - visible_to_contacts: true - default: true - ticket_type_id: 67 - archived: false - created_at: 1734537866 - updated_at: 1734537866 - category: Customer - ticket_states: - type: list - data: - - type: ticket_state - id: '8321' - category: submitted - internal_label: Submitted - external_label: Submitted - - type: ticket_state - id: '8322' - category: in_progress - internal_label: In progress - external_label: In progress - - type: ticket_state - id: '8323' - category: waiting_on_customer - internal_label: Waiting on customer - external_label: Waiting on you - - type: ticket_state - id: '8324' - category: resolved - internal_label: Resolved - external_label: Resolved + - type: ticket_type + id: '67' + name: Bug Report + description: Bug Report Template + icon: "\U0001F39F️" + workspace_id: this_is_an_id648_that_should_be_at_least_ + archived: false + created_at: 1734537866 + updated_at: 1734537866 + is_internal: false + ticket_type_attributes: + type: list + data: + - type: ticket_type_attribute + id: '165' + workspace_id: this_is_an_id648_that_should_be_at_least_ + name: _default_title_ + description: '' + data_type: string + input_options: + multiline: false + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 67 + archived: false + created_at: 1734537866 + updated_at: 1734537866 + - type: ticket_type_attribute + id: '167' + workspace_id: this_is_an_id648_that_should_be_at_least_ + name: name + description: description + data_type: string + input_options: + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: false + visible_to_contacts: false + default: false + ticket_type_id: 67 + archived: false + created_at: 1734537866 + updated_at: 1734537866 + - type: ticket_type_attribute + id: '166' + workspace_id: this_is_an_id648_that_should_be_at_least_ + name: _default_description_ + description: '' + data_type: string + input_options: + multiline: true + order: 1 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 67 + archived: false + created_at: 1734537866 + updated_at: 1734537866 + category: Customer + ticket_states: + type: list + data: + - type: ticket_state + id: '8321' + category: submitted + internal_label: Submitted + external_label: Submitted + - type: ticket_state + id: '8322' + category: in_progress + internal_label: In progress + external_label: In progress + - type: ticket_state + id: '8323' + category: waiting_on_customer + internal_label: Waiting on customer + external_label: Waiting on you + - type: ticket_state + id: '8324' + category: resolved + internal_label: Resolved + external_label: Resolved schema: "$ref": "#/components/schemas/ticket_type_list" '401': @@ -10676,19 +10477,19 @@ paths: type: error.list request_id: a63507c2-3b3b-4a1a-aafa-f08b87eb2c12 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" post: summary: Create a ticket type parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Ticket Types + - Ticket Types operationId: createTicketType description: "You can create a new ticket type.\n> \U0001F4D8 Creating ticket types.\n>\n> Every ticket type will be created with two default attributes: @@ -10715,66 +10516,66 @@ paths: ticket_type_attributes: type: list data: - - type: ticket_type_attribute - id: '174' - workspace_id: this_is_an_id652_that_should_be_at_least_ - name: _default_title_ - description: '' - data_type: string - input_options: - multiline: false - order: 0 - required_to_create: false - required_to_create_for_contacts: false - visible_on_create: true - visible_to_contacts: true - default: true - ticket_type_id: 70 - archived: false - created_at: 1734537869 - updated_at: 1734537869 - - type: ticket_type_attribute - id: '175' - workspace_id: this_is_an_id652_that_should_be_at_least_ - name: _default_description_ - description: '' - data_type: string - input_options: - multiline: true - order: 1 - required_to_create: false - required_to_create_for_contacts: false - visible_on_create: true - visible_to_contacts: true - default: true - ticket_type_id: 70 - archived: false - created_at: 1734537869 - updated_at: 1734537869 + - type: ticket_type_attribute + id: '174' + workspace_id: this_is_an_id652_that_should_be_at_least_ + name: _default_title_ + description: '' + data_type: string + input_options: + multiline: false + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 70 + archived: false + created_at: 1734537869 + updated_at: 1734537869 + - type: ticket_type_attribute + id: '175' + workspace_id: this_is_an_id652_that_should_be_at_least_ + name: _default_description_ + description: '' + data_type: string + input_options: + multiline: true + order: 1 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 70 + archived: false + created_at: 1734537869 + updated_at: 1734537869 category: Customer ticket_states: type: list data: - - type: ticket_state - id: '8337' - category: submitted - internal_label: Submitted - external_label: Submitted - - type: ticket_state - id: '8338' - category: in_progress - internal_label: In progress - external_label: In progress - - type: ticket_state - id: '8339' - category: waiting_on_customer - internal_label: Waiting on customer - external_label: Waiting on you - - type: ticket_state - id: '8340' - category: resolved - internal_label: Resolved - external_label: Resolved + - type: ticket_state + id: '8337' + category: submitted + internal_label: Submitted + external_label: Submitted + - type: ticket_state + id: '8338' + category: in_progress + internal_label: In progress + external_label: In progress + - type: ticket_state + id: '8339' + category: waiting_on_customer + internal_label: Waiting on customer + external_label: Waiting on you + - type: ticket_state + id: '8340' + category: resolved + internal_label: Resolved + external_label: Resolved schema: "$ref": "#/components/schemas/ticket_type" '401': @@ -10787,8 +10588,8 @@ paths: type: error.list request_id: 36b79d0c-b78f-4e1d-bd6d-bfc3dcc71f53 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: @@ -10808,18 +10609,18 @@ paths: get: summary: Retrieve a ticket type parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - - name: id - in: path - required: true - description: The unique identifier for the ticket type which is given by Intercom. - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the ticket type which is given by Intercom. + schema: + type: string tags: - - Ticket Types + - Ticket Types operationId: getTicketType description: You can fetch the details of a single ticket type. responses: @@ -10843,83 +10644,83 @@ paths: ticket_type_attributes: type: list data: - - type: ticket_type_attribute - id: '179' - workspace_id: this_is_an_id656_that_should_be_at_least_ - name: _default_title_ - description: '' - data_type: string - input_options: - multiline: false - order: 0 - required_to_create: false - required_to_create_for_contacts: false - visible_on_create: true - visible_to_contacts: true - default: true - ticket_type_id: 72 - archived: false - created_at: 1734537871 - updated_at: 1734537871 - - type: ticket_type_attribute - id: '181' - workspace_id: this_is_an_id656_that_should_be_at_least_ - name: name - description: description - data_type: string - input_options: - order: 0 - required_to_create: false - required_to_create_for_contacts: false - visible_on_create: false - visible_to_contacts: false - default: false - ticket_type_id: 72 - archived: false - created_at: 1734537871 - updated_at: 1734537871 - - type: ticket_type_attribute - id: '180' - workspace_id: this_is_an_id656_that_should_be_at_least_ - name: _default_description_ - description: '' - data_type: string - input_options: - multiline: true - order: 1 - required_to_create: false - required_to_create_for_contacts: false - visible_on_create: true - visible_to_contacts: true - default: true - ticket_type_id: 72 - archived: false - created_at: 1734537871 - updated_at: 1734537871 + - type: ticket_type_attribute + id: '179' + workspace_id: this_is_an_id656_that_should_be_at_least_ + name: _default_title_ + description: '' + data_type: string + input_options: + multiline: false + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 72 + archived: false + created_at: 1734537871 + updated_at: 1734537871 + - type: ticket_type_attribute + id: '181' + workspace_id: this_is_an_id656_that_should_be_at_least_ + name: name + description: description + data_type: string + input_options: + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: false + visible_to_contacts: false + default: false + ticket_type_id: 72 + archived: false + created_at: 1734537871 + updated_at: 1734537871 + - type: ticket_type_attribute + id: '180' + workspace_id: this_is_an_id656_that_should_be_at_least_ + name: _default_description_ + description: '' + data_type: string + input_options: + multiline: true + order: 1 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 72 + archived: false + created_at: 1734537871 + updated_at: 1734537871 category: Customer ticket_states: type: list data: - - type: ticket_state - id: '8353' - category: submitted - internal_label: Submitted - external_label: Submitted - - type: ticket_state - id: '8354' - category: in_progress - internal_label: In progress - external_label: In progress - - type: ticket_state - id: '8355' - category: waiting_on_customer - internal_label: Waiting on customer - external_label: Waiting on you - - type: ticket_state - id: '8356' - category: resolved - internal_label: Resolved - external_label: Resolved + - type: ticket_state + id: '8353' + category: submitted + internal_label: Submitted + external_label: Submitted + - type: ticket_state + id: '8354' + category: in_progress + internal_label: In progress + external_label: In progress + - type: ticket_state + id: '8355' + category: waiting_on_customer + internal_label: Waiting on customer + external_label: Waiting on you + - type: ticket_state + id: '8356' + category: resolved + internal_label: Resolved + external_label: Resolved schema: "$ref": "#/components/schemas/ticket_type" '401': @@ -10932,25 +10733,25 @@ paths: type: error.list request_id: c9a2c3da-7536-4eba-bde7-c38c2d9e2942 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" put: summary: Update a ticket type parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - - name: id - in: path - required: true - description: The unique identifier for the ticket type which is given by Intercom. - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the ticket type which is given by Intercom. + schema: + type: string tags: - - Ticket Types + - Ticket Types operationId: updateTicketType description: "\nYou can update a ticket type.\n\n> \U0001F4D8 Updating a ticket type.\n>\n> For the `icon` propery, use an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n" @@ -10975,83 +10776,83 @@ paths: ticket_type_attributes: type: list data: - - type: ticket_type_attribute - id: '185' - workspace_id: this_is_an_id660_that_should_be_at_least_ - name: _default_title_ - description: '' - data_type: string - input_options: - multiline: false - order: 0 - required_to_create: false - required_to_create_for_contacts: false - visible_on_create: true - visible_to_contacts: true - default: true - ticket_type_id: 74 - archived: false - created_at: 1734537873 - updated_at: 1734537873 - - type: ticket_type_attribute - id: '187' - workspace_id: this_is_an_id660_that_should_be_at_least_ - name: name - description: description - data_type: string - input_options: - order: 0 - required_to_create: false - required_to_create_for_contacts: false - visible_on_create: false - visible_to_contacts: false - default: false - ticket_type_id: 74 - archived: false - created_at: 1734537873 - updated_at: 1734537873 - - type: ticket_type_attribute - id: '186' - workspace_id: this_is_an_id660_that_should_be_at_least_ - name: _default_description_ - description: '' - data_type: string - input_options: - multiline: true - order: 1 - required_to_create: false - required_to_create_for_contacts: false - visible_on_create: true - visible_to_contacts: true - default: true - ticket_type_id: 74 - archived: false - created_at: 1734537873 - updated_at: 1734537873 + - type: ticket_type_attribute + id: '185' + workspace_id: this_is_an_id660_that_should_be_at_least_ + name: _default_title_ + description: '' + data_type: string + input_options: + multiline: false + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 74 + archived: false + created_at: 1734537873 + updated_at: 1734537873 + - type: ticket_type_attribute + id: '187' + workspace_id: this_is_an_id660_that_should_be_at_least_ + name: name + description: description + data_type: string + input_options: + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: false + visible_to_contacts: false + default: false + ticket_type_id: 74 + archived: false + created_at: 1734537873 + updated_at: 1734537873 + - type: ticket_type_attribute + id: '186' + workspace_id: this_is_an_id660_that_should_be_at_least_ + name: _default_description_ + description: '' + data_type: string + input_options: + multiline: true + order: 1 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 74 + archived: false + created_at: 1734537873 + updated_at: 1734537873 category: Customer ticket_states: type: list data: - - type: ticket_state - id: '8369' - category: submitted - internal_label: Submitted - external_label: Submitted - - type: ticket_state - id: '8370' - category: in_progress - internal_label: In progress - external_label: In progress - - type: ticket_state - id: '8371' - category: waiting_on_customer - internal_label: Waiting on customer - external_label: Waiting on you - - type: ticket_state - id: '8372' - category: resolved - internal_label: Resolved - external_label: Resolved + - type: ticket_state + id: '8369' + category: submitted + internal_label: Submitted + external_label: Submitted + - type: ticket_state + id: '8370' + category: in_progress + internal_label: In progress + external_label: In progress + - type: ticket_state + id: '8371' + category: waiting_on_customer + internal_label: Waiting on customer + external_label: Waiting on you + - type: ticket_state + id: '8372' + category: resolved + internal_label: Resolved + external_label: Resolved schema: "$ref": "#/components/schemas/ticket_type" '401': @@ -11064,8 +10865,8 @@ paths: type: error.list request_id: 2fc2ae95-64ec-4581-80f0-79ecfdc2e759 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: @@ -11085,20 +10886,20 @@ paths: description: You can reply to a ticket with a message from an admin or on behalf of a contact, or with a note for admins. parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - - name: id - in: path - required: true - schema: - title: Ticket ID - type: string - description: The id of the ticket to target. - example: '123' + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + schema: + title: Ticket ID + type: string + description: The id of the ticket to target. + example: '123' tags: - - Tickets + - Tickets responses: '400': description: User reply @@ -11110,8 +10911,8 @@ paths: type: error.list request_id: 603ce1da-f2bf-4641-a1ee-d1f13ebf9172 errors: - - code: parameter_mismatch - message: User replies are not allowed on Backoffice tickets + - code: parameter_mismatch + message: User replies are not allowed on Backoffice tickets schema: "$ref": "#/components/schemas/error" '200': @@ -11146,7 +10947,6 @@ paths: email: admin419@email.com attachments: [] redacted: false - app_package_code: test-integration Admin quick_reply reply: value: type: ticket_part @@ -11173,8 +10973,8 @@ paths: type: error.list request_id: 24561472-06a4-41b2-aca2-97b3ccd9ca19 errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found schema: "$ref": "#/components/schemas/error" '401': @@ -11187,8 +10987,8 @@ paths: type: error.list request_id: ed4305b3-4364-4fab-9f8d-e07e9a8190ab errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: @@ -11196,8 +10996,8 @@ paths: application/json: schema: oneOf: - - "$ref": "#/components/schemas/contact_reply_ticket_request" - - "$ref": "#/components/schemas/admin_reply_ticket_request" + - "$ref": "#/components/schemas/contact_reply_ticket_request" + - "$ref": "#/components/schemas/admin_reply_ticket_request" properties: skip_notifications: type: boolean @@ -11229,10 +11029,10 @@ paths: type: admin admin_id: 991267948 reply_options: - - text: 'Yes' - uuid: 0df48b85-9a93-4c66-a167-753eff0baaec - - text: 'No' - uuid: 4f0b5145-4193-4b4f-8cad-ce19478a3938 + - text: 'Yes' + uuid: 0df48b85-9a93-4c66-a167-753eff0baaec + - text: 'No' + uuid: 4f0b5145-4193-4b4f-8cad-ce19478a3938 not_found: summary: Not found value: @@ -11244,20 +11044,20 @@ paths: post: summary: Add tag to a ticket parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - - name: ticket_id - in: path - description: ticket_id - example: '64619700005694' - required: true - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: ticket_id + in: path + description: ticket_id + example: '64619700005694' + required: true + schema: + type: string tags: - - Tags - - Tickets + - Tags + - Tickets operationId: attachTagToTicket description: You can tag a specific ticket. This will return a tag object for the tag that was added to the ticket. @@ -11284,8 +11084,8 @@ paths: type: error.list request_id: b44cff1d-c6f8-4d60-ab6f-33522cd739d8 errors: - - code: ticket_not_found - message: Ticket not found + - code: ticket_not_found + message: Ticket not found schema: "$ref": "#/components/schemas/error" '401': @@ -11298,8 +11098,8 @@ paths: type: error.list request_id: 2bed74fe-1b04-4c07-8813-02c700e8dcad errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: @@ -11308,8 +11108,8 @@ paths: schema: type: object required: - - id - - admin_id + - id + - admin_id properties: id: type: string @@ -11336,27 +11136,27 @@ paths: delete: summary: Remove tag from a ticket parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - - name: ticket_id - in: path - description: ticket_id - example: '64619700005694' - 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 + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: ticket_id + in: path + description: ticket_id + example: '64619700005694' + 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 tags: - - Tags - - Tickets + - Tags + - Tickets operationId: detachTagFromTicket description: You can remove tag from a specific ticket. This will return a tag object for the tag that was removed from the ticket. @@ -11383,15 +11183,15 @@ paths: type: error.list request_id: 734019dc-1d61-4fad-a86e-e3fb06244c4d errors: - - code: ticket_not_found - message: Ticket not found + - code: ticket_not_found + message: Ticket not found Tag not found: value: type: error.list request_id: a3658b9a-3562-48a7-8afe-362284632d67 errors: - - code: tag_not_found - message: Tag not found + - code: tag_not_found + message: Tag not found schema: "$ref": "#/components/schemas/error" '401': @@ -11404,8 +11204,8 @@ paths: type: error.list request_id: 2e87c98e-4ffc-407e-b7bc-065d4d456ea7 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: @@ -11414,7 +11214,7 @@ paths: schema: type: object required: - - admin_id + - admin_id properties: admin_id: type: string @@ -11438,12 +11238,12 @@ paths: post: summary: Create a ticket parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Tickets + - Tickets description: You can create a new ticket. operationId: createTicket responses: @@ -11480,47 +11280,47 @@ paths: ticket_type_attributes: type: list data: - - type: ticket_type_attribute - id: '196' - workspace_id: this_is_an_id688_that_should_be_at_least_ - name: _default_title_ - description: ola - data_type: string - input_options: - order: 0 - required_to_create: true - required_to_create_for_contacts: false - visible_on_create: true - visible_to_contacts: false - default: false - ticket_type_id: 88 - archived: false - created_at: 1734537943 - updated_at: 1734537943 - - type: ticket_type_attribute - id: '197' - workspace_id: this_is_an_id688_that_should_be_at_least_ - name: _default_description_ - description: ola - data_type: string - input_options: - order: 0 - required_to_create: true - required_to_create_for_contacts: false - visible_on_create: true - visible_to_contacts: false - default: false - ticket_type_id: 88 - archived: false - created_at: 1734537943 - updated_at: 1734537943 + - type: ticket_type_attribute + id: '196' + workspace_id: this_is_an_id688_that_should_be_at_least_ + name: _default_title_ + description: ola + data_type: string + input_options: + order: 0 + required_to_create: true + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: false + default: false + ticket_type_id: 88 + archived: false + created_at: 1734537943 + updated_at: 1734537943 + - type: ticket_type_attribute + id: '197' + workspace_id: this_is_an_id688_that_should_be_at_least_ + name: _default_description_ + description: ola + data_type: string + input_options: + order: 0 + required_to_create: true + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: false + default: false + ticket_type_id: 88 + archived: false + created_at: 1734537943 + updated_at: 1734537943 category: Back-office contacts: type: contact.list contacts: - - type: contact - id: 6762f2d81bb69f9f2193bc54 - external_id: '70' + - type: contact + id: 6762f2d81bb69f9f2193bc54 + external_id: '70' admin_assignee_id: '0' team_assignee_id: '0' created_at: 1734537944 @@ -11528,20 +11328,20 @@ paths: ticket_parts: type: ticket_part.list ticket_parts: - - type: ticket_part - id: '175' - part_type: ticket_state_updated_by_admin - ticket_state: submitted - previous_ticket_state: submitted - created_at: 1734537945 - updated_at: 1734537945 - author: - id: '991267999' - type: bot - name: Fin - email: operator+this_is_an_id688_that_should_be_at_least_@intercom.io - attachments: [] - redacted: false + - type: ticket_part + id: '175' + part_type: ticket_state_updated_by_admin + ticket_state: submitted + previous_ticket_state: submitted + created_at: 1734537945 + updated_at: 1734537945 + author: + id: '991267999' + type: bot + name: Fin + email: operator+this_is_an_id688_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false total_count: 1 open: true linked_objects: @@ -11563,8 +11363,8 @@ paths: type: error.list request_id: c7bf358f-135e-48d7-8286-a4988a8a1d9b errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: @@ -11572,116 +11372,38 @@ paths: application/json: schema: allOf: - - "$ref": "#/components/schemas/create_ticket_request" - properties: - skip_notifications: - type: boolean - description: Option to disable notifications when a Ticket is created. - example: true - examples: - successful_response: - summary: Successful response - value: - ticket_type_id: 88 - contacts: - - id: 6762f2d81bb69f9f2193bc54 - ticket_attributes: - _default_title_: example - _default_description_: there is a problem - "/tickets/enqueue": - post: - summary: Enqueue create ticket - description: Enqueues ticket creation for asynchronous processing, returning if the job was enqueued successfully to be processed. We attempt to perform a best-effort validation on inputs before tasks are enqueued. If the given parameters are incorrect, we won't enqueue the job. - operationId: enqueueCreateTicket - tags: - - Tickets - parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - requestBody: - content: - application/json: - schema: - allOf: - - "$ref": "#/components/schemas/create_ticket_request" + - "$ref": "#/components/schemas/create_ticket_request" properties: skip_notifications: type: boolean description: Option to disable notifications when a Ticket is created. example: true examples: - successful_response: - summary: Successful response - value: - ticket_type_id: 88 - contacts: - - id: 6762f2d81bb69f9f2193bc54 - ticket_attributes: - _default_title_: example - _default_description_: there is a problem - responses: - '200': - description: Successful response - content: - application/json: - examples: - Successful response: - value: - type: job - id: "20" - status: pending - url: https://api.intercom.io/jobs/status/20 - resource_type: ticket - resource_id: null - resource_url: null - schema: - "$ref": "#/components/schemas/jobs" - '401': - description: Unauthorized - content: - application/json: - examples: - Unauthorized: - value: - type: error.list - request_id: c7bf358f-135e-48d7-8286-a4988a8a1d9b - errors: - - code: unauthorized - message: Access Token Invalid - schema: - "$ref": "#/components/schemas/error" - '400': - description: Bad Request - content: - application/json: - examples: - Bad Request: - value: - type: error.list - request_id: c7bf358f-135e-48d7-8286-a4988a8a1456 - errors: - - code: parameter_invalid - message: "Missing required ticket attributes" - schema: - "$ref": "#/components/schemas/error" + successful_response: + summary: Successful response + value: + ticket_type_id: 88 + contacts: + - id: 6762f2d81bb69f9f2193bc54 + ticket_attributes: + _default_title_: example + _default_description_: there is a problem "/tickets/{id}": put: summary: Update a ticket parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - - name: id - in: path - required: true - description: The unique identifier for the ticket which is given by Intercom - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the ticket which is given by Intercom + schema: + type: string tags: - - Tickets + - Tickets operationId: updateTicket description: You can update a ticket. responses: @@ -11718,47 +11440,47 @@ paths: ticket_type_attributes: type: list data: - - type: ticket_type_attribute - id: '200' - workspace_id: this_is_an_id692_that_should_be_at_least_ - name: _default_title_ - description: ola - data_type: string - input_options: - order: 0 - required_to_create: true - required_to_create_for_contacts: false - visible_on_create: true - visible_to_contacts: false - default: false - ticket_type_id: 90 - archived: false - created_at: 1734537949 - updated_at: 1734537949 - - type: ticket_type_attribute - id: '201' - workspace_id: this_is_an_id692_that_should_be_at_least_ - name: _default_description_ - description: ola - data_type: string - input_options: - order: 0 - required_to_create: true - required_to_create_for_contacts: false - visible_on_create: true - visible_to_contacts: false - default: false - ticket_type_id: 90 - archived: false - created_at: 1734537949 - updated_at: 1734537949 + - type: ticket_type_attribute + id: '200' + workspace_id: this_is_an_id692_that_should_be_at_least_ + name: _default_title_ + description: ola + data_type: string + input_options: + order: 0 + required_to_create: true + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: false + default: false + ticket_type_id: 90 + archived: false + created_at: 1734537949 + updated_at: 1734537949 + - type: ticket_type_attribute + id: '201' + workspace_id: this_is_an_id692_that_should_be_at_least_ + name: _default_description_ + description: ola + data_type: string + input_options: + order: 0 + required_to_create: true + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: false + default: false + ticket_type_id: 90 + archived: false + created_at: 1734537949 + updated_at: 1734537949 category: Back-office contacts: type: contact.list contacts: - - type: contact - id: 6762f2dd1bb69f9f2193bc55 - external_id: 8df1fa21-b41d-4621-9229-d6f7a3a590ce + - type: contact + id: 6762f2dd1bb69f9f2193bc55 + external_id: 8df1fa21-b41d-4621-9229-d6f7a3a590ce admin_assignee_id: '991268013' team_assignee_id: '0' created_at: 1734537950 @@ -11766,86 +11488,85 @@ paths: ticket_parts: type: ticket_part.list ticket_parts: - - type: ticket_part - id: '176' - part_type: ticket_state_updated_by_admin - ticket_state: submitted - previous_ticket_state: submitted - created_at: 1734537951 - updated_at: 1734537951 - author: - id: '991268011' - type: admin - name: Ciaran477 Lee - email: admin477@email.com - attachments: [] - redacted: false - - type: ticket_part - id: '177' - part_type: ticket_attribute_updated_by_admin - created_at: 1734537953 - updated_at: 1734537953 - author: - id: '991268012' - type: bot - name: Fin - email: operator+this_is_an_id692_that_should_be_at_least_@intercom.io - attachments: [] - redacted: false - - type: ticket_part - id: '178' - part_type: ticket_attribute_updated_by_admin - created_at: 1734537953 - updated_at: 1734537953 - author: - id: '991268012' - type: bot - name: Fin - email: operator+this_is_an_id692_that_should_be_at_least_@intercom.io - attachments: [] - redacted: false - - type: ticket_part - id: '179' - part_type: ticket_state_updated_by_admin - ticket_state: in_progress - previous_ticket_state: submitted - created_at: 1734537954 - updated_at: 1734537954 - author: - id: '991268012' - type: bot - name: Fin - email: operator+this_is_an_id692_that_should_be_at_least_@intercom.io - attachments: [] - redacted: false - app_package_code: test-integration - - type: ticket_part - id: '180' - part_type: assignment - created_at: 1734537954 - updated_at: 1734537954 - assigned_to: - type: admin - id: '991268013' - author: - id: '991268011' - type: admin - name: Ciaran477 Lee - email: admin477@email.com - attachments: [] - redacted: false - - type: ticket_part - id: '181' - part_type: snoozed - created_at: 1734537955 - updated_at: 1734537955 - author: - id: '991268012' - type: bot - name: Fin - email: operator+this_is_an_id692_that_should_be_at_least_@intercom.io - attachments: [] - redacted: false + - type: ticket_part + id: '176' + part_type: ticket_state_updated_by_admin + ticket_state: submitted + previous_ticket_state: submitted + created_at: 1734537951 + updated_at: 1734537951 + author: + id: '991268011' + type: admin + name: Ciaran477 Lee + email: admin477@email.com + attachments: [] + redacted: false + - type: ticket_part + id: '177' + part_type: ticket_attribute_updated_by_admin + created_at: 1734537953 + updated_at: 1734537953 + author: + id: '991268012' + type: bot + name: Fin + email: operator+this_is_an_id692_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false + - type: ticket_part + id: '178' + part_type: ticket_attribute_updated_by_admin + created_at: 1734537953 + updated_at: 1734537953 + author: + id: '991268012' + type: bot + name: Fin + email: operator+this_is_an_id692_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false + - type: ticket_part + id: '179' + part_type: ticket_state_updated_by_admin + ticket_state: in_progress + previous_ticket_state: submitted + created_at: 1734537954 + updated_at: 1734537954 + author: + id: '991268012' + type: bot + name: Fin + email: operator+this_is_an_id692_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false + - type: ticket_part + id: '180' + part_type: assignment + created_at: 1734537954 + updated_at: 1734537954 + assigned_to: + type: admin + id: '991268013' + author: + id: '991268011' + type: admin + name: Ciaran477 Lee + email: admin477@email.com + attachments: [] + redacted: false + - type: ticket_part + id: '181' + part_type: snoozed + created_at: 1734537955 + updated_at: 1734537955 + author: + id: '991268012' + type: bot + name: Fin + email: operator+this_is_an_id692_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false total_count: 6 open: true snoozed_until: 1734627600 @@ -11868,15 +11589,15 @@ paths: type: error.list request_id: f9757add-b48a-4519-a6e0-04b2ef9c8c6c errors: - - code: assignee_not_found - message: Assignee not found + - code: assignee_not_found + message: Assignee not found Assignee not found: value: type: error.list request_id: 39cf6495-768c-450c-a2c4-c9c3c4ea2e01 errors: - - code: assignee_not_found - message: Assignee not found + - code: assignee_not_found + message: Assignee not found '400': description: Ticket state id is not valid or is not associated with the ticket type. @@ -11888,9 +11609,9 @@ paths: type: error.list request_id: 28b71de1-b451-433a-a08c-845f2b1736b6 errors: - - code: ticket_state_id_invalid - message: Ticket state id is not valid or is not associated with - the ticket type + - code: ticket_state_id_invalid + message: Ticket state id is not valid or is not associated with + the ticket type '401': description: Unauthorized content: @@ -11901,8 +11622,8 @@ paths: type: error.list request_id: 17db783e-1e43-41c9-b4db-0c05da78a909 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: @@ -11917,9 +11638,8 @@ paths: ticket_attributes: _default_title_: example _default_description_: there is a problem - assignment: - admin_id: '991268011' - assignee_id: '991268013' + admin_id: 991268011 + assignee_id: 991268013 open: true snoozed_until: 1673609604 ticket_state_id: 8498 @@ -11929,9 +11649,8 @@ paths: ticket_attributes: _default_title_: example _default_description_: there is a problem - assignment: - admin_id: '123' - assignee_id: '991268021' + admin_id: 123 + assignee_id: 991268021 ticket_state_id: 8506 assignee_not_found: summary: Assignee not found @@ -11939,9 +11658,8 @@ paths: ticket_attributes: _default_title_: example _default_description_: there is a problem - assignment: - admin_id: '991268027' - assignee_id: '456' + admin_id: 991268027 + assignee_id: 456 ticket_state_id: 8514 ticket_state_id_is_not_valid_or_is_not_associated_with_the_ticket_type: summary: Ticket state id is not valid or is not associated with the @@ -11951,18 +11669,18 @@ paths: get: summary: Retrieve a ticket parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - - name: id - in: path - required: true - description: The unique identifier for the ticket which is given by Intercom. - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the ticket which is given by Intercom. + schema: + type: string tags: - - Tickets + - Tickets operationId: getTicket description: You can fetch the details of a single ticket. responses: @@ -11999,47 +11717,47 @@ paths: ticket_type_attributes: type: list data: - - type: ticket_type_attribute - id: '210' - workspace_id: this_is_an_id702_that_should_be_at_least_ - name: _default_title_ - description: ola - data_type: string - input_options: - order: 0 - required_to_create: true - required_to_create_for_contacts: false - visible_on_create: true - visible_to_contacts: false - default: false - ticket_type_id: 95 - archived: false - created_at: 1734537973 - updated_at: 1734537973 - - type: ticket_type_attribute - id: '211' - workspace_id: this_is_an_id702_that_should_be_at_least_ - name: _default_description_ - description: ola - data_type: string - input_options: - order: 0 - required_to_create: true - required_to_create_for_contacts: false - visible_on_create: true - visible_to_contacts: false - default: false - ticket_type_id: 95 - archived: false - created_at: 1734537973 - updated_at: 1734537973 + - type: ticket_type_attribute + id: '210' + workspace_id: this_is_an_id702_that_should_be_at_least_ + name: _default_title_ + description: ola + data_type: string + input_options: + order: 0 + required_to_create: true + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: false + default: false + ticket_type_id: 95 + archived: false + created_at: 1734537973 + updated_at: 1734537973 + - type: ticket_type_attribute + id: '211' + workspace_id: this_is_an_id702_that_should_be_at_least_ + name: _default_description_ + description: ola + data_type: string + input_options: + order: 0 + required_to_create: true + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: false + default: false + ticket_type_id: 95 + archived: false + created_at: 1734537973 + updated_at: 1734537973 category: Back-office contacts: type: contact.list contacts: - - type: contact - id: 6762f2f61bb69f9f2193bc59 - external_id: b16afa36-2637-4880-adee-a46d145bc27f + - type: contact + id: 6762f2f61bb69f9f2193bc59 + external_id: b16afa36-2637-4880-adee-a46d145bc27f admin_assignee_id: '0' team_assignee_id: '0' created_at: 1734537974 @@ -12047,21 +11765,20 @@ paths: ticket_parts: type: ticket_part.list ticket_parts: - - type: ticket_part - id: '185' - part_type: ticket_state_updated_by_admin - ticket_state: submitted - previous_ticket_state: submitted - created_at: 1734537975 - updated_at: 1734537975 - author: - id: '991268047' - type: admin - name: Ciaran509 Lee - email: admin509@email.com - attachments: [] - redacted: false - app_package_code: test-integration + - type: ticket_part + id: '185' + part_type: ticket_state_updated_by_admin + ticket_state: submitted + previous_ticket_state: submitted + created_at: 1734537975 + updated_at: 1734537975 + author: + id: '991268047' + type: admin + name: Ciaran509 Lee + email: admin509@email.com + attachments: [] + redacted: false total_count: 1 open: true linked_objects: @@ -12083,25 +11800,25 @@ paths: type: error.list request_id: d719ad4f-5ae2-492f-88d6-98ba0a9ab6cc errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" delete: summary: Delete a ticket parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - - name: id - in: path - required: true - description: The unique identifier for the ticket which is given by Intercom. - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the ticket which is given by Intercom. + schema: + type: string tags: - - Tickets + - Tickets operationId: deleteTicket description: You can delete a ticket using the Intercom provided ID. responses: @@ -12128,7 +11845,7 @@ paths: type: string description: always ticket enum: - - ticket + - ticket example: ticket deleted: type: boolean @@ -12144,8 +11861,8 @@ paths: type: error.list request_id: 34a070f1-122e-42dc-a94e-9b86768df26c errors: - - code: ticket_not_found - message: Ticket not found + - code: ticket_not_found + message: Ticket not found schema: type: object title: Ticket not found error @@ -12175,10 +11892,10 @@ paths: description: Ticket not found example: Ticket not found required: - - code + - code required: - - type - - errors + - type + - errors '401': description: Unauthorized content: @@ -12189,8 +11906,8 @@ paths: type: error.list request_id: 50348131-55cd-4ca1-a65f-de093b232adb errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" "/tickets/search": @@ -12198,12 +11915,12 @@ paths: summary: Search tickets operationId: searchTickets parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Tickets + - Tickets description: | You can search for multiple tickets by the value of their attributes in order to fetch exactly which ones you want. @@ -12227,7 +11944,6 @@ paths: ### Accepted Fields Most keys listed as part of the Ticket 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 `"foobar"`). - The `source.body` field is unique as the search will not be performed against the entire value, but instead against every element of the value separately. For example, when searching for a conversation with a `"I need support"` body - the query should contain a `=` operator with the value `"support"` for such conversation to be returned. A query with a `=` operator and a `"need support"` value will not yield a result. | Field | Type | | :---------------------------------------- | :--------------------------------------------------------------------------------------- | @@ -12283,103 +11999,103 @@ paths: total_pages: 1 total_count: 1 tickets: - - type: ticket - id: '633' - ticket_id: '40' - ticket_attributes: - _default_title_: attribute_value - _default_description_: - ticket_state: - type: ticket_state - id: '8577' - category: submitted - internal_label: Submitted - external_label: Submitted - ticket_type: - type: ticket_type - id: '100' - name: my-ticket-type-35 - description: my ticket type description is awesome. - icon: "\U0001F981" - workspace_id: this_is_an_id712_that_should_be_at_least_ - archived: false - created_at: 1734537989 - updated_at: 1734537989 - is_internal: false - ticket_type_attributes: - type: list - data: - - type: ticket_type_attribute - id: '220' - workspace_id: this_is_an_id712_that_should_be_at_least_ - name: _default_title_ - description: ola - data_type: string - input_options: - order: 0 - required_to_create: true - required_to_create_for_contacts: false - visible_on_create: true - visible_to_contacts: false - default: false - ticket_type_id: 100 - archived: false - created_at: 1734537989 - updated_at: 1734537989 - - type: ticket_type_attribute - id: '221' - workspace_id: this_is_an_id712_that_should_be_at_least_ - name: _default_description_ - description: ola - data_type: string - input_options: - order: 0 - required_to_create: true - required_to_create_for_contacts: false - visible_on_create: true - visible_to_contacts: false - default: false - ticket_type_id: 100 - archived: false - created_at: 1734537989 - updated_at: 1734537989 - category: Back-office - contacts: - type: contact.list + - type: ticket + id: '633' + ticket_id: '40' + ticket_attributes: + _default_title_: attribute_value + _default_description_: + ticket_state: + type: ticket_state + id: '8577' + category: submitted + internal_label: Submitted + external_label: Submitted + ticket_type: + type: ticket_type + id: '100' + name: my-ticket-type-35 + description: my ticket type description is awesome. + icon: "\U0001F981" + workspace_id: this_is_an_id712_that_should_be_at_least_ + archived: false + created_at: 1734537989 + updated_at: 1734537989 + is_internal: false + ticket_type_attributes: + type: list + data: + - type: ticket_type_attribute + id: '220' + workspace_id: this_is_an_id712_that_should_be_at_least_ + name: _default_title_ + description: ola + data_type: string + input_options: + order: 0 + required_to_create: true + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: false + default: false + ticket_type_id: 100 + archived: false + created_at: 1734537989 + updated_at: 1734537989 + - type: ticket_type_attribute + id: '221' + workspace_id: this_is_an_id712_that_should_be_at_least_ + name: _default_description_ + description: ola + data_type: string + input_options: + order: 0 + required_to_create: true + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: false + default: false + ticket_type_id: 100 + archived: false + created_at: 1734537989 + updated_at: 1734537989 + category: Back-office contacts: - - type: contact - id: 6762f3061bb69f9f2193bc5b - external_id: 9b913927-c084-4391-b1db-098341b5ffe3 - admin_assignee_id: '0' - team_assignee_id: '0' - created_at: 1734537990 - updated_at: 1734537992 - ticket_parts: - type: ticket_part.list + type: contact.list + contacts: + - type: contact + id: 6762f3061bb69f9f2193bc5b + external_id: 9b913927-c084-4391-b1db-098341b5ffe3 + admin_assignee_id: '0' + team_assignee_id: '0' + created_at: 1734537990 + updated_at: 1734537992 ticket_parts: - - type: ticket_part - id: '188' - part_type: ticket_state_updated_by_admin - ticket_state: submitted - previous_ticket_state: submitted - created_at: 1734537991 - updated_at: 1734537991 - author: - id: '991268079' - type: admin - name: Ciaran539 Lee - email: admin539@email.com - attachments: [] - redacted: false - total_count: 1 - open: true - linked_objects: - type: list - data: [] - total_count: 0 - has_more: false - category: Back-office - is_shared: false + type: ticket_part.list + ticket_parts: + - type: ticket_part + id: '188' + part_type: ticket_state_updated_by_admin + ticket_state: submitted + previous_ticket_state: submitted + created_at: 1734537991 + updated_at: 1734537991 + author: + id: '991268079' + type: admin + name: Ciaran539 Lee + email: admin539@email.com + attachments: [] + redacted: false + total_count: 1 + open: true + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + category: Back-office + is_shared: false schema: "$ref": "#/components/schemas/ticket_list" requestBody: @@ -12394,21 +12110,21 @@ paths: query: operator: AND value: - - field: created_at - operator: ">" - value: '1306054154' + - field: created_at + operator: ">" + value: '1306054154' pagination: per_page: 5 "/visitors": put: - summary: Update a visitor - parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" + summary: Update a visitor + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Visitors + - Visitors operationId: updateVisitor description: | Sending a PUT request to `/visitors` will result in an update of an existing Visitor. @@ -12479,8 +12195,8 @@ paths: type: error.list request_id: 6a6d5522-54e2-437d-8fd0-1109686af965 errors: - - code: not_found - message: Visitor Not Found + - code: not_found + message: Visitor Not Found schema: "$ref": "#/components/schemas/error" '401': @@ -12493,8 +12209,8 @@ paths: type: error.list request_id: 3f474ec4-4e61-42ee-9acc-eac64982e393 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: @@ -12516,18 +12232,18 @@ paths: 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 + - 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 + - Visitors operationId: retrieveVisitorWithUserId description: You can fetch the details of a single visitor. responses: @@ -12593,8 +12309,8 @@ paths: type: error.list request_id: 3c1b017d-39fb-4d13-8cc9-540ad0d37106 errors: - - code: not_found - message: Visitor Not Found + - code: not_found + message: Visitor Not Found schema: "$ref": "#/components/schemas/error" '401': @@ -12607,20 +12323,20 @@ paths: type: error.list request_id: 1d7f49b3-10bc-4bf8-a28a-1ac95de3a6ff errors: - - code: unauthorized - message: Access Token Invalid + - 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" + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Visitors + - 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 @@ -12734,8 +12450,8 @@ paths: type: error.list request_id: b3e71306-0600-41e4-9f44-83b52906d2b7 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: @@ -12754,15 +12470,6 @@ paths: type: user components: schemas: - datetime: - oneOf: - - title: string - type: string - format: date-time - description: A date and time following the ISO8601 notation. - - title: integer - type: integer - description: A date and time as UNIX timestamp notation. activity_log: title: Activity Log type: object @@ -12804,73 +12511,73 @@ components: 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 + - 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 @@ -12971,7 +12678,7 @@ components: title: Admin type: object x-tags: - - Admins + - Admins description: Admins are teammate accounts that have access to a workspace. nullable: true properties: @@ -13014,7 +12721,7 @@ components: type: array description: This object represents the avatar associated with the admin. example: - - 814865 + - 814865 items: type: integer avatar: @@ -13051,7 +12758,7 @@ components: description: The primary admin ids for the team nullable: true example: - - 493881 + - 493881 items: type: integer secondary_admin_ids: @@ -13059,7 +12766,7 @@ components: description: The secondary admin ids for the team nullable: true example: - - 814865 + - 814865 items: type: integer admin_reply_conversation_request: @@ -13070,14 +12777,14 @@ components: message_type: type: string enum: - - comment - - note - - quick_reply + - comment + - note + - quick_reply example: comment type: type: string enum: - - admin + - admin example: admin body: type: string @@ -13112,8 +12819,8 @@ components: value will be available within the metadata of the comment conversation part that is created when a user clicks on this reply option. required: - - text - - uuid + - text + - uuid attachment_urls: type: array description: A list of image URLs that will be added as attachments. You @@ -13130,9 +12837,9 @@ components: "$ref": "#/components/schemas/conversation_attachment_files" maxItems: 10 required: - - message_type - - type - - admin_id + - message_type + - type + - admin_id admin_reply_ticket_request: title: Admin Reply on ticket type: object @@ -13141,14 +12848,14 @@ components: message_type: type: string enum: - - comment - - note - - quick_reply + - comment + - note + - quick_reply example: comment type: type: string enum: - - admin + - admin example: admin body: type: string @@ -13183,8 +12890,8 @@ components: value will be available within the metadata of the comment ticket part that is created when a user clicks on this reply option. required: - - text - - uuid + - text + - uuid attachment_urls: type: array description: A list of image URLs that will be added as attachments. You @@ -13194,9 +12901,9 @@ components: format: uri maxItems: 10 required: - - message_type - - type - - admin_id + - message_type + - type + - admin_id admin_with_app: title: Admin type: object @@ -13243,7 +12950,7 @@ components: description: This is a list of ids of the teams that this admin is part of. example: - - 814865 + - 814865 items: type: integer avatar: @@ -13275,7 +12982,7 @@ components: title: AI Agent type: object x-tags: - - Ai Agent + - Ai Agent description: Data related to AI Agent involvement in the conversation. properties: source_type: @@ -13283,11 +12990,11 @@ components: description: The type of the source that triggered AI Agent involvement in the conversation. enum: - - essentials_plan_setup - - profile - - workflow - - workflow_preview - - fin_preview + - essentials_plan_setup + - profile + - workflow + - workflow_preview + - fin_preview example: workflow source_title: type: string @@ -13301,9 +13008,9 @@ components: description: The type of the last answer delivered by AI Agent. If no answer was delivered then this will return `null` enum: - - - - ai_answer - - custom_answer + - + - ai_answer + - custom_answer example: ai_answer nullable: true resolution_state: @@ -13311,11 +13018,11 @@ components: description: The resolution state of AI Agent. If no AI or custom answer has been delivered then this will return `null`. enum: - - assumed_resolution - - confirmed_resolution - - routed_to_team - - abandoned - - + - assumed_resolution + - confirmed_resolution + - routed_to_team + - abandoned + - example: assumed_resolution nullable: true rating: @@ -13369,7 +13076,7 @@ components: title: Article type: object x-tags: - - Articles + - 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. @@ -13378,7 +13085,7 @@ components: nullable: true "$ref": "#/components/schemas/article_statistics" allOf: - - "$ref": "#/components/schemas/article_list_item" + - "$ref": "#/components/schemas/article_list_item" article_content: title: Article Content type: object @@ -13389,8 +13096,8 @@ components: type: string description: The type of object - `article_content` . enum: - - - - article_content + - + - article_content example: article_content nullable: true title: @@ -13413,8 +13120,8 @@ components: type: string description: Whether the article is `published` or is a `draft` . enum: - - published - - draft + - published + - draft example: draft created_at: type: integer @@ -13439,7 +13146,7 @@ components: type: string description: The type of the object - `list`. enum: - - list + - list example: list pages: "$ref": "#/components/schemas/cursor_pages" @@ -13456,14 +13163,14 @@ components: title: Articles type: object x-tags: - - Articles + - Articles description: The data returned about your articles when you list them. properties: type: type: string description: The type of object - `article`. enum: - - article + - article default: article example: article id: @@ -13502,8 +13209,8 @@ components: 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 + - published + - draft default: draft example: published created_at: @@ -13539,8 +13246,8 @@ components: items: type: integer example: - - 18 - - 19 + - 18 + - 19 parent_type: type: string nullable: true @@ -13558,7 +13265,7 @@ components: title: Article Search Highlights type: object x-tags: - - Articles + - Articles description: The highlighted results of an Article search. In the examples provided my search query is always "my query". properties: @@ -13577,8 +13284,8 @@ components: type: string description: The type of text - `highlight` or `plain`. enum: - - highlight - - plain + - highlight + - plain example: 'The highlight is ' text: type: string @@ -13599,8 +13306,8 @@ components: type: string description: The type of text - `highlight` or `plain`. enum: - - highlight - - plain + - highlight + - plain example: 'How to highlight ' text: type: string @@ -13610,14 +13317,14 @@ components: title: Article Search Response type: object x-tags: - - Articles + - Articles description: The results of an Article search properties: type: type: string description: The type of the object - `list`. enum: - - list + - list example: list total_count: type: integer @@ -13649,7 +13356,7 @@ components: type: string description: The type of object - `article_statistics`. enum: - - article_statistics + - article_statistics default: article_statistics example: article_statistics views: @@ -13693,8 +13400,8 @@ components: type: string description: The type of object - article_translated_content. enum: - - - - article_translated_content + - + - article_translated_content example: article_translated_content nullable: true ar: @@ -13816,13 +13523,13 @@ components: message_type: type: string enum: - - assignment + - assignment example: assignment type: type: string enum: - - admin - - team + - admin + - team example: admin admin_id: type: string @@ -13840,10 +13547,10 @@ components: it is assigned. example: Let me pass you over to one of my colleagues. required: - - message_type - - type - - admin_id - - assignee_id + - message_type + - type + - admin_id + - assignee_id attach_contact_to_conversation_request: title: Assign Conversation Request type: object @@ -13856,38 +13563,38 @@ components: 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 + - 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 away_status_reason: type: object properties: @@ -13920,7 +13627,7 @@ components: updated_at: type: integer description: "The Unix timestamp when the status reason was last updated" - example: 1734537243 + example: 1734537243 close_conversation_request: title: Close Conversation Request type: object @@ -13929,12 +13636,12 @@ components: message_type: type: string enum: - - close + - close example: close type: type: string enum: - - admin + - admin example: admin admin_id: type: string @@ -13946,14 +13653,14 @@ components: additional context to the user and other teammates. example: " This conversation is now closed!" required: - - message_type - - type - - admin_id + - message_type + - type + - admin_id collection: title: Collection type: object x-tags: - - Help Center + - Help Center description: Collections are top level containers for Articles within the Help Center. properties: @@ -14036,7 +13743,7 @@ components: type: string description: The type of the object - `list`. enum: - - list + - list example: list pages: "$ref": "#/components/schemas/cursor_pages" @@ -14053,7 +13760,7 @@ components: title: Company type: object x-tags: - - Companies + - 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. @@ -14062,7 +13769,7 @@ components: type: string description: Value is `company` enum: - - company + - company example: company id: type: string @@ -14153,7 +13860,7 @@ components: type: string description: The type of the object enum: - - tag.list + - tag.list tags: type: array items: @@ -14167,7 +13874,7 @@ components: type: string description: The type of the object enum: - - segment.list + - segment.list segments: type: array items: @@ -14181,7 +13888,7 @@ components: type: string description: The type of object - `list` enum: - - list + - list example: list data: type: array @@ -14203,7 +13910,7 @@ components: type: string description: The type of object - `list` enum: - - list + - list example: list data: type: array @@ -14219,7 +13926,7 @@ components: type: string description: The type of object - `list`. enum: - - list + - list example: list pages: "$ref": "#/components/schemas/cursor_pages" @@ -14244,7 +13951,7 @@ components: type: string description: The type of object - `list` enum: - - list + - list example: list data: type: array @@ -14266,7 +13973,7 @@ components: title: Contact type: object x-tags: - - Contacts + - Contacts x-fern-sdk-group-name: contacts description: Contacts represent your leads and users in Intercom. properties: @@ -14499,6 +14206,31 @@ components: "$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 @@ -14508,7 +14240,7 @@ components: type: string description: The type of object enum: - - list + - list example: list companies: type: array @@ -14525,13 +14257,9 @@ components: title: Contact companies type: object nullable: false - description: An object with metadata about companies attached to a contact . Up to 10 will be displayed here. Use the url to get more. + 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: - data: - type: array - description: An array of company data objects attached to the contact. - items: - "$ref": "#/components/schemas/company_data" url: type: string format: uri @@ -14539,7 +14267,7 @@ components: example: "/contacts/5ba682d23d7cf92bef87bfd4/companies" total_count: type: integer - description: Integer representing the total number of companies attached to + description: Int representing the total number of companyies attached to this contact example: 100 has_more: @@ -14547,32 +14275,27 @@ components: description: Whether there's more Addressable Objects to be viewed. If true, use the url to view all example: true - company_data: - title: Company Data + contact_deleted: + title: Contact Deleted type: object - description: An object containing data about the companies that a contact is associated with. + description: deleted contact object properties: - id: - type: string - description: The unique identifier for the company which is given by Intercom. - example: 5ba682d23d7cf92bef87bfd4 type: type: string - description: The type of the object. Always company. + description: always contact enum: - - company - example: company - url: + - contact + example: contact + id: type: string - format: uri - description: The relative URL of the company. - example: "/companies/5ba682d23d7cf92bef87bfd4" - contact_deleted: - title: Contact Deleted - description: deleted contact object - allOf: - - "$ref": "#/components/schemas/contact_reference" - properties: + 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. @@ -14586,7 +14309,7 @@ components: type: string description: Always list enum: - - list + - list example: list data: type: array @@ -14661,7 +14384,7 @@ components: type: string description: always contact enum: - - contact + - contact example: contact id: type: string @@ -14672,7 +14395,7 @@ components: nullable: true description: The unique identifier for the contact which is provided by the Client. - example: "70" + example: f3b87a2e09d514c6c2e79b9a contact_reply_base_request: title: Contact Reply Base Object type: object @@ -14680,11 +14403,11 @@ components: message_type: type: string enum: - - comment + - comment type: type: string enum: - - user + - user body: type: string description: The text body of the comment. @@ -14703,15 +14426,15 @@ components: format: uri maxItems: 10 required: - - message_type - - type - - body + - 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" + - "$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 @@ -14727,16 +14450,16 @@ components: items: "$ref": "#/components/schemas/conversation_attachment_files" allOf: - - "$ref": "#/components/schemas/contact_reply_base_request" + - "$ref": "#/components/schemas/contact_reply_base_request" required: - - email + - 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" + - "$ref": "#/components/schemas/contact_reply_base_request" properties: intercom_user_id: type: string @@ -14747,7 +14470,7 @@ components: items: "$ref": "#/components/schemas/conversation_attachment_files" required: - - intercom_user_id + - intercom_user_id contact_reply_ticket_email_request: title: Email type: object @@ -14758,48 +14481,48 @@ components: type: string description: The email you have defined for the user. allOf: - - "$ref": "#/components/schemas/contact_reply_base_request" + - "$ref": "#/components/schemas/contact_reply_base_request" required: - - email + - 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" + - "$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 + - intercom_user_id contact_reply_ticket_request: title: Contact Reply on ticket oneOf: - - "$ref": "#/components/schemas/contact_reply_ticket_intercom_user_id_request" - - "$ref": "#/components/schemas/contact_reply_ticket_user_id_request" - - "$ref": "#/components/schemas/contact_reply_ticket_email_request" + - "$ref": "#/components/schemas/contact_reply_ticket_intercom_user_id_request" + - "$ref": "#/components/schemas/contact_reply_ticket_user_id_request" + - "$ref": "#/components/schemas/contact_reply_ticket_email_request" 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" + - "$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 + - 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" + - "$ref": "#/components/schemas/contact_reply_base_request" properties: user_id: type: string @@ -14812,7 +14535,7 @@ components: "$ref": "#/components/schemas/conversation_attachment_files" maxItems: 10 required: - - user_id + - user_id contact_segments: title: Segments type: object @@ -14822,7 +14545,7 @@ components: type: string description: The type of the object enum: - - list + - list example: list data: type: array @@ -14894,42 +14617,36 @@ components: description: Whether there's more Addressable Objects to be viewed. If true, use the url to view all example: true - contact_archived: - title: Contact Archived - description: archived contact object - allOf: - - "$ref": "#/components/schemas/contact_reference" - properties: - archived: - type: boolean - description: Whether the contact is archived or not. - example: true contact_unarchived: title: Contact Unarchived + type: object description: unarchived contact object - allOf: - - "$ref": "#/components/schemas/contact_reference" 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 - contact_blocked: - title: Contact Blocked - type: object - description: blocked contact object - allOf: - - "$ref": "#/components/schemas/contact_reference" - properties: - blocked: - type: boolean - description: Always true. - example: true content_import_source: title: Content Import Source type: object x-tags: - - AI Content + - AI Content description: An external source for External Pages that you add to your Fin Content Library. nullable: false @@ -14938,7 +14655,7 @@ components: type: string description: Always external_page enum: - - content_import_source + - content_import_source default: content_import_source example: content_import_source id: @@ -14956,16 +14673,16 @@ components: description: If you intend to create or update External Pages via the API, this should be set to `api`. enum: - - api - - automatic - - manual + - api + - automatic + - manual example: api status: type: string description: The status of the content import source. enum: - - active - - deactivated + - active + - deactivated default: active example: active url: @@ -14983,19 +14700,19 @@ components: description: The time when the content import source was last updated. example: 1672928610 required: - - id - - type - - url - - sync_behavior - - status - - created_at - - updated_at - - last_synced_at + - id + - type + - url + - sync_behavior + - status + - created_at + - updated_at + - last_synced_at content_import_sources_list: title: Content Import Sources type: object x-tags: - - AI Content + - AI Content description: This will return a list of the content import sources for the App. nullable: false properties: @@ -15003,7 +14720,7 @@ components: type: string description: The type of the object - `list`. enum: - - list + - list example: list pages: "$ref": "#/components/schemas/pages_link" @@ -15020,7 +14737,7 @@ components: title: Content Source type: object x-tags: - - AI Content Source + - AI Content Source description: The content source used by AI Agent in the conversation. properties: content_type: @@ -15028,11 +14745,11 @@ components: description: The type of the content source. example: content_snippet enum: - - file - - article - - external_content - - content_snippet - - workflow_connector_action + - file + - article + - external_content + - content_snippet + - workflow_connector_action url: type: string description: The internal URL linking to the content source for teammates. @@ -15052,7 +14769,7 @@ components: type: type: string enum: - - content_source.list + - content_source.list example: content_source.list total_count: type: integer @@ -15068,7 +14785,7 @@ components: title: Conversation type: object x-tags: - - Conversations + - 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. @@ -15119,9 +14836,9 @@ components: state: type: string enum: - - open - - closed - - snoozed + - open + - closed + - snoozed description: Can be set to "open", "closed" or "snoozed". example: open read: @@ -15131,8 +14848,8 @@ components: priority: type: string enum: - - priority - - not_priority + - priority + - not_priority description: If marked as priority, it will return priority or else not_priority. example: priority admin_assignee_id: @@ -15204,7 +14921,7 @@ components: type: string description: '' enum: - - contact.list + - contact.list example: contact.list contacts: type: array @@ -15226,7 +14943,7 @@ components: type: string description: always conversation enum: - - conversation + - conversation example: conversation deleted: type: boolean @@ -15264,7 +14981,7 @@ components: type: string description: Always conversation.list enum: - - conversation.list + - conversation.list example: conversation.list conversations: type: array @@ -15340,28 +15057,6 @@ components: email_message_metadata: "$ref": "#/components/schemas/email_message_metadata" nullable: true - state: - type: string - enum: - - open - - closed - - snoozed - description: Indicates the current state of conversation when the conversation part was created. - example: open - tags: - type: array - description: A list of tags objects associated with the conversation part. - items: - "$ref": "#/components/schemas/tag_basic" - nullable: true - event_details: - "$ref": "#/components/schemas/event_details" - nullable: true - app_package_code: - type: string - nullable: true - example: "test-integration" - description: The app package code if this part was created via API. null if the part was not created via API. conversation_part_author: title: Conversation part author type: object @@ -15397,7 +15092,7 @@ components: type: string description: '' enum: - - conversation_part.list + - conversation_part.list example: conversation_part.list conversation_parts: title: Conversation Parts @@ -15410,7 +15105,7 @@ components: total_count: type: integer description: '' - example: 1 + example: 2 conversation_rating: title: Conversation Rating type: object @@ -15458,24 +15153,14 @@ components: conversation_source: title: Conversation source type: object - description: The type of the conversation part that started this conversation. Can be Contact, Admin, Campaign, Automated or Operator initiated. + 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 - enum: - - conversation - - email - - facebook - - instagram - - phone_call - - phone_switch - - push - - sms - - twitter - - whatsapp id: type: string description: The id representing the message. @@ -15660,7 +15345,7 @@ components: attributes: "$ref": "#/components/schemas/ticket_request_custom_attributes" required: - - ticket_type_id + - ticket_type_id convert_visitor_request: description: You can merge a Visitor to a Contact of role type lead or user. type: object @@ -15690,10 +15375,10 @@ components: description: The contact's email, retained by default if one is present. example: winstonsmith@truth.org anyOf: - - required: - - id - - required: - - user_id + - required: + - id + - required: + - user_id visitor: type: object description: The unique identifiers to convert a single Visitor. @@ -15712,16 +15397,16 @@ components: description: The visitor's email. example: winstonsmith@truth.org anyOf: - - required: - - id - - required: - - user_id - - required: - - email + - required: + - id + - required: + - user_id + - required: + - email required: - - type - - user - - visitor + - type + - user + - visitor create_article_request: description: You can create an Article type: object @@ -15755,8 +15440,8 @@ components: Defaults to draft. For multilingual articles, this will be the state of the default language's content. enum: - - published - - draft + - published + - draft example: draft parent_id: type: integer @@ -15770,8 +15455,8 @@ components: translated_content: "$ref": "#/components/schemas/article_translated_content" required: - - title - - author_id + - title + - author_id create_collection_request: description: You can create a collection type: object @@ -15803,7 +15488,7 @@ components: If `null` then it will be created in the default help center. example: '123' required: - - name + - name create_contact_request: description: Payload to create a contact type: object @@ -15863,15 +15548,15 @@ components: 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 + - required: + - email + title: Create contact with email + - required: + - external_id + title: Create contact with external_id + - required: + - role + title: Create contact with role create_content_import_source_request: title: Create Content Import Source Payload type: object @@ -15883,14 +15568,14 @@ components: description: If you intend to create or update External Pages via the API, this should be set to `api`. enum: - - api + - api example: api status: type: string description: The status of the content import source. enum: - - active - - deactivated + - active + - deactivated default: active example: active url: @@ -15898,8 +15583,8 @@ components: description: The URL of the content import source. example: https://help.example.com required: - - sync_behavior - - url + - sync_behavior + - url 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 @@ -15913,9 +15598,9 @@ components: type: type: string enum: - - lead - - user - - contact + - lead + - user + - contact description: The role associated to the contact - user or lead. example: user id: @@ -15926,20 +15611,15 @@ components: maxLength: 24 example: 536e564f316c83104c000020 required: - - type - - id + - type + - id body: type: string description: The content of the message. HTML is not supported. example: Hello - created_at: - type: integer - format: date-time - description: The time the conversation was created as a UTC Unix timestamp. If not provided, the current time will be used. This field is only recommneded for migrating past conversations from another source into Intercom. - example: 1671028894 required: - - from - - body + - from + - body create_data_attribute_request: description: '' type: object @@ -15953,19 +15633,19 @@ components: type: string description: The model that the data attribute belongs to. enum: - - contact - - company + - contact + - company example: contact data_type: type: string description: The type of data stored for this attribute. enum: - - string - - integer - - float - - boolean - - datetime - - date + - string + - integer + - float + - boolean + - datetime + - date example: string description: type: string @@ -15978,16 +15658,16 @@ components: items: type: string example: - - option1 - - option2 + - option1 + - option2 messenger_writable: type: boolean description: Can this attribute be updated by the Messenger example: false required: - - name - - model - - data_type + - name + - model + - data_type create_data_event_request: description: '' type: object @@ -16027,21 +15707,21 @@ components: 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 + - 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 @@ -16097,8 +15777,8 @@ components: as a unix timestamp. example: 1527811200 required: - - created_at_after - - created_at_before + - created_at_after + - created_at_before create_external_page_request: title: Create External Page Payload type: object @@ -16135,7 +15815,7 @@ components: type: string description: Always en enum: - - en + - en default: en example: en source_id: @@ -16153,11 +15833,11 @@ components: source. Must be unique for the source. example: '5678' required: - - title - - html - - locale - - source_id - - external_id + - title + - html + - locale + - source_id + - external_id create_message_request: description: You can create a message type: object @@ -16168,8 +15848,8 @@ components: type: string description: 'The kind of message being created. Values: `in_app` or `email`.' enum: - - in_app - - email + - in_app + - email example: in_app subject: type: string @@ -16193,15 +15873,15 @@ components: type: string description: Always `admin`. enum: - - admin + - admin example: admin id: type: integer description: The identifier for the admin which is given by Intercom. example: 394051 required: - - type - - id + - type + - id to: type: object description: The sender of the message. If not provided, the default sender @@ -16211,16 +15891,16 @@ components: type: string description: The role associated to the contact - `user` or `lead`. enum: - - user - - lead + - user + - lead example: user id: type: string description: The identifier for the contact which is given by Intercom. example: 536e564f316c83104c000020 required: - - type - - id + - type + - id created_at: type: integer description: The time the message was created. If not provided, the current @@ -16233,26 +15913,20 @@ components: 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 - - title: 'message_type: `sms`.' - required: - - message_type - - body - - from - - to + - 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 @@ -16332,8 +16006,6 @@ components: type: object nullable: true description: The custom attributes which are set for the Custom Object instance. - additionalProperties: - type: string create_or_update_tag_request: description: You can create or update an existing tag. type: object @@ -16350,7 +16022,7 @@ components: description: The id of tag to updates. example: '656452352' required: - - name + - name create_phone_switch_request: description: You can create an phone switch type: object @@ -16365,12 +16037,12 @@ components: custom_attributes: "$ref": "#/components/schemas/custom_attributes" required: - - phone + - phone create_ticket_reply_with_comment_request: title: Create Ticket Reply Request Payload oneOf: - - "$ref": "#/components/schemas/contact_reply_ticket_request" - - "$ref": "#/components/schemas/admin_reply_ticket_request" + - "$ref": "#/components/schemas/contact_reply_ticket_request" + - "$ref": "#/components/schemas/admin_reply_ticket_request" create_ticket_request: description: You can create a Ticket type: object @@ -16378,42 +16050,43 @@ components: properties: ticket_type_id: type: string - description: The ID of the type of ticket you want to create - example: '1234' - contacts: - type: array - description: The list of contacts (users or leads) affected by this ticket. - Currently only one is allowed - items: - type: object - oneOf: - - title: ID - properties: - id: - type: string - description: The identifier for the contact as given by Intercom. - required: - - id - - title: External ID - properties: - external_id: - type: string - description: The external_id you have defined for the contact who - is being added as a participant. - required: - - external_id - - title: Email - properties: - email: - type: string - description: The email you have defined for the contact who is being - added as a participant. If a contact with this email does not - exist, one will be created. - required: - - email + description: The ID of the type of ticket you want to create + example: '1234' + contacts: + type: array + description: The list of contacts (users or leads) affected by this ticket. + Currently only one is allowed + items: + type: object + oneOf: + - title: ID + properties: + id: + type: string + description: The identifier for the contact as given by Intercom. + required: + - id + - title: External ID + properties: + external_id: + type: string + description: The external_id you have defined for the contact who + is being added as a participant. + required: + - external_id + - title: Email + properties: + email: + type: string + description: The email you have defined for the contact who is being + added as a participant. If a contact with this email does not + exist, one will be created. + required: + - email example: - - id: '1234' + - id: '1234' conversation_to_link_id: + required: false type: string description: "The ID of the conversation you want to link to the ticket. Here are the valid ways of linking two tickets:\n @@ -16434,22 +16107,9 @@ components: example: 1590000000 ticket_attributes: "$ref": "#/components/schemas/ticket_request_custom_attributes" - assignment: - type: object - properties: - admin_assignee_id: - type: string - description: The ID of the admin to which the ticket is assigned. - If not provided, the ticket will be unassigned. - example: '123' - team_assignee_id: - type: string - description: The ID of the team to which the ticket is assigned. - If not provided, the ticket will be unassigned. - example: '8' required: - - ticket_type_id - - contacts + - ticket_type_id + - contacts create_ticket_type_attribute_request: description: You can create a Ticket Type Attribute type: object @@ -16468,13 +16128,13 @@ components: type: string description: The data type of the attribute enum: - - string - - list - - integer - - decimal - - boolean - - datetime - - files + - string + - list + - integer + - decimal + - boolean + - datetime + - files example: string required_to_create: type: boolean @@ -16516,9 +16176,9 @@ components: to it (only applicable to file attributes) example: false required: - - name - - description - - data_type + - name + - description + - data_type create_ticket_type_request: description: | The request payload for creating a ticket type. @@ -16539,9 +16199,9 @@ components: type: string description: Category of the Ticket Type. enum: - - Customer - - Back-office - - Tracker + - Customer + - Back-office + - Tracker example: Customer icon: type: string @@ -16556,7 +16216,7 @@ components: example: false default: false required: - - name + - name cursor_pages: title: Cursor based pages type: object @@ -16570,7 +16230,7 @@ components: description: the type of object `pages`. example: pages enum: - - pages + - pages page: type: integer description: The current page @@ -16593,21 +16253,13 @@ components: will be a list of custom object instance models. additionalProperties: anyOf: - - type: string - - type: integer - - $ref: "#/components/schemas/datetime" - - "$ref": "#/components/schemas/custom_object_instance_list" - example: - paid_subscriber: true - monthly_spend: 155.5 - team_mates: 9 - start_date_iso8601: "2023-03-04T09:46:14Z" - end_date_timestamp: 1677923174 + - type: string + - "$ref": "#/components/schemas/custom_object_instance_list" custom_object_instance: title: Custom Object Instance type: object x-tags: - - Custom Object Instances + - 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 @@ -16617,35 +16269,11 @@ components: id: type: string description: The Intercom defined id representing the custom object instance. - example: 16032025 + example: 5a7a19e9f59ae20001d1c1e6 external_id: type: string description: The id you have defined for the custom object instance. example: 0001d1c1e65a7a19e9f59ae2 - external_created_at: - type: integer - format: date-time - nullable: true - description: The time when the Custom Object instance was created in the - external system it originated from. - example: 1571672154 - external_updated_at: - type: integer - format: date-time - nullable: true - description: The time when the Custom Object instance was last updated in - the external system it originated from. - example: 1571672154 - 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 type: type: string description: The identifier of the custom object type that defines the structure @@ -16693,37 +16321,37 @@ components: 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 + - 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 + - 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 @@ -16733,7 +16361,7 @@ components: type: string description: Value is `data_attribute`. enum: - - data_attribute + - data_attribute example: data_attribute id: type: integer @@ -16745,8 +16373,8 @@ components: description: Value is `contact` for user/lead attributes and `company` for company attributes. enum: - - contact - - company + - contact + - company example: contact name: type: string @@ -16770,11 +16398,11 @@ components: type: string description: The data type of the attribute. enum: - - string - - integer - - float - - boolean - - date + - string + - integer + - float + - boolean + - date example: boolean options: type: array @@ -16782,8 +16410,8 @@ components: items: type: string example: - - 'true' - - 'false' + - 'true' + - 'false' api_writable: type: boolean description: Can this attribute be updated through API @@ -16828,7 +16456,7 @@ components: type: string description: The type of the object enum: - - list + - list example: list data: type: array @@ -16839,14 +16467,14 @@ components: title: Data Event type: object x-tags: - - Data Events + - 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 + - event example: event event_name: type: string @@ -16885,8 +16513,8 @@ components: example: invite_code: ADDAFRIEND required: - - event_name - - created_at + - event_name + - created_at data_event_list: title: Data Event List type: object @@ -16896,7 +16524,7 @@ components: type: string description: The type of the object enum: - - event.list + - event.list example: event.list events: type: array @@ -16922,7 +16550,7 @@ components: type: string description: The type of the object enum: - - event.summary + - event.summary example: event.summary email: type: string @@ -16971,7 +16599,7 @@ components: title: Data Export type: object x-tags: - - Data Export + - Data Export description: The data export api is used to view all message sent & viewed in a given timeframe. properties: @@ -16982,12 +16610,12 @@ components: status: type: string enum: - - pending - - in_progress - - failed - - completed - - no_data - - canceled + - pending + - in_progress + - failed + - completed + - no_data + - canceled description: The current state of your job. example: pending download_expires_at: @@ -17108,7 +16736,7 @@ components: type: string description: The type of object which was deleted. - article enum: - - article + - article example: article deleted: type: boolean @@ -17128,7 +16756,7 @@ components: type: string description: The type of object which was deleted. - `collection` enum: - - collection + - collection example: collection deleted: type: boolean @@ -17147,7 +16775,7 @@ components: type: string description: The type of object which was deleted. - `company` enum: - - company + - company example: company deleted: type: boolean @@ -17167,7 +16795,7 @@ components: type: string description: The type of object which was deleted - news-item. enum: - - news-item + - news-item example: news-item deleted: type: boolean @@ -17180,7 +16808,7 @@ components: description: The `id` of the admin who is performing the action. example: '5017690' required: - - admin_id + - admin_id email_address_header: title: Email Address Header type: object @@ -17215,114 +16843,6 @@ components: description: A list of an email address headers. items: "$ref": "#/components/schemas/email_address_header" - conversation_attribute_updated_by_workflow: - title: Part type - conversation_attribute_updated_by_workflow - type: object - description: Contains details about the workflow that was triggered and any Custom Data Attributes (CDAs) that were modified during the workflow execution for conversation part typeconversation_attribute_updated_by_workflow.
- properties:
- workflow:
- type: object
- properties:
- name:
- type: string
- description: Name of the workflow
- example: Workflow 1
- attribute:
- type: object
- properties:
- name:
- type: string
- description: Name of the CDA updated
- example: flight_category
- value:
- type: object
- properties:
- name:
- type: string
- description: Value of the CDA updated
- example: vip_status
- conversation_attribute_updated_by_admin:
- title: Part type - conversation_attribute_updated_by_admin
- type: object
- description: Contains details about Custom Data Attributes (CDAs) that were modified by an admin (operator) for conversation part type conversation_attribute_updated_by_admin.
- properties:
- attribute:
- type: object
- properties:
- name:
- type: string
- description: Name of the CDA updated
- example: jira_issue_key
- value:
- type: object
- properties:
- name:
- type: string
- description: Value of the CDA updated
- example: PROJ-007
- custom_action_started:
- title: Part type - custom_action_started
- type: object
- description: Contains details about name of the action that was initiated for conversation part type custom_action_started.
- properties:
- action:
- type: object
- properties:
- name:
- type: string
- description: Name of the action
- example: Jira Create Issue
- custom_action_finished:
- title: Part type - custom_action_finished
- type: object
- description: Contains details about final status of the completed action for conversation part type custom_action_finished.
- properties:
- action:
- type: object
- properties:
- name:
- type: string
- description: Name of the action
- example: Jira Create Issue
- result:
- type: string
- description: Status of the action
- enum:
- - success
- - failed
- example: success
- operator_workflow_event:
- title: Part type - operator_workflow_event
- type: object
- description: Contains details about name of the workflow for conversation part type operator_workflow_event.
- properties:
- workflow:
- type: object
- properties:
- name:
- type: string
- description: The name of the workflow
- example: Custom Bot 1
- event:
- type: object
- properties:
- type:
- type: string
- description: Type of the workflow event initiated
- example: wait_finished
- result:
- type: string
- description: Result of the workflow event
- example: Finsihed waiting
- event_details:
- title: Event details of Workflow & actions
- type: object
- anyOf:
- - "$ref": "#/components/schemas/conversation_attribute_updated_by_workflow"
- - "$ref": "#/components/schemas/conversation_attribute_updated_by_admin"
- - "$ref": "#/components/schemas/custom_action_started"
- - "$ref": "#/components/schemas/custom_action_finished"
- - "$ref": "#/components/schemas/operator_workflow_event"
error:
type: object
title: Error
@@ -17361,15 +16881,15 @@ components:
parameter that was in error.
example: email
required:
- - code
+ - code
required:
- - type
- - errors
+ - type
+ - errors
external_page:
title: External Page
type: object
x-tags:
- - AI Content
+ - AI Content
description: External pages that you have added to your Fin Content Library.
nullable: false
properties:
@@ -17377,7 +16897,7 @@ components:
type: string
description: Always external_page
enum:
- - external_page
+ - external_page
default: external_page
example: external_page
id:
@@ -17417,7 +16937,7 @@ components:
type: string
description: Always en
enum:
- - en
+ - en
default: en
example: en
source_id:
@@ -17450,23 +16970,23 @@ components:
description: The time when the external page was last ingested.
example: 1672928610
required:
- - id
- - type
- - title
- - html
- - ai_agent_availability
- - ai_copilot_availability
- - locale
- - source_id
- - created_at
- - updated_at
- - last_ingested_at
- - external_id
+ - id
+ - type
+ - title
+ - html
+ - ai_agent_availability
+ - ai_copilot_availability
+ - locale
+ - source_id
+ - created_at
+ - updated_at
+ - last_ingested_at
+ - external_id
external_pages_list:
title: External Pages
type: object
x-tags:
- - AI Content
+ - AI Content
description: This will return a list of external pages for the App.
nullable: false
properties:
@@ -17474,7 +16994,7 @@ components:
type: string
description: The type of the object - `list`.
enum:
- - list
+ - list
example: list
pages:
"$ref": "#/components/schemas/pages_link"
@@ -17530,8 +17050,8 @@ components:
type: string
description: The type of object - `group_content` .
enum:
- -
- - group_content
+ -
+ - group_content
example: group_content
nullable: true
name:
@@ -17554,8 +17074,8 @@ components:
description: The type of object - group_translated_content.
nullable: true
enum:
- -
- - group_translated_content
+ -
+ - group_translated_content
example: group_translated_content
ar:
description: The content of the group in Arabic
@@ -17672,7 +17192,7 @@ components:
title: Help Center
type: object
x-tags:
- - Help Center
+ - Help Center
description: Help Centers contain collections
properties:
id:
@@ -17712,63 +17232,20 @@ components:
title: Help Centers
type: object
x-tags:
- - Help Center
+ - 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
+ - list
example: list
data:
type: array
description: An array of Help Center objects
items:
"$ref": "#/components/schemas/help_center"
- jobs:
- title: Jobs
- type: object
- x-tags:
- - Jobs
- description: Jobs are tasks that are processed asynchronously by the Intercom system after being enqueued via the API. This allows for efficient handling of operations that may take time to complete, such as data imports or exports. You can check the status of your jobs to monitor their progress and ensure they are completed successfully.
- properties:
- type:
- type: string
- description: The type of the object
- enum:
- - job
- id:
- type: string
- description: The id of the job that's currently being processed or has completed.
- example: 20
- url:
- type: string
- description: API endpoint URL to check the job status.
- example: https://api.intercom.io/jobs/status/20
- status:
- type: string
- description: The status of the job execution.
- enum:
- - pending
- - success
- - failed
- resource_type:
- type: string
- description: The type of resource created during job execution.
- example: ticket
- resource_id:
- type: string
- description: The id of the resource created during job execution (e.g. ticket id)
- example: 123
- nullable: true
- resource_url:
- type: string
- description: The url of the resource created during job exeuction. Use this url to fetch the resource.
- example: http://api.intercom.io/tickets/123
- nullable: true
- required:
- - id
intercom_version:
description: Intercom API version.By default, it's equal to the version
set in the app package.
@@ -17776,24 +17253,24 @@ components:
example: Unstable
default: Unstable
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'
- - '2.11'
- - Unstable
+ - '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'
+ - '2.11'
+ - Unstable
linked_object:
title: Linked Object
type: object
@@ -17803,8 +17280,8 @@ components:
type: string
description: ticket or conversation
enum:
- - ticket
- - conversation
+ - ticket
+ - conversation
example: ticket
id:
type: string
@@ -17814,10 +17291,10 @@ components:
type: string
description: Category of the Linked Ticket Object.
enum:
- - Customer
- - Back-office
- - Tracker
- -
+ - Customer
+ - Back-office
+ - Tracker
+ -
example: Customer
nullable: true
linked_object_list:
@@ -17830,7 +17307,7 @@ components:
type: string
description: Always list.
enum:
- - list
+ - list
example: list
total_count:
type: integer
@@ -17864,7 +17341,7 @@ components:
type: object
title: Message
x-tags:
- - Messages
+ - 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:
@@ -17893,24 +17370,23 @@ components:
message_type:
type: string
enum:
- - email
- - inapp
- - facebook
- - twitter
- - sms
+ - email
+ - inapp
+ - facebook
+ - twitter
description: The type of message that was sent. Can be email, inapp, facebook
- ,twitter or sms.
+ or twitter.
example: inapp
conversation_id:
type: string
description: The associated conversation_id
example: '64619700005570'
required:
- - type
- - id
- - created_at
- - body
- - message_type
+ - type
+ - id
+ - created_at
+ - body
+ - message_type
multiple_filter_search_request:
title: Multiple Filter Search Request
description: Search using Intercoms Search APIs with more than one filter.
@@ -17919,27 +17395,27 @@ components:
operator:
type: string
enum:
- - AND
- - OR
+ - 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"
+ - 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
+ - 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:
@@ -17947,7 +17423,7 @@ components:
type: string
description: The type of object.
enum:
- - news-item
+ - news-item
example: news-item
id:
type: string
@@ -17977,8 +17453,8 @@ components:
description: News items will not be visible to your users in the assigned
newsfeeds until they are set live.
enum:
- - draft
- - live
+ - draft
+ - live
example: live
newsfeed_assignments:
type: array
@@ -18047,8 +17523,8 @@ components:
description: News items will not be visible to your users in the assigned
newsfeeds until they are set live.
enum:
- - draft
- - live
+ - draft
+ - live
example: live
deliver_silently:
type: boolean
@@ -18061,9 +17537,9 @@ components:
items:
type: string
example:
- - Product
- - Update
- - New
+ - Product
+ - Update
+ - New
reactions:
type: array
description: Ordered list of emoji reactions to the news item. When empty,
@@ -18072,21 +17548,21 @@ components:
type: string
nullable: true
example:
- - "\U0001F606"
- - "\U0001F605"
+ - "\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
+ - title
+ - sender_id
newsfeed:
title: Newsfeed
type: object
x-tags:
- - News
+ - News
description: |
A newsfeed is a collection of news items, targeted to a specific audience.
@@ -18100,7 +17576,7 @@ components:
type: string
description: The type of object.
enum:
- - newsfeed
+ - newsfeed
example: newsfeed
name:
type: string
@@ -18121,7 +17597,7 @@ components:
title: Newsfeed Assignment
type: object
x-tags:
- - News
+ - News
description: Assigns a news item to a newsfeed.
properties:
newsfeed_id:
@@ -18142,7 +17618,7 @@ components:
title: Note
type: object
x-tags:
- - Notes
+ - Notes
description: Notes allow you to annotate and comment on your contacts.
properties:
type:
@@ -18208,15 +17684,15 @@ components:
message_type:
type: string
enum:
- - open
+ - 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
+ - message_type
+ - admin_id
pages_link:
title: Pagination Object
type: object
@@ -18229,7 +17705,7 @@ components:
type: string
example: pages
enum:
- - pages
+ - pages
page:
type: integer
example: 1
@@ -18254,8 +17730,8 @@ components:
type: string
description: The type of object
enum:
- - list
- - conversation.list
+ - list
+ - conversation.list
example: list
pages:
"$ref": "#/components/schemas/cursor_pages"
@@ -18268,8 +17744,8 @@ components:
description: An array of Objects
items:
anyOf:
- - "$ref": "#/components/schemas/news_item"
- - "$ref": "#/components/schemas/newsfeed"
+ - "$ref": "#/components/schemas/news_item"
+ - "$ref": "#/components/schemas/newsfeed"
part_attachment:
title: Part attachment
type: object
@@ -18313,7 +17789,7 @@ components:
type: string
description: ''
enum:
- - phone_call_redirect
+ - phone_call_redirect
default: phone_call_redirect
example: phone_call_redirect
phone:
@@ -18323,50 +17799,50 @@ components:
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
+ - 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
@@ -18383,8 +17859,8 @@ components:
example: 1a2b3c
reply_conversation_request:
oneOf:
- - "$ref": "#/components/schemas/contact_reply_conversation_request"
- - "$ref": "#/components/schemas/admin_reply_conversation_request"
+ - "$ref": "#/components/schemas/contact_reply_conversation_request"
+ - "$ref": "#/components/schemas/admin_reply_conversation_request"
search_request:
description: Search using Intercoms Search APIs.
type: object
@@ -18392,19 +17868,19 @@ components:
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
+ - "$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
+ - query
segment:
title: Segment
type: object
x-tags:
- - Segments
+ - Segments
description: A segment is a group of your contacts defined by the rules that
you set.
properties:
@@ -18412,7 +17888,7 @@ components:
type: string
description: The type of object.
enum:
- - segment
+ - segment
example: segment
id:
type: string
@@ -18434,8 +17910,8 @@ components:
type: string
description: 'Type of the contact: contact (lead) or user.'
enum:
- - contact
- - user
+ - contact
+ - user
example: contact
count:
type: integer
@@ -18453,7 +17929,7 @@ components:
type: string
description: The type of the object
enum:
- - segment.list
+ - segment.list
example: segment.list
segments:
type: array
@@ -18476,31 +17952,23 @@ components:
operator:
type: string
enum:
- - "="
- - "!="
- - IN
- - NIN
- - "<"
- - ">"
- - "~"
- - "!~"
- - "^"
- - "$"
+ - "="
+ - "!="
+ - IN
+ - NIN
+ - "<"
+ - ">"
+ - "~"
+ - "!~"
+ - "^"
+ - "$"
description: The accepted operators you can use to define how you want to
search for the value.
example: ">"
value:
- oneOf:
- - type: string
- - type: integer
- - type: array
- items:
- oneOf:
- - type: string
- - type: integer
+ type: string
description: The value that you want to search on.
example: '73732934'
- nullable: true
sla_applied:
title: Applied SLA
type: object
@@ -18520,10 +17988,10 @@ components:
sla_status:
type: string
enum:
- - hit
- - missed
- - cancelled
- - active
+ - 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.
@@ -18538,7 +18006,7 @@ components:
message_type:
type: string
enum:
- - snoozed
+ - snoozed
example: snoozed
admin_id:
type: string
@@ -18550,9 +18018,9 @@ components:
description: The time you want the conversation to reopen.
example: 1673609604
required:
- - message_type
- - admin_id
- - snoozed_until
+ - message_type
+ - admin_id
+ - snoozed_until
social_profile:
title: Social Profile
type: object
@@ -18591,7 +18059,7 @@ components:
title: Subscription Types
type: object
x-tags:
- - Subscription Types
+ - Subscription Types
description: A subscription type lets customers easily opt out of non-essential
communications without missing what's important to them.
properties:
@@ -18607,9 +18075,9 @@ components:
type: string
description: The state of the subscription type.
enum:
- - live
- - draft
- - archived
+ - live
+ - draft
+ - archived
example: live
default_translation:
"$ref": "#/components/schemas/translation"
@@ -18624,8 +18092,8 @@ components:
type: string
description: Describes the type of consent.
enum:
- - opt_out
- - opt_in
+ - opt_out
+ - opt_in
example: opt_in
content_types:
type: array
@@ -18634,8 +18102,8 @@ components:
items:
type: string
enum:
- - email
- - sms_message
+ - email
+ - sms_message
example: email
subscription_type_list:
title: Subscription Types
@@ -18646,7 +18114,7 @@ components:
type: string
description: The type of the object
enum:
- - list
+ - list
example: list
data:
type: array
@@ -18658,7 +18126,7 @@ components:
title: Tag
type: object
x-tags:
- - Tags
+ - Tags
description: A tag allows you to label your contacts, companies, and conversations
and list them using that tag.
properties:
@@ -18681,26 +18149,6 @@ components:
example: 1663597223
applied_by:
"$ref": "#/components/schemas/reference"
- tag_basic:
- 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
tag_company_request:
description: You can tag a single company or a list of companies.
type: object
@@ -18725,8 +18173,8 @@ components:
description: The id or company_id of the company can be passed as input
parameters.
required:
- - name
- - companies
+ - name
+ - companies
tag_list:
title: Tags
type: object
@@ -18736,7 +18184,7 @@ components:
type: string
description: The type of the object
enum:
- - list
+ - list
example: list
data:
type: array
@@ -18761,8 +18209,8 @@ components:
description: The Intercom defined id representing the user.
example: 5f7f0d217289f8d2f4262080
required:
- - name
- - users
+ - name
+ - users
tags:
title: Tags
type: object
@@ -18772,7 +18220,7 @@ components:
type: string
description: The type of the object
enum:
- - tag.list
+ - tag.list
example: tag.list
tags:
type: array
@@ -18783,7 +18231,7 @@ components:
title: Team
type: object
x-tags:
- - Teams
+ - Teams
description: Teams are groups of admins in Intercom.
properties:
type:
@@ -18802,7 +18250,7 @@ components:
type: array
description: The list of admin IDs that are a part of the team.
example:
- - 493881
+ - 493881
items:
type: integer
admin_priority_level:
@@ -18816,7 +18264,7 @@ components:
type: string
description: The type of the object
enum:
- - team.list
+ - team.list
example: team.list
teams:
type: array
@@ -18834,7 +18282,7 @@ components:
description: The primary team ids for the team
nullable: true
example:
- - 814865
+ - 814865
items:
type: integer
secondary_team_ids:
@@ -18842,14 +18290,14 @@ components:
description: The secondary team ids for the team
nullable: true
example:
- - 493881
+ - 493881
items:
type: integer
ticket:
title: Ticket
type: object
x-tags:
- - Tickets
+ - Tickets
description: Tickets are how you track requests from your users.
nullable: true
properties:
@@ -18857,7 +18305,7 @@ components:
type: string
description: Always ticket
enum:
- - ticket
+ - ticket
default: ticket
example: ticket
id:
@@ -18873,9 +18321,9 @@ components:
type: string
description: Category of the Ticket.
enum:
- - Customer
- - Back-office
- - Tracker
+ - Customer
+ - Back-office
+ - Tracker
example: Customer
ticket_attributes:
"$ref": "#/components/schemas/ticket_custom_attributes"
@@ -18926,14 +18374,14 @@ components:
title: Contacts
type: object
x-tags:
- - Tickets
+ - Tickets
description: The list of contacts affected by a ticket.
properties:
type:
type: string
description: always contact.list
enum:
- - contact.list
+ - contact.list
example: contact.list
contacts:
type: array
@@ -18948,12 +18396,12 @@ components:
the keys are `_default_title_` and `_default_description_`.
additionalProperties:
anyOf:
- - type: string
- nullable: true
- - type: number
- - type: boolean
- - type: array
- - "$ref": "#/components/schemas/file_attribute"
+ - type: string
+ nullable: true
+ - type: number
+ - type: boolean
+ - type: array
+ - "$ref": "#/components/schemas/file_attribute"
example:
_default_title_: Found a bug
_default_description_: The button's not working
@@ -18966,7 +18414,7 @@ components:
type: string
description: Always ticket.list
enum:
- - ticket.list
+ - ticket.list
example: ticket.list
tickets:
type: array
@@ -18983,7 +18431,7 @@ components:
title: Ticket Part
type: object
x-tags:
- - Tickets
+ - Tickets
description: A Ticket Part represents a message in the ticket.
properties:
type:
@@ -19006,19 +18454,19 @@ components:
previous_ticket_state:
type: string
enum:
- - submitted
- - in_progress
- - waiting_on_customer
- - resolved
+ - submitted
+ - in_progress
+ - waiting_on_customer
+ - resolved
description: The previous state of the ticket.
example: submitted
ticket_state:
type: string
enum:
- - submitted
- - in_progress
- - waiting_on_customer
- - resolved
+ - submitted
+ - in_progress
+ - waiting_on_customer
+ - resolved
description: The state of the ticket.
example: submitted
created_at:
@@ -19053,11 +18501,6 @@ components:
type: boolean
description: Whether or not the ticket part has been redacted.
example: false
- app_package_code:
- type: string
- nullable: false
- example: text-integration
- description: The app package code if this part was created via API. Note this field won't show if the part was not created via API.
ticket_part_author:
title: Ticket part author
type: object
@@ -19069,10 +18512,10 @@ components:
description: The type of the author
example: admin
enum:
- - admin
- - bot
- - team
- - user
+ - admin
+ - bot
+ - team
+ - user
id:
type: string
description: The id of the author
@@ -19097,7 +18540,7 @@ components:
type: string
description: ''
enum:
- - ticket_part.list
+ - ticket_part.list
example: ticket_part.list
ticket_parts:
title: Tickt Parts
@@ -19121,7 +18564,7 @@ components:
description: Always ticket_part
example: ticket_part
enum:
- - ticket_part
+ - ticket_part
id:
type: string
description: The id representing the part.
@@ -19131,9 +18574,9 @@ components:
description: Type of the part
example: note
enum:
- - note
- - comment
- - quick_reply
+ - note
+ - comment
+ - quick_reply
body:
type: string
nullable: true
@@ -19174,11 +18617,11 @@ components:
be the guid of the list item (e.g. `de1825a0-0164-4070-8ca6-13e22462fa7e`).
additionalProperties:
anyOf:
- - type: string
- nullable: true
- - type: number
- - type: boolean
- - type: array
+ - type: string
+ nullable: true
+ - type: number
+ - type: boolean
+ - type: array
example:
_default_title_: Found a bug
_default_description_: The button is not working
@@ -19186,7 +18629,7 @@ components:
title: Ticket State
type: object
x-tags:
- - Tickets
+ - Tickets
description: A ticket state, used to define the state of a ticket.
nullable: true
properties:
@@ -19204,10 +18647,10 @@ components:
description: The category of the ticket state
example: in_progress
enum:
- - submitted
- - in_progress
- - waiting_on_customer
- - resolved
+ - submitted
+ - in_progress
+ - waiting_on_customer
+ - resolved
internal_label:
type: string
description: The state the ticket is currently in, in a human readable form
@@ -19222,7 +18665,7 @@ components:
title: Ticket State
type: object
x-tags:
- - Tickets
+ - Tickets
description: A ticket state, used to define the state of a ticket.
nullable: true
properties:
@@ -19240,10 +18683,10 @@ components:
description: The category of the ticket state
example: in_progress
enum:
- - submitted
- - in_progress
- - waiting_on_customer
- - resolved
+ - submitted
+ - in_progress
+ - waiting_on_customer
+ - resolved
internal_label:
type: string
description: The state the ticket is currently in, in a human readable form
@@ -19292,7 +18735,7 @@ components:
title: Ticket Type
type: object
x-tags:
- - Tickets
+ - Tickets
description: A ticket type, used to define the data fields to be captured in
a ticket.
nullable: true
@@ -19310,9 +18753,9 @@ components:
type: string
description: Category of the Ticket Type.
enum:
- - Customer
- - Back-office
- - Tracker
+ - Customer
+ - Back-office
+ - Tracker
example: Customer
name:
type: string
@@ -19519,8 +18962,8 @@ components:
description: The id or company_id of the company can be passed as input
parameters.
required:
- - name
- - companies
+ - name
+ - companies
update_article_request:
description: You can Update an Article
type: object
@@ -19554,8 +18997,8 @@ components:
Defaults to draft. For multilingual articles, this will be the state of
the default language's content.
enum:
- - published
- - draft
+ - published
+ - draft
example: draft
parent_id:
type: string
@@ -19661,16 +19104,16 @@ components:
description: If you intend to create or update External Pages via the API,
this should be set to `api`. You can not change the value to or from api.
enum:
- - api
- - automated
- - manual
+ - api
+ - automated
+ - manual
example: api
status:
type: string
description: The status of the content import source.
enum:
- - active
- - deactivated
+ - active
+ - deactivated
default: active
example: active
url:
@@ -19679,8 +19122,8 @@ components:
from the existing value if the sync behavior is API.
example: https://help.example.com
required:
- - sync_behavior
- - url
+ - sync_behavior
+ - url
update_conversation_request:
title: Update Conversation Request
type: object
@@ -19690,10 +19133,6 @@ components:
type: boolean
description: Mark a conversation as read within Intercom.
example: true
- title:
- type: string
- description: The title given to the conversation
- example: Conversation Title
custom_attributes:
"$ref": "#/components/schemas/custom_attributes"
update_data_attribute_request:
@@ -19716,8 +19155,8 @@ components:
items:
type: string
example:
- - option1
- - option2
+ - option1
+ - option2
messenger_writable:
type: boolean
description: Can this attribute be updated by the Messenger
@@ -19751,7 +19190,7 @@ components:
type: string
description: Always en
enum:
- - en
+ - en
default: en
example: en
source_id:
@@ -19769,11 +19208,11 @@ components:
source. Must be unique for the source.
example: '5678'
required:
- - title
- - html
- - url
- - locale
- - source_id
+ - title
+ - html
+ - url
+ - locale
+ - source_id
update_ticket_request:
description: You can update a Ticket
type: object
@@ -19789,11 +19228,6 @@ components:
type: string
description: The ID of the ticket state associated with the ticket type.
example: '123'
- company_id:
- type: string
- description: The ID of the company that the ticket is associated with. The
- unique identifier for the company which is given by Intercom. Set to nil to remove company.
- example: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632
open:
type: boolean
description: Specify if a ticket is open. Set to false to close a ticket.
@@ -19808,18 +19242,16 @@ components:
format: timestamp
description: The time you want the ticket to reopen.
example: 1673609604
- assignment:
- type: object
- properties:
- admin_id:
- type: string
- description: The ID of the admin performing the action.
- example: '123'
- assignee_id:
- type: string
- description: The ID of the admin or team to which the ticket is assigned.
- Set this 0 to unassign it.
- example: '123'
+ admin_id:
+ type: integer
+ description: The ID of the admin performing ticket update. Needed for workflows
+ execution and attributing actions to specific admins.
+ example: 123
+ assignee_id:
+ type: string
+ description: The ID of the admin or team to which the ticket is assigned.
+ Set this 0 to unassign it.
+ example: '123'
update_ticket_type_attribute_request:
description: You can update a Ticket Type Attribute
type: object
@@ -19899,9 +19331,9 @@ components:
type: string
description: Category of the Ticket Type.
enum:
- - Customer
- - Back-office
- - Tracker
+ - Customer
+ - Back-office
+ - Tracker
example: Customer
icon:
type: string
@@ -19946,10 +19378,10 @@ components:
monthly_spend: 155.5
team_mates: 9
anyOf:
- - required:
- - id
- - required:
- - user_id
+ - required:
+ - id
+ - required:
+ - user_id
visitor:
title: Visitor
type: object
@@ -20021,7 +19453,7 @@ components:
type: string
description: The type of the object
enum:
- - company.list
+ - company.list
example: company.list
companies:
type: array
@@ -20094,7 +19526,7 @@ components:
type: string
description: The type of the object
enum:
- - social_profile.list
+ - social_profile.list
example: social_profile.list
social_profiles:
type: array
@@ -20124,7 +19556,7 @@ components:
type: string
description: The type of the object
enum:
- - tag.list
+ - tag.list
example: tag.list
tags:
type: array
@@ -20134,7 +19566,7 @@ components:
type: string
description: The type of the object
enum:
- - tag
+ - tag
example: tag
id:
type: string
@@ -20151,7 +19583,7 @@ components:
type: string
description: The type of the object
enum:
- - segment.list
+ - segment.list
example: segment.list
segments:
type: array
@@ -20210,7 +19642,7 @@ components:
type: string
description: The type of object which was deleted
enum:
- - visitor
+ - visitor
example: visitor
user_id:
type: string
@@ -20220,134 +19652,91 @@ components:
bearerAuth:
type: http
scheme: bearer
- responses:
- Unauthorized:
- description: Unauthorized
- content:
- application/json:
- examples:
- Unauthorized:
- value:
- type: error.list
- request_id: 12a938a3-314e-4939-b773-5cd45738bd21
- errors:
- - code: unauthorized
- message: Access Token Invalid
- schema:
- "$ref": "#/components/schemas/error"
- TypeNotFound:
- description: Not Found
- content:
- application/json:
- examples:
- TypeNotFound:
- value:
- type: error.list
- request_id: 12a938a3-314e-4939-b773-5cd45738bd21
- errors:
- - code: not_found
- message: Custom object type `undefined` not found
- schema:
- "$ref": "#/components/schemas/error"
- ObjectNotFound:
- description: Not Found
- content:
- application/json:
- examples:
- ObjectNotFound:
- value:
- type: error.list
- request_id: 12a938a3-314e-4939-b773-5cd45738bd21
- errors:
- - code: not_found
- message: Custom object instance not found
- schema:
- "$ref": "#/components/schemas/error"
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
+ - 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: []
+ - bearerAuth: []
tags:
-- name: Admins
+ - name: Admins
description: Everything about your Admins
-- name: AI Content
- description: |
- With the AI Content APIs, you can create and manage External Pages and Content Import Sources for your Fin Content Library.
+ - name: AI Content
+ description: |
+ With the AI Content APIs, you can create and manage External Pages and Content Import Sources for your Fin Content Library.
-
+
- *External Pages* are pages that you want Fin to be able to answer questions about. The API for External Pages is a great way to ingest into your Fin Content Library pages that are not publicly accessible and hence can't be crawled by Intercom.
+ *External Pages* are pages that you want Fin to be able to answer questions about. The API for External Pages is a great way to ingest into your Fin Content Library pages that are not publicly accessible and hence can't be crawled by Intercom.
-
+
- *Content Import Sources* are the sources of those pages, and they are used to determine the default audience for the pages (configured via the UI). You should create a Content Import Source for each source of External Pages that you want to ingest into your Fin Content Library.
+ *Content Import Sources* are the sources of those pages, and they are used to determine the default audience for the pages (configured via the UI). You should create a Content Import Source for each source of External Pages that you want to ingest into your Fin Content Library.
-
+
- You can then iterate through the content from that source via its API and POST it to the External Pages endpoint. That endpoint has an *external_id* parameter which allows you to specify the identifier from the source. The endpoint will then either create a new External Page or update an existing one as appropriate.",
-- name: Articles
- description: Everything about your Articles
-- name: Away Status Reasons
- description: Everything about your Away Status Reasons
-- 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: Custom Object Instances
- description: |
- Everything about your Custom Object instances.
- {% admonition type="warning" name="Permission Requirements" %}
- From now on, to access this endpoint, you need additional permissions. Please head over to the [Developer Hub](https://app.intercom.com/a/apps/_/developer-hub) app package authentication settings to configure the required permissions.
- {% /admonition %}
-- 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: Jobs
- description: Everything about jobs
-- 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: Ticket States
- description: Everything about your ticket states
-- name: Ticket Type Attributes
- description: Everything about your ticket type attributes
-- name: Ticket Types
- description: Everything about your ticket types
-- name: Tickets
- description: Everything about your tickets
-- name: Visitors
- description: Everything about your Visitors
+ You can then iterate through the content from that source via its API and POST it to the External Pages endpoint. That endpoint has an *external_id* parameter which allows you to specify the identifier from the source. The endpoint will then either create a new External Page or update an existing one as appropriate.",
+ - name: Articles
+ description: Everything about your Articles
+ - name: Away Status Reasons
+ description: Everything about your Away Status Reasons
+ - 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: Custom Object Instances
+ description: |
+ Everything about your Custom Object instances.
+ {% admonition type="warning" name="Permission Requirements" %}
+ From now on, to access this endpoint, you need additional permissions. Please head over to the [Developer Hub](https://app.intercom.com/a/apps/_/developer-hub) app package authentication settings to configure the required permissions.
+ {% /admonition %}
+ - 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: Jobs
+ description: Everything about jobs
+ - 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: Ticket States
+ description: Everything about your ticket states
+ - name: Ticket Type Attributes
+ description: Everything about your ticket type attributes
+ - name: Ticket Types
+ description: Everything about your ticket types
+ - name: Tickets
+ description: Everything about your tickets
+ - name: Visitors
+ description: Everything about your Visitors
\ No newline at end of file