From 1cb163fe60e187e0a2f1341aaba52998095fc8b8 Mon Sep 17 00:00:00 2001 From: Elizabeth Moy Date: Thu, 5 Dec 2024 12:48:00 +0000 Subject: [PATCH] updating dummy messages and method names - unstable --- descriptions/0/api.intercom.io.yaml | 11361 +++++++++++++------------- 1 file changed, 5890 insertions(+), 5471 deletions(-) diff --git a/descriptions/0/api.intercom.io.yaml b/descriptions/0/api.intercom.io.yaml index c7a1551..828ada6 100644 --- a/descriptions/0/api.intercom.io.yaml +++ b/descriptions/0/api.intercom.io.yaml @@ -11,20 +11,22 @@ info: name: MIT url: https://spdx.org/licenses/MIT paths: - "/me": + '/me': get: + x-fern-sdk-group-name: + - admins + x-fern-sdk-method-name: identify summary: Identify an admin parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" + - name: Intercom-Version + in: header + schema: + '$ref': '#/components/schemas/intercom_version' tags: - - Admins + - Admins operationId: identifyAdmin - description: "\nYou can view the currently authorised admin along with the embedded - app object (a \"workspace\" in legacy terminology).\n\n> \U0001F6A7 Single - Sign On\n>\n> If you are building a custom \"Log in with Intercom\" flow for + description: "\nYou can view the authorized admin and the workspace/app details.\n\n Single + Sign On\n\n If you are building a custom \"Log in with Intercom\" flow for your site, and you call the `/me` endpoint to identify the logged-in user, you should not accept any sign-ins from users with unverified email addresses as it poses a potential impersonation security risk.\n" @@ -38,13 +40,13 @@ paths: value: type: admin id: '991266830' - email: admin1@email.com - name: Ciaran1 Lee + email: email@example.com + name: Joe Example email_verified: true app: type: app - id_code: this_is_an_id1_that_should_be_at_least_40 - name: MyApp 1 + id_code: aaaa0000 + name: TestSpace created_at: 1727856792 secure: false identity_verification: false @@ -55,25 +57,28 @@ paths: image_url: https://static.intercomassets.com/assets/default-avatars/admins/128.png has_inbox_seat: true schema: - "$ref": "#/components/schemas/admin_with_app" - "/admins/{id}/away": + '$ref': '#/components/schemas/admin_with_app' + '/admins/{id}/away': + x-fern-sdk-group-name: + - admins + x-fern-sdk-method-name: setAway put: summary: Set an admin to away 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 admin - 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 admin + schema: + type: integer tags: - - Admins + - Admins operationId: setAwayAdmin - description: You can set an Admin as away for the Inbox. + description: You can set an admin to away by changing their away status. responses: '200': description: Successful response @@ -84,14 +89,18 @@ paths: value: type: admin id: '991266831' - name: Ciaran2 Lee - email: admin2@email.com + name: Jane Example + email: email@example.com away_mode_enabled: true away_mode_reassign: true has_inbox_seat: true + avatar: + type: avatar + image_url: https://static.intercomassets.com/assets/default-avatars/admins/128.png team_ids: [] + team_priority_level: {} schema: - "$ref": "#/components/schemas/admin" + '$ref': '#/components/schemas/admin' '404': description: Admin not found content: @@ -102,10 +111,10 @@ paths: type: error.list request_id: cc85f377-00d3-4294-ae76-fd7b5a580e37 errors: - - code: admin_not_found - message: Admin for admin_id not found + - code: admin_not_found + message: Admin for admin_id not found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -116,18 +125,18 @@ paths: type: error.list request_id: f82a1d2b-fec2-4546-8768-2cc339a119ab errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: type: object required: - - away_mode_enabled - - away_mode_reassign + - away_mode_enabled + - away_mode_reassign properties: away_mode_enabled: type: boolean @@ -157,32 +166,35 @@ paths: value: away_mode_enabled: true away_mode_reassign: true - "/admins/activity_logs": + '/admins/activity_logs': + x-fern-sdk-group-name: + - admins + x-fern-sdk-method-name: listActivityLogs get: summary: List all activity logs parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - - name: created_at_after - in: query - required: true - description: The start date that you request data for. It must be formatted - as a UNIX timestamp. - example: '1677253093' - schema: - type: string - - name: created_at_before - in: query - required: false - description: The end date that you request data for. It must be formatted - as a UNIX timestamp. - example: '1677861493' - schema: - type: string + - name: Intercom-Version + in: header + schema: + '$ref': '#/components/schemas/intercom_version' + - name: created_at_after + in: query + required: true + description: The start date that you request data for. It must be formatted + as a UNIX timestamp. + example: '1677253093' + schema: + type: string + - name: created_at_before + in: query + required: false + description: The end date that you request data for. It must be formatted + as a UNIX timestamp. + example: '1677861493' + schema: + type: string tags: - - Admins + - Admins operationId: listActivityLogs description: You can get a log of activities by all admins in an app. responses: @@ -201,38 +213,38 @@ paths: per_page: 20 total_pages: 1 activity_logs: - - id: 51388355-4556-4f75-98f2-2f713d781377 - performed_by: - type: admin - id: '991266835' - email: admin5@email.com - ip: 127.0.0.1 - metadata: - before: before - after: after - created_at: 1727856800 - activity_type: app_name_change - activity_description: Ciaran5 Lee changed your app name from - before to after. - - id: 5eba91c1-5cf7-476f-ae35-7f34a0ea8e3e - performed_by: - type: admin - id: '991266835' - email: admin5@email.com - ip: 127.0.0.1 - metadata: - message: - id: 123 - title: Initial message title - before: Initial message title - after: Eventual message title - created_at: 1727856800 - activity_type: message_state_change - activity_description: Ciaran5 Lee changed your Initial message - title message from Initial message title to Eventual message - title. - schema: - "$ref": "#/components/schemas/activity_log_list" + - id: 51388355-4556-4f75-98f2-2f713d781377 + performed_by: + type: admin + id: '991266835' + email: admin5@email.com + ip: 127.0.0.1 + metadata: + before: before + after: after + created_at: 1727856800 + activity_type: app_name_change + activity_description: Joe Example changed your app name from + before to after. + - id: 5eba91c1-5cf7-476f-ae35-7f34a0ea8e3e + performed_by: + type: admin + id: '991266835' + email: email@example.com + ip: 127.0.0.1 + metadata: + message: + id: 123 + title: Initial message title + before: Initial message title + after: Eventual message title + created_at: 1727856800 + activity_type: message_state_change + activity_description: Jane Example changed your Initial message + title message from Initial message title to Eventual message + title. + schema: + '$ref': '#/components/schemas/activity_log_list' '401': description: Unauthorized content: @@ -243,20 +255,23 @@ paths: type: error.list request_id: b1508a10-0195-43d7-aeb2-4eaa1b72132d errors: - - code: unauthorized - message: Access Token Invalid - schema: - "$ref": "#/components/schemas/error" - "/admins": + - code: unauthorized + message: Access Token Invalid + schema: + '$ref': '#/components/schemas/error' + '/admins': + x-fern-sdk-group-name: + - admins + x-fern-sdk-method-name: list get: summary: List all admins parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" + - name: Intercom-Version + in: header + schema: + '$ref': '#/components/schemas/intercom_version' tags: - - Admins + - Admins operationId: listAdmins description: You can fetch a list of admins for a given workspace. responses: @@ -269,16 +284,17 @@ paths: value: type: admin.list admins: - - type: admin - email: admin7@email.com - id: '991266837' - name: Ciaran7 Lee - away_mode_enabled: false - away_mode_reassign: false - has_inbox_seat: true - team_ids: [] + - type: admin + email: email@example.com + id: '991266837' + name: Jane Example + away_mode_enabled: false + away_mode_reassign: false + has_inbox_seat: true + team_ids: [] + team_priority_level: {} schema: - "$ref": "#/components/schemas/admin_list" + '$ref': '#/components/schemas/admin_list' '401': description: Unauthorized content: @@ -289,28 +305,31 @@ paths: type: error.list request_id: 8f6afb01-98ec-4ccd-8a7d-6069a78ec697 errors: - - code: unauthorized - message: Access Token Invalid - schema: - "$ref": "#/components/schemas/error" - "/admins/{id}": + - code: unauthorized + message: Access Token Invalid + schema: + '$ref': '#/components/schemas/error' + '/admins/{id}': + x-fern-sdk-group-name: + - admins + x-fern-sdk-method-name: get get: - summary: Retrieve an admin + summary: Get an admin 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 admin - 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 admin + example: 991266839 + schema: + type: integer tags: - - Admins - operationId: retrieveAdmin + - Admins + operationId: getAdmin description: You can retrieve the details of a single admin. responses: '200': @@ -322,14 +341,16 @@ paths: value: type: admin id: '991266839' - name: Ciaran9 Lee - email: admin9@email.com + name: Joe Example + email: test@example.com away_mode_enabled: false away_mode_reassign: false has_inbox_seat: true - team_ids: [] + team_ids: ['111'] + team_priority_level: + primary_team_ids: ['111'] schema: - "$ref": "#/components/schemas/admin" + '$ref': '#/components/schemas/admin' '404': description: Admin not found content: @@ -340,10 +361,10 @@ paths: type: error.list request_id: 2d72b5aa-926f-45e9-9f0c-ed05a6a9296a errors: - - code: admin_not_found - message: Admin not found + - code: admin_not_found + message: Admin not found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -354,20 +375,24 @@ paths: type: error.list request_id: 7170420b-64c8-4ce6-905c-10deba56cce3 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" - "/ai/content_import_sources": + '$ref': '#/components/schemas/error' + '/ai/content_import_sources': get: + x-fern-sdk-group-name: + - ai + - contentImportSources + x-fern-sdk-method-name: list summary: List content import sources 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: listContentImportSources description: You can retrieve a list of all content import sources for a workspace. responses: @@ -379,30 +404,30 @@ paths: successful: value: data: - - id: 17 - type: content_import_source - last_synced_at: 1727856804 - status: active - url: https://support.example.com/us/1 - sync_behavior: automatic - created_at: 1727856804 - updated_at: 1727856804 - - id: 18 - type: content_import_source - last_synced_at: 1727856804 - status: active - url: https://support.example.com/us/2 - sync_behavior: automatic - created_at: 1727856804 - updated_at: 1727856804 - - id: 19 - type: content_import_source - last_synced_at: 1727856804 - status: active - url: https://support.example.com/us/3 - sync_behavior: automatic - created_at: 1727856804 - updated_at: 1727856804 + - id: 17 + type: content_import_source + last_synced_at: 1727856804 + status: active + url: https://support.example.com/us/1 + sync_behavior: automatic + created_at: 1727856804 + updated_at: 1727856804 + - id: 18 + type: content_import_source + last_synced_at: 1727856804 + status: active + url: https://support.example.com/us/2 + sync_behavior: automatic + created_at: 1727856804 + updated_at: 1727856804 + - id: 19 + type: content_import_source + last_synced_at: 1727856804 + status: active + url: https://support.example.com/us/3 + sync_behavior: automatic + created_at: 1727856804 + updated_at: 1727856804 pages: type: pages page: 1 @@ -411,7 +436,7 @@ paths: total_count: 3 type: list schema: - "$ref": "#/components/schemas/content_import_sources_list" + '$ref': '#/components/schemas/content_import_sources_list' '401': description: Unauthorized content: @@ -422,19 +447,23 @@ paths: type: error.list request_id: 1de1fb14-56dd-43da-9e33-ca6a288cd1e8 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' post: + x-fern-sdk-group-name: + - ai + - contentImportSources + x-fern-sdk-method-name: create summary: Create a content import source 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: createContentImportSource description: You can create a new content import source by sending a POST request to this endpoint. @@ -455,7 +484,7 @@ paths: created_at: 1727856806 updated_at: 1727856806 schema: - "$ref": "#/components/schemas/content_import_source" + '$ref': '#/components/schemas/content_import_source' '401': description: Unauthorized content: @@ -466,43 +495,47 @@ paths: type: error.list request_id: d190a53b-d380-44e8-945d-65b6f3518cf5 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: - "$ref": "#/components/schemas/create_content_import_source_request" + '$ref': '#/components/schemas/create_content_import_source_request' examples: successful: summary: successful value: sync_behavior: api url: https://www.example.com - "/ai/content_import_sources/{id}": + '/ai/content_import_sources/{id}': parameters: - - name: id - in: path - description: The unique identifier for the content import source which is given - by Intercom. - required: true - schema: - type: string + - name: id + in: path + description: The unique identifier for the content import source which is given + by Intercom. + required: true + schema: + type: string delete: + x-fern-sdk-group-name: + - ai + - contentImportSources + x-fern-sdk-method-name: delete summary: Delete a content import source operationId: deleteContentImportSource description: You can delete a content import source by making a DELETE request this endpoint. This will also delete all external pages that were imported from this source. 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 responses: '204': description: successful @@ -516,20 +549,23 @@ paths: type: error.list request_id: 285a794e-efb4-4d71-9eae-5f274c67b711 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' get: + x-fern-sdk-group-name: + - ai + x-fern-sdk-method-name: getSource summary: Retrieve a content import source operationId: getContentImportSource 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 responses: '200': description: successful @@ -547,7 +583,7 @@ paths: created_at: 1727856808 updated_at: 1727856808 schema: - "$ref": "#/components/schemas/content_import_source" + '$ref': '#/components/schemas/content_import_source' '401': description: Unauthorized content: @@ -558,19 +594,22 @@ paths: type: error.list request_id: c279123e-3692-4d46-976e-901932435a66 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' put: + x-fern-sdk-group-name: + - ai + x-fern-sdk-method-name: updateSource summary: Update a content import source 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: updateContentImportSource description: You can update an existing content import source. responses: @@ -590,7 +629,7 @@ paths: created_at: 1727856809 updated_at: 1727856810 schema: - "$ref": "#/components/schemas/content_import_source" + '$ref': '#/components/schemas/content_import_source' '401': description: Unauthorized content: @@ -601,31 +640,35 @@ paths: type: error.list request_id: 858a0910-c9b2-4302-8537-130b68bd020d errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: - "$ref": "#/components/schemas/update_content_import_source_request" + '$ref': '#/components/schemas/update_content_import_source_request' examples: successful: summary: successful value: sync_behavior: api url: https://www.example.com - "/ai/external_pages": + '/ai/external_pages': get: + x-fern-sdk-group-name: + - ai + - externalPages + x-fern-sdk-method-name: list summary: List external pages 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: listExternalPages description: You can retrieve a list of all external pages for a workspace. responses: @@ -637,48 +680,48 @@ paths: successful: value: data: - - id: '11' - type: external_page - title: My External Content - html: "

Hello world

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: 26 - external_id: '3' - created_at: 1727856811 - updated_at: 1727856811 - last_ingested_at: 1727856811 - - id: '10' - type: external_page - title: My External Content - html: "

Hello world

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: 25 - external_id: '2' - created_at: 1727856811 - updated_at: 1727856811 - last_ingested_at: 1727856811 - - id: '9' - type: external_page - title: My External Content - html: "

Hello world

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: 24 - external_id: '1' - created_at: 1727856811 - updated_at: 1727856811 - last_ingested_at: 1727856811 + - id: '11' + type: external_page + title: My External Content + html: '

Hello world

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: 26 + external_id: '3' + created_at: 1727856811 + updated_at: 1727856811 + last_ingested_at: 1727856811 + - id: '10' + type: external_page + title: My External Content + html: '

Hello world

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: 25 + external_id: '2' + created_at: 1727856811 + updated_at: 1727856811 + last_ingested_at: 1727856811 + - id: '9' + type: external_page + title: My External Content + html: '

Hello world

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: 24 + external_id: '1' + created_at: 1727856811 + updated_at: 1727856811 + last_ingested_at: 1727856811 pages: type: pages page: 1 @@ -687,7 +730,7 @@ paths: total_count: 3 type: list schema: - "$ref": "#/components/schemas/external_pages_list" + '$ref': '#/components/schemas/external_pages_list' '401': description: Unauthorized content: @@ -698,19 +741,23 @@ paths: type: error.list request_id: db45aca5-7713-46a3-941e-75901ca936bf errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' post: + x-fern-sdk-group-name: + - ai + - externalPages + x-fern-sdk-method-name: create 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 @@ -726,7 +773,7 @@ paths: id: '13' type: external_page title: Test - html: "

Test

" + html: '

Test

' url: https://www.example.com ai_agent_availability: true ai_copilot_availability: true @@ -738,7 +785,7 @@ paths: updated_at: 1727856814 last_ingested_at: 1727856814 schema: - "$ref": "#/components/schemas/external_page" + '$ref': '#/components/schemas/external_page' '401': description: Unauthorized content: @@ -749,42 +796,46 @@ paths: type: error.list request_id: 387b0e3f-0105-41f3-afed-bc906ee12a5c errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: - "$ref": "#/components/schemas/create_external_page_request" + '$ref': '#/components/schemas/create_external_page_request' examples: successful: summary: successful value: external_id: abc1234 - html: "

Test

" + html: '

Test

' locale: en source_id: 28 title: Test url: https://www.example.com - "/ai/external_pages/{id}": + '/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: + x-fern-sdk-group-name: + - ai + - externalPages + x-fern-sdk-method-name: 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. @@ -811,7 +862,7 @@ paths: updated_at: 1727856815 last_ingested_at: 1727856815 schema: - "$ref": "#/components/schemas/external_page" + '$ref': '#/components/schemas/external_page' '401': description: Unauthorized content: @@ -822,19 +873,23 @@ paths: type: error.list request_id: be39c0f6-55e8-44ff-8327-b70bc9e55aec errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' get: - summary: Retrieve an external page + summary: Get an external page + x-fern-sdk-group-name: + - ai + - externalPages + x-fern-sdk-method-name: get 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: @@ -848,7 +903,7 @@ paths: id: '15' type: external_page title: My External Content - html: "

Hello world

This is external content

" + html: '

Hello world

This is external content

' url: https://support.example.com/us/6 ai_agent_availability: true ai_copilot_availability: true @@ -860,7 +915,7 @@ paths: updated_at: 1727856817 last_ingested_at: 1727856817 schema: - "$ref": "#/components/schemas/external_page" + '$ref': '#/components/schemas/external_page' '401': description: Unauthorized content: @@ -871,19 +926,23 @@ paths: type: error.list request_id: e10b7ffb-2964-4b3c-bc0b-b172a1b92ead errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' put: + x-fern-sdk-group-name: + - ai + - externalPages + x-fern-sdk-method-name: update 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). @@ -898,7 +957,7 @@ paths: id: '16' type: external_page title: Test - html: "

Test

" + html: '

Test

' url: https://www.example.com ai_agent_availability: true ai_copilot_availability: true @@ -910,7 +969,7 @@ paths: updated_at: 1727856818 last_ingested_at: 1727856818 schema: - "$ref": "#/components/schemas/external_page" + '$ref': '#/components/schemas/external_page' '401': description: Unauthorized content: @@ -921,39 +980,41 @@ paths: type: error.list request_id: c71ccf6b-6333-4d5c-bf47-7604266d0eea errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: - "$ref": "#/components/schemas/update_external_page_request" + '$ref': '#/components/schemas/update_external_page_request' examples: successful: summary: successful value: external_id: '5678' - html: "

Test

" + html: '

Test

' locale: en source_id: 31 title: Test url: https://www.example.com - "/articles": + '/articles': get: + x-fern-sdk-group-name: + - articles + x-fern-sdk-method-name: list 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 - and ordered?\n>\n> Articles will be returned in descending order on the `updated_at` + `https://api.intercom.io/articles`.\n Articles will be returned in descending order on the `updated_at` attribute. This means if you need to iterate through results then we'll show the most recently updated articles first.\n" responses: @@ -972,22 +1033,22 @@ paths: total_pages: 1 total_count: 1 data: - - id: '20' - type: article - workspace_id: this_is_an_id64_that_should_be_at_least_4 - parent_id: 72 - parent_type: collection - parent_ids: [] - title: This is the article title - description: '' - body: '' - author_id: 991266863 - state: published - created_at: 1727856820 - updated_at: 1727856820 - url: http://help-center.test/myapp-64/en/articles/20-this-is-the-article-title + - id: '20' + type: article + workspace_id: this_is_an_id64_that_should_be_at_least_4 + parent_id: 72 + parent_type: collection + parent_ids: [] + title: This is the article title + description: '' + body: '' + author_id: 991266863 + state: published + created_at: 1727856820 + updated_at: 1727856820 + url: http://help-center.test/myapp-64/en/articles/20-this-is-the-article-title schema: - "$ref": "#/components/schemas/article_list" + '$ref': '#/components/schemas/article_list' '401': description: Unauthorized content: @@ -998,19 +1059,22 @@ paths: type: error.list request_id: e550e46b-1974-4312-9983-25378549254c errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' post: + x-fern-sdk-group-name: + - articles + x-fern-sdk-method-name: create 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: @@ -1044,7 +1108,7 @@ paths: updated_at: 1727856823 url: http://help-center.test/myapp-68/en/articles/23-thanks-for-everything schema: - "$ref": "#/components/schemas/article" + '$ref': '#/components/schemas/article' '400': description: Bad Request content: @@ -1055,11 +1119,11 @@ paths: type: error.list request_id: 4516b3bb-3057-4dfd-9d50-072ec16c007f 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" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -1070,15 +1134,15 @@ paths: type: error.list request_id: abf685e8-18c0-4ae9-aa24-ed5b070d6249 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: - "$ref": "#/components/schemas/create_article_request" + '$ref': '#/components/schemas/create_article_request' examples: article_created: summary: article created @@ -1104,23 +1168,26 @@ paths: description: Description of the Article body: Body of the Article state: published - "/articles/{id}": + '/articles/{id}': get: - summary: Retrieve an article + x-fern-sdk-group-name: + - articles + x-fern-sdk-method-name: get + summary: Get 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/`. @@ -1155,7 +1222,7 @@ paths: updated_at: 1727856826 url: http://help-center.test/myapp-74/en/articles/26-this-is-the-article-title schema: - "$ref": "#/components/schemas/article" + '$ref': '#/components/schemas/article' '404': description: Article not found content: @@ -1166,10 +1233,10 @@ paths: type: error.list request_id: 94144152-d550-4319-8e87-6ec6d48a9395 errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -1180,26 +1247,29 @@ paths: type: error.list request_id: 5c8cb9f3-8e0b-4070-a980-01ef9e3e3ee9 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' put: + x-fern-sdk-group-name: + - articles + x-fern-sdk-method-name: update summary: Update 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: updateArticle description: You can update the details of a single article by making a PUT request to `https://api.intercom.io/articles/`. @@ -1234,7 +1304,7 @@ paths: updated_at: 1727856830 url: http://help-center.test/myapp-80/en/articles/29-christmas-is-here schema: - "$ref": "#/components/schemas/article" + '$ref': '#/components/schemas/article' '404': description: Article Not Found content: @@ -1245,10 +1315,10 @@ paths: type: error.list request_id: 869da353-32dd-415d-94d2-092a0b57273e errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -1259,42 +1329,45 @@ paths: type: error.list request_id: ca9b4122-c978-4d54-a06d-9514267890fc errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: - "$ref": "#/components/schemas/update_article_request" + '$ref': '#/components/schemas/update_article_request' examples: successful: summary: successful value: title: Christmas is here! - body: "

New gifts in store for the jolly season

" + body: '

New gifts in store for the jolly season

' article_not_found: summary: Article Not Found value: title: Christmas is here! - body: "

New gifts in store for the jolly season

" + body: '

New gifts in store for the jolly season

' delete: + x-fern-sdk-group-name: + - articles + x-fern-sdk-method-name: delete summary: Delete an article parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - - name: id - in: path - required: true - description: The unique identifier for the article which is given by Intercom. - example: 123 - schema: - type: integer + - 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: deleteArticle description: You can delete a single article by making a DELETE request to `https://api.intercom.io/articles/`. responses: @@ -1309,7 +1382,7 @@ paths: object: article deleted: true schema: - "$ref": "#/components/schemas/deleted_article_object" + '$ref': '#/components/schemas/deleted_article_object' '404': description: Article Not Found content: @@ -1320,10 +1393,10 @@ paths: type: error.list request_id: a9b48eb2-39d4-4bc3-8603-e6e353cdc0c9 errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -1334,50 +1407,53 @@ paths: type: error.list request_id: '096d5175-52c8-4ebe-a766-f0033e39cc5e' errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" - "/articles/search": + '$ref': '#/components/schemas/error' + '/articles/search': get: + x-fern-sdk-group-name: + - articles + x-fern-sdk-method-name: search summary: Search for articles parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - - name: phrase - in: query - required: false - description: The phrase within your articles to search for. - example: Getting started - schema: - type: string - - name: state - in: query - required: false - description: The state of the Articles returned. One of `published`, `draft` - or `all`. - example: published - schema: - type: string - - name: help_center_id - in: query - required: false - description: The ID of the Help Center to search in. - example: 123 - schema: - type: integer - - name: highlight - in: query - required: false - description: Return a highlighted version of the matching content within your - articles. Refer to the response schema for more details. - example: false - schema: - type: boolean + - name: Intercom-Version + in: header + schema: + '$ref': '#/components/schemas/intercom_version' + - name: phrase + in: query + required: false + description: The phrase within your articles to search for. + example: Getting started + schema: + type: string + - name: state + in: query + required: false + description: The state of the Articles returned. One of `published`, `draft` + or `all`. + example: published + schema: + type: string + - name: help_center_id + in: query + required: false + description: The ID of the Help Center to search in. + example: 123 + schema: + type: integer + - name: highlight + in: query + required: false + description: Return a highlighted version of the matching content within your + articles. Refer to the response schema for more details. + example: false + schema: + type: boolean tags: - - Articles + - Articles operationId: searchArticles description: You can search for articles by making a GET request to `https://api.intercom.io/articles/search`. responses: @@ -1392,20 +1468,20 @@ paths: total_count: 1 data: articles: - - id: '36' - type: article - workspace_id: this_is_an_id92_that_should_be_at_least_4 - parent_id: - parent_type: - parent_ids: [] - title: Title 1 - description: '' - body: '' - author_id: 991266892 - state: draft - created_at: 1727856837 - updated_at: 1727856837 - url: + - id: '36' + type: article + workspace_id: this_is_an_id92_that_should_be_at_least_4 + parent_id: + parent_type: + parent_ids: [] + title: Title 1 + description: '' + body: '' + author_id: 991266892 + state: draft + created_at: 1727856837 + updated_at: 1727856837 + url: highlights: [] pages: type: pages @@ -1413,7 +1489,7 @@ paths: total_pages: 1 per_page: 10 schema: - "$ref": "#/components/schemas/article_search_response" + '$ref': '#/components/schemas/article_search_response' '401': description: Unauthorized content: @@ -1424,20 +1500,24 @@ paths: type: error.list request_id: 84a092d5-9c1c-4017-abdc-afb03b128af5 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" - "/help_center/collections": + '$ref': '#/components/schemas/error' + '/help_center/collections': get: + x-fern-sdk-group-name: + - helpCenter + - collections + x-fern-sdk-method-name: list summary: List all collections parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" + - name: Intercom-Version + in: header + schema: + '$ref': '#/components/schemas/intercom_version' tags: - - Help Center + - Help Center operationId: listAllCollections description: | You can fetch a list of all collections by making a GET request to `https://api.intercom.io/help_center/collections`. @@ -1453,28 +1533,28 @@ paths: value: type: list data: - - id: '88' - workspace_id: this_is_an_id96_that_should_be_at_least_4 - name: English collection title - url: http://help-center.test/myapp-96/collection-17 - order: 17 - created_at: 1727856839 - updated_at: 1727856839 - description: english collection description - icon: bookmark - parent_id: - help_center_id: 48 - - id: '89' - workspace_id: this_is_an_id96_that_should_be_at_least_4 - name: English section title - url: http://help-center.test/myapp-96/section-1 - order: 1 - created_at: 1727856839 - updated_at: 1727856839 - description: - icon: bookmark - parent_id: '88' - help_center_id: + - id: '88' + workspace_id: this_is_an_id96_that_should_be_at_least_4 + name: English collection title + url: http://help-center.test/myapp-96/collection-17 + order: 17 + created_at: 1727856839 + updated_at: 1727856839 + description: english collection description + icon: bookmark + parent_id: + help_center_id: 48 + - id: '89' + workspace_id: this_is_an_id96_that_should_be_at_least_4 + name: English section title + url: http://help-center.test/myapp-96/section-1 + order: 1 + created_at: 1727856839 + updated_at: 1727856839 + description: + icon: bookmark + parent_id: '88' + help_center_id: total_count: 2 pages: type: pages @@ -1482,7 +1562,7 @@ paths: per_page: 20 total_pages: 1 schema: - "$ref": "#/components/schemas/collection_list" + '$ref': '#/components/schemas/collection_list' '401': description: Unauthorized content: @@ -1493,19 +1573,19 @@ paths: type: error.list request_id: 30051b93-dbf3-4b17-bc3d-df93fe4b1146 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' post: summary: Create a collection parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" + - name: Intercom-Version + in: header + schema: + '$ref': '#/components/schemas/intercom_version' tags: - - Help Center + - Help Center operationId: createCollection description: You can create a new collection by making a POST request to `https://api.intercom.io/help_center/collections.` responses: @@ -1517,7 +1597,7 @@ paths: collection created: value: id: '94' - workspace_id: this_is_an_id100_that_should_be_at_least_ + workspace_id: aaa000 name: Thanks for everything url: http://help-center.test/myapp-100/ order: 1 @@ -1528,7 +1608,7 @@ paths: parent_id: help_center_id: 50 schema: - "$ref": "#/components/schemas/collection" + '$ref': '#/components/schemas/collection' '400': description: Bad Request content: @@ -1539,10 +1619,10 @@ paths: type: error.list request_id: 2976e109-3e90-433a-9a58-c795739fd750 errors: - - code: parameter_not_found - message: Name is a required parameter. + - code: parameter_not_found + message: Name is a required parameter. schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -1553,15 +1633,15 @@ paths: type: error.list request_id: 6d2f1b0f-7d09-4cff-afd6-06ecdfa23419 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: - "$ref": "#/components/schemas/create_collection_request" + '$ref': '#/components/schemas/create_collection_request' examples: collection_created: summary: collection created @@ -1571,23 +1651,27 @@ paths: summary: Bad Request value: description: Missing required parameter - "/help_center/collections/{id}": + '/help_center/collections/{id}': get: - summary: Retrieve a collection + x-fern-sdk-group-name: + - helpCenter + - collections + x-fern-sdk-method-name: get + summary: Get a collection parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - - name: id - in: path - required: true - description: The unique identifier for the collection 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 collection which is given by Intercom. + example: 123 + schema: + type: integer tags: - - Help Center + - Help Center operationId: retrieveCollection description: You can fetch the details of a single collection by making a GET request to `https://api.intercom.io/help_center/collections/`. @@ -1600,7 +1684,7 @@ paths: Collection found: value: id: '99' - workspace_id: this_is_an_id106_that_should_be_at_least_ + workspace_id: aaa000 name: English collection title url: http://help-center.test/myapp-106/collection-22 order: 22 @@ -1611,7 +1695,7 @@ paths: parent_id: help_center_id: 53 schema: - "$ref": "#/components/schemas/collection" + '$ref': '#/components/schemas/collection' '404': description: Collection not found content: @@ -1622,10 +1706,10 @@ paths: type: error.list request_id: 9d6ea1af-30cc-4c70-b692-e74b798a50c6 errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -1636,26 +1720,30 @@ paths: type: error.list request_id: 4859234a-b4e2-438c-ad8c-b30ed41ab313 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' put: + x-fern-sdk-group-name: + - helpCenter + - collections + x-fern-sdk-method-name: update summary: Update a collection parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - - name: id - in: path - required: true - description: The unique identifier for the collection 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 collection which is given by Intercom. + example: 123 + schema: + type: integer tags: - - Help Center + - Help Center operationId: updateCollection description: You can update the details of a single collection by making a PUT request to `https://api.intercom.io/collections/`. @@ -1679,7 +1767,7 @@ paths: parent_id: help_center_id: 56 schema: - "$ref": "#/components/schemas/collection" + '$ref': '#/components/schemas/collection' '404': description: Collection Not Found content: @@ -1690,10 +1778,10 @@ paths: type: error.list request_id: 836ac598-181e-457f-bea8-b5dbdf8f73ae errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -1704,15 +1792,15 @@ paths: type: error.list request_id: dbfcbdd3-1761-482d-82c5-0eb285cb9a79 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: - "$ref": "#/components/schemas/update_collection_request" + '$ref': '#/components/schemas/update_collection_request' examples: successful: summary: successful @@ -1723,21 +1811,25 @@ paths: value: name: Update collection name delete: + x-fern-sdk-group-name: + - helpCenter + - collections + x-fern-sdk-method-name: delete summary: Delete a collection parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - - name: id - in: path - required: true - description: The unique identifier for the collection 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 collection which is given by Intercom. + example: 123 + schema: + type: integer tags: - - Help Center + - Help Center operationId: deleteCollection description: You can delete a single collection by making a DELETE request to `https://api.intercom.io/collections/`. @@ -1753,7 +1845,7 @@ paths: object: collection deleted: true schema: - "$ref": "#/components/schemas/deleted_collection_object" + '$ref': '#/components/schemas/deleted_collection_object' '404': description: collection Not Found content: @@ -1764,10 +1856,10 @@ paths: type: error.list request_id: cb237461-fdba-4b97-adf7-9692c92acfe7 errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -1778,27 +1870,31 @@ paths: type: error.list request_id: 5b39cbad-b15f-409e-9428-b57eb94c8b3d errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" - "/help_center/help_centers/{id}": + '$ref': '#/components/schemas/error' + '/help_center/help_centers/{id}': get: + x-fern-sdk-group-name: + - helpCenter + - helpCenters + x-fern-sdk-method-name: get summary: Retrieve a Help Center parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - - name: id - in: path - required: true - description: The unique identifier for the collection 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 collection which is given by Intercom. + example: 123 + schema: + type: integer tags: - - Help Center + - Help Center operationId: retrieveHelpCenter description: You can fetch the details of a single Help Center by making a GET request to `https://api.intercom.io/help_center/help_center/`. @@ -1818,7 +1914,7 @@ paths: website_turned_on: false display_name: Intercom Help Center schema: - "$ref": "#/components/schemas/help_center" + '$ref': '#/components/schemas/help_center' '404': description: Collection not found content: @@ -1829,10 +1925,10 @@ paths: type: error.list request_id: df02015a-7c46-4eee-8f35-0ae268eb75c3 errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -1843,20 +1939,24 @@ paths: type: error.list request_id: 2f844ec3-e4cd-43e9-bf0b-d1064c0ed7cd errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" - "/help_center/help_centers": + '$ref': '#/components/schemas/error' + '/help_center/help_centers': get: - summary: List all Help Centers + x-fern-sdk-group-name: + - helpCenter + - helpCenters + x-fern-sdk-method-name: list + summary: List Help Centers parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" + - name: Intercom-Version + in: header + schema: + '$ref': '#/components/schemas/intercom_version' tags: - - Help Center + - Help Center operationId: listHelpCenters description: You can list all Help Centers by making a GET request to `https://api.intercom.io/help_center/help_centers`. responses: @@ -1870,7 +1970,7 @@ paths: type: list data: [] schema: - "$ref": "#/components/schemas/help_center_list" + '$ref': '#/components/schemas/help_center_list' '401': description: Unauthorized content: @@ -1881,20 +1981,23 @@ paths: type: error.list request_id: 5c488c7a-b061-4880-8da5-ad93865dc8f0 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" - "/companies": + '$ref': '#/components/schemas/error' + '/companies': post: - summary: Create or Update a company + x-fern-sdk-group-name: + - companies + x-fern-sdk-method-name: create + summary: Create a company parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" + - name: Intercom-Version + in: header + schema: + '$ref': '#/components/schemas/intercom_version' tags: - - Companies + - Companies operationId: createOrUpdateCompany description: | You can create or update a company. @@ -1935,7 +2038,7 @@ paths: custom_attributes: creation_source: api schema: - "$ref": "#/components/schemas/company" + '$ref': '#/components/schemas/company' '400': description: Bad Request content: @@ -1946,10 +2049,10 @@ paths: type: error.list request_id: errors: - - code: bad_request - message: bad 'test' parameter + - code: bad_request + message: bad 'test' parameter schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -1960,15 +2063,15 @@ paths: type: error.list request_id: 53f950ad-1395-4b39-a6aa-d4323b8dfd10 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: - "$ref": "#/components/schemas/create_or_update_company_request" + '$ref': '#/components/schemas/create_or_update_company_request' examples: successful: summary: Successful @@ -1981,56 +2084,59 @@ paths: value: test: invalid get: + x-fern-sdk-group-name: + - companies + x-fern-sdk-method-name: list summary: Retrieve companies parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - - name: name - in: query - required: false - description: The `name` of the company to filter by. - example: my company - schema: - type: string - - name: company_id - in: query - required: false - description: The `company_id` of the company to filter by. - example: '12345' - schema: - type: string - - name: tag_id - in: query - required: false - description: The `tag_id` of the company to filter by. - example: '678910' - schema: - type: string - - name: segment_id - in: query - required: false - description: The `segment_id` of the company to filter by. - example: '98765' - schema: - type: string - - name: page - in: query - required: false - description: The page of results to fetch. Defaults to first page - example: 1 - schema: - type: integer - - name: per_page - in: query - required: false - description: How many results to display per page. Defaults to 15 - example: 15 - schema: - type: integer + - name: Intercom-Version + in: header + schema: + '$ref': '#/components/schemas/intercom_version' + - name: name + in: query + required: false + description: The `name` of the company to filter by. + example: my company + schema: + type: string + - name: company_id + in: query + required: false + description: The `company_id` of the company to filter by. + example: '12345' + schema: + type: string + - name: tag_id + in: query + required: false + description: The `tag_id` of the company to filter by. + example: '678910' + schema: + type: string + - name: segment_id + in: query + required: false + description: The `segment_id` of the company to filter by. + example: '98765' + schema: + type: string + - name: page + in: query + required: false + description: The page of results to fetch. Defaults to first page + example: 1 + schema: + type: integer + - name: per_page + in: query + required: false + description: How many results to display per page. Defaults to 15 + example: 15 + schema: + type: integer tags: - - Companies + - Companies operationId: retrieveCompany description: | You can fetch a single company by passing in `company_id` or `name`. @@ -2054,25 +2160,25 @@ paths: value: type: list data: - - type: company - company_id: remote_companies_scroll_2 - id: 66fd00dd9ffbe52cc8b3a9cc - app_id: this_is_an_id153_that_should_be_at_least_ - name: IntercomQATest1 - remote_created_at: 1727856861 - created_at: 1727856861 - updated_at: 1727856861 - monthly_spend: 0 - session_count: 0 - user_count: 4 - tags: - type: tag.list - tags: [] - segments: - type: segment.list - segments: [] - plan: {} - custom_attributes: {} + - type: company + company_id: remote_companies_scroll_2 + id: 66fd00dd9ffbe52cc8b3a9cc + app_id: this_is_an_id153_that_should_be_at_least_ + name: IntercomQATest1 + remote_created_at: 1727856861 + created_at: 1727856861 + updated_at: 1727856861 + monthly_spend: 0 + session_count: 0 + user_count: 4 + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + plan: {} + custom_attributes: {} pages: type: pages next: @@ -2081,7 +2187,7 @@ paths: total_pages: 1 total_count: 1 schema: - "$ref": "#/components/schemas/company_list" + '$ref': '#/components/schemas/company_list' '404': description: Company Not Found content: @@ -2092,10 +2198,10 @@ paths: type: error.list request_id: df490fa4-28c8-4c09-8e13-87be99912f4d errors: - - code: company_not_found - message: Company Not Found + - code: company_not_found + message: Company Not Found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -2106,27 +2212,30 @@ paths: type: error.list request_id: 141f46bf-fa8c-4b64-90ff-db6e23599d75 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" - "/companies/{id}": + '$ref': '#/components/schemas/error' + '/companies/{id}': get: - summary: Retrieve a company by ID + x-fern-sdk-group-name: + - companies + x-fern-sdk-method-name: get + summary: Get a company by ID parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - - name: id - in: path - required: true - description: The unique identifier for the company which is given by Intercom - example: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 - 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 company which is given by Intercom + example: 6634ab5eafff231757496dd7 + schema: + type: string tags: - - Companies + - Companies operationId: RetrieveACompanyById description: You can fetch a single company. responses: @@ -2157,7 +2266,7 @@ paths: plan: {} custom_attributes: {} schema: - "$ref": "#/components/schemas/company" + '$ref': '#/components/schemas/company' '404': description: Company Not Found content: @@ -2168,10 +2277,10 @@ paths: type: error.list request_id: 56c7582d-9ae7-4f22-af29-3570044a0ea5 errors: - - code: company_not_found - message: Company Not Found + - code: company_not_found + message: Company Not Found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -2182,26 +2291,29 @@ paths: type: error.list request_id: 7ce5547a-717d-4441-b968-cbda363ec7fb errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' put: + x-fern-sdk-group-name: + - companies + x-fern-sdk-method-name: update summary: Update a company parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - - name: id - in: path - required: true - description: The unique identifier for the company which is given by Intercom - example: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 - 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 company which is given by Intercom + example: 6634ab5eafff231757496dd7 + schema: + type: string tags: - - Companies + - Companies operationId: UpdateCompany description: | You can update a single company using the Intercom provisioned `id`. @@ -2237,7 +2349,7 @@ paths: plan: {} custom_attributes: {} schema: - "$ref": "#/components/schemas/company" + '$ref': '#/components/schemas/company' '404': description: Company Not Found content: @@ -2248,10 +2360,10 @@ paths: type: error.list request_id: 5e589fe7-2913-47d2-b711-61129cf91c51 errors: - - code: company_not_found - message: Company Not Found + - code: company_not_found + message: Company Not Found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -2262,26 +2374,29 @@ paths: type: error.list request_id: 23d7c88a-c971-401b-9085-a0191cf7ac6a errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' delete: + x-fern-sdk-group-name: + - companies + x-fern-sdk-method-name: delete summary: Delete a company parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - - name: id - in: path - required: true - description: The unique identifier for the company which is given by Intercom - example: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 - 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 company which is given by Intercom + example: 6634ab5eafff231757496dd7 + schema: + type: string tags: - - Companies + - Companies operationId: deleteCompany description: You can delete a single company. responses: @@ -2296,7 +2411,7 @@ paths: object: company deleted: true schema: - "$ref": "#/components/schemas/deleted_company_object" + '$ref': '#/components/schemas/deleted_company_object' '404': description: Company Not Found content: @@ -2307,10 +2422,10 @@ paths: type: error.list request_id: 9d76873f-1164-4838-bc98-710a51a8f765 errors: - - code: company_not_found - message: Company Not Found + - code: company_not_found + message: Company Not Found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -2321,28 +2436,32 @@ paths: type: error.list request_id: 69c21889-2980-4a4a-a028-ca47480205f0 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" - "/companies/{id}/contacts": + '$ref': '#/components/schemas/error' + '/companies/{id}/contacts': get: + x-fern-sdk-group-name: + - companies + - contacts + x-fern-sdk-method-name: list summary: List attached contacts parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - - name: id - in: path - required: true - description: The unique identifier for the company which is given by Intercom - example: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 - 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 company which is given by Intercom + example: 6634ab5eafff231757496dd7 + schema: + type: string tags: - - Companies - - Contacts + - Companies + - Contacts operationId: ListAttachedContacts description: You can fetch a list of all contacts that belong to a company. responses: @@ -2362,7 +2481,7 @@ paths: per_page: 50 total_pages: 0 schema: - "$ref": "#/components/schemas/company_attached_contacts" + '$ref': '#/components/schemas/company_attached_contacts' '404': description: Company Not Found content: @@ -2373,10 +2492,10 @@ paths: type: error.list request_id: d1064107-cae5-4747-befc-b320a73f9a93 errors: - - code: company_not_found - message: Company Not Found + - code: company_not_found + message: Company Not Found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -2387,27 +2506,31 @@ paths: type: error.list request_id: f8b7b87c-0fcd-4e76-bbfa-2df4cee2dfd2 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" - "/companies/{id}/segments": + '$ref': '#/components/schemas/error' + '/companies/{id}/segments': get: + x-fern-sdk-group-name: + - companies + - segments + x-fern-sdk-method-name: list summary: List attached segments for companies parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - - name: id - in: path - required: true - description: The unique identifier for the company which is given by Intercom - example: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 - 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 company which is given by Intercom + example: 6634ab5eafff231757496dd7 + schema: + type: string tags: - - Companies + - Companies operationId: ListAttachedSegmentsForCompanies description: You can fetch a list of all segments that belong to a company. responses: @@ -2421,7 +2544,7 @@ paths: type: list data: [] schema: - "$ref": "#/components/schemas/company_attached_segments" + '$ref': '#/components/schemas/company_attached_segments' '404': description: Company Not Found content: @@ -2432,10 +2555,10 @@ paths: type: error.list request_id: a37aefd0-2de3-4eb2-b2cf-9d28fcc59c89 errors: - - code: company_not_found - message: Company Not Found + - code: company_not_found + message: Company Not Found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -2446,47 +2569,50 @@ paths: type: error.list request_id: fc4f6acb-0315-42e6-9adc-d5d5939fea8c errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" - "/companies/list": + '$ref': '#/components/schemas/error' + '/companies/list': post: + x-fern-sdk-group-name: + - companies + x-fern-sdk-method-name: list summary: List all companies parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - - name: page - in: query - required: false - description: The page of results to fetch. Defaults to first page - example: 1 - schema: - type: integer - - name: per_page - in: query - required: false - description: How many results to return per page. Defaults to 15 - example: 15 - schema: - type: integer - - name: order - in: query - required: false - description: "`asc` or `desc`. Return the companies in ascending or descending - order. Defaults to desc" - example: desc - schema: - type: string + - name: Intercom-Version + in: header + schema: + '$ref': '#/components/schemas/intercom_version' + - name: page + in: query + required: false + description: The page of results to fetch. Defaults to first page + example: 1 + schema: + type: integer + - name: per_page + in: query + required: false + description: How many results to return per page. Defaults to 15 + example: 15 + schema: + type: integer + - name: order + in: query + required: false + description: '`asc` or `desc`. Return the companies in ascending or descending + order. Defaults to desc' + example: desc + schema: + type: string tags: - - Companies + - Companies operationId: listAllCompanies description: | - You can list companies. The company list is sorted by the `last_request_at` field and by default is ordered descending, most recently requested first. + The company list is sorted by the `last_request_at` field and by default is ordered descending, most recently requested first. - Note that the API does not include companies who have no associated users in list responses. + The API does not include companies who have no associated users in list responses. When using the Companies endpoint and the pages object to iterate through the returned companies, there is a limit of 10,000 Companies that can be returned. If you need to list or iterate on more than 10,000 Companies, please use the [Scroll API](https://developers.intercom.com/reference#iterating-over-all-companies). {% admonition type="warning" name="Pagination" %} @@ -2503,25 +2629,25 @@ paths: value: type: list data: - - type: company - company_id: remote_companies_scroll_2 - id: 66fd00f19ffbe52cc8b3aa07 - app_id: this_is_an_id189_that_should_be_at_least_ - name: IntercomQATest1 - remote_created_at: 1727856881 - created_at: 1727856881 - updated_at: 1727856881 - monthly_spend: 0 - session_count: 0 - user_count: 4 - tags: - type: tag.list - tags: [] - segments: - type: segment.list - segments: [] - plan: {} - custom_attributes: {} + - type: company + company_id: remote_companies_scroll_2 + id: 66fd00f19ffbe52cc8b3aa07 + app_id: this_is_an_id189_that_should_be_at_least_ + name: IntercomQATest1 + remote_created_at: 1727856881 + created_at: 1727856881 + updated_at: 1727856881 + monthly_spend: 0 + session_count: 0 + user_count: 4 + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + plan: {} + custom_attributes: {} pages: type: pages next: @@ -2530,7 +2656,7 @@ paths: total_pages: 1 total_count: 1 schema: - "$ref": "#/components/schemas/company_list" + '$ref': '#/components/schemas/company_list' '401': description: Unauthorized content: @@ -2541,26 +2667,29 @@ paths: type: error.list request_id: 12c3a436-fdaf-445e-9dd1-1346ecb33c45 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" - "/companies/scroll": + '$ref': '#/components/schemas/error' + '/companies/scroll': get: + x-fern-sdk-group-name: + - companies + x-fern-sdk-method-name: scroll summary: Scroll over all companies parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - - name: scroll_param - in: query - required: false - description: '' - schema: - type: string + - name: Intercom-Version + in: header + schema: + '$ref': '#/components/schemas/intercom_version' + - name: scroll_param + in: query + required: false + description: '' + schema: + type: string tags: - - Companies + - Companies operationId: scrollOverAllCompanies description: |2 The `list all companies` functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. The Scroll API provides an efficient mechanism for iterating over all companies in a dataset. @@ -2588,30 +2717,30 @@ paths: value: type: list data: - - type: company - company_id: remote_companies_scroll_2 - id: 66fd00f39ffbe52cc8b3aa0d - app_id: this_is_an_id193_that_should_be_at_least_ - name: IntercomQATest1 - remote_created_at: 1727856883 - created_at: 1727856883 - updated_at: 1727856883 - monthly_spend: 0 - session_count: 0 - user_count: 4 - tags: - type: tag.list - tags: [] - segments: - type: segment.list - segments: [] - plan: {} - custom_attributes: {} - pages: - total_count: + - type: company + company_id: 0fec4640-dd4d-4229-b591-002dc70c7282 + id: 66fd00f39ffbe52cc8b3aa0d + app_id: aaa000 + name: Example Company + remote_created_at: 1727856883 + created_at: 1727856883 + updated_at: 1727856883 + monthly_spend: 0 + session_count: 0 + user_count: 4 + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + plan: {} + custom_attributes: {} + pages: null + total_count: null scroll_param: 6f0c010d-8de4-411d-8cf2-6fb728d4941a schema: - "$ref": "#/components/schemas/company_scroll" + '$ref': '#/components/schemas/company_scroll' '401': description: Unauthorized content: @@ -2622,27 +2751,31 @@ paths: type: error.list request_id: a0506b9b-d0d5-46b7-bb6c-392f2e82c226 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" - "/contacts/{id}/companies": + '$ref': '#/components/schemas/error' + '/contacts/{id}/companies': post: + x-fern-sdk-group-name: + - companies + - contacts + x-fern-sdk-method-name: attach summary: Attach a Contact to a Company parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - - name: id - in: path - required: true - description: The unique identifier for the contact 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 contact which is given by Intercom + schema: + type: string tags: - - Companies - - Contacts + - Companies + - Contacts operationId: attachContactToACompany description: You can attach a company to a single contact. responses: @@ -2654,10 +2787,10 @@ paths: Successful: value: type: company - company_id: '1' + company_id: 0fec4640-dd4d-4229-b591-002dc70c7282 id: 66fd00f69ffbe52cc8b3aa16 - app_id: this_is_an_id197_that_should_be_at_least_ - name: company6 + app_id: aaa000 + name: Example Company remote_created_at: 1727856886 created_at: 1727856886 updated_at: 1727856886 @@ -2673,7 +2806,7 @@ paths: plan: {} custom_attributes: {} schema: - "$ref": "#/components/schemas/company" + '$ref': '#/components/schemas/company' '400': description: Bad Request content: @@ -2684,10 +2817,10 @@ paths: type: error.list request_id: 6c18323d-7c0c-430a-8315-62c7688d9221 errors: - - code: parameter_not_found - message: company not specified + - code: parameter_not_found + message: company not specified schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '404': description: Company Not Found content: @@ -2698,10 +2831,10 @@ paths: type: error.list request_id: 0dbe8e3d-efe4-49b7-a4e6-84b477ccff9e errors: - - code: company_not_found - message: Company Not Found + - code: company_not_found + message: Company Not Found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -2712,17 +2845,17 @@ paths: type: error.list request_id: 46cd55fe-5c27-4ec8-98e0-bfd9c1d2a490 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: type: object required: - - id + - id properties: id: type: string @@ -2742,22 +2875,26 @@ paths: value: id: '123' get: - summary: List attached companies for contact + x-fern-sdk-group-name: + - companies + - contacts + x-fern-sdk-method-name: list + summary: List companies associated with acontact parameters: - - name: 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: 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 - - Companies + - Contacts + - Companies operationId: listCompaniesForAContact description: You can fetch a list of companies that are associated to a contact. responses: @@ -2770,26 +2907,26 @@ paths: value: type: list data: - - type: company - company_id: '1' - id: 66fd01009ffbe52cc8b3aa37 - app_id: this_is_an_id213_that_should_be_at_least_ - name: company12 - remote_created_at: 1727856896 - created_at: 1727856896 - updated_at: 1727856896 - last_request_at: 1727684096 - monthly_spend: 0 - session_count: 0 - user_count: 1 - tags: - type: tag.list - tags: [] - segments: - type: segment.list - segments: [] - plan: {} - custom_attributes: {} + - type: company + company_id: '1' + id: 66fd01009ffbe52cc8b3aa37 + app_id: this_is_an_id213_that_should_be_at_least_ + name: company12 + remote_created_at: 1727856896 + created_at: 1727856896 + updated_at: 1727856896 + last_request_at: 1727684096 + monthly_spend: 0 + session_count: 0 + user_count: 1 + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + plan: {} + custom_attributes: {} pages: type: pages next: @@ -2798,7 +2935,7 @@ paths: total_pages: 1 total_count: 1 schema: - "$ref": "#/components/schemas/contact_attached_companies" + '$ref': '#/components/schemas/contact_attached_companies' '404': description: Contact not found content: @@ -2809,10 +2946,10 @@ paths: type: error.list request_id: df816646-79c4-4d81-92fd-3f2710c3e72d errors: - - code: not_found - message: User Not Found + - code: not_found + message: User Not Found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -2823,35 +2960,39 @@ paths: type: error.list request_id: 9b1176e4-c54b-4931-b8c5-401de4ca35e3 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" - "/contacts/{contact_id}/companies/{id}": + '$ref': '#/components/schemas/error' + '/contacts/{contact_id}/companies/{id}': delete: + x-fern-sdk-group-name: + - companies + - contacts + x-fern-sdk-method-name: detach summary: Detach a contact from a company parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - - name: contact_id - in: path - required: true - description: The unique identifier for the contact which is given by Intercom - example: 58a430d35458202d41b1e65b - schema: - type: string - - name: id - in: path - required: true - description: The unique identifier for the company which is given by Intercom - example: 58a430d35458202d41b1e65b - schema: - type: string + - name: Intercom-Version + in: header + schema: + '$ref': '#/components/schemas/intercom_version' + - name: contact_id + in: path + required: true + description: The unique identifier for the contact which is given by Intercom + example: 58a430d35458202d41b1e65b + schema: + type: string + - name: id + in: path + required: true + description: The unique identifier for the company which is given by Intercom + example: 58a430d35458202d41b1e65b + schema: + type: string tags: - - Companies - - Contacts + - Companies + - Contacts operationId: detachContactFromACompany description: You can detach a company from a single contact. responses: @@ -2882,7 +3023,7 @@ paths: plan: {} custom_attributes: {} schema: - "$ref": "#/components/schemas/company" + '$ref': '#/components/schemas/company' '404': description: Contact Not Found content: @@ -2893,17 +3034,17 @@ paths: type: error.list request_id: 14121a1a-a146-4035-8073-5e63897bffec errors: - - code: company_not_found - message: Company Not Found + - code: company_not_found + message: Company Not Found Contact Not Found: value: type: error.list request_id: 714bd18d-28aa-46e0-bea2-1fd0881185a4 errors: - - code: not_found - message: User Not Found + - code: not_found + message: User Not Found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -2914,27 +3055,31 @@ paths: type: error.list request_id: 891db4db-706e-4d1a-a0c2-6d0bd8a2c0bc errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" - "/contacts/{id}/notes": + '$ref': '#/components/schemas/error' + '/contacts/{id}/notes': get: + x-fern-sdk-group-name: + - notes + - contacts + x-fern-sdk-method-name: list summary: List all notes parameters: - - name: id - in: path - required: true - description: The unique identifier of a contact. - 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 contact. + schema: + type: integer + - name: Intercom-Version + in: header + schema: + '$ref': '#/components/schemas/intercom_version' tags: - - Notes - - Contacts + - Notes + - Contacts operationId: listNotes description: You can fetch a list of notes that are associated to a contact. responses: @@ -2947,48 +3092,48 @@ paths: value: type: list data: - - type: note - id: '16' - created_at: 1727252100 - contact: - type: contact - id: 66fd01049ffbe52cc8b3aa42 - author: - type: admin - id: '991266952' - name: Ciaran122 Lee - email: admin122@email.com - away_mode_enabled: false - away_mode_reassign: false - body: "

This is a note.

" - - type: note - id: '15' - created_at: 1727165700 - contact: - type: contact - id: 66fd01049ffbe52cc8b3aa42 - author: - type: admin - id: '991266952' - name: Ciaran122 Lee - email: admin122@email.com - away_mode_enabled: false - away_mode_reassign: false - body: "

This is a note.

" - - type: note - id: '14' - created_at: 1727165700 - contact: - type: contact - id: 66fd01049ffbe52cc8b3aa42 - author: - type: admin - id: '991266952' - name: Ciaran122 Lee - email: admin122@email.com - away_mode_enabled: false - away_mode_reassign: false - body: "

This is a note.

" + - type: note + id: '16' + created_at: 1727252100 + contact: + type: contact + id: 66fd01049ffbe52cc8b3aa42 + author: + type: admin + id: '991266952' + name: Jane Example + email: email@example.com + away_mode_enabled: false + away_mode_reassign: false + body: '

This is a note.

' + - type: note + id: '15' + created_at: 1727165700 + contact: + type: contact + id: 66fd01049ffbe52cc8b3aa42 + author: + type: admin + id: '991266952' + name: Joe Example + email: email@example.com + away_mode_enabled: false + away_mode_reassign: false + body: '

This is a note.

' + - type: note + id: '14' + created_at: 1727165700 + contact: + type: contact + id: 66fd01049ffbe52cc8b3aa42 + author: + type: admin + id: '991266952' + name: Jane Example + email: email@example.com + away_mode_enabled: false + away_mode_reassign: false + body: '

This is a note.

' total_count: 3 pages: type: pages @@ -2997,7 +3142,7 @@ paths: per_page: 50 total_pages: 1 schema: - "$ref": "#/components/schemas/note_list" + '$ref': '#/components/schemas/note_list' '404': description: Contact not found content: @@ -3008,27 +3153,31 @@ paths: type: error.list request_id: 69dae9ea-0711-4dd9-af8b-aedc7c1e34c3 errors: - - code: not_found - message: User Not Found + - code: not_found + message: User Not Found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' post: + x-fern-sdk-group-name: + - notes + - contacts + x-fern-sdk-method-name: create 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: @@ -3048,13 +3197,13 @@ paths: author: type: admin id: '991266954' - name: Ciaran124 Lee - email: admin124@email.com + name: Jane Example + email: email@example.com away_mode_enabled: false away_mode_reassign: false - body: "

Hello

" + body: '

Hello

' schema: - "$ref": "#/components/schemas/note" + '$ref': '#/components/schemas/note' '404': description: Contact not found content: @@ -3065,24 +3214,24 @@ paths: type: error.list request_id: d6a77f1d-7eb7-4af9-9807-13c9b2058ceb errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found Contact not found: value: type: error.list request_id: bdac6716-6720-4990-bc1f-a283574ceaee errors: - - code: not_found - message: User Not Found + - code: not_found + message: User Not Found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: type: object required: - - body + - body properties: body: type: string @@ -3115,24 +3264,28 @@ paths: contact_id: 123 admin_id: 991266956 body: Hello - "/contacts/{contact_id}/segments": + '/contacts/{contact_id}/segments': get: - summary: List attached segments for contact + x-fern-sdk-group-name: + - segments + - contacts + x-fern-sdk-method-name: list + summary: List segments 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 - - Segments + - Contacts + - Segments operationId: listSegmentsForAContact description: You can fetch a list of segments that are associated to a contact. responses: @@ -3145,14 +3298,14 @@ paths: value: type: list data: - - type: segment - id: 66fd010a9ffbe52cc8b3aa47 - name: segment - created_at: 1727856906 - updated_at: 1727856906 - person_type: user - schema: - "$ref": "#/components/schemas/contact_segments" + - type: segment + id: 66fd010a9ffbe52cc8b3aa47 + name: segment + created_at: 1727856906 + updated_at: 1727856906 + person_type: user + schema: + '$ref': '#/components/schemas/contact_segments' '404': description: Contact not found content: @@ -3163,10 +3316,10 @@ paths: type: error.list request_id: f5eaedc9-9c7e-467c-83cf-2bb27a1ab70e errors: - - code: not_found - message: User Not Found + - code: not_found + message: User Not Found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -3177,28 +3330,32 @@ paths: type: error.list request_id: 0d5bd439-7eb7-4c83-861b-804a3c666c5d errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" - "/contacts/{contact_id}/subscriptions": + '$ref': '#/components/schemas/error' + '/contacts/{contact_id}/subscriptions': get: + x-fern-sdk-group-name: + - subscriptionTypes + - contacts + x-fern-sdk-method-name: list 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. @@ -3218,36 +3375,36 @@ paths: value: type: list data: - - type: subscription - id: '47' - 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: '49' - 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" + - type: subscription + id: '47' + 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: '49' + state: live + consent_type: opt_in + default_translation: + name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + translations: + - name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + content_types: + - sms_message + schema: + '$ref': '#/components/schemas/subscription_type_list' '404': description: Contact not found content: @@ -3258,10 +3415,10 @@ paths: type: error.list request_id: a3b635b2-18b4-4050-bb95-eb7d350d645e errors: - - code: not_found - message: User Not Found + - code: not_found + message: User Not Found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -3272,27 +3429,31 @@ paths: type: error.list request_id: 16e6d3d1-3105-42c3-8612-077ce9b5c871 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' post: - summary: Add subscription to a contact + x-fern-sdk-group-name: + - subscriptions + - contacts + x-fern-sdk-method-name: attach + summary: Add a 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: @@ -3319,13 +3480,13 @@ 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" + '$ref': '#/components/schemas/subscription_type' '404': description: Resource not found content: @@ -3336,17 +3497,17 @@ paths: type: error.list request_id: fd87c3e0-af0e-4144-8cd9-13734a4dc1e0 errors: - - code: not_found - message: User Not Found + - code: not_found + message: User Not Found Resource not found: value: type: error.list request_id: 6a8feb4c-981d-453e-ade0-5725de361dad errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -3357,18 +3518,18 @@ paths: type: error.list request_id: 03cf16eb-c261-4c29-9d7b-471822531291 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: type: object required: - - id - - consent_type + - id + - consent_type properties: id: type: string @@ -3395,32 +3556,36 @@ paths: value: id: invalid_id consent_type: opt_in - "/contacts/{contact_id}/subscriptions/{id}": + '/contacts/{contact_id}/subscriptions/{id}': delete: - summary: Remove subscription from a contact + x-fern-sdk-group-name: + - subscriptions + - contacts + x-fern-sdk-method-name: detach + summary: Remove a 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 @@ -3442,13 +3607,13 @@ 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" + '$ref': '#/components/schemas/subscription_type' '404': description: Resource not found content: @@ -3459,17 +3624,17 @@ paths: type: error.list request_id: 12fb835c-7ed9-496c-b2aa-ccb8de94e670 errors: - - code: not_found - message: User Not Found + - code: not_found + message: User Not Found Resource not found: value: type: error.list request_id: d9f37d47-4ae5-4219-a915-4e4eab5d73ec errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -3480,28 +3645,32 @@ paths: type: error.list request_id: ea6d6c78-cfb3-47c4-b49b-182214870200 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" - "/contacts/{contact_id}/tags": + '$ref': '#/components/schemas/error' + '/contacts/{contact_id}/tags': get: + x-fern-sdk-group-name: + - tags + - contacts + x-fern-sdk-method-name: list 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. @@ -3515,11 +3684,11 @@ paths: value: type: list data: - - type: tag - id: '47' - name: Manual tag + - type: tag + id: '47' + name: Manual tag schema: - "$ref": "#/components/schemas/tag_list" + '$ref': '#/components/schemas/tag_list' '404': description: Contact not found content: @@ -3530,10 +3699,10 @@ paths: type: error.list request_id: 677e9745-29e7-4651-86bf-c33caa803fdb errors: - - code: not_found - message: User Not Found + - code: not_found + message: User Not Found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -3544,27 +3713,31 @@ paths: type: error.list request_id: c97b42ad-c524-438e-ba9f-b34a50b5a458 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' post: + x-fern-sdk-group-name: + - tags + - contacts + x-fern-sdk-method-name: add 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. @@ -3580,7 +3753,7 @@ paths: id: '48' name: Manual tag schema: - "$ref": "#/components/schemas/tag" + '$ref': '#/components/schemas/tag' '404': description: Tag not found content: @@ -3591,17 +3764,17 @@ paths: type: error.list request_id: 836128ff-c99d-4fe8-86e0-c49fe95f0b4b errors: - - code: not_found - message: User Not Found + - code: not_found + message: User Not Found Tag not found: value: type: error.list request_id: b3036f7a-1747-46ae-a936-6eecdaf00035 errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -3612,17 +3785,17 @@ paths: type: error.list request_id: 362b4ff1-e885-46a2-9eed-28467e242aad errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: type: object required: - - id + - id properties: id: type: string @@ -3642,31 +3815,35 @@ paths: summary: Tag not found value: id: '123' - "/contacts/{contact_id}/tags/{id}": + '/contacts/{contact_id}/tags/{id}': delete: + x-fern-sdk-group-name: + - tags + - contacts + x-fern-sdk-method-name: remove 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. @@ -3682,7 +3859,7 @@ paths: id: '51' name: Manual tag schema: - "$ref": "#/components/schemas/tag" + '$ref': '#/components/schemas/tag' '404': description: Tag not found content: @@ -3693,17 +3870,17 @@ paths: type: error.list request_id: 5192f776-12c4-4e22-b056-328dd42381ad errors: - - code: not_found - message: User Not Found + - code: not_found + message: User Not Found Tag not found: value: type: error.list request_id: 689e4255-3285-4b93-96c1-1a1042cb7c4a errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -3714,27 +3891,30 @@ paths: type: error.list request_id: '097cc71a-add9-489a-a1e5-6eed83b99d51' errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" - "/contacts/{id}": + '$ref': '#/components/schemas/error' + '/contacts/{id}': put: + x-fern-sdk-group-name: + - contacts + x-fern-sdk-method-name: update 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 + - Contacts operationId: UpdateContact description: You can update an existing contact (ie. user or lead). responses: @@ -3798,31 +3978,31 @@ paths: tags: type: list data: [] - url: "/contacts/66fd01239ffbe52cc8b3aa5e/tags" + url: '/contacts/66fd01239ffbe52cc8b3aa5e/tags' total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/66fd01239ffbe52cc8b3aa5e/notes" + url: '/contacts/66fd01239ffbe52cc8b3aa5e/notes' total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/66fd01239ffbe52cc8b3aa5e/companies" + url: '/contacts/66fd01239ffbe52cc8b3aa5e/companies' total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/66fd01239ffbe52cc8b3aa5e/subscriptions" + url: '/contacts/66fd01239ffbe52cc8b3aa5e/subscriptions' total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/66fd01239ffbe52cc8b3aa5e/subscriptions" + url: '/contacts/66fd01239ffbe52cc8b3aa5e/subscriptions' total_count: 0 has_more: false utm_campaign: @@ -3832,7 +4012,7 @@ paths: utm_term: referrer: schema: - "$ref": "#/components/schemas/contact" + '$ref': '#/components/schemas/contact' '401': description: Unauthorized content: @@ -3843,16 +4023,16 @@ paths: type: error.list request_id: b2f4b92f-9a9b-4888-b9ca-95aae731dc48 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: oneOf: - - "$ref": "#/components/schemas/update_contact_request" + - '$ref': '#/components/schemas/update_contact_request' examples: successful: summary: successful @@ -3860,21 +4040,24 @@ paths: email: joebloggs@intercom.io name: joe bloggs get: + x-fern-sdk-group-name: + - contacts + x-fern-sdk-method-name: 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: @@ -3938,31 +4121,31 @@ paths: tags: type: list data: [] - url: "/contacts/66fd01259ffbe52cc8b3aa5f/tags" + url: '/contacts/66fd01259ffbe52cc8b3aa5f/tags' total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/66fd01259ffbe52cc8b3aa5f/notes" + url: '/contacts/66fd01259ffbe52cc8b3aa5f/notes' total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/66fd01259ffbe52cc8b3aa5f/companies" + url: '/contacts/66fd01259ffbe52cc8b3aa5f/companies' total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/66fd01259ffbe52cc8b3aa5f/subscriptions" + url: '/contacts/66fd01259ffbe52cc8b3aa5f/subscriptions' total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/66fd01259ffbe52cc8b3aa5f/subscriptions" + url: '/contacts/66fd01259ffbe52cc8b3aa5f/subscriptions' total_count: 0 has_more: false utm_campaign: @@ -3972,7 +4155,7 @@ paths: utm_term: referrer: schema: - "$ref": "#/components/schemas/contact" + '$ref': '#/components/schemas/contact' '401': description: Unauthorized content: @@ -3983,25 +4166,28 @@ paths: type: error.list request_id: 0e8e7323-189a-4257-9e71-2cbdb93b56c2 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' delete: + x-fern-sdk-group-name: + - contacts + x-fern-sdk-method-name: 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: @@ -4017,7 +4203,7 @@ paths: type: contact deleted: true schema: - "$ref": "#/components/schemas/contact_deleted" + '$ref': '#/components/schemas/contact_deleted' '401': description: Unauthorized content: @@ -4028,20 +4214,23 @@ paths: type: error.list request_id: fe391f69-e134-49dd-ba65-5bb49fe412e0 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" - "/contacts/merge": + '$ref': '#/components/schemas/error' + '/contacts/merge': post: + x-fern-sdk-group-name: + - contacts + x-fern-sdk-method-name: merge 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`. @@ -4106,31 +4295,31 @@ paths: tags: type: list data: [] - url: "/contacts/66fd01299ffbe52cc8b3aa62/tags" + url: '/contacts/66fd01299ffbe52cc8b3aa62/tags' total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/66fd01299ffbe52cc8b3aa62/notes" + url: '/contacts/66fd01299ffbe52cc8b3aa62/notes' total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/66fd01299ffbe52cc8b3aa62/companies" + url: '/contacts/66fd01299ffbe52cc8b3aa62/companies' total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/66fd01299ffbe52cc8b3aa62/subscriptions" + url: '/contacts/66fd01299ffbe52cc8b3aa62/subscriptions' total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/66fd01299ffbe52cc8b3aa62/subscriptions" + url: '/contacts/66fd01299ffbe52cc8b3aa62/subscriptions' total_count: 0 has_more: false utm_campaign: @@ -4140,7 +4329,7 @@ paths: utm_term: referrer: schema: - "$ref": "#/components/schemas/contact" + '$ref': '#/components/schemas/contact' '401': description: Unauthorized content: @@ -4151,38 +4340,37 @@ paths: type: error.list request_id: 7bb0d16d-62f8-4e6f-aed8-fd7ee19bb4eb errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: - "$ref": "#/components/schemas/merge_contacts_request" + '$ref': '#/components/schemas/merge_contacts_request' examples: successful: summary: successful value: from: 66fd01299ffbe52cc8b3aa61 into: 66fd01299ffbe52cc8b3aa62 - "/contacts/search": + '/contacts/search': post: + x-fern-sdk-group-name: + - contacts + x-fern-sdk-method-name: search 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. - - To search for contacts, you need to send a `POST` request to `https://api.intercom.io/contacts/search`. - - This will accept a query object in the body which will define your filters in order to search for contacts. + Find multiple contacts by filtering on specified attributes. {% admonition type="warning" name="Optimizing search queries" %} Search queries can be complex, so optimizing them can help the performance of your search. @@ -4295,7 +4483,7 @@ paths: per_page: 5 total_pages: 0 schema: - "$ref": "#/components/schemas/contact_list" + '$ref': '#/components/schemas/contact_list' '401': description: Unauthorized content: @@ -4306,15 +4494,15 @@ paths: type: error.list request_id: c055b158-ec01-49c5-b16a-8eb13db90c0d errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: - "$ref": "#/components/schemas/search_request" + '$ref': '#/components/schemas/search_request' examples: successful: summary: successful @@ -4322,21 +4510,24 @@ paths: query: operator: AND value: - - field: created_at - operator: ">" - value: '1306054154' + - field: created_at + operator: '>' + value: '1306054154' pagination: per_page: 5 - "/contacts": + '/contacts': get: + x-fern-sdk-group-name: + - contacts + x-fern-sdk-method-name: list 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. @@ -4361,7 +4552,7 @@ paths: per_page: 10 total_pages: 0 schema: - "$ref": "#/components/schemas/contact_list" + '$ref': '#/components/schemas/contact_list' '401': description: Unauthorized content: @@ -4372,19 +4563,22 @@ paths: type: error.list request_id: 9592a707-0231-4d17-bc4a-afd5d2f95440 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' post: + x-fern-sdk-group-name: + - contacts + x-fern-sdk-method-name: create 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: @@ -4448,31 +4642,31 @@ paths: tags: type: list data: [] - url: "/contacts/66fd01309ffbe52cc8b3aa65/tags" + url: '/contacts/66fd01309ffbe52cc8b3aa65/tags' total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/66fd01309ffbe52cc8b3aa65/notes" + url: '/contacts/66fd01309ffbe52cc8b3aa65/notes' total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/66fd01309ffbe52cc8b3aa65/companies" + url: '/contacts/66fd01309ffbe52cc8b3aa65/companies' total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/66fd01309ffbe52cc8b3aa65/subscriptions" + url: '/contacts/66fd01309ffbe52cc8b3aa65/subscriptions' total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/66fd01309ffbe52cc8b3aa65/subscriptions" + url: '/contacts/66fd01309ffbe52cc8b3aa65/subscriptions' total_count: 0 has_more: false utm_campaign: @@ -4482,7 +4676,7 @@ paths: utm_term: referrer: schema: - "$ref": "#/components/schemas/contact" + '$ref': '#/components/schemas/contact' '401': description: Unauthorized content: @@ -4493,38 +4687,42 @@ paths: type: error.list request_id: ebe26426-9c95-455c-ad5d-dd6f8366b20e errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: oneOf: - - "$ref": "#/components/schemas/create_contact_request" + - '$ref': '#/components/schemas/create_contact_request' examples: successful: summary: successful value: email: joebloggs@intercom.io - "/contacts/find_by_external_id/{external_id}": + '/contacts/find_by_external_id/{external_id}': get: + x-fern-sdk-group-name: + - contacts + - externalId + x-fern-sdk-method-name: 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. @@ -4589,31 +4787,31 @@ paths: tags: type: list data: [] - url: "/contacts/66fd01329ffbe52cc8b3aa66/tags" + url: '/contacts/66fd01329ffbe52cc8b3aa66/tags' total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/66fd01329ffbe52cc8b3aa66/notes" + url: '/contacts/66fd01329ffbe52cc8b3aa66/notes' total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/66fd01329ffbe52cc8b3aa66/companies" + url: '/contacts/66fd01329ffbe52cc8b3aa66/companies' total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/66fd01329ffbe52cc8b3aa66/subscriptions" + url: '/contacts/66fd01329ffbe52cc8b3aa66/subscriptions' total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/66fd01329ffbe52cc8b3aa66/subscriptions" + url: '/contacts/66fd01329ffbe52cc8b3aa66/subscriptions' total_count: 0 has_more: false utm_campaign: @@ -4623,7 +4821,7 @@ paths: utm_term: referrer: schema: - "$ref": "#/components/schemas/contact" + '$ref': '#/components/schemas/contact' '401': description: Unauthorized content: @@ -4634,27 +4832,30 @@ paths: type: error.list request_id: 2093ae35-8bf9-49d4-8c11-57771e4b3c06 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" - "/contacts/{id}/archive": + '$ref': '#/components/schemas/error' + '/contacts/{id}/archive': post: + x-fern-sdk-group-name: + - contacts + x-fern-sdk-method-name: archive 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: @@ -4670,24 +4871,27 @@ paths: type: contact archived: true schema: - "$ref": "#/components/schemas/contact_archived" - "/contacts/{id}/unarchive": + '$ref': '#/components/schemas/contact_archived' + '/contacts/{id}/unarchive': post: + x-fern-sdk-group-name: + - contacts + x-fern-sdk-method-name: unarchive 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: @@ -4703,25 +4907,29 @@ paths: type: contact archived: false schema: - "$ref": "#/components/schemas/contact_unarchived" - "/conversations/{conversation_id}/tags": + '$ref': '#/components/schemas/contact_unarchived' + '/conversations/{conversation_id}/tags': post: + x-fern-sdk-group-name: + - tags + - conversations + x-fern-sdk-method-name: add summary: Add tag to a conversation parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - - name: conversation_id - in: path - description: conversation_id - example: '64619700005694' - required: true - schema: - type: string + - name: Intercom-Version + in: header + schema: + '$ref': '#/components/schemas/intercom_version' + - name: conversation_id + in: path + description: conversation_id + example: '64619700005694' + required: true + schema: + type: string tags: - - Tags - - Conversations + - Tags + - Conversations operationId: attachTagToConversation description: You can tag a specific conversation. This will return a tag object for the tag that was added to the conversation. @@ -4737,7 +4945,7 @@ paths: id: '53' name: Manual tag schema: - "$ref": "#/components/schemas/tag" + '$ref': '#/components/schemas/tag' '404': description: Conversation not found content: @@ -4748,10 +4956,10 @@ paths: type: error.list request_id: 7cb55eca-e989-410d-b223-4f947a6ecf5f errors: - - code: not_found - message: Conversation not found + - code: not_found + message: Conversation not found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -4762,18 +4970,18 @@ paths: type: error.list request_id: 64d7a15e-4438-47b0-bbf8-8559a8e892d2 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: type: object required: - - id - - admin_id + - id + - admin_id properties: id: type: string @@ -4796,31 +5004,35 @@ paths: value: id: 54 admin_id: 991266991 - "/conversations/{conversation_id}/tags/{id}": + '/conversations/{conversation_id}/tags/{id}': delete: + x-fern-sdk-group-name: + - tags + - conversations + x-fern-sdk-method-name: remove summary: Remove tag from a conversation parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - - name: conversation_id - in: path - description: conversation_id - example: '64619700005694' - required: true - schema: - type: string - - name: id - in: path - description: id - example: '7522907' - required: true - schema: - type: string + - name: Intercom-Version + in: header + schema: + '$ref': '#/components/schemas/intercom_version' + - name: conversation_id + in: path + description: conversation_id + example: '64619700005694' + required: true + schema: + type: string + - name: id + in: path + description: id + example: '7522907' + required: true + schema: + type: string tags: - - Tags - - Conversations + - Tags + - Conversations operationId: detachTagFromConversation description: You can remove tag from a specific conversation. This will return a tag object for the tag that was removed from the conversation. @@ -4836,7 +5048,7 @@ paths: id: '56' name: Manual tag schema: - "$ref": "#/components/schemas/tag" + '$ref': '#/components/schemas/tag' '404': description: Tag not found content: @@ -4847,17 +5059,17 @@ paths: type: error.list request_id: 38ff13a7-7283-423c-93b8-14c242662487 errors: - - code: not_found - message: Conversation not found + - code: not_found + message: Conversation not found Tag not found: value: type: error.list request_id: 34ef3b73-b554-46f3-98c9-8d5910e4cd83 errors: - - code: tag_not_found - message: Tag not found + - code: tag_not_found + message: Tag not found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -4868,17 +5080,17 @@ paths: type: error.list request_id: 736f0c2b-fc56-4b1d-bbf4-85a3918334d9 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: type: object required: - - admin_id + - admin_id properties: admin_id: type: string @@ -4898,30 +5110,33 @@ paths: summary: Tag not found value: admin_id: 991266996 - "/conversations": + '/conversations': get: + x-fern-sdk-group-name: + - conversations + x-fern-sdk-method-name: list summary: List all conversations parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - - name: per_page - in: query - schema: - type: integer - default: 20 - maximum: 150 - required: false - description: How many results per page - - name: starting_after - in: query - required: false - description: String used to get the next page of conversations. - schema: - type: string + - name: Intercom-Version + in: header + schema: + '$ref': '#/components/schemas/intercom_version' + - name: per_page + in: query + schema: + type: integer + default: 20 + maximum: 150 + required: false + description: How many results per page + - name: starting_after + in: query + required: false + description: String used to get the next page of conversations. + schema: + type: string tags: - - Conversations + - Conversations operationId: listConversations description: | You can fetch a list of all conversations. @@ -4947,59 +5162,59 @@ paths: total_pages: 1 total_count: 1 conversations: - - type: conversation - id: '171' - created_at: 1727856965 - updated_at: 1727856965 - waiting_since: - snoozed_until: - source: - type: conversation - id: '403918153' - delivered_as: admin_initiated - subject: '' - body: "

this is the message body

" - author: - type: admin - id: '991266999' - name: Ciaran166 Lee - email: admin166@email.com - attachments: [] - url: - redacted: false - contacts: - type: contact.list + - type: conversation + id: '171' + created_at: 1727856965 + updated_at: 1727856965 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918153' + delivered_as: admin_initiated + subject: '' + body: '

this is the message body

' + author: + type: admin + id: '991266999' + name: Joe Example + email: email@example.com + attachments: [] + url: + redacted: false contacts: - - type: contact - id: 66fd01449ffbe52cc8b3aa6d - 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: 66fd01449ffbe52cc8b3aa6d + 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/paginated_response" + '$ref': '#/components/schemas/paginated_response' '401': description: Unauthorized content: @@ -5010,10 +5225,10 @@ paths: type: error.list request_id: 24b961f0-5ae0-4476-bc2d-6340b7c58ebe errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '403': description: API plan restricted content: @@ -5024,19 +5239,22 @@ paths: type: error.list request_id: 6a3e8010-1fe0-439e-986a-01486f641bfc errors: - - code: api_plan_restricted - message: Active subscription needed. + - code: api_plan_restricted + message: Active subscription needed. schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' post: + x-fern-sdk-group-name: + - conversations + x-fern-sdk-method-name: create 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). @@ -5064,7 +5282,7 @@ paths: message_type: inapp conversation_id: '199' schema: - "$ref": "#/components/schemas/message" + '$ref': '#/components/schemas/message' '404': description: Contact Not Found content: @@ -5075,10 +5293,10 @@ paths: type: error.list request_id: 1430dc67-fe2c-43e8-9f1f-ce82c871b7ca errors: - - code: not_found - message: User Not Found + - code: not_found + message: User Not Found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -5089,10 +5307,10 @@ paths: type: error.list request_id: e1fbce52-d712-45a4-a677-96ec34208546 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '403': description: API plan restricted content: @@ -5103,15 +5321,15 @@ paths: type: error.list request_id: 7be7ca5f-b5b3-4360-a12b-8367451ed02c errors: - - code: api_plan_restricted - message: Active subscription needed. + - code: api_plan_restricted + message: Active subscription needed. schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: - "$ref": "#/components/schemas/create_conversation_request" + '$ref': '#/components/schemas/create_conversation_request' examples: conversation_created: summary: conversation created @@ -5127,30 +5345,33 @@ paths: type: user id: 123_doesnt_exist body: Hello there - "/conversations/{id}": + '/conversations/{id}': get: + x-fern-sdk-group-name: + - conversations + x-fern-sdk-method-name: 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 @@ -5182,21 +5403,21 @@ paths: id: '403918167' delivered_as: admin_initiated subject: '' - body: "

this is the message body

" + body: '

this is the message body

' author: type: admin id: '991267016' - name: Ciaran176 Lee - email: admin176@email.com + name: Jane Lee + email: email@example.com attachments: [] url: redacted: false contacts: type: contact.list contacts: - - type: contact - id: 66fd01789ffbe52cc8b3aa89 - external_id: '70' + - type: contact + id: 66fd01789ffbe52cc8b3aa89 + external_id: '70' first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5227,7 +5448,7 @@ paths: conversation_parts: [] total_count: 0 schema: - "$ref": "#/components/schemas/conversation" + '$ref': '#/components/schemas/conversation' '404': description: Not found content: @@ -5238,10 +5459,10 @@ paths: type: error.list request_id: 43c9b3eb-75fb-4d81-a582-0288cfd111d7 errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -5252,10 +5473,10 @@ paths: type: error.list request_id: 77136027-72ca-4792-8eef-406104220952 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '403': description: API plan restricted content: @@ -5266,33 +5487,36 @@ paths: type: error.list request_id: e458da79-ae4c-4b9a-b3b3-a6398b2fe94d errors: - - code: api_plan_restricted - message: Active subscription needed. + - code: api_plan_restricted + message: Active subscription needed. schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' put: + x-fern-sdk-group-name: + - conversations + x-fern-sdk-method-name: update 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 + - Conversations operationId: updateConversation description: |2+ @@ -5321,21 +5545,21 @@ paths: id: '403918171' delivered_as: admin_initiated subject: '' - body: "

this is the message body

" + body: '

this is the message body

' author: type: admin id: '991267024' - name: Ciaran180 Lee - email: admin180@email.com + name: Joe Example + email: email@example.com attachments: [] url: redacted: false contacts: type: contact.list contacts: - - type: contact - id: 66fd01819ffbe52cc8b3aa8d - external_id: '70' + - type: contact + id: 66fd01819ffbe52cc8b3aa8d + external_id: '70' first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5366,45 +5590,45 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '65' - part_type: conversation_attribute_updated_by_admin - body: - created_at: 1727857027 - updated_at: 1727857027 - notified_at: 1727857027 - assigned_to: - author: - id: '991267025' - type: bot - name: Operator - 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: '66' - part_type: conversation_attribute_updated_by_admin - body: - created_at: 1727857027 - updated_at: 1727857027 - notified_at: 1727857027 - assigned_to: - author: - id: '991267025' - type: bot - name: Operator - 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: '65' + part_type: conversation_attribute_updated_by_admin + body: + created_at: 1727857027 + updated_at: 1727857027 + notified_at: 1727857027 + assigned_to: + author: + id: '991267025' + type: bot + name: Operator + 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: '66' + part_type: conversation_attribute_updated_by_admin + body: + created_at: 1727857027 + updated_at: 1727857027 + notified_at: 1727857027 + assigned_to: + author: + id: '991267025' + type: bot + name: Operator + 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 schema: - "$ref": "#/components/schemas/conversation" + '$ref': '#/components/schemas/conversation' '404': description: Not found content: @@ -5415,10 +5639,10 @@ paths: type: error.list request_id: da3b8d2a-b8d2-4338-86bb-2c7c2a2991f3 errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -5429,10 +5653,10 @@ paths: type: error.list request_id: ca1d4caa-d9db-4eb6-becf-b0cf1a1ce61e errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '403': description: API plan restricted content: @@ -5443,15 +5667,15 @@ paths: type: error.list request_id: ee098ddb-32be-4351-8a24-e850878cfcac errors: - - code: api_plan_restricted - message: Active subscription needed. + - code: api_plan_restricted + message: Active subscription needed. schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: - "$ref": "#/components/schemas/update_conversation_request" + '$ref': '#/components/schemas/update_conversation_request' examples: conversation_found: summary: conversation found @@ -5468,20 +5692,23 @@ paths: issue_type: Billing priority: High delete: + x-fern-sdk-group-name: + - conversations + x-fern-sdk-method-name: 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: @@ -5496,7 +5723,7 @@ paths: object: conversation deleted: true schema: - "$ref": "#/components/schemas/conversation_deleted" + '$ref': '#/components/schemas/conversation_deleted' '401': description: Unauthorized content: @@ -5507,10 +5734,10 @@ paths: type: error.list request_id: 1855affc-fbdf-428e-a267-48a6343f571d errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '403': description: API plan restricted content: @@ -5521,20 +5748,23 @@ paths: type: error.list request_id: 7ce56f06-d349-4ff1-9f24-b9bd7e3b8a6c errors: - - code: api_plan_restricted - message: Active subscription needed. + - code: api_plan_restricted + message: Active subscription needed. schema: - "$ref": "#/components/schemas/error" - "/conversations/search": + '$ref': '#/components/schemas/error' + '/conversations/search': post: + x-fern-sdk-group-name: + - conversations + x-fern-sdk-method-name: search 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. @@ -5651,64 +5881,64 @@ paths: total_pages: 1 total_count: 1 conversations: - - type: conversation - id: '214' - created_at: 1727857044 - updated_at: 1727857044 - waiting_since: - snoozed_until: - source: - type: conversation - id: '403918178' - delivered_as: admin_initiated - subject: '' - body: "

this is the message body

" - author: - type: admin - id: '991267054' - name: Ciaran203 Lee - email: admin203@email.com - attachments: [] - url: - redacted: false - contacts: - type: contact.list + - type: conversation + id: '214' + created_at: 1727857044 + updated_at: 1727857044 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918178' + delivered_as: admin_initiated + subject: '' + body: '

this is the message body

' + author: + type: admin + id: '991267054' + name: Jane Example + email: email@example.com + attachments: [] + url: + redacted: false contacts: - - type: contact - id: 66fd01939ffbe52cc8b3aa94 - 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: 66fd01939ffbe52cc8b3aa94 + 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/conversation_list' requestBody: content: application/json: schema: - "$ref": "#/components/schemas/search_request" + '$ref': '#/components/schemas/search_request' examples: successful: summary: successful @@ -5716,29 +5946,32 @@ paths: query: operator: AND value: - - field: created_at - operator: ">" - value: '1306054154' + - field: created_at + operator: '>' + value: '1306054154' pagination: per_page: 5 - "/conversations/{id}/reply": + '/conversations/{id}/reply': post: + x-fern-sdk-group-name: + - conversations + x-fern-sdk-method-name: reply 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. @@ -5761,21 +5994,21 @@ paths: id: '403918181' delivered_as: admin_initiated subject: '' - body: "

this is the message body

" + body: '

this is the message body

' author: type: admin id: '991267057' - name: Ciaran205 Lee - email: admin205@email.com + name: Joe Example + email: email@example.com attachments: [] url: redacted: false contacts: type: contact.list contacts: - - type: contact - id: 66fd01a09ffbe52cc8b3aa9c - external_id: '70' + - type: contact + id: 66fd01a09ffbe52cc8b3aa9c + external_id: '70' first_contact_reply: created_at: 1727857057 type: conversation @@ -5807,24 +6040,24 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '68' - part_type: open - body: "

Thanks again :)

" - created_at: 1727857057 - updated_at: 1727857057 - notified_at: 1727857057 - assigned_to: - author: - id: 66fd01a09ffbe52cc8b3aa9c - type: user - name: Joe Bloggs - email: joe@bloggs.com - attachments: [] - external_id: - redacted: false - metadata: {} - email_message_metadata: + - type: conversation_part + id: '68' + part_type: open + body: '

Thanks again :)

' + created_at: 1727857057 + updated_at: 1727857057 + notified_at: 1727857057 + assigned_to: + author: + id: 66fd01a09ffbe52cc8b3aa9c + 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: @@ -5839,21 +6072,21 @@ paths: id: '403918182' delivered_as: admin_initiated subject: '' - body: "

this is the message body

" + body: '

this is the message body

' author: type: admin id: '991267059' - name: Ciaran206 Lee - email: admin206@email.com + name: Jane Example + email: email@example.com attachments: [] url: redacted: false contacts: type: contact.list contacts: - - type: contact - id: 66fd01a29ffbe52cc8b3aa9d - external_id: '70' + - type: contact + id: 66fd01a29ffbe52cc8b3aa9d + external_id: '70' first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5882,36 +6115,36 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '69' - part_type: note - body: |- -

An Unordered HTML List

-
    -
  • Coffee
  • -
  • Tea
  • -
  • Milk
  • -
-

An Ordered HTML List

-
    -
  1. Coffee
  2. -
  3. Tea
  4. -
  5. Milk
  6. -
- created_at: 1727857061 - updated_at: 1727857061 - notified_at: 1727857061 - assigned_to: - author: - id: '991267059' - type: admin - name: Ciaran206 Lee - email: admin206@email.com - attachments: [] - external_id: - redacted: false - metadata: {} - email_message_metadata: + - type: conversation_part + id: '69' + part_type: note + body: |- +

An Unordered HTML List

+
    +
  • Coffee
  • +
  • Tea
  • +
  • Milk
  • +
+

An Ordered HTML List

+
    +
  1. Coffee
  2. +
  3. Tea
  4. +
  5. Milk
  6. +
+ created_at: 1727857061 + updated_at: 1727857061 + notified_at: 1727857061 + assigned_to: + author: + id: '991267059' + type: admin + name: Joe Example + email: email@example.com + attachments: [] + external_id: + redacted: false + metadata: {} + email_message_metadata: total_count: 1 Admin quick_reply reply: value: @@ -5926,21 +6159,21 @@ paths: id: '403918183' delivered_as: admin_initiated subject: '' - body: "

this is the message body

" + body: '

this is the message body

' author: type: admin id: '991267061' - name: Ciaran207 Lee - email: admin207@email.com + name: Jane Example + email: email@example.com attachments: [] url: redacted: false contacts: type: contact.list contacts: - - type: contact - id: 66fd01a69ffbe52cc8b3aa9e - external_id: '70' + - type: contact + id: 66fd01a69ffbe52cc8b3aa9e + external_id: '70' first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5969,24 +6202,24 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '70' - part_type: quick_reply - body: - created_at: 1727857064 - updated_at: 1727857064 - notified_at: 1727857064 - assigned_to: - author: - id: '991267061' - type: admin - name: Ciaran207 Lee - email: admin207@email.com - attachments: [] - external_id: - redacted: false - metadata: {} - email_message_metadata: + - type: conversation_part + id: '70' + part_type: quick_reply + body: + created_at: 1727857064 + updated_at: 1727857064 + notified_at: 1727857064 + assigned_to: + author: + id: '991267061' + type: admin + name: Jane Example + email: email@example.com + attachments: [] + external_id: + redacted: false + metadata: {} + email_message_metadata: total_count: 1 User last conversation reply: value: @@ -6001,21 +6234,21 @@ paths: id: '403918184' delivered_as: admin_initiated subject: '' - body: "

this is the message body

" + body: '

this is the message body

' author: type: admin id: '991267063' - name: Ciaran208 Lee - email: admin208@email.com + name: Jane Example + email: email@example.com attachments: [] url: redacted: false contacts: type: contact.list contacts: - - type: contact - id: 66fd01a99ffbe52cc8b3aa9f - external_id: '70' + - type: contact + id: 66fd01a99ffbe52cc8b3aa9f + external_id: '70' first_contact_reply: created_at: 1727857067 type: conversation @@ -6047,27 +6280,27 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '71' - part_type: open - body: "

Thanks again :)

" - created_at: 1727857067 - updated_at: 1727857067 - notified_at: 1727857067 - assigned_to: - author: - id: 66fd01a99ffbe52cc8b3aa9f - type: user - name: Joe Bloggs - email: joe@bloggs.com - attachments: [] - external_id: - redacted: false - metadata: {} - email_message_metadata: + - type: conversation_part + id: '71' + part_type: open + body: '

Thanks again :)

' + created_at: 1727857067 + updated_at: 1727857067 + notified_at: 1727857067 + assigned_to: + author: + id: 66fd01a99ffbe52cc8b3aa9f + 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" + '$ref': '#/components/schemas/conversation' '404': description: Not found content: @@ -6078,10 +6311,10 @@ paths: type: error.list request_id: 4154228e-b2c3-4899-90fc-72185bc1233e errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -6092,10 +6325,10 @@ paths: type: error.list request_id: 7ad53952-7179-4d7b-8b07-e41da78983ac errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '403': description: API plan restricted content: @@ -6106,15 +6339,15 @@ paths: type: error.list request_id: 5fae2837-22f7-4670-bd8e-1b71de0bfb2d errors: - - code: api_plan_restricted - message: Active subscription needed. + - code: api_plan_restricted + message: Active subscription needed. schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: - "$ref": "#/components/schemas/reply_conversation_request" + '$ref': '#/components/schemas/reply_conversation_request' examples: user_reply: summary: User reply @@ -6140,10 +6373,10 @@ paths: type: admin admin_id: 991267061 reply_options: - - text: 'Yes' - uuid: 52337e6c-5eba-48a3-aa23-c66b234985d6 - - text: 'No' - uuid: 49b7650d-ffca-4116-b3b1-dcee4680704a + - text: 'Yes' + uuid: 52337e6c-5eba-48a3-aa23-c66b234985d6 + - text: 'No' + uuid: 49b7650d-ffca-4116-b3b1-dcee4680704a user_last_conversation_reply: summary: User last conversation reply value: @@ -6158,23 +6391,26 @@ paths: type: user intercom_user_id: 66fd01ac9ffbe52cc8b3aaa0 body: Thanks again :) - "/conversations/{id}/parts": + '/conversations/{id}/parts': post: + x-fern-sdk-group-name: + - conversations + x-fern-sdk-method-name: assign 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: @@ -6201,21 +6437,21 @@ paths: id: '403918188' delivered_as: admin_initiated subject: '' - body: "

this is the message body

" + body: '

this is the message body

' author: type: admin id: '991267071' - name: Ciaran212 Lee - email: admin212@email.com + name: Joe Example + email: email@example.com attachments: [] url: redacted: false contacts: type: contact.list contacts: - - type: contact - id: 66fd01b49ffbe52cc8b3aaa3 - external_id: '70' + - type: contact + id: 66fd01b49ffbe52cc8b3aaa3 + external_id: '70' first_contact_reply: admin_assignee_id: team_assignee_id: @@ -6244,24 +6480,24 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '72' - part_type: close - body: "

Goodbye :)

" - created_at: 1727857077 - updated_at: 1727857077 - notified_at: 1727857077 - assigned_to: - author: - id: '991267071' - type: admin - name: Ciaran212 Lee - email: admin212@email.com - attachments: [] - external_id: - redacted: false - metadata: {} - email_message_metadata: + - type: conversation_part + id: '72' + part_type: close + body: '

Goodbye :)

' + created_at: 1727857077 + updated_at: 1727857077 + notified_at: 1727857077 + assigned_to: + author: + id: '991267071' + type: admin + name: Joe Example + email: email@example.com + attachments: [] + external_id: + redacted: false + metadata: {} + email_message_metadata: total_count: 1 Snooze a conversation: value: @@ -6276,21 +6512,21 @@ paths: id: '403918189' delivered_as: admin_initiated subject: '' - body: "

this is the message body

" + body: '

this is the message body

' author: type: admin id: '991267073' - name: Ciaran213 Lee - email: admin213@email.com + name: Joe Example + email: email@example.com attachments: [] url: redacted: false contacts: type: contact.list contacts: - - type: contact - id: 66fd01b79ffbe52cc8b3aaa4 - external_id: '70' + - type: contact + id: 66fd01b79ffbe52cc8b3aaa4 + external_id: '70' first_contact_reply: admin_assignee_id: team_assignee_id: @@ -6319,24 +6555,24 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '73' - part_type: snoozed - body: - created_at: 1727857081 - updated_at: 1727857081 - notified_at: 1727857081 - assigned_to: - author: - id: '991267073' - type: admin - name: Ciaran213 Lee - email: admin213@email.com - attachments: [] - external_id: - redacted: false - metadata: {} - email_message_metadata: + - type: conversation_part + id: '73' + part_type: snoozed + body: + created_at: 1727857081 + updated_at: 1727857081 + notified_at: 1727857081 + assigned_to: + author: + id: '991267073' + type: admin + name: Joe Example + email: email@example.com + attachments: [] + external_id: + redacted: false + metadata: {} + email_message_metadata: total_count: 1 Open a conversation: value: @@ -6351,21 +6587,21 @@ paths: id: '403918190' delivered_as: admin_initiated subject: '' - body: "

this is the message body

" + body: '

this is the message body

' author: type: admin id: '991267075' - name: Ciaran214 Lee - email: admin214@email.com + name: Jane Example + email: email@example.com attachments: [] url: redacted: false contacts: type: contact.list contacts: - - type: contact - id: 66fd01bd9ffbe52cc8b3aaa9 - external_id: '74' + - type: contact + id: 66fd01bd9ffbe52cc8b3aaa9 + external_id: '74' first_contact_reply: admin_assignee_id: team_assignee_id: @@ -6394,24 +6630,24 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '75' - part_type: open - body: - created_at: 1727857094 - updated_at: 1727857094 - notified_at: 1727857094 - assigned_to: - author: - id: '991267075' - type: admin - name: Ciaran214 Lee - email: admin214@email.com - attachments: [] - external_id: - redacted: false - metadata: {} - email_message_metadata: + - type: conversation_part + id: '75' + part_type: open + body: + created_at: 1727857094 + updated_at: 1727857094 + notified_at: 1727857094 + assigned_to: + author: + id: '991267075' + type: admin + name: Jane Example + email: email@example.com + attachments: [] + external_id: + redacted: false + metadata: {} + email_message_metadata: total_count: 1 Assign a conversation: value: @@ -6426,21 +6662,21 @@ paths: id: '403918193' delivered_as: admin_initiated subject: '' - body: "

this is the message body

" + body: '

this is the message body

' author: type: admin id: '991267078' - name: Ciaran216 Lee - email: admin216@email.com + name: Jane Example + email: email@example.com attachments: [] url: redacted: false contacts: type: contact.list contacts: - - type: contact - id: 66fd01c79ffbe52cc8b3aaad - external_id: '70' + - type: contact + id: 66fd01c79ffbe52cc8b3aaad + external_id: '70' first_contact_reply: admin_assignee_id: 991267078 team_assignee_id: @@ -6469,29 +6705,29 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '76' - part_type: assign_and_reopen - body: - created_at: 1727857096 - updated_at: 1727857096 - notified_at: 1727857096 - assigned_to: - type: admin - id: '991267078' - author: - id: '991267078' - type: admin - name: Ciaran216 Lee - email: admin216@email.com - attachments: [] - external_id: - redacted: false - metadata: {} - email_message_metadata: + - type: conversation_part + id: '76' + part_type: assign_and_reopen + body: + created_at: 1727857096 + updated_at: 1727857096 + notified_at: 1727857096 + assigned_to: + type: admin + id: '991267078' + author: + id: '991267078' + type: admin + name: Jane Example + email: email@example.com + attachments: [] + external_id: + redacted: false + metadata: {} + email_message_metadata: total_count: 1 schema: - "$ref": "#/components/schemas/conversation" + '$ref': '#/components/schemas/conversation' '404': description: Not found content: @@ -6502,10 +6738,10 @@ paths: type: error.list request_id: 1ce8ab2b-11a4-4efc-a0a8-8bfe8ca93a63 errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -6516,10 +6752,10 @@ paths: type: error.list request_id: f32e2852-e962-4ea8-bdb5-1486185178af errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '403': description: API plan restricted content: @@ -6530,19 +6766,19 @@ paths: type: error.list request_id: b063ec68-5d77-41e6-bc9e-d05473a09825 errors: - - code: api_plan_restricted - message: Active subscription needed. + - code: api_plan_restricted + message: Active subscription needed. schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: oneOf: - - "$ref": "#/components/schemas/close_conversation_request" - - "$ref": "#/components/schemas/snooze_conversation_request" - - "$ref": "#/components/schemas/open_conversation_request" - - "$ref": "#/components/schemas/assign_conversation_request" + - '$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 @@ -6576,27 +6812,34 @@ paths: type: admin admin_id: 991267080 body: Goodbye :) - "/conversations/{id}/run_assignment_rules": + '/conversations/{id}/run_assignment_rules': post: + x-fern-sdk-group-name: + - conversations + x-fern-sdk-method-name: assign 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 + - 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: autoAssignConversation description: | You can let a conversation be automatically assigned following assignment rules. - {% admonition type="attention" name="When using workflows" %} + {% admonition type="danger" name="Deprecation" %} + Running assignment rules has been deprecated as of version 2.12. It will be removed from all versions by October 2026. + {% /admonition %} + + {% admonition type="warning" name="Using with workflows" %} It is not possible to use this endpoint with Workflows. {% /admonition %} responses: @@ -6618,21 +6861,21 @@ paths: id: '403918197' delivered_as: admin_initiated subject: '' - body: "

this is the message body

" + body: '

this is the message body

' author: type: admin id: '991267086' - name: Ciaran220 Lee - email: admin220@email.com + name: Jane Example + email: email@example.com attachments: [] url: redacted: false contacts: type: contact.list contacts: - - type: contact - id: 66fd01d19ffbe52cc8b3aab1 - external_id: '70' + - type: contact + id: 66fd01d19ffbe52cc8b3aab1 + external_id: '70' first_contact_reply: admin_assignee_id: team_assignee_id: @@ -6661,29 +6904,29 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '77' - part_type: default_assignment - body: - created_at: 1727857107 - updated_at: 1727857107 - notified_at: 1727857107 - assigned_to: - type: nobody_admin - id: - author: - id: '991267087' - type: bot - name: Operator - email: operator+this_is_an_id400_that_should_be_at_least_@intercom.io - attachments: [] - external_id: - redacted: false - metadata: {} - email_message_metadata: + - type: conversation_part + id: '77' + part_type: default_assignment + body: + created_at: 1727857107 + updated_at: 1727857107 + notified_at: 1727857107 + assigned_to: + type: nobody_admin + id: + author: + id: '991267087' + type: bot + name: Operator + email: operator+aaa000@intercom.io + attachments: [] + external_id: + redacted: false + metadata: {} + email_message_metadata: total_count: 1 schema: - "$ref": "#/components/schemas/conversation" + '$ref': '#/components/schemas/conversation' '404': description: Not found content: @@ -6694,10 +6937,10 @@ paths: type: error.list request_id: 6d258aef-dc4e-4f71-977b-a0de678b1315 errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -6708,10 +6951,10 @@ paths: type: error.list request_id: b6c09ad4-23d9-47e5-b569-965edf404b2b errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '403': description: API plan restricted content: @@ -6722,32 +6965,36 @@ paths: type: error.list request_id: 8d83cdfe-7a5c-4d79-b778-6ac01a137bf6 errors: - - code: api_plan_restricted - message: Active subscription needed. + - code: api_plan_restricted + message: Active subscription needed. schema: - "$ref": "#/components/schemas/error" - "/conversations/{id}/customers": + '$ref': '#/components/schemas/error' + '/conversations/{id}/customers': post: - summary: Attach a contact to a conversation + x-fern-sdk-group-name: + - conversations + - contacts + x-fern-sdk-method-name: add + summary: Add 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. + Add contacts to a conversation on behalf of either another contact or an admin. - {% admonition type="attention" name="Contacts without an email" %} + {% admonition type="info" name="Contacts without an email" %} If you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with `role` set to `lead`. {% /admonition %} @@ -6760,10 +7007,10 @@ paths: Attach a contact to a conversation: value: customers: - - type: user - id: 66fd01dc9ffbe52cc8b3aab5 + - type: user + id: 66fd01dc9ffbe52cc8b3aab5 schema: - "$ref": "#/components/schemas/conversation" + '$ref': '#/components/schemas/conversation' '404': description: Not found content: @@ -6774,10 +7021,10 @@ paths: type: error.list request_id: b254197f-6466-48c9-8fa8-c185b376cc36 errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -6788,10 +7035,10 @@ paths: type: error.list request_id: 65ff1db5-088b-4f44-b65e-18b4f06b46df errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '403': description: API plan restricted content: @@ -6802,15 +7049,15 @@ paths: type: error.list request_id: '0890263b-a009-4763-97f4-d8865ba2c8c5' errors: - - code: api_plan_restricted - message: Active subscription needed. + - code: api_plan_restricted + message: Active subscription needed. schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: - "$ref": "#/components/schemas/attach_contact_to_conversation_request" + '$ref': '#/components/schemas/attach_contact_to_conversation_request' examples: attach_a_contact_to_a_conversation: summary: Attach a contact to a conversation @@ -6824,35 +7071,39 @@ paths: admin_id: 991267096 customer: intercom_user_id: 66fd01df9ffbe52cc8b3aab6 - "/conversations/{conversation_id}/customers/{contact_id}": + '/conversations/{conversation_id}/customers/{contact_id}': delete: - summary: Detach a contact from a group conversation + x-fern-sdk-group-name: + - conversations + - contacts + x-fern-sdk-method-name: remove + summary: Remove 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. + Remove a contact from a conversation on behalf of either another contact or an admin. - {% admonition type="attention" name="Contacts without an email" %} + {% admonition type="info" name="Contacts without an email" %} If you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with `role` set to `lead`. {% /admonition %} @@ -6865,10 +7116,10 @@ paths: Detach a contact from a group conversation: value: customers: - - type: user - id: 66fd01f39ffbe52cc8b3aac1 + - type: user + id: 66fd01f39ffbe52cc8b3aac1 schema: - "$ref": "#/components/schemas/conversation" + '$ref': '#/components/schemas/conversation' '404': description: Contact not found content: @@ -6879,17 +7130,17 @@ paths: type: error.list request_id: ca541ef4-b8cc-48a3-858b-a05a488db707 errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found Contact not found: value: type: error.list request_id: b75e74ba-f21e-473d-9c37-1d26c556af08 errors: - - code: not_found - message: User Not Found + - code: not_found + message: User Not Found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '422': description: Last customer content: @@ -6900,10 +7151,10 @@ paths: type: error.list request_id: e82741ec-00fe-4ae4-9e7d-11ba86420b5e 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" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -6914,10 +7165,10 @@ paths: type: error.list request_id: dbbd5d8e-9071-4ab3-9a5f-b46b81f8f3a9 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '403': description: API plan restricted content: @@ -6928,15 +7179,15 @@ paths: type: error.list request_id: a120e33c-f5be-4b17-806e-c8bf6650d1d3 errors: - - code: api_plan_restricted - message: Active subscription needed. + - code: api_plan_restricted + message: Active subscription needed. schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: - "$ref": "#/components/schemas/detach_contact_from_conversation_request" + '$ref': '#/components/schemas/detach_contact_from_conversation_request' examples: detach_a_contact_from_a_group_conversation: summary: Detach a contact from a group conversation @@ -6962,16 +7213,19 @@ paths: admin_id: 991267111 customer: intercom_user_id: 66fd020e9ffbe52cc8b3aad2 - "/conversations/redact": + '/conversations/redact': post: + x-fern-sdk-group-name: + - conversations + x-fern-sdk-method-name: redact 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). @@ -6999,21 +7253,21 @@ paths: id: '403918223' delivered_as: admin_initiated subject: '' - body: "

this is the message body

" + body: '

this is the message body

' author: type: admin id: '991267120' - name: Ciaran240 Lee - email: admin240@email.com + name: Joe Example + email: email@example.com attachments: [] url: redacted: false contacts: type: contact.list contacts: - - type: contact - id: 66fd02339ffbe52cc8b3aaea - external_id: '70' + - type: contact + id: 66fd02339ffbe52cc8b3aaea + external_id: '70' first_contact_reply: created_at: 1727857204 type: conversation @@ -7045,27 +7299,27 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '85' - part_type: open - body: "

This message was deleted

" - created_at: 1727857204 - updated_at: 1727857206 - notified_at: 1727857204 - assigned_to: - author: - id: 66fd02339ffbe52cc8b3aaea - type: user - name: Joe Bloggs - email: joe@bloggs.com - attachments: [] - external_id: - redacted: true - metadata: {} - email_message_metadata: + - type: conversation_part + id: '85' + part_type: open + body: '

This message was deleted

' + created_at: 1727857204 + updated_at: 1727857206 + notified_at: 1727857204 + assigned_to: + author: + id: 66fd02339ffbe52cc8b3aaea + 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" + '$ref': '#/components/schemas/conversation' '404': description: Not found content: @@ -7076,10 +7330,10 @@ paths: type: error.list request_id: 44fec627-e443-4cca-9958-0b30d582b0b4 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" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -7090,15 +7344,15 @@ paths: type: error.list request_id: 46401bdb-91eb-4bbe-a396-fde65fa96c27 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: - "$ref": "#/components/schemas/redact_conversation_request" + '$ref': '#/components/schemas/redact_conversation_request' examples: redact_a_conversation_part: summary: Redact a conversation part @@ -7112,23 +7366,27 @@ paths: type: conversation_part conversation_id: really_123_doesnt_exist conversation_part_id: really_123_doesnt_exist - "/conversations/{id}/convert": + '/conversations/{id}/convert': post: + x-fern-sdk-group-name: + - conversations + - tickets + x-fern-sdk-method-name: convert 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: @@ -7167,9 +7425,9 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 66fd023e9ffbe52cc8b3aaed - external_id: '70' + - type: contact + id: 66fd023e9ffbe52cc8b3aaed + external_id: '70' admin_assignee_id: '0' team_assignee_id: '0' created_at: 1727857214 @@ -7177,33 +7435,33 @@ paths: ticket_parts: type: ticket_part.list ticket_parts: - - type: ticket_part - id: '87' - part_type: comment - body: "

Comment for message

" - created_at: 1727857214 - updated_at: 1727857214 - author: - id: 66fd023e9ffbe52cc8b3aaed - type: user - name: Joe Bloggs - email: joe@bloggs.com - attachments: [] - redacted: false - - type: ticket_part - id: '88' - part_type: ticket_state_updated_by_admin - ticket_state: submitted - previous_ticket_state: submitted - created_at: 1727857219 - updated_at: 1727857219 - author: - id: '991267130' - type: bot - name: Operator - email: operator+this_is_an_id440_that_should_be_at_least_@intercom.io - attachments: [] - redacted: false + - type: ticket_part + id: '87' + part_type: comment + body: '

Comment for message

' + created_at: 1727857214 + updated_at: 1727857214 + author: + id: 66fd023e9ffbe52cc8b3aaed + type: user + name: Joe Bloggs + email: joe@bloggs.com + attachments: [] + redacted: false + - type: ticket_part + id: '88' + part_type: ticket_state_updated_by_admin + ticket_state: submitted + previous_ticket_state: submitted + created_at: 1727857219 + updated_at: 1727857219 + author: + id: '991267130' + type: bot + name: Operator + email: operator+this_is_an_id440_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false total_count: 2 open: true linked_objects: @@ -7214,7 +7472,7 @@ paths: category: Customer is_shared: true schema: - "$ref": "#/components/schemas/ticket" + '$ref': '#/components/schemas/ticket' '400': description: Bad request content: @@ -7225,15 +7483,15 @@ paths: type: error.list request_id: 160ccb27-e177-468a-ad34-97548e488bfa 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" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: - "$ref": "#/components/schemas/convert_conversation_to_ticket_request" + '$ref': '#/components/schemas/convert_conversation_to_ticket_request' examples: successful: summary: successful @@ -7243,25 +7501,28 @@ paths: summary: Bad request value: ticket_type_id: '50' - "/custom_object_instances/{custom_object_type_identifier}": + '/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: + x-fern-sdk-group-name: + - customObjects + x-fern-sdk-method-name: create 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 + - Custom Object Instances description: Create or update a custom object instance responses: '200': @@ -7280,7 +7541,7 @@ paths: created_at: 1727857226 updated_at: 1727857226 schema: - "$ref": "#/components/schemas/custom_object_instance" + '$ref': '#/components/schemas/custom_object_instance' '401': description: Unauthorized content: @@ -7291,15 +7552,15 @@ paths: type: error.list request_id: ed872bd0-2442-4e59-aa3f-7f9a7fcdf169 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: - "$ref": "#/components/schemas/create_or_update_custom_object_instance_request" + '$ref': '#/components/schemas/create_or_update_custom_object_instance_request' examples: successful: summary: successful @@ -7308,38 +7569,41 @@ paths: external_created_at: 1392036272 external_updated_at: 1392036272 get: + x-fern-sdk-group-name: + - customObjects + x-fern-sdk-method-name: getByExternalId summary: Get Custom Object Instance by External ID parameters: - - 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" + - 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 + - Custom Object Instances description: Fetch a Custom Object Instance by external_id. responses: '200': @@ -7358,7 +7622,7 @@ paths: created_at: 1727857228 updated_at: 1727857228 schema: - "$ref": "#/components/schemas/custom_object_instance" + '$ref': '#/components/schemas/custom_object_instance' '401': description: Unauthorized content: @@ -7369,35 +7633,38 @@ paths: type: error.list request_id: 7a244bcf-1487-4e1e-abb7-4f80a4d5ecef errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" - "/custom_object_instances/{custom_object_type_identifier}/{id}": + '$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: + x-fern-sdk-group-name: + - customObjects + x-fern-sdk-method-name: getById + 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 + - Custom Object Instances description: Fetch a Custom Object Instance by id. responses: '200': @@ -7416,7 +7683,7 @@ paths: created_at: 1727857229 updated_at: 1727857229 schema: - "$ref": "#/components/schemas/custom_object_instance" + '$ref': '#/components/schemas/custom_object_instance' '401': description: Unauthorized content: @@ -7427,25 +7694,28 @@ paths: type: error.list request_id: 72a31e34-c5c6-4f29-b387-e1e7be6fe475 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' delete: + x-fern-sdk-group-name: + - customObjects + x-fern-sdk-method-name: delete 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 + - Custom Object Instances description: Delete a single Custom Object instance using the Intercom defined id. responses: @@ -7460,7 +7730,7 @@ paths: object: object_type_identifier_8 deleted: true schema: - "$ref": "#/components/schemas/custom_object_instance_deleted" + '$ref': '#/components/schemas/custom_object_instance_deleted' '401': description: Unauthorized content: @@ -7471,39 +7741,42 @@ paths: type: error.list request_id: 649b8a8f-5eb8-441e-894a-0c3c9a5874d1 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" - "/data_attributes": + '$ref': '#/components/schemas/error' + '/data_attributes': get: + x-fern-sdk-group-name: + - dataAttributes + x-fern-sdk-method-name: list 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. @@ -7517,223 +7790,223 @@ 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: 18 - 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: '991267147' - created_at: 1727857232 - updated_at: 1727857232 - 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: 18 + 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: '991267147' + created_at: 1727857232 + updated_at: 1727857232 + 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" + '$ref': '#/components/schemas/data_attribute_list' '401': description: Unauthorized content: @@ -7744,19 +8017,22 @@ paths: type: error.list request_id: 7094c9ac-50f8-4b70-8322-94a59ec22184 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' post: + x-fern-sdk-group-name: + - dataAttributes + x-fern-sdk-method-name: create 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: @@ -7783,7 +8059,7 @@ paths: updated_at: 1727857234 model: company schema: - "$ref": "#/components/schemas/data_attribute" + '$ref': '#/components/schemas/data_attribute' '400': description: Too few options for list content: @@ -7794,42 +8070,42 @@ paths: type: error.list request_id: 16e616ae-1e20-460d-b414-c1334789ecbb 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: c6c87a7e-49ca-46f9-82ff-8d82dd61ccdf 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: e2233d83-6518-4559-91e8-87770036d6fe 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: 6a37d4c7-7cef-4a41-a128-5335e2ee6b72 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: f5f1d0aa-2ffc-43a6-815e-439a4adca8af 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" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -7840,15 +8116,15 @@ paths: type: error.list request_id: 2e9f4e21-5ef0-4047-95a1-58e5f052d09e errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: - "$ref": "#/components/schemas/create_data_attribute_request" + '$ref': '#/components/schemas/create_data_attribute_request' examples: successful: summary: Successful @@ -7865,7 +8141,7 @@ paths: invalid_name: summary: Invalid name value: - name: "!nv@l!d n@me" + name: '!nv@l!d n@me' model: company data_type: string attribute_already_exists: @@ -7885,25 +8161,28 @@ paths: value: description: Just a plain old ring options: - - value: 1-10 + - value: 1-10 archived: false - "/data_attributes/{id}": + '/data_attributes/{id}': put: + x-fern-sdk-group-name: + - dataAttributes + x-fern-sdk-method-name: update 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 @@ -7925,8 +8204,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 @@ -7937,7 +8216,7 @@ paths: updated_at: 1727857239 model: company schema: - "$ref": "#/components/schemas/data_attribute" + '$ref': '#/components/schemas/data_attribute' '400': description: Too few options in list content: @@ -7948,10 +8227,10 @@ paths: type: error.list request_id: dc4a4575-c686-43b7-b695-96d63dc87cca errors: - - code: parameter_invalid - message: Options isn't an array + - code: parameter_invalid + message: Options isn't an array schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '404': description: Attribute Not Found content: @@ -7962,10 +8241,10 @@ paths: type: error.list request_id: 145c272e-06ba-46cc-b8b5-cc438635063f 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" + '$ref': '#/components/schemas/error' '422': description: Has Dependant Object content: @@ -7976,11 +8255,11 @@ paths: type: error.list request_id: 8e16d3a3-7458-4910-a900-91c8d4329d3b 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" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -7991,23 +8270,23 @@ paths: type: error.list request_id: b6d77524-7f36-49ce-b8bc-501ad11b6fd6 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: - "$ref": "#/components/schemas/update_data_attribute_request" + '$ref': '#/components/schemas/update_data_attribute_request' examples: successful: summary: Successful value: description: Just a plain old ring options: - - value: 1-10 - - value: 11-20 + - value: 1-10 + - value: 11-20 archived: false too_few_options_in_list: summary: Too few options in list @@ -8021,24 +8300,27 @@ 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 value: description: Trying to archieve archived: true - "/events": + '/events': post: - summary: Submit a data event + x-fern-sdk-group-name: + - dataEvents + x-fern-sdk-method-name: create + summary: Create 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+ @@ -8063,7 +8345,7 @@ paths: When submitting events for Leads, you will need to specify the Lead's `id`. - **Metadata behaviour** + **Metadata behavior** - We currently limit the number of tracked metadata keys to 10 per event. Once the quota is reached, we ignore any further keys we receive. The first 10 metadata keys are determined by the order in which they are sent in with the event. - It is not possible to change the metadata keys once the event has been sent. A new event will need to be created with the new keys and you can archive the old one. @@ -8078,7 +8360,7 @@ paths: ### HTTP API Responses - Successful responses to submitted events return `202 Accepted` with an empty body. - - Unauthorised access will be rejected with a `401 Unauthorized` or `403 Forbidden` response code. + - Unauthorized access will be rejected with a `401 Unauthorized` or `403 Forbidden` response code. - Events sent about users that cannot be found will return a `404 Not Found`. - Event lists containing duplicate events will have those duplicates ignored. - Server errors will return a `500` response code and may contain an error message in the body. @@ -8096,78 +8378,74 @@ paths: type: error.list request_id: 913a60e0-4025-4a1a-a60f-82051a8f9fcf errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: - "$ref": "#/components/schemas/create_data_event_request" + '$ref': '#/components/schemas/create_data_event_request' get: + x-fern-sdk-group-name: + - dataEvents + x-fern-sdk-method-name: list 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 + - 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 + - Data Events operationId: lisDataEvents - description: "\n> \U0001F6A7\n>\n> Please note that you can only 'list' events - that are less than 90 days old. Event counts and summaries will still include - your events older than 90 days but you cannot 'list' these events individually - if they are older than 90 days\n\nThe events belonging to a customer can be - listed by sending a GET request to `https://api.intercom.io/events` with a - user or lead identifier along with a `type` parameter. The identifier parameter - can be one of `user_id`, `email` or `intercom_user_id`. The `type` parameter - value must be `user`.\n\n- `https://api.intercom.io/events?type=user&user_id={user_id}`\n- - `https://api.intercom.io/events?type=user&email={email}`\n- `https://api.intercom.io/events?type=user&intercom_user_id={id}` - (this call can be used to list leads)\n\nThe `email` parameter value should - be [url encoded](http://en.wikipedia.org/wiki/Percent-encoding) when sending.\n\nYou - can optionally define the result page size as well with the `per_page` parameter.\n" + description: "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 + `email` parameter value should be url encoded.\n\nYou can optionally define + the result page size as well with the `per_page` parameter.\n" responses: '200': description: Successful response @@ -8184,7 +8462,7 @@ paths: intercom_user_id: 66fd025f9ffbe52cc8b3aaf3 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 schema: - "$ref": "#/components/schemas/data_event_summary" + '$ref': '#/components/schemas/data_event_summary' '401': description: Unauthorized content: @@ -8195,20 +8473,23 @@ paths: type: error.list request_id: 1d331cf2-3933-4007-a81e-c292880681bf errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" - "/events/summaries": + '$ref': '#/components/schemas/error' + '/events/summaries': post: + x-fern-sdk-group-name: + - dataEvents + x-fern-sdk-method-name: createSummaries 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 @@ -8226,40 +8507,36 @@ paths: type: error.list request_id: 62219d74-e6fa-4e6e-9583-f23ed87b2324 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: - "$ref": "#/components/schemas/create_data_event_summaries_request" - "/export/content/data": + '$ref': '#/components/schemas/create_data_event_summaries_request' + '/export/content/data': post: - summary: Create content data export + x-fern-sdk-group-name: + - dataExports + x-fern-sdk-method-name: create + summary: Create a 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 - only parameters you need to provide are the range of dates that you want exported.\n\n>\U0001F6A7 - Limit of one active job\n>\n> You can only have one active job per workspace. - You will receive a HTTP status code of 429 with the message Exceeded rate - limit of 1 pending message data export jobs if you attempt to create a second - concurrent job.\n\n>❗️ Updated_at not included\n>\n> It should be noted that - the timeframe only includes messages sent during the time period and not messages - that were only updated during this period. For example, if a message was updated - yesterday but sent two days ago, you would need to set the created_at_after - date before the message was sent to include that in your retrieval job.\n\n>\U0001F4D8 - Date ranges are inclusive\n>\n> Requesting data for 2018-06-01 until 2018-06-30 - will get all data for those days including those specified - e.g. 2018-06-01 - 00:00:00 until 2018-06-30 23:59:99.\n" + description: "For data exports the timeframe only includes messages sent during the + time period and not messages that were only updated during this period. + For example, if a message was updated yesterday but sent two days ago, you would + need to set the created_at_after date before the message was sent to include that + in your retrieval job.\n\nDate ranges are inclusive. Requesting data for 2018-06-01 + until 2018-06-30 will get all data for those days including those specified - + e.g. 2018-06-01 00:00:00 until 2018-06-30 23:59:99.\n" responses: '200': description: successful @@ -8273,42 +8550,45 @@ paths: download_url: '' download_expires_at: '' schema: - "$ref": "#/components/schemas/data_export" + '$ref': '#/components/schemas/data_export' requestBody: content: application/json: schema: - "$ref": "#/components/schemas/create_data_exports_request" + '$ref': '#/components/schemas/create_data_exports_request' examples: successful: summary: successful value: created_at_after: 1727839250 created_at_before: 1727857250 - "/export/content/data/{job_identifier}": + '/export/content/data/{job_identifier}': get: - summary: Show content data export + x-fern-sdk-group-name: + - dataExports + x-fern-sdk-method-name: getStatus + summary: Get data export status 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}` - the `{job_identifier}` is the value returned in the response when you first - created the export job. More on it can be seen in the Export Job Model.\n\n> - \U0001F6A7 Jobs expire after two days\n> All jobs that have completed processing - (and are thus available to download from the provided URL) will have an expiry - limit of two days from when the export ob completed. After this, the data + created the export job. More on it can be seen in the Export Job Model.\n\nJobs + expire after two days. All jobs that have completed processing (and are thus + available to download from the provided URL) will have an expiry limit of two + days from when the export ob completed. After this, the data will no longer be will no longer be available.\n" responses: '200': @@ -8323,23 +8603,26 @@ paths: download_url: '' download_expires_at: '' schema: - "$ref": "#/components/schemas/data_export" - "/export/cancel/{job_identifier}": + '$ref': '#/components/schemas/data_export' + '/export/cancel/{job_identifier}': post: - summary: Cancel content data export + x-fern-sdk-group-name: + - dataExports + x-fern-sdk-method-name: cancel + summary: Cancel a 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: @@ -8355,51 +8638,57 @@ paths: download_url: '' download_expires_at: '' schema: - "$ref": "#/components/schemas/data_export" - "/download/content/data/{job_identifier}": + '$ref': '#/components/schemas/data_export' + '/download/content/data/{job_identifier}': get: - summary: Download content data export + x-fern-sdk-group-name: + - dataExports + x-fern-sdk-method-name: download + summary: Download a 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: https://api.intercom.io/download/content/data/xyz1234.\n\nYour exported message - data will be streamed continuously back down to you in a gzipped CSV format.\n\n> - \U0001F4D8 Octet header required\n>\n> You will have to specify the header - Accept: `application/octet-stream` when hitting this endpoint.\n" + data will be streamed continuously back down to you in a gzipped CSV format.\n\n + You will have to specify the header Accept: `application/octet-stream` when hitting + this endpoint.\n" responses: '200': description: successful - "/messages": + '/messages': post: + x-fern-sdk-group-name: + - messages + x-fern-sdk-method-name: create 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 or an email.\n\n> \U0001F6A7 - Sending for visitors\n>\n> There can be a short delay between when a contact - is created and when a contact becomes available to be messaged through the - API. A 404 Not Found error will be returned in this case.\n\nThis will return - the Message model that has been created.\n\n> \U0001F6A7 Retrieving Associated - Conversations\n>\n> As this is a message, there will be no conversation present + The conversation can be either an in-app message or an email.\n\nSending for + visitors There can be a short delay between when a contact is created and when + a contact becomes available to be messaged through the API. A 404 Not Found + error will be returned in this case.\n\nThis will return the Message model that + has been created.\n\nRetrieving Associated Conversations As this is a message, + there will be no conversation present until the contact responds. Once they do, until the contact responds. Once they do, you will have to search for a contact's conversations with the id of the message.\n" responses: @@ -8413,7 +8702,7 @@ paths: type: user_message id: '403918228' created_at: 1727857254 - body: heyy + body: hello there message_type: inapp conversation_id: '312' lead message created: @@ -8421,7 +8710,7 @@ paths: type: user_message id: '403918229' created_at: 1727857256 - body: heyy + body: hello there message_type: inapp conversation_id: '313' admin message created: @@ -8429,18 +8718,18 @@ paths: type: admin_message id: '10' created_at: 1727857258 - subject: heyy - body: heyy + subject: hello there + body: this is a test message message_type: inapp owner: type: admin id: '991267179' - name: Ciaran292 Lee - email: admin292@email.com + name: Joe Example + email: test@example.com away_mode_enabled: false away_mode_reassign: false schema: - "$ref": "#/components/schemas/message" + '$ref': '#/components/schemas/message' '400': description: No body supplied for email message content: @@ -8451,17 +8740,17 @@ paths: type: error.list request_id: c0c38cb5-63d4-44e1-b418-4eaba75fdb7c 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: 18a870a1-2994-4b9c-b5e0-cb36e3b6edce errors: - - code: parameter_invalid - message: Body is required + - code: parameter_invalid + message: Body is required schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '422': description: No subject supplied for email message content: @@ -8472,10 +8761,10 @@ paths: type: error.list request_id: ec3fd41b-0f1c-4146-92bf-429d634b0476 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" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -8486,10 +8775,10 @@ paths: type: error.list request_id: b44aa0fc-e600-4830-bef0-a16e1e7180b8 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '403': description: API plan restricted content: @@ -8500,15 +8789,15 @@ paths: type: error.list request_id: 3ad5b261-9a63-4571-b2ed-5c9aa98a5003 errors: - - code: api_plan_restricted - message: Active subscription needed. + - code: api_plan_restricted + message: Active subscription needed. schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: - "$ref": "#/components/schemas/create_message_request" + '$ref': '#/components/schemas/create_message_request' examples: user_message_created: summary: user message created @@ -8516,7 +8805,7 @@ paths: from: type: user id: 66fd02669ffbe52cc8b3aaf8 - body: heyy + body: hello there referer: https://twitter.com/bob lead_message_created: summary: lead message created @@ -8524,7 +8813,7 @@ paths: from: type: lead id: 66fd02689ffbe52cc8b3aaf9 - body: heyy + body: hello there referer: https://twitter.com/bob admin_message_created: summary: admin message created @@ -8548,7 +8837,7 @@ paths: id: 66fd026b9ffbe52cc8b3aafb message_type: inapp body: - subject: heyy + subject: hello there no_subject_supplied_for_email_message: summary: No subject supplied for email message value: @@ -8571,17 +8860,21 @@ paths: id: 66fd026d9ffbe52cc8b3aafd message_type: email body: - subject: heyy - "/news/news_items": + subject: hello there + '/news/news_items': get: + x-fern-sdk-group-name: + - news + - newsItems + x-fern-sdk-method-name: list 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: @@ -8599,45 +8892,45 @@ paths: total_pages: 1 type: pages data: - - id: '15' - type: news-item - workspace_id: this_is_an_id530_that_should_be_at_least_ - title: We have news - body: "

Hello there,

" - sender_id: 991267188 - state: draft - labels: [] - cover_image_url: - reactions: - - - - - - - - - deliver_silently: false - created_at: 1727857264 - updated_at: 1727857264 - newsfeed_assignments: [] - - id: '16' - type: news-item - workspace_id: this_is_an_id530_that_should_be_at_least_ - title: We have news - body: "

Hello there,

" - sender_id: 991267190 - state: draft - labels: [] - cover_image_url: - reactions: - - - - - - - - - deliver_silently: false - created_at: 1727857264 - updated_at: 1727857264 - newsfeed_assignments: [] + - id: '15' + type: news-item + workspace_id: this_is_an_id530_that_should_be_at_least_ + title: We have news + body: '

Hello there,

' + sender_id: 991267188 + state: draft + labels: [] + cover_image_url: + reactions: + - + - + - + - + deliver_silently: false + created_at: 1727857264 + updated_at: 1727857264 + newsfeed_assignments: [] + - id: '16' + type: news-item + workspace_id: this_is_an_id530_that_should_be_at_least_ + title: We have news + body: '

Hello there,

' + sender_id: 991267190 + state: draft + labels: [] + cover_image_url: + reactions: + - + - + - + - + deliver_silently: false + created_at: 1727857264 + updated_at: 1727857264 + newsfeed_assignments: [] total_count: 2 schema: - "$ref": "#/components/schemas/paginated_response" + '$ref': '#/components/schemas/paginated_response' '401': description: Unauthorized content: @@ -8648,19 +8941,23 @@ paths: type: error.list request_id: d485bf96-c6e6-445c-84d0-5606708e4474 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' post: + x-fern-sdk-group-name: + - news + - newsItems + x-fern-sdk-method-name: create 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: @@ -8675,25 +8972,25 @@ paths: type: news-item workspace_id: this_is_an_id534_that_should_be_at_least_ title: Halloween is here! - body: "

New costumes in store for this spooky season

" + body: '

New costumes in store for this spooky season

' sender_id: 991267197 state: live labels: - - New - - Product - - Update + - New + - Product + - Update cover_image_url: reactions: - - "\U0001F606" - - "\U0001F605" + - "\U0001F606" + - "\U0001F605" deliver_silently: true created_at: 1727857267 updated_at: 1727857267 newsfeed_assignments: - - newsfeed_id: 28 - published_at: 1664638214 + - newsfeed_id: 28 + published_at: 1664638214 schema: - "$ref": "#/components/schemas/news_item" + '$ref': '#/components/schemas/news_item' '401': description: Unauthorized content: @@ -8704,51 +9001,55 @@ paths: type: error.list request_id: c510fe9a-3843-4446-b25c-48cf23e4a0ea errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: - "$ref": "#/components/schemas/news_item_request" + '$ref': '#/components/schemas/news_item_request' examples: successful: summary: successful value: title: Halloween is here! - body: "

New costumes in store for this spooky season

" + body: '

New costumes in store for this spooky season

' labels: - - Product - - Update - - New + - Product + - Update + - New sender_id: 991267197 deliver_silently: true reactions: - - "\U0001F606" - - "\U0001F605" + - "\U0001F606" + - "\U0001F605" state: live newsfeed_assignments: - - newsfeed_id: 28 - published_at: 1664638214 - "/news/news_items/{id}": + - newsfeed_id: 28 + published_at: 1664638214 + '/news/news_items/{id}': get: - summary: Retrieve a news item + x-fern-sdk-group-name: + - news + - newsItems + x-fern-sdk-method-name: get + summary: Get 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: @@ -8763,24 +9064,24 @@ paths: type: news-item workspace_id: this_is_an_id538_that_should_be_at_least_ title: We have news - body: "

Hello there,

" + body: '

Hello there,

' sender_id: 991267200 state: live labels: [] cover_image_url: reactions: - - - - - - - - + - + - + - + - deliver_silently: false created_at: 1727857269 updated_at: 1727857269 newsfeed_assignments: - - newsfeed_id: 30 - published_at: 1727857269 + - newsfeed_id: 30 + published_at: 1727857269 schema: - "$ref": "#/components/schemas/news_item" + '$ref': '#/components/schemas/news_item' '404': description: News Item Not Found content: @@ -8791,10 +9092,10 @@ paths: type: error.list request_id: f68cd910-d16a-498d-9711-1af86e2348a0 errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -8805,26 +9106,30 @@ paths: type: error.list request_id: dd9fe9e2-c88c-42e7-82ce-08ed3d8ee0e0 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' put: + x-fern-sdk-group-name: + - news + - newsItems + x-fern-sdk-method-name: update 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': @@ -8838,20 +9143,20 @@ paths: type: news-item workspace_id: this_is_an_id544_that_should_be_at_least_ title: Christmas is here! - body: "

New gifts in store for the jolly season

" + body: '

New gifts in store for the jolly season

' sender_id: 991267208 state: live labels: [] cover_image_url: reactions: - - "\U0001F61D" - - "\U0001F602" + - "\U0001F61D" + - "\U0001F602" deliver_silently: false created_at: 1727857272 updated_at: 1727857272 newsfeed_assignments: [] schema: - "$ref": "#/components/schemas/news_item" + '$ref': '#/components/schemas/news_item' '404': description: News Item Not Found content: @@ -8862,10 +9167,10 @@ paths: type: error.list request_id: 6d5f0200-a2bd-458f-9812-fe2d09dc59a5 errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -8876,50 +9181,54 @@ paths: type: error.list request_id: 6deaed9c-3eeb-4da9-8fe7-990bb8ec2006 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: - "$ref": "#/components/schemas/news_item_request" + '$ref': '#/components/schemas/news_item_request' examples: successful: summary: successful value: title: Christmas is here! - body: "

New gifts in store for the jolly season

" + body: '

New gifts in store for the jolly season

' sender_id: 991267208 reactions: - - "\U0001F61D" - - "\U0001F602" + - "\U0001F61D" + - "\U0001F602" news_item_not_found: summary: News Item Not Found value: title: Christmas is here! - body: "

New gifts in store for the jolly season

" + body: '

New gifts in store for the jolly season

' sender_id: 991267211 reactions: - - "\U0001F61D" - - "\U0001F602" + - "\U0001F61D" + - "\U0001F602" delete: + x-fern-sdk-group-name: + - news + - newsItems + x-fern-sdk-method-name: 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: @@ -8934,7 +9243,7 @@ paths: object: news-item deleted: true schema: - "$ref": "#/components/schemas/deleted_object" + '$ref': '#/components/schemas/deleted_object' '404': description: News Item Not Found content: @@ -8945,10 +9254,10 @@ paths: type: error.list request_id: ca1cea72-f3da-442c-a726-18a39cd9f372 errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -8959,28 +9268,33 @@ paths: type: error.list request_id: fb278bb8-7a96-4d09-b032-90fecda2410e errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" - "/news/newsfeeds/{id}/items": + '$ref': '#/components/schemas/error' + '/news/newsfeeds/{id}/items': get: + x-fern-sdk-group-name: + - news + - newsItems + - newsFeeds + x-fern-sdk-method-name: list 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 @@ -9001,7 +9315,7 @@ paths: data: [] total_count: 0 schema: - "$ref": "#/components/schemas/paginated_response" + '$ref': '#/components/schemas/paginated_response' '401': description: Unauthorized content: @@ -9012,20 +9326,24 @@ paths: type: error.list request_id: 0c6d76c8-bdfc-4e54-a6d6-9b8d551a3aba errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" - "/news/newsfeeds": + '$ref': '#/components/schemas/error' + '/news/newsfeeds': get: + x-fern-sdk-group-name: + - news + - newsFeeds + x-fern-sdk-method-name: list 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: @@ -9043,19 +9361,19 @@ paths: total_pages: 1 type: pages data: - - id: '44' - type: newsfeed - name: Visitor Feed - created_at: 1727857280 - updated_at: 1727857280 - - id: '43' - type: newsfeed - name: Visitor Feed - created_at: 1727857279 - updated_at: 1727857279 + - id: '44' + type: newsfeed + name: Visitor Feed + created_at: 1727857280 + updated_at: 1727857280 + - id: '43' + type: newsfeed + name: Visitor Feed + created_at: 1727857279 + updated_at: 1727857279 total_count: 2 schema: - "$ref": "#/components/schemas/paginated_response" + '$ref': '#/components/schemas/paginated_response' '401': description: Unauthorized content: @@ -9066,28 +9384,32 @@ paths: type: error.list request_id: 6f2be0c1-27aa-4397-b31a-0169dbe542a3 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" - "/news/newsfeeds/{id}": + '$ref': '#/components/schemas/error' + '/news/newsfeeds/{id}': get: + x-fern-sdk-group-name: + - news + - newsFeeds + x-fern-sdk-method-name: 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: @@ -9104,7 +9426,7 @@ paths: created_at: 1727857281 updated_at: 1727857281 schema: - "$ref": "#/components/schemas/newsfeed" + '$ref': '#/components/schemas/newsfeed' '401': description: Unauthorized content: @@ -9115,27 +9437,30 @@ paths: type: error.list request_id: 538c5dc6-7fbd-4e7f-b8f9-6a080d761895 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" - "/notes/{id}": + '$ref': '#/components/schemas/error' + '/notes/{id}': get: - summary: Retrieve a note + x-fern-sdk-group-name: + - notes + x-fern-sdk-method-name: get + summary: Get 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: @@ -9155,13 +9480,13 @@ paths: author: type: admin id: '991267227' - name: Ciaran339 Lee - email: admin339@email.com + name: Jane Example + email: email@example.com away_mode_enabled: false away_mode_reassign: false - body: "

This is a note.

" + body: '

This is a note.

' schema: - "$ref": "#/components/schemas/note" + '$ref': '#/components/schemas/note' '404': description: Note not found content: @@ -9172,10 +9497,10 @@ paths: type: error.list request_id: 33d614dd-e3bb-47a0-ac62-c9011db026bf errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -9186,27 +9511,30 @@ paths: type: error.list request_id: eecbbfee-4640-4c7e-8b04-03bed46d7341 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" - "/segments": + '$ref': '#/components/schemas/error' + '/segments': get: + x-fern-sdk-group-name: + - segments + x-fern-sdk-method-name: list 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: @@ -9219,20 +9547,20 @@ paths: value: type: segment.list segments: - - type: segment - id: 66fd02869ffbe52cc8b3ab03 - name: John segment - created_at: 1727857286 - updated_at: 1727857286 - person_type: user - - type: segment - id: 66fd02869ffbe52cc8b3ab04 - name: Jane segment - created_at: 1727857286 - updated_at: 1727857286 - person_type: user - schema: - "$ref": "#/components/schemas/segment_list" + - type: segment + id: 66fd02869ffbe52cc8b3ab03 + name: John segment + created_at: 1727857286 + updated_at: 1727857286 + person_type: user + - type: segment + id: 66fd02869ffbe52cc8b3ab04 + name: Jane segment + created_at: 1727857286 + updated_at: 1727857286 + person_type: user + schema: + '$ref': '#/components/schemas/segment_list' '401': description: Unauthorized content: @@ -9243,27 +9571,30 @@ paths: type: error.list request_id: ce940eba-89d4-4ac7-a629-0b9c1b53de37 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" - "/segments/{id}": + '$ref': '#/components/schemas/error' + '/segments/{id}': get: - summary: Retrieve a segment + x-fern-sdk-group-name: + - segments + x-fern-sdk-method-name: get + summary: Get 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: @@ -9276,12 +9607,12 @@ paths: value: type: segment id: 66fd02889ffbe52cc8b3ab07 - name: John segment + name: Joe Example created_at: 1727857288 updated_at: 1727857288 person_type: user schema: - "$ref": "#/components/schemas/segment" + '$ref': '#/components/schemas/segment' '404': description: Segment not found content: @@ -9292,10 +9623,10 @@ paths: type: error.list request_id: 07e00389-c67c-4cc7-ad63-6cdd2c3c6460 errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -9306,20 +9637,23 @@ paths: type: error.list request_id: 77dcef51-06dd-4525-bbf8-6044f11b08cc errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" - "/subscription_types": + '$ref': '#/components/schemas/error' + '/subscription_types': get: + x-fern-sdk-group-name: + - subscriptionTypes + x-fern-sdk-method-name: list 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. @@ -9333,22 +9667,22 @@ 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 - schema: - "$ref": "#/components/schemas/subscription_type_list" + - 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 + schema: + '$ref': '#/components/schemas/subscription_type_list' '401': description: Unauthorized content: @@ -9359,20 +9693,23 @@ paths: type: error.list request_id: 7c62cfef-e04c-44bc-a19f-07941561885f errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" - "/phone_call_redirects": + '$ref': '#/components/schemas/error' + '/phone_call_redirects': post: + x-fern-sdk-group-name: + - phone + x-fern-sdk-method-name: createSwitch 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. @@ -9390,7 +9727,7 @@ paths: url: http://via.intercom.io/msgr/24f320ac-246f-4386-a94e-f04821314dc1 type: phone_call_redirect schema: - "$ref": "#/components/schemas/phone_switch" + '$ref': '#/components/schemas/phone_switch' '400': description: bad request - invalid number content: @@ -9422,54 +9759,57 @@ paths: type: error.list request_id: 937454ce-d9af-4b74-8763-8cfe11dce51c errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: - "$ref": "#/components/schemas/create_phone_switch_request" + '$ref': '#/components/schemas/create_phone_switch_request' examples: successful: summary: successful value: - phone: "+353832345678" + phone: '+353832345678' custom_attributes: issue_type: Billing priority: High bad_request_-_exception_sending_sms: summary: bad request - exception sending sms value: - phone: "+353832345678" + phone: '+353832345678' custom_attributes: issue_type: Billing priority: High bad_request_-_invalid_number: summary: bad request - invalid number value: - phone: "+353832345678" + phone: '+353832345678' custom_attributes: issue_type: Billing priority: High unprocessable_entity: summary: unprocessable entity value: - phone: "+40241100100" + phone: '+40241100100' custom_attributes: issue_type: Billing priority: High - "/tags": + '/tags': get: + x-fern-sdk-group-name: + - tags + x-fern-sdk-method-name: list 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: @@ -9482,11 +9822,11 @@ paths: value: type: list data: - - type: tag - id: '69' - name: Manual tag 1 + - type: tag + id: '69' + name: Manual tag 1 schema: - "$ref": "#/components/schemas/tag_list" + '$ref': '#/components/schemas/tag_list' '401': description: Unauthorized content: @@ -9497,19 +9837,19 @@ paths: type: error.list request_id: 728e6de8-83df-4466-a83f-0dbd68d87b12 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$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: @@ -9537,7 +9877,7 @@ paths: id: '72' name: test schema: - "$ref": "#/components/schemas/tag" + '$ref': '#/components/schemas/tag' '400': description: Invalid parameters content: @@ -9548,10 +9888,10 @@ paths: type: error.list request_id: 47e1978a-ce1c-40f2-91c6-dc7df400667a errors: - - code: parameter_invalid - message: invalid tag parameters + - code: parameter_invalid + message: invalid tag parameters schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '404': description: User not found content: @@ -9562,17 +9902,17 @@ paths: type: error.list request_id: c09821b3-0d4c-48cd-b098-bec827484232 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: c2658060-aa56-47ef-a501-c69a480dc7d4 errors: - - code: not_found - message: User Not Found + - code: not_found + message: User Not Found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -9583,19 +9923,19 @@ paths: type: error.list request_id: b221bfd5-2423-4365-892b-c8766ad97701 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: oneOf: - - "$ref": "#/components/schemas/create_or_update_tag_request" - - "$ref": "#/components/schemas/tag_company_request" - - "$ref": "#/components/schemas/untag_company_request" - - "$ref": "#/components/schemas/tag_multiple_users_request" + - '$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 @@ -9610,30 +9950,33 @@ paths: value: name: test companies: - - company_id: '123' + - company_id: '123' user_not_found: summary: User not found value: name: test users: - - id: '123' - "/tags/{id}": + - id: '123' + '/tags/{id}': get: + x-fern-sdk-group-name: + - tags + x-fern-sdk-method-name: find 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. @@ -9650,7 +9993,7 @@ paths: id: '80' name: Manual tag schema: - "$ref": "#/components/schemas/tag" + '$ref': '#/components/schemas/tag' '404': description: Tag not found content: @@ -9661,10 +10004,10 @@ paths: type: error.list request_id: d016c66d-e66c-4574-9d6e-d5523444d8a2 errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -9675,26 +10018,29 @@ paths: type: error.list request_id: 75ecbc66-a998-4d5d-9450-44fc56846a54 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' delete: + x-fern-sdk-group-name: + - tags + x-fern-sdk-method-name: 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. @@ -9711,10 +10057,10 @@ paths: type: error.list request_id: 5b4fe9e5-b5bb-4249-ae2b-0d8d87cf0490 errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '400': description: Tag has dependent objects content: @@ -9725,11 +10071,11 @@ paths: type: error.list request_id: 05547561-8902-4734-a1d1-67e9019d1847 errors: - - code: tag_has_dependent_objects - message: 'Unable to delete Tag with dependent objects. Segments: - Seg 1.' + - code: tag_has_dependent_objects + message: 'Unable to delete Tag with dependent objects. Segments: + Seg 1.' schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -9740,20 +10086,23 @@ paths: type: error.list request_id: 89c8f6cd-9ee0-403b-b42e-605022cbb921 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" - "/teams": + '$ref': '#/components/schemas/error' + '/teams': get: + x-fern-sdk-group-name: + - teams + x-fern-sdk-method-name: list 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: @@ -9767,7 +10116,7 @@ paths: type: team.list teams: [] schema: - "$ref": "#/components/schemas/team_list" + '$ref': '#/components/schemas/team_list' '401': description: Unauthorized content: @@ -9778,27 +10127,30 @@ paths: type: error.list request_id: 55d69964-d923-4702-ae43-dd82b459469c errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" - "/teams/{id}": + '$ref': '#/components/schemas/error' + '/teams/{id}': get: - summary: Retrieve a team + x-fern-sdk-group-name: + - teams + x-fern-sdk-method-name: get + summary: Get 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. @@ -9815,7 +10167,7 @@ paths: name: team 1 admin_ids: [] schema: - "$ref": "#/components/schemas/team" + '$ref': '#/components/schemas/team' '404': description: Team not found content: @@ -9826,10 +10178,10 @@ paths: type: error.list request_id: 37abcb7a-7e0f-4c09-a1a6-5d27bc16708c errors: - - code: team_not_found - message: Team not found + - code: team_not_found + message: Team not found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -9840,20 +10192,23 @@ paths: type: error.list request_id: effb9bb2-e20b-444c-810a-ef8e3840ee6c errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" - "/ticket_states": + '$ref': '#/components/schemas/error' + '/ticket_states': get: + x-fern-sdk-group-name: + - ticketStates + x-fern-sdk-method-name: list 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: @@ -9866,182 +10221,182 @@ paths: value: type: list data: - - type: ticket_state - id: '5413' - category: submitted - internal_label: Submitted - external_label: Submitted - ticket_types: - type: list - data: - - type: ticket_type - id: '51' - 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: '52' - 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: '54' - 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: '5414' - category: in_progress - internal_label: In progress - external_label: In progress - ticket_types: - type: list - data: - - type: ticket_type - id: '51' - 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: '52' - 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: '54' - 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: '5415' - category: waiting_on_customer - internal_label: Waiting on customer - external_label: Waiting on you - ticket_types: - type: list - data: - - type: ticket_type - id: '51' - 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: '52' - 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: '54' - 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: '5416' - category: resolved - internal_label: Resolved - external_label: Resolved - ticket_types: - type: list - data: - - type: ticket_type - id: '51' - 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: '52' - 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: '54' - 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: '5417' - category: submitted - internal_label: Admin label 1 - external_label: User label - ticket_types: - type: list - data: - - type: ticket_type - id: '51' - 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: '52' - 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: '5418' - category: submitted - internal_label: Admin label 2 - external_label: User label - ticket_types: - type: list - data: - - type: ticket_type - id: '54' - 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: '5413' + category: submitted + internal_label: Submitted + external_label: Submitted + ticket_types: + type: list + data: + - type: ticket_type + id: '51' + name: feature-request + description: product feature requests. + icon: "\U0001F981" + archived: false + is_internal: false + category: Back-office + - type: ticket_type + id: '52' + name: bug + description: something in-product isn't working. + icon: "\U0001F981" + archived: false + is_internal: false + category: Back-office + - type: ticket_type + id: '54' + name: product-question + description: need support understanding product capabilities. + icon: "\U0001F981" + archived: false + is_internal: false + category: Back-office + archived: false + - type: ticket_state + id: '5414' + category: in_progress + internal_label: In progress + external_label: In progress + ticket_types: + type: list + data: + - type: ticket_type + id: '51' + 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: '52' + 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: '54' + 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: '5415' + category: waiting_on_customer + internal_label: Waiting on customer + external_label: Waiting on you + ticket_types: + type: list + data: + - type: ticket_type + id: '51' + 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: '52' + 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: '54' + 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: '5416' + category: resolved + internal_label: Resolved + external_label: Resolved + ticket_types: + type: list + data: + - type: ticket_type + id: '51' + 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: '52' + 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: '54' + 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: '5417' + category: submitted + internal_label: Admin label 1 + external_label: User label + ticket_types: + type: list + data: + - type: ticket_type + id: '51' + 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: '52' + 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: '5418' + category: submitted + internal_label: Admin label 2 + external_label: User label + ticket_types: + type: list + data: + - type: ticket_type + id: '54' + 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" + '$ref': '#/components/schemas/ticket_state_list' '401': description: Unauthorized content: @@ -10052,26 +10407,30 @@ paths: type: error.list request_id: dbd44320-b1c6-4a0f-a798-2b0f61a7716d errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" - "/ticket_types/{ticket_type_id}/attributes": + '$ref': '#/components/schemas/error' + '/ticket_types/{ticket_type_id}/attributes': post: + x-fern-sdk-group-name: + - ticketTypes + - attributes + x-fern-sdk-method-name: create 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: @@ -10101,7 +10460,7 @@ paths: created_at: 1727857320 updated_at: 1727857320 schema: - "$ref": "#/components/schemas/ticket_type_attribute" + '$ref': '#/components/schemas/ticket_type_attribute' '401': description: Unauthorized content: @@ -10112,15 +10471,15 @@ paths: type: error.list request_id: 94f6ab96-e21f-408c-a8b3-11737aa7ce3c errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: - "$ref": "#/components/schemas/create_ticket_type_attribute_request" + '$ref': '#/components/schemas/create_ticket_type_attribute_request' examples: ticket_type_attribute_created: summary: Ticket Type Attribute created @@ -10129,29 +10488,33 @@ paths: description: Attribute Description data_type: string required_to_create: false - "/ticket_types/{ticket_type_id}/attributes/{id}": + '/ticket_types/{ticket_type_id}/attributes/{id}': put: + x-fern-sdk-group-name: + - ticketTypes + - attributes + x-fern-sdk-method-name: update 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: @@ -10179,7 +10542,7 @@ paths: created_at: 1727857322 updated_at: 1727857322 schema: - "$ref": "#/components/schemas/ticket_type_attribute" + '$ref': '#/components/schemas/ticket_type_attribute' '401': description: Unauthorized content: @@ -10190,30 +10553,33 @@ paths: type: error.list request_id: 7fb51e03-1418-41c8-8439-0a70b46f8d2b errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: - "$ref": "#/components/schemas/update_ticket_type_attribute_request" + '$ref': '#/components/schemas/update_ticket_type_attribute_request' examples: ticket_type_attribute_updated: summary: Ticket Type Attribute updated value: description: New Attribute Description - "/ticket_types": + '/ticket_types': get: + x-fern-sdk-group-name: + - ticketTypes + x-fern-sdk-method-name: list 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: @@ -10226,98 +10592,98 @@ paths: value: type: list data: - - type: ticket_type - id: '63' - name: Bug Report - description: Bug Report Template - icon: "\U0001F39F️" - workspace_id: this_is_an_id648_that_should_be_at_least_ - archived: false - created_at: 1727857323 - updated_at: 1727857323 - is_internal: false - ticket_type_attributes: - type: list - data: - - type: ticket_type_attribute - id: '114' - 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: 63 - archived: false - created_at: 1727857323 - updated_at: 1727857323 - - type: ticket_type_attribute - id: '116' - 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: 63 - archived: false - created_at: 1727857324 - updated_at: 1727857324 - - type: ticket_type_attribute - id: '115' - 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: 63 - archived: false - created_at: 1727857323 - updated_at: 1727857323 - category: Customer - ticket_states: - type: list - data: - - type: ticket_state - id: '5465' - category: submitted - internal_label: Submitted - external_label: Submitted - - type: ticket_state - id: '5466' - category: in_progress - internal_label: In progress - external_label: In progress - - type: ticket_state - id: '5467' - category: waiting_on_customer - internal_label: Waiting on customer - external_label: Waiting on you - - type: ticket_state - id: '5468' - category: resolved - internal_label: Resolved - external_label: Resolved - schema: - "$ref": "#/components/schemas/ticket_type_list" + - type: ticket_type + id: '63' + name: Bug Report + description: Bug Report Template + icon: "\U0001F39F️" + workspace_id: this_is_an_id648_that_should_be_at_least_ + archived: false + created_at: 1727857323 + updated_at: 1727857323 + is_internal: false + ticket_type_attributes: + type: list + data: + - type: ticket_type_attribute + id: '114' + 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: 63 + archived: false + created_at: 1727857323 + updated_at: 1727857323 + - type: ticket_type_attribute + id: '116' + 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: 63 + archived: false + created_at: 1727857324 + updated_at: 1727857324 + - type: ticket_type_attribute + id: '115' + 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: 63 + archived: false + created_at: 1727857323 + updated_at: 1727857323 + category: Customer + ticket_states: + type: list + data: + - type: ticket_state + id: '5465' + category: submitted + internal_label: Submitted + external_label: Submitted + - type: ticket_state + id: '5466' + category: in_progress + internal_label: In progress + external_label: In progress + - type: ticket_state + id: '5467' + category: waiting_on_customer + internal_label: Waiting on customer + external_label: Waiting on you + - type: ticket_state + id: '5468' + category: resolved + internal_label: Resolved + external_label: Resolved + schema: + '$ref': '#/components/schemas/ticket_type_list' '401': description: Unauthorized content: @@ -10328,19 +10694,22 @@ paths: type: error.list request_id: c8086fd8-b402-4c44-a87e-11fbea550dea errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' post: + x-fern-sdk-group-name: + - ticketTypes + x-fern-sdk-method-name: create 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: @@ -10367,68 +10736,68 @@ paths: ticket_type_attributes: type: list data: - - type: ticket_type_attribute - id: '123' - 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: 66 - archived: false - created_at: 1727857326 - updated_at: 1727857326 - - type: ticket_type_attribute - id: '124' - 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: 66 - archived: false - created_at: 1727857326 - updated_at: 1727857326 + - type: ticket_type_attribute + id: '123' + 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: 66 + archived: false + created_at: 1727857326 + updated_at: 1727857326 + - type: ticket_type_attribute + id: '124' + 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: 66 + archived: false + created_at: 1727857326 + updated_at: 1727857326 category: Customer ticket_states: type: list data: - - type: ticket_state - id: '5481' - category: submitted - internal_label: Submitted - external_label: Submitted - - type: ticket_state - id: '5482' - category: in_progress - internal_label: In progress - external_label: In progress - - type: ticket_state - id: '5483' - category: waiting_on_customer - internal_label: Waiting on customer - external_label: Waiting on you - - type: ticket_state - id: '5484' - category: resolved - internal_label: Resolved - external_label: Resolved + - type: ticket_state + id: '5481' + category: submitted + internal_label: Submitted + external_label: Submitted + - type: ticket_state + id: '5482' + category: in_progress + internal_label: In progress + external_label: In progress + - type: ticket_state + id: '5483' + category: waiting_on_customer + internal_label: Waiting on customer + external_label: Waiting on you + - type: ticket_state + id: '5484' + category: resolved + internal_label: Resolved + external_label: Resolved schema: - "$ref": "#/components/schemas/ticket_type" + '$ref': '#/components/schemas/ticket_type' '401': description: Unauthorized content: @@ -10439,15 +10808,15 @@ paths: type: error.list request_id: b83bb13d-ae98-4163-91c3-b067c573bbe2 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: - "$ref": "#/components/schemas/create_ticket_type_request" + '$ref': '#/components/schemas/create_ticket_type_request' examples: ticket_type_created: summary: Ticket type created @@ -10456,22 +10825,25 @@ paths: description: Customer Report Template icon: "\U0001F39F️" category: Customer - "/ticket_types/{id}": + '/ticket_types/{id}': get: - summary: Retrieve a ticket type + x-fern-sdk-group-name: + - ticketTypes + x-fern-sdk-method-name: get + summary: Get 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: @@ -10495,85 +10867,85 @@ paths: ticket_type_attributes: type: list data: - - type: ticket_type_attribute - id: '128' - 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: 68 - archived: false - created_at: 1727857327 - updated_at: 1727857327 - - type: ticket_type_attribute - id: '130' - 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: 68 - archived: false - created_at: 1727857328 - updated_at: 1727857328 - - type: ticket_type_attribute - id: '129' - 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: 68 - archived: false - created_at: 1727857327 - updated_at: 1727857327 + - type: ticket_type_attribute + id: '128' + 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: 68 + archived: false + created_at: 1727857327 + updated_at: 1727857327 + - type: ticket_type_attribute + id: '130' + 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: 68 + archived: false + created_at: 1727857328 + updated_at: 1727857328 + - type: ticket_type_attribute + id: '129' + 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: 68 + archived: false + created_at: 1727857327 + updated_at: 1727857327 category: Customer ticket_states: type: list data: - - type: ticket_state - id: '5497' - category: submitted - internal_label: Submitted - external_label: Submitted - - type: ticket_state - id: '5498' - category: in_progress - internal_label: In progress - external_label: In progress - - type: ticket_state - id: '5499' - category: waiting_on_customer - internal_label: Waiting on customer - external_label: Waiting on you - - type: ticket_state - id: '5500' - category: resolved - internal_label: Resolved - external_label: Resolved + - type: ticket_state + id: '5497' + category: submitted + internal_label: Submitted + external_label: Submitted + - type: ticket_state + id: '5498' + category: in_progress + internal_label: In progress + external_label: In progress + - type: ticket_state + id: '5499' + category: waiting_on_customer + internal_label: Waiting on customer + external_label: Waiting on you + - type: ticket_state + id: '5500' + category: resolved + internal_label: Resolved + external_label: Resolved schema: - "$ref": "#/components/schemas/ticket_type" + '$ref': '#/components/schemas/ticket_type' '401': description: Unauthorized content: @@ -10584,25 +10956,28 @@ paths: type: error.list request_id: fcd072d9-9d08-4ec8-8e0e-1b539b66bd02 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' put: + x-fern-sdk-group-name: + - ticketTypes + x-fern-sdk-method-name: update 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" @@ -10627,85 +11002,85 @@ paths: ticket_type_attributes: type: list data: - - type: ticket_type_attribute - id: '134' - 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: 70 - archived: false - created_at: 1727857329 - updated_at: 1727857329 - - type: ticket_type_attribute - id: '136' - 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: 70 - archived: false - created_at: 1727857329 - updated_at: 1727857329 - - type: ticket_type_attribute - id: '135' - 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: 70 - archived: false - created_at: 1727857329 - updated_at: 1727857329 + - type: ticket_type_attribute + id: '134' + 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: 70 + archived: false + created_at: 1727857329 + updated_at: 1727857329 + - type: ticket_type_attribute + id: '136' + 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: 70 + archived: false + created_at: 1727857329 + updated_at: 1727857329 + - type: ticket_type_attribute + id: '135' + 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: 70 + archived: false + created_at: 1727857329 + updated_at: 1727857329 category: Customer ticket_states: type: list data: - - type: ticket_state - id: '5513' - category: submitted - internal_label: Submitted - external_label: Submitted - - type: ticket_state - id: '5514' - category: in_progress - internal_label: In progress - external_label: In progress - - type: ticket_state - id: '5515' - category: waiting_on_customer - internal_label: Waiting on customer - external_label: Waiting on you - - type: ticket_state - id: '5516' - category: resolved - internal_label: Resolved - external_label: Resolved + - type: ticket_state + id: '5513' + category: submitted + internal_label: Submitted + external_label: Submitted + - type: ticket_state + id: '5514' + category: in_progress + internal_label: In progress + external_label: In progress + - type: ticket_state + id: '5515' + category: waiting_on_customer + internal_label: Waiting on customer + external_label: Waiting on you + - type: ticket_state + id: '5516' + category: resolved + internal_label: Resolved + external_label: Resolved schema: - "$ref": "#/components/schemas/ticket_type" + '$ref': '#/components/schemas/ticket_type' '401': description: Unauthorized content: @@ -10716,41 +11091,44 @@ paths: type: error.list request_id: 8fb6d693-a5a9-4cea-bf06-361fcbf8e3b9 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: - "$ref": "#/components/schemas/update_ticket_type_request" + '$ref': '#/components/schemas/update_ticket_type_request' examples: ticket_type_updated: summary: Ticket type updated value: name: Bug Report 2 - "/tickets/{id}/reply": + '/tickets/{id}/reply': post: + x-fern-sdk-group-name: + - tickets + x-fern-sdk-method-name: reply summary: Reply to a ticket operationId: replyTicket 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 @@ -10762,10 +11140,10 @@ paths: type: error.list request_id: 97e531a7-65bf-4cb3-a108-ea68c7ec4f9a 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" + '$ref': '#/components/schemas/error' '200': description: Admin quick_reply reply content: @@ -10794,8 +11172,8 @@ paths: author: id: '991267306' type: admin - name: Ciaran412 Lee - email: admin412@email.com + name: Joe Example + email: email@example.com attachments: [] redacted: false Admin quick_reply reply: @@ -10808,12 +11186,12 @@ paths: author: id: '991267311' type: admin - name: Ciaran416 Lee - email: admin416@email.com + name: Jane Example + email: email@example.com attachments: [] redacted: false schema: - "$ref": "#/components/schemas/ticket_reply" + '$ref': '#/components/schemas/ticket_reply' '404': description: Not found content: @@ -10824,10 +11202,10 @@ paths: type: error.list request_id: a0ee157b-43d6-4a68-902b-e32c13214566 errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -10838,17 +11216,17 @@ paths: type: error.list request_id: 1613ae6b-4f02-4134-a9a2-3087a5430fd0 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: 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 @@ -10880,10 +11258,10 @@ paths: type: admin admin_id: 991267311 reply_options: - - text: 'Yes' - uuid: 992196aa-7c1e-4efa-b010-898e540e31e9 - - text: 'No' - uuid: a2840bb0-6acc-42e5-9d14-f561ae7015f5 + - text: 'Yes' + uuid: 992196aa-7c1e-4efa-b010-898e540e31e9 + - text: 'No' + uuid: a2840bb0-6acc-42e5-9d14-f561ae7015f5 not_found: summary: Not found value: @@ -10891,24 +11269,28 @@ paths: type: user intercom_user_id: 66fd02c69ffbe52cc8b3ab2d body: Thanks again :) - "/tickets/{ticket_id}/tags": + '/tickets/{ticket_id}/tags': post: + x-fern-sdk-group-name: + - tickets + - tags + x-fern-sdk-method-name: addTag 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. @@ -10924,7 +11306,7 @@ paths: id: '88' name: Manual tag schema: - "$ref": "#/components/schemas/tag" + '$ref': '#/components/schemas/tag' '404': description: Ticket not found content: @@ -10935,10 +11317,10 @@ paths: type: error.list request_id: 043502bf-c192-4bf5-bb44-0bf721135e17 errors: - - code: ticket_not_found - message: Ticket not found + - code: ticket_not_found + message: Ticket not found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -10949,18 +11331,18 @@ paths: type: error.list request_id: 35f4e126-b7db-40a5-8f83-c080bac87d9e errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: type: object required: - - id - - admin_id + - id + - admin_id properties: id: type: string @@ -10983,31 +11365,35 @@ paths: value: id: 89 admin_id: 991267326 - "/tickets/{ticket_id}/tags/{id}": + '/tickets/{ticket_id}/tags/{id}': delete: + x-fern-sdk-group-name: + - tickets + - tags + x-fern-sdk-method-name: removeTag 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. @@ -11023,7 +11409,7 @@ paths: id: '91' name: Manual tag schema: - "$ref": "#/components/schemas/tag" + '$ref': '#/components/schemas/tag' '404': description: Tag not found content: @@ -11034,17 +11420,17 @@ paths: type: error.list request_id: ddcaec90-16e4-4fda-8e90-9425950fbf69 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: bb38ed23-9af4-4b6e-a7a8-5af78f1e79d8 errors: - - code: tag_not_found - message: Tag not found + - code: tag_not_found + message: Tag not found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -11055,17 +11441,17 @@ paths: type: error.list request_id: 4363447e-e266-4190-a81e-ccb30b700d2c errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: type: object required: - - admin_id + - admin_id properties: admin_id: type: string @@ -11085,16 +11471,19 @@ paths: summary: Tag not found value: admin_id: 991267346 - "/tickets": + '/tickets': post: + x-fern-sdk-group-name: + - tickets + x-fern-sdk-method-name: create 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: @@ -11131,47 +11520,47 @@ paths: ticket_type_attributes: type: list data: - - type: ticket_type_attribute - id: '145' - 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: 84 - archived: false - created_at: 1727857399 - updated_at: 1727857399 - - type: ticket_type_attribute - id: '146' - 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: 84 - archived: false - created_at: 1727857399 - updated_at: 1727857399 + - type: ticket_type_attribute + id: '145' + 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: 84 + archived: false + created_at: 1727857399 + updated_at: 1727857399 + - type: ticket_type_attribute + id: '146' + 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: 84 + archived: false + created_at: 1727857399 + updated_at: 1727857399 category: Back-office contacts: type: contact.list contacts: - - type: contact - id: 66fd02f79ffbe52cc8b3ab35 - external_id: '70' + - type: contact + id: 66fd02f79ffbe52cc8b3ab35 + external_id: '70' admin_assignee_id: '0' team_assignee_id: '0' created_at: 1727857400 @@ -11179,20 +11568,20 @@ paths: ticket_parts: type: ticket_part.list ticket_parts: - - type: ticket_part - id: '109' - part_type: ticket_state_updated_by_admin - ticket_state: submitted - previous_ticket_state: submitted - created_at: 1727857401 - updated_at: 1727857401 - author: - id: '991267362' - type: bot - name: Operator - email: operator+this_is_an_id688_that_should_be_at_least_@intercom.io - attachments: [] - redacted: false + - type: ticket_part + id: '109' + part_type: ticket_state_updated_by_admin + ticket_state: submitted + previous_ticket_state: submitted + created_at: 1727857401 + updated_at: 1727857401 + author: + id: '991267362' + type: bot + name: Operator + email: operator+this_is_an_id688_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false total_count: 1 open: true linked_objects: @@ -11203,7 +11592,7 @@ paths: category: Back-office is_shared: false schema: - "$ref": "#/components/schemas/ticket" + '$ref': '#/components/schemas/ticket' '401': description: Unauthorized content: @@ -11214,16 +11603,16 @@ paths: type: error.list request_id: '09018f45-6f49-485d-ada1-25a37a0e27a9' errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: allOf: - - "$ref": "#/components/schemas/create_ticket_request" + - '$ref': '#/components/schemas/create_ticket_request' properties: skip_notifications: type: boolean @@ -11235,26 +11624,29 @@ paths: value: ticket_type_id: 84 contacts: - - id: 66fd02f79ffbe52cc8b3ab35 + - id: 66fd02f79ffbe52cc8b3ab35 ticket_attributes: _default_title_: example _default_description_: there is a problem - "/tickets/{id}": + '/tickets/{id}': put: + x-fern-sdk-group-name: + - tickets + x-fern-sdk-method-name: update 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: @@ -11291,47 +11683,47 @@ paths: ticket_type_attributes: type: list data: - - type: ticket_type_attribute - id: '149' - 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: 86 - archived: false - created_at: 1727857403 - updated_at: 1727857403 - - type: ticket_type_attribute - id: '150' - 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: 86 - archived: false - created_at: 1727857404 - updated_at: 1727857404 + - type: ticket_type_attribute + id: '149' + 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: 86 + archived: false + created_at: 1727857403 + updated_at: 1727857403 + - type: ticket_type_attribute + id: '150' + 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: 86 + archived: false + created_at: 1727857404 + updated_at: 1727857404 category: Back-office contacts: type: contact.list contacts: - - type: contact - id: 66fd02fc9ffbe52cc8b3ab36 - external_id: 5541ee93-e8b8-4b09-b084-1e0b30d7e06b + - type: contact + id: 66fd02fc9ffbe52cc8b3ab36 + external_id: 5541ee93-e8b8-4b09-b084-1e0b30d7e06b admin_assignee_id: '991267376' team_assignee_id: '0' created_at: 1727857404 @@ -11339,85 +11731,85 @@ paths: ticket_parts: type: ticket_part.list ticket_parts: - - type: ticket_part - id: '110' - part_type: ticket_state_updated_by_admin - ticket_state: submitted - previous_ticket_state: submitted - created_at: 1727857405 - updated_at: 1727857405 - author: - id: '991267374' - type: admin - name: Ciaran470 Lee - email: admin470@email.com - attachments: [] - redacted: false - - type: ticket_part - id: '111' - part_type: ticket_attribute_updated_by_admin - created_at: 1727857408 - updated_at: 1727857408 - author: - id: '991267375' - type: bot - name: Operator - email: operator+this_is_an_id692_that_should_be_at_least_@intercom.io - attachments: [] - redacted: false - - type: ticket_part - id: '112' - part_type: ticket_attribute_updated_by_admin - created_at: 1727857408 - updated_at: 1727857408 - author: - id: '991267375' - type: bot - name: Operator - email: operator+this_is_an_id692_that_should_be_at_least_@intercom.io - attachments: [] - redacted: false - - type: ticket_part - id: '113' - part_type: ticket_state_updated_by_admin - ticket_state: in_progress - previous_ticket_state: submitted - created_at: 1727857408 - updated_at: 1727857408 - author: - id: '991267375' - type: bot - name: Operator - email: operator+this_is_an_id692_that_should_be_at_least_@intercom.io - attachments: [] - redacted: false - - type: ticket_part - id: '114' - part_type: assignment - created_at: 1727857409 - updated_at: 1727857409 - assigned_to: - type: admin - id: '991267376' - author: - id: '991267374' - type: admin - name: Ciaran470 Lee - email: admin470@email.com - attachments: [] - redacted: false - - type: ticket_part - id: '115' - part_type: snoozed - created_at: 1727857410 - updated_at: 1727857410 - author: - id: '991267375' - type: bot - name: Operator - email: operator+this_is_an_id692_that_should_be_at_least_@intercom.io - attachments: [] - redacted: false + - type: ticket_part + id: '110' + part_type: ticket_state_updated_by_admin + ticket_state: submitted + previous_ticket_state: submitted + created_at: 1727857405 + updated_at: 1727857405 + author: + id: '991267374' + type: admin + name: Jane Example + email: email@example.com + attachments: [] + redacted: false + - type: ticket_part + id: '111' + part_type: ticket_attribute_updated_by_admin + created_at: 1727857408 + updated_at: 1727857408 + author: + id: '991267375' + type: bot + name: Operator + email: operator+this_is_an_id692_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false + - type: ticket_part + id: '112' + part_type: ticket_attribute_updated_by_admin + created_at: 1727857408 + updated_at: 1727857408 + author: + id: '991267375' + type: bot + name: Operator + email: operator+this_is_an_id692_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false + - type: ticket_part + id: '113' + part_type: ticket_state_updated_by_admin + ticket_state: in_progress + previous_ticket_state: submitted + created_at: 1727857408 + updated_at: 1727857408 + author: + id: '991267375' + type: bot + name: Operator + email: operator+this_is_an_id692_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false + - type: ticket_part + id: '114' + part_type: assignment + created_at: 1727857409 + updated_at: 1727857409 + assigned_to: + type: admin + id: '991267376' + author: + id: '991267374' + type: admin + name: Jane Example + email: email@example.com + attachments: [] + redacted: false + - type: ticket_part + id: '115' + part_type: snoozed + created_at: 1727857410 + updated_at: 1727857410 + author: + id: '991267375' + type: bot + name: Operator + email: operator+this_is_an_id692_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false total_count: 6 open: true snoozed_until: 1727971200 @@ -11429,7 +11821,7 @@ paths: category: Back-office is_shared: false schema: - "$ref": "#/components/schemas/ticket" + '$ref': '#/components/schemas/ticket' '404': description: Assignee not found content: @@ -11440,15 +11832,15 @@ paths: type: error.list request_id: da26b7c9-6e36-4c8b-b9bd-4e49ba0c7188 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: 1da0e75f-fa8a-4510-bdb9-26ce477d205f 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. @@ -11460,9 +11852,9 @@ paths: type: error.list request_id: e182c683-6225-46af-9240-89f82130cd45 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: @@ -11473,15 +11865,15 @@ paths: type: error.list request_id: 4e23008e-87a3-4702-9917-517c9fd6da1f errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: - "$ref": "#/components/schemas/update_ticket_request" + '$ref': '#/components/schemas/update_ticket_request' examples: successful_response: summary: Successful response @@ -11521,20 +11913,23 @@ paths: value: ticket_state_id: 0 get: - summary: Retrieve a ticket + x-fern-sdk-group-name: + - tickets + x-fern-sdk-method-name: get + summary: Get 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: @@ -11571,47 +11966,47 @@ paths: ticket_type_attributes: type: list data: - - type: ticket_type_attribute - id: '159' - 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: 91 - archived: false - created_at: 1727857428 - updated_at: 1727857428 - - type: ticket_type_attribute - id: '160' - 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: 91 - archived: false - created_at: 1727857428 - updated_at: 1727857428 + - type: ticket_type_attribute + id: '159' + 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: 91 + archived: false + created_at: 1727857428 + updated_at: 1727857428 + - type: ticket_type_attribute + id: '160' + 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: 91 + archived: false + created_at: 1727857428 + updated_at: 1727857428 category: Back-office contacts: type: contact.list contacts: - - type: contact - id: 66fd03159ffbe52cc8b3ab3a - external_id: 152a82f6-36b2-484b-a049-a02b530561d4 + - type: contact + id: 66fd03159ffbe52cc8b3ab3a + external_id: 152a82f6-36b2-484b-a049-a02b530561d4 admin_assignee_id: '0' team_assignee_id: '0' created_at: 1727857429 @@ -11619,20 +12014,20 @@ paths: ticket_parts: type: ticket_part.list ticket_parts: - - type: ticket_part - id: '119' - part_type: ticket_state_updated_by_admin - ticket_state: submitted - previous_ticket_state: submitted - created_at: 1727857429 - updated_at: 1727857429 - author: - id: '991267410' - type: admin - name: Ciaran502 Lee - email: admin502@email.com - attachments: [] - redacted: false + - type: ticket_part + id: '119' + part_type: ticket_state_updated_by_admin + ticket_state: submitted + previous_ticket_state: submitted + created_at: 1727857429 + updated_at: 1727857429 + author: + id: '991267410' + type: admin + name: Joe Example + email: email@example.com + attachments: [] + redacted: false total_count: 1 open: true linked_objects: @@ -11643,7 +12038,7 @@ paths: category: Back-office is_shared: false schema: - "$ref": "#/components/schemas/ticket" + '$ref': '#/components/schemas/ticket' '401': description: Unauthorized content: @@ -11654,25 +12049,28 @@ paths: type: error.list request_id: e64cf768-c096-4660-a10f-3e4576552dcf errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' delete: + x-fern-sdk-group-name: + - tickets + x-fern-sdk-method-name: 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: @@ -11699,7 +12097,7 @@ paths: type: string description: always ticket enum: - - ticket + - ticket example: ticket deleted: type: boolean @@ -11715,8 +12113,8 @@ paths: type: error.list request_id: 0734062a-278f-4d71-b9eb-95d3d0836e88 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 @@ -11746,10 +12144,10 @@ paths: description: Ticket not found example: Ticket not found required: - - code + - code required: - - type - - errors + - type + - errors '401': description: Unauthorized content: @@ -11760,27 +12158,27 @@ paths: type: error.list request_id: 392d5127-e1e3-4e2a-b2b3-99c2fd576c07 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" - "/tickets/search": + '$ref': '#/components/schemas/error' + '/tickets/search': post: + x-fern-sdk-group-name: + - tickets + x-fern-sdk-method-name: search 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. - To search for tickets, you send a `POST` request to `https://api.intercom.io/tickets/search`. - - This will accept a query object in the body which will define your filters. {% admonition type="warning" name="Optimizing search queries" %} Search queries can be complex, so optimizing them can help the performance of your search. Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize @@ -11831,132 +12229,132 @@ paths: | != | All | Doesn't Equal | | IN | All | In Shortcut for `OR` queries Values most be in Array | | NIN | All | Not In Shortcut for `OR !` queries Values must be in Array | - | > | Integer Date (UNIX Timestamp) | Greater (or equal) than | - | < | Integer Date (UNIX Timestamp) | Lower (or equal) than | - | ~ | String | Contains | - | !~ | String | Doesn't Contain | - | ^ | String | Starts With | - | $ | String | Ends With | - responses: - '200': - description: successful - content: - application/json: - examples: - successful: - value: - type: ticket.list - pages: - type: pages - page: 1 - per_page: 5 - total_pages: 1 - total_count: 1 - tickets: - - type: ticket - id: '332' - ticket_id: '38' - ticket_attributes: - _default_title_: attribute_value - _default_description_: - ticket_state: - type: ticket_state - id: '5721' - category: submitted - internal_label: Submitted - external_label: Submitted - ticket_type: - type: ticket_type - id: '96' - 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: 1727857444 - updated_at: 1727857444 - is_internal: false - ticket_type_attributes: - type: list - data: - - type: ticket_type_attribute - id: '169' - 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: 96 - archived: false - created_at: 1727857444 - updated_at: 1727857444 - - type: ticket_type_attribute - id: '170' - 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: 96 - archived: false - created_at: 1727857445 - updated_at: 1727857445 - category: Back-office - contacts: - type: contact.list + | > | Integer Date (UNIX Timestamp) | Greater (or equal) than | + | < | Integer Date (UNIX Timestamp) | Lower (or equal) than | + | ~ | String | Contains | + | !~ | String | Doesn't Contain | + | ^ | String | Starts With | + | $ | String | Ends With | + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: ticket.list + pages: + type: pages + page: 1 + per_page: 5 + total_pages: 1 + total_count: 1 + tickets: + - type: ticket + id: '332' + ticket_id: '38' + ticket_attributes: + _default_title_: attribute_value + _default_description_: + ticket_state: + type: ticket_state + id: '5721' + category: submitted + internal_label: Submitted + external_label: Submitted + ticket_type: + type: ticket_type + id: '96' + 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: 1727857444 + updated_at: 1727857444 + is_internal: false + ticket_type_attributes: + type: list + data: + - type: ticket_type_attribute + id: '169' + 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: 96 + archived: false + created_at: 1727857444 + updated_at: 1727857444 + - type: ticket_type_attribute + id: '170' + 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: 96 + archived: false + created_at: 1727857445 + updated_at: 1727857445 + category: Back-office contacts: - - type: contact - id: 66fd03259ffbe52cc8b3ab3c - external_id: db14385b-0bfc-4275-ba1c-d4cad2293516 - admin_assignee_id: '0' - team_assignee_id: '0' - created_at: 1727857445 - updated_at: 1727857447 - ticket_parts: - type: ticket_part.list + type: contact.list + contacts: + - type: contact + id: 66fd03259ffbe52cc8b3ab3c + external_id: db14385b-0bfc-4275-ba1c-d4cad2293516 + admin_assignee_id: '0' + team_assignee_id: '0' + created_at: 1727857445 + updated_at: 1727857447 ticket_parts: - - type: ticket_part - id: '122' - part_type: ticket_state_updated_by_admin - ticket_state: submitted - previous_ticket_state: submitted - created_at: 1727857446 - updated_at: 1727857446 - author: - id: '991267442' - type: admin - name: Ciaran532 Lee - email: admin532@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: '122' + part_type: ticket_state_updated_by_admin + ticket_state: submitted + previous_ticket_state: submitted + created_at: 1727857446 + updated_at: 1727857446 + author: + id: '991267442' + type: admin + name: Joe Example + email: email@example.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" + '$ref': '#/components/schemas/ticket_list' requestBody: content: application/json: schema: - "$ref": "#/components/schemas/search_request" + '$ref': '#/components/schemas/search_request' examples: successful: summary: successful @@ -11964,24 +12362,27 @@ paths: query: operator: AND value: - - field: created_at - operator: ">" - value: '1306054154' + - field: created_at + operator: '>' + value: '1306054154' pagination: per_page: 5 - "/visitors": + '/visitors': put: + x-fern-sdk-group-name: + - visitors + x-fern-sdk-method-name: update summary: Update 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: updateVisitor description: | - Sending a PUT request to `/visitors` will result in an update of an existing Visitor. + Sending a PUT request to `/visitors` will update an existing Visitor. **Option 1.** You can update a visitor by passing in the `user_id` of the visitor in the Request body. @@ -12038,7 +12439,7 @@ paths: utm_term: do_not_track: schema: - "$ref": "#/components/schemas/visitor" + '$ref': '#/components/schemas/visitor' '404': description: visitor Not Found content: @@ -12049,10 +12450,10 @@ paths: type: error.list request_id: 9f8a197d-d8bd-425a-a09a-d09afc9ac9c3 errors: - - code: not_found - message: Visitor Not Found + - code: not_found + message: Visitor Not Found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -12063,15 +12464,15 @@ paths: type: error.list request_id: 5e7fe5b0-cf18-4034-a284-ea8ecb989d6a errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: - "$ref": "#/components/schemas/update_visitor_request" + '$ref': '#/components/schemas/update_visitor_request' examples: successful: summary: successful @@ -12084,20 +12485,23 @@ paths: user_id: fail name: Christian Fail get: + x-fern-sdk-group-name: + - visitors + x-fern-sdk-method-name: getByUserId 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: @@ -12152,7 +12556,7 @@ paths: utm_term: do_not_track: schema: - "$ref": "#/components/schemas/visitor" + '$ref': '#/components/schemas/visitor' '404': description: Visitor not found content: @@ -12163,10 +12567,10 @@ paths: type: error.list request_id: 312d4805-5369-47e3-b73e-f7c3bdbb8743 errors: - - code: not_found - message: Visitor Not Found + - code: not_found + message: Visitor Not Found schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' '401': description: Unauthorized content: @@ -12177,26 +12581,29 @@ paths: type: error.list request_id: b9f098b2-bdb5-4260-8ceb-78aa84f22c59 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" - "/visitors/convert": + '$ref': '#/components/schemas/error' + '/visitors/convert': post: + x-fern-sdk-group-name: + - visitors + - contacts + x-fern-sdk-method-name: convert 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 - exists, then the Visitor will be merged into it, the Visitor deleted and the - User returned. If the User does not exist, the Visitor will be converted to - a User, with the User identifiers replacing it's Visitor identifiers.\n" + description: "You can merge a Visitor to a Contact of role type `lead` or `user`.\n + If the User exists, then the Visitor will be merged and deleted. + If the User does not exist, the Visitor will be converted to a User, + with the User identifiers replacing it's Visitor identifiers.\n" responses: '200': description: successful @@ -12258,31 +12665,31 @@ paths: tags: type: list data: [] - url: "/contacts/66fd03319ffbe52cc8b3ab4c/tags" + url: '/contacts/66fd03319ffbe52cc8b3ab4c/tags' total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/66fd03319ffbe52cc8b3ab4c/notes" + url: '/contacts/66fd03319ffbe52cc8b3ab4c/notes' total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/66fd03319ffbe52cc8b3ab4c/companies" + url: '/contacts/66fd03319ffbe52cc8b3ab4c/companies' total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/66fd03319ffbe52cc8b3ab4c/subscriptions" + url: '/contacts/66fd03319ffbe52cc8b3ab4c/subscriptions' total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/66fd03319ffbe52cc8b3ab4c/subscriptions" + url: '/contacts/66fd03319ffbe52cc8b3ab4c/subscriptions' total_count: 0 has_more: false utm_campaign: @@ -12292,7 +12699,7 @@ paths: utm_term: referrer: schema: - "$ref": "#/components/schemas/contact" + '$ref': '#/components/schemas/contact' '401': description: Unauthorized content: @@ -12303,15 +12710,15 @@ paths: type: error.list request_id: 632444f2-db4e-421d-916f-1f229ca2ea1e errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - "$ref": "#/components/schemas/error" + '$ref': '#/components/schemas/error' requestBody: content: application/json: schema: - "$ref": "#/components/schemas/convert_visitor_request" + '$ref': '#/components/schemas/convert_visitor_request' examples: successful: summary: successful @@ -12355,7 +12762,7 @@ components: description: The IP address of the admin. example: 198.51.100.255 metadata: - "$ref": "#/components/schemas/activity_log_metadata" + '$ref': '#/components/schemas/activity_log_metadata' created_at: type: integer format: date-time @@ -12364,73 +12771,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 @@ -12447,12 +12854,12 @@ components: `activity_log.list`. example: activity_log.list pages: - "$ref": "#/components/schemas/cursor_pages" + '$ref': '#/components/schemas/cursor_pages' activity_logs: type: array description: An array of activity logs items: - "$ref": "#/components/schemas/activity_log" + '$ref': '#/components/schemas/activity_log' activity_log_metadata: title: Activity Log Metadata type: object @@ -12526,12 +12933,12 @@ components: type: string format: uri description: Url to get more company resources for this contact - example: "/contacts/5ba682d23d7cf92bef87bfd4/notes" + example: '/contacts/5ba682d23d7cf92bef87bfd4/notes' admin: title: Admin type: object x-tags: - - Admins + - Admins description: Admins are teammate accounts that have access to a workspace. nullable: true properties: @@ -12547,15 +12954,15 @@ components: name: type: string description: The name of the admin. - example: Hoban Washburne + example: Joe Example email: type: string description: The email of the admin. - example: wash@serenity.io + example: email@example.com job_title: type: string description: The job title of the admin. - example: Philosopher + example: Associate away_mode_enabled: type: boolean description: Identifies if this admin is currently set in away mode. @@ -12574,7 +12981,7 @@ components: type: array description: This object represents the avatar associated with the admin. example: - - 814865 + - 814865 items: type: integer avatar: @@ -12584,7 +12991,7 @@ components: description: Image for the associated team or teammate example: https://picsum.photos/200/300 team_priority_level: - "$ref": "#/components/schemas/team_priority_level" + '$ref': '#/components/schemas/team_priority_level' admin_list: title: Admins type: object @@ -12599,7 +13006,7 @@ components: type: array description: A list of admins associated with a given workspace. items: - "$ref": "#/components/schemas/admin" + '$ref': '#/components/schemas/admin' admin_priority_level: title: Admin Priority Level type: object @@ -12611,7 +13018,7 @@ components: description: The primary admin ids for the team nullable: true example: - - 493881 + - 493881 items: type: integer secondary_admin_ids: @@ -12619,7 +13026,7 @@ components: description: The secondary admin ids for the team nullable: true example: - - 814865 + - 814865 items: type: integer admin_reply_conversation_request: @@ -12630,14 +13037,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 @@ -12672,8 +13079,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 @@ -12687,12 +13094,12 @@ components: description: A list of files that will be added as attachments. You can include up to 10 files items: - "$ref": "#/components/schemas/conversation_attachment_files" + '$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 @@ -12701,14 +13108,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 @@ -12743,8 +13150,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 @@ -12754,14 +13161,21 @@ components: format: uri maxItems: 10 required: - - message_type - - type - - admin_id + - message_type + - type + - admin_id admin_with_app: title: Admin type: object description: Admins are the teammate accounts that have access to a workspace - nullable: true + required: + - type + - id + - name + - email_verified + - app + - avatar + - has_inbox_seat properties: type: type: string @@ -12775,15 +13189,15 @@ components: name: type: string description: The name of the admin. - example: Hoban Washburne + example: Jane Example email: type: string description: The email of the admin. - example: wash@serenity.io + example: email@example.com job_title: type: string description: The job title of the admin. - example: Philosopher + example: Associate away_mode_enabled: type: boolean description: Identifies if this admin is currently set in away mode. @@ -12803,7 +13217,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: @@ -12828,14 +13242,14 @@ components: nullable: true example: true app: - "$ref": "#/components/schemas/app" + '$ref': '#/components/schemas/app' nullable: true description: App that the admin belongs to. ai_agent: title: AI Agent type: object x-tags: - - Ai Agent + - Ai Agent description: Data related to AI Agent involvement in the conversation. properties: source_type: @@ -12843,11 +13257,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 @@ -12861,9 +13275,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: @@ -12871,11 +13285,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: @@ -12889,7 +13303,7 @@ components: example: Very helpful! nullable: true content_sources: - "$ref": "#/components/schemas/content_sources_list" + '$ref': '#/components/schemas/content_sources_list' app: title: App type: object @@ -12929,16 +13343,16 @@ 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. properties: statistics: nullable: true - "$ref": "#/components/schemas/article_statistics" + '$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 @@ -12949,8 +13363,8 @@ components: type: string description: The type of object - `article_content` . enum: - - - - article_content + - + - article_content example: article_content nullable: true title: @@ -12973,8 +13387,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 @@ -12999,10 +13413,10 @@ components: type: string description: The type of the object - `list`. enum: - - list + - list example: list pages: - "$ref": "#/components/schemas/cursor_pages" + '$ref': '#/components/schemas/cursor_pages' total_count: type: integer description: A count of the total number of articles. @@ -13011,19 +13425,19 @@ components: type: array description: An array of Article objects items: - "$ref": "#/components/schemas/article_list_item" + '$ref': '#/components/schemas/article_list_item' article_list_item: 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: @@ -13062,8 +13476,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: @@ -13099,8 +13513,8 @@ components: items: type: integer example: - - 18 - - 19 + - 18 + - 19 parent_type: type: string nullable: true @@ -13113,12 +13527,12 @@ components: example: en translated_content: nullable: true - "$ref": "#/components/schemas/article_translated_content" + '$ref': '#/components/schemas/article_translated_content' article_search_highlights: 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: @@ -13131,14 +13545,15 @@ components: description: An Article title highlighted. items: type: object + x-fern-type-name: HighlightedTitle description: A highlighted article title. properties: type: type: string description: The type of text - `highlight` or `plain`. enum: - - highlight - - plain + - highlight + - plain example: 'The highlight is ' text: type: string @@ -13147,6 +13562,7 @@ components: highlighted_summary: type: array description: An Article description and body text highlighted. + x-fern-type-name: HighlightedSummary items: type: array description: An array containing the highlighted summary text split into @@ -13154,30 +13570,33 @@ components: items: type: object description: An instance of highlighted summary text. + x-fern-type-name: HighlightedSummary properties: type: type: string description: The type of text - `highlight` or `plain`. + x-fern-type-name: HighlightedType enum: - - highlight - - plain + - highlight + - plain example: 'How to highlight ' text: type: string description: The text of the title. + x-fern-type-name: HighlightedText example: my query article_search_response: 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 @@ -13191,14 +13610,14 @@ components: type: array description: An array of Article objects items: - "$ref": "#/components/schemas/article" + '$ref': '#/components/schemas/article' highlights: type: array description: A corresponding array of highlighted Article content items: - "$ref": "#/components/schemas/article_search_highlights" + '$ref': '#/components/schemas/article_search_highlights' pages: - "$ref": "#/components/schemas/cursor_pages" + '$ref': '#/components/schemas/cursor_pages' article_statistics: title: Article Statistics type: object @@ -13209,7 +13628,7 @@ components: type: string description: The type of object - `article_statistics`. enum: - - article_statistics + - article_statistics default: article_statistics example: article_statistics views: @@ -13253,121 +13672,121 @@ 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: description: The content of the article in Arabic - "$ref": "#/components/schemas/article_content" + '$ref': '#/components/schemas/article_content' bg: description: The content of the article in Bulgarian - "$ref": "#/components/schemas/article_content" + '$ref': '#/components/schemas/article_content' bs: description: The content of the article in Bosnian - "$ref": "#/components/schemas/article_content" + '$ref': '#/components/schemas/article_content' ca: description: The content of the article in Catalan - "$ref": "#/components/schemas/article_content" + '$ref': '#/components/schemas/article_content' cs: description: The content of the article in Czech - "$ref": "#/components/schemas/article_content" + '$ref': '#/components/schemas/article_content' da: description: The content of the article in Danish - "$ref": "#/components/schemas/article_content" + '$ref': '#/components/schemas/article_content' de: description: The content of the article in German - "$ref": "#/components/schemas/article_content" + '$ref': '#/components/schemas/article_content' el: description: The content of the article in Greek - "$ref": "#/components/schemas/article_content" + '$ref': '#/components/schemas/article_content' en: description: The content of the article in English - "$ref": "#/components/schemas/article_content" + '$ref': '#/components/schemas/article_content' es: description: The content of the article in Spanish - "$ref": "#/components/schemas/article_content" + '$ref': '#/components/schemas/article_content' et: description: The content of the article in Estonian - "$ref": "#/components/schemas/article_content" + '$ref': '#/components/schemas/article_content' fi: description: The content of the article in Finnish - "$ref": "#/components/schemas/article_content" + '$ref': '#/components/schemas/article_content' fr: description: The content of the article in French - "$ref": "#/components/schemas/article_content" + '$ref': '#/components/schemas/article_content' he: description: The content of the article in Hebrew - "$ref": "#/components/schemas/article_content" + '$ref': '#/components/schemas/article_content' hr: description: The content of the article in Croatian - "$ref": "#/components/schemas/article_content" + '$ref': '#/components/schemas/article_content' hu: description: The content of the article in Hungarian - "$ref": "#/components/schemas/article_content" + '$ref': '#/components/schemas/article_content' id: description: The content of the article in Indonesian - "$ref": "#/components/schemas/article_content" + '$ref': '#/components/schemas/article_content' it: description: The content of the article in Italian - "$ref": "#/components/schemas/article_content" + '$ref': '#/components/schemas/article_content' ja: description: The content of the article in Japanese - "$ref": "#/components/schemas/article_content" + '$ref': '#/components/schemas/article_content' ko: description: The content of the article in Korean - "$ref": "#/components/schemas/article_content" + '$ref': '#/components/schemas/article_content' lt: description: The content of the article in Lithuanian - "$ref": "#/components/schemas/article_content" + '$ref': '#/components/schemas/article_content' lv: description: The content of the article in Latvian - "$ref": "#/components/schemas/article_content" + '$ref': '#/components/schemas/article_content' mn: description: The content of the article in Mongolian - "$ref": "#/components/schemas/article_content" + '$ref': '#/components/schemas/article_content' nb: description: The content of the article in Norwegian - "$ref": "#/components/schemas/article_content" + '$ref': '#/components/schemas/article_content' nl: description: The content of the article in Dutch - "$ref": "#/components/schemas/article_content" + '$ref': '#/components/schemas/article_content' pl: description: The content of the article in Polish - "$ref": "#/components/schemas/article_content" + '$ref': '#/components/schemas/article_content' pt: description: The content of the article in Portuguese (Portugal) - "$ref": "#/components/schemas/article_content" + '$ref': '#/components/schemas/article_content' ro: description: The content of the article in Romanian - "$ref": "#/components/schemas/article_content" + '$ref': '#/components/schemas/article_content' ru: description: The content of the article in Russian - "$ref": "#/components/schemas/article_content" + '$ref': '#/components/schemas/article_content' sl: description: The content of the article in Slovenian - "$ref": "#/components/schemas/article_content" + '$ref': '#/components/schemas/article_content' sr: description: The content of the article in Serbian - "$ref": "#/components/schemas/article_content" + '$ref': '#/components/schemas/article_content' sv: description: The content of the article in Swedish - "$ref": "#/components/schemas/article_content" + '$ref': '#/components/schemas/article_content' tr: description: The content of the article in Turkish - "$ref": "#/components/schemas/article_content" + '$ref': '#/components/schemas/article_content' vi: description: The content of the article in Vietnamese - "$ref": "#/components/schemas/article_content" + '$ref': '#/components/schemas/article_content' pt-BR: description: The content of the article in Portuguese (Brazil) - "$ref": "#/components/schemas/article_content" + '$ref': '#/components/schemas/article_content' zh-CN: description: The content of the article in Chinese (China) - "$ref": "#/components/schemas/article_content" + '$ref': '#/components/schemas/article_content' zh-TW: description: The content of the article in Chinese (Taiwan) - "$ref": "#/components/schemas/article_content" + '$ref': '#/components/schemas/article_content' assign_conversation_request: title: Assign Conversation Request type: object @@ -13376,13 +13795,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 @@ -13400,10 +13819,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 @@ -13416,38 +13835,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 close_conversation_request: title: Close Conversation Request type: object @@ -13456,12 +13875,12 @@ components: message_type: type: string enum: - - close + - close example: close type: type: string enum: - - admin + - admin example: admin admin_id: type: string @@ -13471,16 +13890,16 @@ components: type: string description: Optionally you can leave a message in the conversation to provide additional context to the user and other teammates. - example: " This conversation is now closed!" + 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: @@ -13542,7 +13961,7 @@ components: example: en translated_content: nullable: true - "$ref": "#/components/schemas/group_translated_content" + '$ref': '#/components/schemas/group_translated_content' parent_id: type: string nullable: true @@ -13563,10 +13982,10 @@ components: type: string description: The type of the object - `list`. enum: - - list + - list example: list pages: - "$ref": "#/components/schemas/cursor_pages" + '$ref': '#/components/schemas/cursor_pages' total_count: type: integer description: A count of the total number of collections. @@ -13575,12 +13994,12 @@ components: type: array description: An array of collection objects items: - "$ref": "#/components/schemas/collection" + '$ref': '#/components/schemas/collection' company: 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. @@ -13589,7 +14008,7 @@ components: type: string description: Value is `company` enum: - - company + - company example: company id: type: string @@ -13680,12 +14099,12 @@ components: type: string description: The type of the object enum: - - tag.list + - tag.list tags: type: array items: items: - "$ref": "#/components/schemas/tag" + '$ref': '#/components/schemas/tag' segments: type: object description: The list of segments associated with the company @@ -13694,11 +14113,11 @@ components: type: string description: The type of the object enum: - - segment.list + - segment.list segments: type: array items: - "$ref": "#/components/schemas/segment" + '$ref': '#/components/schemas/segment' company_attached_contacts: title: Company Attached Contacts type: object @@ -13708,19 +14127,19 @@ components: type: string description: The type of object - `list` enum: - - list + - list example: list data: type: array description: An array containing Contact Objects items: - "$ref": "#/components/schemas/contact" + '$ref': '#/components/schemas/contact' total_count: type: integer description: The total number of contacts example: 100 pages: - "$ref": "#/components/schemas/cursor_pages" + '$ref': '#/components/schemas/cursor_pages' company_attached_segments: title: Company Attached Segments type: object @@ -13730,13 +14149,13 @@ components: type: string description: The type of object - `list` enum: - - list + - list example: list data: type: array description: An array containing Segment Objects items: - "$ref": "#/components/schemas/segment" + '$ref': '#/components/schemas/segment' company_list: title: Companies type: object @@ -13746,10 +14165,10 @@ components: type: string description: The type of object - `list`. enum: - - list + - list example: list pages: - "$ref": "#/components/schemas/cursor_pages" + '$ref': '#/components/schemas/cursor_pages' total_count: type: integer description: The total number of companies. @@ -13758,7 +14177,7 @@ components: type: array description: An array containing Company Objects. items: - "$ref": "#/components/schemas/company" + '$ref': '#/components/schemas/company' company_scroll: title: Company Scroll type: object @@ -13771,14 +14190,14 @@ components: type: string description: The type of object - `list` enum: - - list + - list example: list data: type: array items: - "$ref": "#/components/schemas/company" + '$ref': '#/components/schemas/company' pages: - "$ref": "#/components/schemas/cursor_pages" + '$ref': '#/components/schemas/cursor_pages' total_count: type: integer description: The total number of companies @@ -13793,7 +14212,7 @@ components: title: Contact type: object x-tags: - - Contacts + - Contacts description: Contact are the objects that represent your leads and users in Intercom. properties: @@ -13831,12 +14250,12 @@ components: type: string nullable: true description: The contacts phone. - example: "+1123456789" + example: '+1123456789' formatted_phone: type: string nullable: true description: The contacts phone number normalized to the E164 format - example: "+1123456789" + example: '+1123456789' name: type: string nullable: true @@ -13863,52 +14282,52 @@ components: created_at: type: integer format: date-time - description: "(UNIX timestamp) The time when the contact was created." + description: '(UNIX timestamp) The time when the contact was created.' example: 1571672154 updated_at: type: integer format: date-time - description: "(UNIX timestamp) The time when the contact was last updated." + description: '(UNIX timestamp) The time when the contact was last updated.' example: 1571672154 signed_up_at: type: integer format: date-time nullable: true - description: "(UNIX timestamp) The time specified for when a contact signed - up." + description: '(UNIX timestamp) The time specified for when a contact signed + up.' example: 1571672154 last_seen_at: type: integer format: date-time nullable: true - description: "(UNIX timestamp) The time when the contact was last seen (either - where the Intercom Messenger was installed or when specified manually)." + description: '(UNIX timestamp) The time when the contact was last seen (either + where the Intercom Messenger was installed or when specified manually).' example: 1571672154 last_replied_at: type: integer format: date-time nullable: true - description: "(UNIX timestamp) The time when the contact last messaged in." + description: '(UNIX timestamp) The time when the contact last messaged in.' example: 1571672154 last_contacted_at: type: integer format: date-time nullable: true - description: "(UNIX timestamp) The time when the contact was last messaged." + description: '(UNIX timestamp) The time when the contact was last messaged.' example: 1571672154 last_email_opened_at: type: integer format: date-time nullable: true - description: "(UNIX timestamp) The time when the contact last opened an - email." + description: '(UNIX timestamp) The time when the contact last opened an + email.' example: 1571672154 last_email_clicked_at: type: integer format: date-time nullable: true - description: "(UNIX timestamp) The time when the contact last clicked a - link in an email." + description: '(UNIX timestamp) The time when the contact last clicked a + link in an email.' example: 1571672154 language_override: type: string @@ -13965,8 +14384,8 @@ components: type: integer nullable: true format: date-time - description: "(UNIX timestamp) The time when the contact was last seen on - an Android device." + description: '(UNIX timestamp) The time when the contact was last seen on + an Android device.' example: 1571672154 ios_app_name: type: string @@ -13997,7 +14416,7 @@ components: type: integer nullable: true format: date-time - description: "(UNIX timestamp) The last time the contact used the iOS app." + description: '(UNIX timestamp) The last time the contact used the iOS app.' example: 1571672154 custom_attributes: type: object @@ -14017,15 +14436,15 @@ components: description: An image URL containing the avatar of a contact. example: https://example.org/128Wash.jpg tags: - "$ref": "#/components/schemas/contact_tags" + '$ref': '#/components/schemas/contact_tags' notes: - "$ref": "#/components/schemas/contact_notes" + '$ref': '#/components/schemas/contact_notes' companies: - "$ref": "#/components/schemas/contact_companies" + '$ref': '#/components/schemas/contact_companies' location: - "$ref": "#/components/schemas/contact_location" + '$ref': '#/components/schemas/contact_location' social_profiles: - "$ref": "#/components/schemas/contact_social_profiles" + '$ref': '#/components/schemas/contact_social_profiles' contact_archived: title: Contact Archived type: object @@ -14035,7 +14454,7 @@ components: type: string description: always contact enum: - - contact + - contact example: contact id: type: string @@ -14060,19 +14479,19 @@ components: type: string description: The type of object enum: - - list + - list example: list companies: type: array description: An array containing Company Objects items: - "$ref": "#/components/schemas/company" + '$ref': '#/components/schemas/company' total_count: type: integer description: The total number of companies associated to this contact example: 100 pages: - "$ref": "#/components/schemas/pages_link" + '$ref': '#/components/schemas/pages_link' contact_companies: title: Contact companies type: object @@ -14084,7 +14503,7 @@ components: type: string format: uri description: Url to get more company resources for this contact - example: "/contacts/5ba682d23d7cf92bef87bfd4/companies" + example: '/contacts/5ba682d23d7cf92bef87bfd4/companies' total_count: type: integer description: Int representing the total number of companyies attached to @@ -14104,7 +14523,7 @@ components: type: string description: always contact enum: - - contact + - contact example: contact id: type: string @@ -14129,19 +14548,19 @@ components: type: string description: Always list enum: - - list + - list example: list data: type: array description: The list of contact objects items: - "$ref": "#/components/schemas/contact" + '$ref': '#/components/schemas/contact' total_count: type: integer description: A count of the total number of objects. example: 100 pages: - "$ref": "#/components/schemas/cursor_pages" + '$ref': '#/components/schemas/cursor_pages' contact_location: title: Contact Location type: object @@ -14179,12 +14598,12 @@ components: type: array description: This object represents the notes attached to a contact. items: - "$ref": "#/components/schemas/addressable_list" + '$ref': '#/components/schemas/addressable_list' url: type: string format: uri description: Url to get more company resources for this contact - example: "/contacts/5ba682d23d7cf92bef87bfd4/notes" + example: '/contacts/5ba682d23d7cf92bef87bfd4/notes' total_count: type: integer description: Int representing the total number of companyies attached to @@ -14204,7 +14623,7 @@ components: type: string description: always contact enum: - - contact + - contact example: contact id: type: string @@ -14223,11 +14642,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. @@ -14246,15 +14665,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 @@ -14268,18 +14687,18 @@ components: type: array description: A list of files that will be added as attachments. items: - "$ref": "#/components/schemas/conversation_attachment_files" + '$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 @@ -14288,9 +14707,9 @@ components: type: array description: A list of files that will be added as attachments. items: - "$ref": "#/components/schemas/conversation_attachment_files" + '$ref': '#/components/schemas/conversation_attachment_files' required: - - intercom_user_id + - intercom_user_id contact_reply_ticket_email_request: title: Email type: object @@ -14301,48 +14720,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 @@ -14352,10 +14771,10 @@ components: description: A list of files that will be added as attachments. You can include up to 10 files. items: - "$ref": "#/components/schemas/conversation_attachment_files" + '$ref': '#/components/schemas/conversation_attachment_files' maxItems: 10 required: - - user_id + - user_id contact_segments: title: Segments type: object @@ -14365,13 +14784,13 @@ components: type: string description: The type of the object enum: - - list + - list example: list data: type: array description: Segment objects associated with the contact. items: - "$ref": "#/components/schemas/segment" + '$ref': '#/components/schemas/segment' contact_social_profiles: title: Social Profile type: object @@ -14382,7 +14801,7 @@ components: type: array description: A list of social profiles objects associated with the contact. items: - "$ref": "#/components/schemas/social_profile" + '$ref': '#/components/schemas/social_profile' contact_subscription_types: title: Contact Subscription Types type: object @@ -14394,12 +14813,12 @@ components: type: array description: This object represents the subscriptions attached to a contact. items: - "$ref": "#/components/schemas/addressable_list" + '$ref': '#/components/schemas/addressable_list' url: type: string format: uri description: Url to get more subscription type resources for this contact - example: "/contacts/5ba682d23d7cf92bef87bfd4/subscriptions" + example: '/contacts/5ba682d23d7cf92bef87bfd4/subscriptions' total_count: type: integer description: Int representing the total number of subscription types attached @@ -14421,12 +14840,12 @@ components: type: array description: This object represents the tags attached to a contact. items: - "$ref": "#/components/schemas/addressable_list" + '$ref': '#/components/schemas/addressable_list' url: type: string format: uri description: url to get more tag resources for this contact - example: "/contacts/5ba682d23d7cf92bef87bfd4/tags" + example: '/contacts/5ba682d23d7cf92bef87bfd4/tags' total_count: type: integer description: Int representing the total number of tags attached to this @@ -14446,7 +14865,7 @@ components: type: string description: always contact enum: - - contact + - contact example: contact id: type: string @@ -14466,7 +14885,7 @@ components: 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 @@ -14475,7 +14894,7 @@ components: type: string description: Always external_page enum: - - content_import_source + - content_import_source default: content_import_source example: content_import_source id: @@ -14493,16 +14912,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: @@ -14520,19 +14939,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: @@ -14540,10 +14959,10 @@ components: type: string description: The type of the object - `list`. enum: - - list + - list example: list pages: - "$ref": "#/components/schemas/pages_link" + '$ref': '#/components/schemas/pages_link' total_count: type: integer description: A count of the total number of content import sources. @@ -14552,12 +14971,12 @@ components: type: array description: An array of Content Import Source objects items: - "$ref": "#/components/schemas/content_import_source" + '$ref': '#/components/schemas/content_import_source' content_source: 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: @@ -14565,15 +14984,15 @@ 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. - example: "/fin-ai-agent/content?content=content_snippet&id=3234924" + example: '/fin-ai-agent/content?content=content_snippet&id=3234924' title: type: string description: The title of the content source. @@ -14589,7 +15008,7 @@ components: type: type: string enum: - - content_source.list + - content_source.list example: content_source.list total_count: type: integer @@ -14600,12 +15019,12 @@ components: type: array description: The content sources used by AI Agent in the conversation. items: - "$ref": "#/components/schemas/content_source" + '$ref': '#/components/schemas/content_source' conversation: 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. @@ -14656,9 +15075,9 @@ components: state: type: string enum: - - open - - closed - - snoozed + - open + - closed + - snoozed description: Can be set to "open", "closed" or "snoozed". example: open read: @@ -14668,8 +15087,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: @@ -14685,33 +15104,33 @@ components: assigned to a team it will return null. example: '5017691' tags: - "$ref": "#/components/schemas/tags" + '$ref': '#/components/schemas/tags' conversation_rating: - "$ref": "#/components/schemas/conversation_rating" + '$ref': '#/components/schemas/conversation_rating' source: - "$ref": "#/components/schemas/conversation_source" + '$ref': '#/components/schemas/conversation_source' contacts: - "$ref": "#/components/schemas/conversation_contacts" + '$ref': '#/components/schemas/conversation_contacts' teammates: - "$ref": "#/components/schemas/conversation_teammates" + '$ref': '#/components/schemas/conversation_teammates' custom_attributes: - "$ref": "#/components/schemas/custom_attributes" + '$ref': '#/components/schemas/custom_attributes' first_contact_reply: - "$ref": "#/components/schemas/conversation_first_contact_reply" + '$ref': '#/components/schemas/conversation_first_contact_reply' sla_applied: - "$ref": "#/components/schemas/sla_applied" + '$ref': '#/components/schemas/sla_applied' statistics: - "$ref": "#/components/schemas/conversation_statistics" + '$ref': '#/components/schemas/conversation_statistics' conversation_parts: - "$ref": "#/components/schemas/conversation_parts" + '$ref': '#/components/schemas/conversation_parts' linked_objects: - "$ref": "#/components/schemas/linked_object_list" + '$ref': '#/components/schemas/linked_object_list' ai_agent_participated: type: boolean description: Indicates whether the AI Agent participated in the conversation. example: true ai_agent: - "$ref": "#/components/schemas/ai_agent" + '$ref': '#/components/schemas/ai_agent' nullable: true conversation_attachment_files: title: Conversation attachment files @@ -14741,7 +15160,7 @@ components: type: string description: '' enum: - - contact.list + - contact.list example: contact.list contacts: type: array @@ -14749,7 +15168,7 @@ components: This will only contain one customer unless more were added via the group conversation feature. items: - "$ref": "#/components/schemas/contact_reference" + '$ref': '#/components/schemas/contact_reference' conversation_deleted: title: Conversation Deleted type: object @@ -14763,7 +15182,7 @@ components: type: string description: always conversation enum: - - conversation + - conversation example: conversation deleted: type: boolean @@ -14801,19 +15220,19 @@ components: type: string description: Always conversation.list enum: - - conversation.list + - conversation.list example: conversation.list conversations: type: array description: The list of conversation objects items: - "$ref": "#/components/schemas/conversation" + '$ref': '#/components/schemas/conversation' total_count: type: integer description: A count of the total number of objects. example: 12345 pages: - "$ref": "#/components/schemas/cursor_pages" + '$ref': '#/components/schemas/cursor_pages' conversation_part: title: Conversation Part type: object @@ -14836,7 +15255,7 @@ components: nullable: true description: The message body, which may contain HTML. For Twitter, this will show a generic message regarding why the body is obscured. - example: "

Okay!

" + example: '

Okay!

' created_at: type: integer format: date-time @@ -14853,18 +15272,18 @@ components: description: The time the user was notified with the conversation part. example: 1663597260 assigned_to: - "$ref": "#/components/schemas/reference" + '$ref': '#/components/schemas/reference' nullable: true description: The id of the admin that was assigned the conversation by this conversation_part (null if there has been no change in assignment.) author: - "$ref": "#/components/schemas/conversation_part_author" + '$ref': '#/components/schemas/conversation_part_author' attachments: title: Conversation part attachments type: array description: A list of attachments for the part. items: - "$ref": "#/components/schemas/part_attachment" + '$ref': '#/components/schemas/part_attachment' external_id: type: string nullable: true @@ -14875,7 +15294,7 @@ components: description: Whether or not the conversation part has been redacted. example: false email_message_metadata: - "$ref": "#/components/schemas/email_message_metadata" + '$ref': '#/components/schemas/email_message_metadata' nullable: true conversation_part_author: title: Conversation part author @@ -14912,7 +15331,7 @@ components: type: string description: '' enum: - - conversation_part.list + - conversation_part.list example: conversation_part.list conversation_parts: title: Conversation Parts @@ -14921,7 +15340,7 @@ components: the conversation. This is only returned when Retrieving a Conversation, and ignored when Listing all Conversations. There is a limit of 500 parts. items: - "$ref": "#/components/schemas/conversation_part" + '$ref': '#/components/schemas/conversation_part' total_count: type: integer description: '' @@ -14949,9 +15368,9 @@ components: rated. example: 1671028894 contact: - "$ref": "#/components/schemas/contact_reference" + '$ref': '#/components/schemas/contact_reference' teammate: - "$ref": "#/components/schemas/reference" + '$ref': '#/components/schemas/reference' conversation_response_time: title: Conversation response time type: object @@ -15002,14 +15421,14 @@ components: type: string description: The message body, which may contain HTML. For Twitter, this will show a generic message regarding why the body is obscured. - example: "

Hey there!

" + example: '

Hey there!

' author: - "$ref": "#/components/schemas/conversation_part_author" + '$ref': '#/components/schemas/conversation_part_author' attachments: type: array description: A list of attachments for the part. items: - "$ref": "#/components/schemas/part_attachment" + '$ref': '#/components/schemas/part_attachment' url: type: string nullable: true @@ -15123,13 +15542,13 @@ components: type: array description: An array of conversation response time objects items: - "$ref": "#/components/schemas/conversation_response_time" + '$ref': '#/components/schemas/conversation_response_time' assigned_team_first_response_time_in_office_hours: type: array description: An array of conversation response time objects within office hours items: - "$ref": "#/components/schemas/conversation_response_time" + '$ref': '#/components/schemas/conversation_response_time' handling_time: type: integer description: Time from conversation assignment to conversation close in @@ -15151,7 +15570,7 @@ components: description: The list of teammates who participated in the conversation (wrote at least one conversation part). items: - "$ref": "#/components/schemas/reference" + '$ref': '#/components/schemas/reference' convert_conversation_to_ticket_request: description: You can convert a Conversation to a Ticket type: object @@ -15163,9 +15582,9 @@ components: to example: '1234' attributes: - "$ref": "#/components/schemas/ticket_request_custom_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 @@ -15195,10 +15614,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. @@ -15217,16 +15636,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 @@ -15247,7 +15666,7 @@ components: type: string description: The content of the article. For multilingual articles, this will be the body of the default language's content. - example: "

This is the body in html

" + example: '

This is the body in html

' author_id: type: integer description: The id of the author of the article. For multilingual articles, @@ -15260,8 +15679,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 @@ -15273,10 +15692,10 @@ components: description: The type of parent, which can either be a `collection` or `section`. example: collection translated_content: - "$ref": "#/components/schemas/article_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 @@ -15294,7 +15713,7 @@ components: example: English description translated_content: nullable: true - "$ref": "#/components/schemas/group_translated_content" + '$ref': '#/components/schemas/group_translated_content' parent_id: type: string nullable: true @@ -15308,7 +15727,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 @@ -15328,7 +15747,7 @@ components: type: string nullable: true description: The contacts phone - example: "+353871234567" + example: '+353871234567' name: type: string nullable: true @@ -15368,15 +15787,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 @@ -15388,14 +15807,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: @@ -15403,8 +15822,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 @@ -15418,9 +15837,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: @@ -15431,15 +15850,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 required: - - from - - body + - from + - body create_data_attribute_request: description: '' type: object @@ -15453,19 +15872,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 @@ -15478,16 +15897,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 @@ -15527,21 +15946,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 @@ -15597,8 +16016,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 @@ -15612,7 +16031,7 @@ components: html: type: string description: The body of the external page in HTML. - example: "

Hello world!

" + example: '

Hello world!

' url: type: string description: The URL of the external page. This will be used by Fin to link @@ -15628,7 +16047,7 @@ components: type: string description: Always en enum: - - en + - en default: en example: en source_id: @@ -15646,11 +16065,11 @@ components: source. Must be unique for the source. example: '5678' required: - - title - - html - - url - - locale - - source_id + - title + - html + - url + - locale + - source_id create_message_request: description: You can create a message type: object @@ -15661,8 +16080,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 @@ -15686,15 +16105,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 @@ -15704,16 +16123,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 @@ -15726,20 +16145,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: `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 @@ -15835,7 +16254,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 @@ -15846,16 +16265,16 @@ components: type: string description: Phone number in E.164 format, that will receive the SMS to continue the conversation in the Messenger. - example: "+1 1234567890" + example: '+1 1234567890' custom_attributes: - "$ref": "#/components/schemas/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 @@ -15872,32 +16291,32 @@ components: 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 + - 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' company_id: type: string description: The ID of the company that the ticket is associated with. The @@ -15909,10 +16328,10 @@ components: time will be used. example: 1590000000 ticket_attributes: - "$ref": "#/components/schemas/ticket_request_custom_attributes" + '$ref': '#/components/schemas/ticket_request_custom_attributes' required: - - ticket_type_id - - contacts + - ticket_type_id + - contacts create_ticket_type_attribute_request: description: You can create a Ticket Type Attribute type: object @@ -15931,13 +16350,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 @@ -15979,9 +16398,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. @@ -16002,9 +16421,9 @@ components: type: string description: Category of the Ticket Type. enum: - - Customer - - Back-office - - Tracker + - Customer + - Back-office + - Tracker example: Customer icon: type: string @@ -16019,7 +16438,7 @@ components: example: false default: false required: - - name + - name cursor_pages: title: Cursor based pages type: object @@ -16033,13 +16452,13 @@ components: description: the type of object `pages`. example: pages enum: - - pages + - pages page: type: integer description: The current page example: 1 next: - "$ref": "#/components/schemas/starting_after_paging" + '$ref': '#/components/schemas/starting_after_paging' per_page: type: integer description: Number of results per page @@ -16056,13 +16475,13 @@ components: will be a list of custom object instance models. additionalProperties: anyOf: - - type: string - - "$ref": "#/components/schemas/custom_object_instance" + - type: string + - '$ref': '#/components/schemas/custom_object_instance' 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 @@ -16109,37 +16528,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 @@ -16149,7 +16568,7 @@ components: type: string description: Value is `data_attribute`. enum: - - data_attribute + - data_attribute example: data_attribute id: type: integer @@ -16161,8 +16580,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 @@ -16186,11 +16605,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 @@ -16198,8 +16617,8 @@ components: items: type: string example: - - 'true' - - 'false' + - 'true' + - 'false' api_writable: type: boolean description: Can this attribute be updated through API @@ -16244,25 +16663,25 @@ components: type: string description: The type of the object enum: - - list + - list example: list data: type: array description: A list of data attributes items: - "$ref": "#/components/schemas/data_attribute" + '$ref': '#/components/schemas/data_attribute' data_event: 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 @@ -16301,8 +16720,8 @@ components: example: invite_code: ADDAFRIEND required: - - event_name - - created_at + - event_name + - created_at data_event_list: title: Data Event List type: object @@ -16312,13 +16731,13 @@ components: type: string description: The type of the object enum: - - event.list + - event.list example: event.list events: type: array description: A list of data events items: - "$ref": "#/components/schemas/data_event" + '$ref': '#/components/schemas/data_event' pages: type: object description: Pagination @@ -16338,7 +16757,7 @@ components: type: string description: The type of the object enum: - - event.summary + - event.summary example: event.summary email: type: string @@ -16356,7 +16775,7 @@ components: type: array description: A summary of data events items: - "$ref": "#/components/schemas/data_event_summary_item" + '$ref': '#/components/schemas/data_event_summary_item' data_event_summary_item: title: Data Event Summary Item type: object @@ -16387,7 +16806,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: @@ -16398,12 +16817,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: @@ -16524,7 +16943,7 @@ components: type: string description: The type of object which was deleted. - article enum: - - article + - article example: article deleted: type: boolean @@ -16544,7 +16963,7 @@ components: type: string description: The type of object which was deleted. - `collection` enum: - - collection + - collection example: collection deleted: type: boolean @@ -16558,12 +16977,12 @@ components: id: type: string description: The unique identifier for the company which is given by Intercom. - example: 5b7e8b2f-7a1a-4e6c-8e1b-4f9d4f4c4d4f + example: 6634ab5eafff231757496dd7 object: type: string description: The type of object which was deleted. - `company` enum: - - company + - company example: company deleted: type: boolean @@ -16583,7 +17002,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 @@ -16596,7 +17015,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 @@ -16610,12 +17029,12 @@ components: email_address: type: string description: The email address - example: wash@serenity.io + example: email@example.com name: type: string nullable: true description: The name associated with the email address - example: Hoban Washburne + example: Jane Example email_message_metadata: title: Email Message Metadata type: object @@ -16630,7 +17049,7 @@ components: type: array description: A list of an email address headers. items: - "$ref": "#/components/schemas/email_address_header" + '$ref': '#/components/schemas/email_address_header' error: type: object title: Error @@ -16669,15 +17088,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: @@ -16685,7 +17104,7 @@ components: type: string description: Always external_page enum: - - external_page + - external_page default: external_page example: external_page id: @@ -16700,7 +17119,7 @@ components: html: type: string description: The body of the external page in HTML. - example: "

Hello world!

" + example: '

Hello world!

' url: type: string description: The URL of the external page. This will be used by Fin to link @@ -16725,7 +17144,7 @@ components: type: string description: Always en enum: - - en + - en default: en example: en source_id: @@ -16758,23 +17177,23 @@ components: description: The time when the external page was last ingested. example: 1672928610 required: - - id - - type - - title - - html - - url - - ai_agent_availability - - ai_copilot_availability - - locale - - source_id - - created_at - - updated_at - - last_ingested_at + - id + - type + - title + - html + - url + - ai_agent_availability + - ai_copilot_availability + - locale + - source_id + - created_at + - updated_at + - last_ingested_at 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: @@ -16782,10 +17201,10 @@ components: type: string description: The type of the object - `list`. enum: - - list + - list example: list pages: - "$ref": "#/components/schemas/pages_link" + '$ref': '#/components/schemas/pages_link' total_count: type: integer description: A count of the total number of external pages. @@ -16794,7 +17213,7 @@ components: type: array description: An array of External Page objects items: - "$ref": "#/components/schemas/external_page" + '$ref': '#/components/schemas/external_page' file_attribute: title: File type: object @@ -16838,8 +17257,8 @@ components: type: string description: The type of object - `group_content` . enum: - - - - group_content + - + - group_content example: group_content nullable: true name: @@ -16849,7 +17268,7 @@ components: description: type: string description: The description of the collection. Only available for collections. - example: " Collection description" + example: ' Collection description' group_translated_content: title: Group Translated Content type: object @@ -16862,125 +17281,125 @@ 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 - "$ref": "#/components/schemas/group_content" + '$ref': '#/components/schemas/group_content' bg: description: The content of the group in Bulgarian - "$ref": "#/components/schemas/group_content" + '$ref': '#/components/schemas/group_content' bs: description: The content of the group in Bosnian - "$ref": "#/components/schemas/group_content" + '$ref': '#/components/schemas/group_content' ca: description: The content of the group in Catalan - "$ref": "#/components/schemas/group_content" + '$ref': '#/components/schemas/group_content' cs: description: The content of the group in Czech - "$ref": "#/components/schemas/group_content" + '$ref': '#/components/schemas/group_content' da: description: The content of the group in Danish - "$ref": "#/components/schemas/group_content" + '$ref': '#/components/schemas/group_content' de: description: The content of the group in German - "$ref": "#/components/schemas/group_content" + '$ref': '#/components/schemas/group_content' el: description: The content of the group in Greek - "$ref": "#/components/schemas/group_content" + '$ref': '#/components/schemas/group_content' en: description: The content of the group in English - "$ref": "#/components/schemas/group_content" + '$ref': '#/components/schemas/group_content' es: description: The content of the group in Spanish - "$ref": "#/components/schemas/group_content" + '$ref': '#/components/schemas/group_content' et: description: The content of the group in Estonian - "$ref": "#/components/schemas/group_content" + '$ref': '#/components/schemas/group_content' fi: description: The content of the group in Finnish - "$ref": "#/components/schemas/group_content" + '$ref': '#/components/schemas/group_content' fr: description: The content of the group in French - "$ref": "#/components/schemas/group_content" + '$ref': '#/components/schemas/group_content' he: description: The content of the group in Hebrew - "$ref": "#/components/schemas/group_content" + '$ref': '#/components/schemas/group_content' hr: description: The content of the group in Croatian - "$ref": "#/components/schemas/group_content" + '$ref': '#/components/schemas/group_content' hu: description: The content of the group in Hungarian - "$ref": "#/components/schemas/group_content" + '$ref': '#/components/schemas/group_content' id: description: The content of the group in Indonesian - "$ref": "#/components/schemas/group_content" + '$ref': '#/components/schemas/group_content' it: description: The content of the group in Italian - "$ref": "#/components/schemas/group_content" + '$ref': '#/components/schemas/group_content' ja: description: The content of the group in Japanese - "$ref": "#/components/schemas/group_content" + '$ref': '#/components/schemas/group_content' ko: description: The content of the group in Korean - "$ref": "#/components/schemas/group_content" + '$ref': '#/components/schemas/group_content' lt: description: The content of the group in Lithuanian - "$ref": "#/components/schemas/group_content" + '$ref': '#/components/schemas/group_content' lv: description: The content of the group in Latvian - "$ref": "#/components/schemas/group_content" + '$ref': '#/components/schemas/group_content' mn: description: The content of the group in Mongolian - "$ref": "#/components/schemas/group_content" + '$ref': '#/components/schemas/group_content' nb: description: The content of the group in Norwegian - "$ref": "#/components/schemas/group_content" + '$ref': '#/components/schemas/group_content' nl: description: The content of the group in Dutch - "$ref": "#/components/schemas/group_content" + '$ref': '#/components/schemas/group_content' pl: description: The content of the group in Polish - "$ref": "#/components/schemas/group_content" + '$ref': '#/components/schemas/group_content' pt: description: The content of the group in Portuguese (Portugal) - "$ref": "#/components/schemas/group_content" + '$ref': '#/components/schemas/group_content' ro: description: The content of the group in Romanian - "$ref": "#/components/schemas/group_content" + '$ref': '#/components/schemas/group_content' ru: description: The content of the group in Russian - "$ref": "#/components/schemas/group_content" + '$ref': '#/components/schemas/group_content' sl: description: The content of the group in Slovenian - "$ref": "#/components/schemas/group_content" + '$ref': '#/components/schemas/group_content' sr: description: The content of the group in Serbian - "$ref": "#/components/schemas/group_content" + '$ref': '#/components/schemas/group_content' sv: description: The content of the group in Swedish - "$ref": "#/components/schemas/group_content" + '$ref': '#/components/schemas/group_content' tr: description: The content of the group in Turkish - "$ref": "#/components/schemas/group_content" + '$ref': '#/components/schemas/group_content' vi: description: The content of the group in Vietnamese - "$ref": "#/components/schemas/group_content" + '$ref': '#/components/schemas/group_content' pt-BR: description: The content of the group in Portuguese (Brazil) - "$ref": "#/components/schemas/group_content" + '$ref': '#/components/schemas/group_content' zh-CN: description: The content of the group in Chinese (China) - "$ref": "#/components/schemas/group_content" + '$ref': '#/components/schemas/group_content' zh-TW: description: The content of the group in Chinese (Taiwan) - "$ref": "#/components/schemas/group_content" + '$ref': '#/components/schemas/group_content' help_center: title: Help Center type: object x-tags: - - Help Center + - Help Center description: Help Centers contain collections properties: id: @@ -17020,20 +17439,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" + '$ref': '#/components/schemas/help_center' intercom_version: description: Intercom API version.
By default, it's equal to the version set in the app package. @@ -17041,24 +17460,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 @@ -17068,8 +17487,8 @@ components: type: string description: ticket or conversation enum: - - ticket - - conversation + - ticket + - conversation example: ticket id: type: string @@ -17079,10 +17498,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: @@ -17095,7 +17514,7 @@ components: type: string description: Always list. enum: - - list + - list example: list total_count: type: integer @@ -17109,7 +17528,7 @@ components: type: array description: An array containing the linked conversations and linked tickets. items: - "$ref": "#/components/schemas/linked_object" + '$ref': '#/components/schemas/linked_object' merge_contacts_request: description: Merge contact data. type: object @@ -17129,7 +17548,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: @@ -17158,10 +17577,10 @@ components: message_type: type: string enum: - - email - - inapp - - facebook - - twitter + - email + - inapp + - facebook + - twitter description: The type of message that was sent. Can be email, inapp, facebook or twitter. example: inapp @@ -17170,11 +17589,11 @@ components: 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. @@ -17183,27 +17602,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: @@ -17211,7 +17630,7 @@ components: type: string description: The type of object. enum: - - news-item + - news-item example: news-item id: type: string @@ -17241,14 +17660,14 @@ 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 description: A list of newsfeed_assignments to assign to the specified newsfeed. items: - "$ref": "#/components/schemas/newsfeed_assignment" + '$ref': '#/components/schemas/newsfeed_assignment' labels: type: array description: Label names displayed to users to categorize the news item. @@ -17300,7 +17719,7 @@ components: body: type: string description: The news item body, which may contain HTML. - example: "

New costumes in store for this spooky season

" + example: '

New costumes in store for this spooky season

' sender_id: type: integer description: The id of the sender of the news item. Must be a teammate on @@ -17311,8 +17730,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 @@ -17325,9 +17744,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, @@ -17336,21 +17755,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" + '$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. @@ -17364,7 +17783,7 @@ components: type: string description: The type of object. enum: - - newsfeed + - newsfeed example: newsfeed name: type: string @@ -17385,7 +17804,7 @@ components: title: Newsfeed Assignment type: object x-tags: - - News + - News description: Assigns a news item to a newsfeed. properties: newsfeed_id: @@ -17406,7 +17825,7 @@ components: title: Note type: object x-tags: - - Notes + - Notes description: Notes allow you to annotate and comment on your contacts. properties: type: @@ -17437,12 +17856,12 @@ components: description: The id of the contact. example: 214656d0c743eafcfde7f248 author: - "$ref": "#/components/schemas/admin" + '$ref': '#/components/schemas/admin' description: Optional. Represents the Admin that created the note. body: type: string description: The body text of the note. - example: "

Text for the note.

" + example: '

Text for the note.

' note_list: title: Paginated Response type: object @@ -17457,13 +17876,13 @@ components: type: array description: An array of notes. items: - "$ref": "#/components/schemas/note" + '$ref': '#/components/schemas/note' total_count: type: integer description: A count of the total number of notes. example: 1 pages: - "$ref": "#/components/schemas/cursor_pages" + '$ref': '#/components/schemas/cursor_pages' open_conversation_request: title: Open Conversation Request type: object @@ -17472,15 +17891,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 @@ -17493,7 +17912,7 @@ components: type: string example: pages enum: - - pages + - pages page: type: integer example: 1 @@ -17518,11 +17937,11 @@ components: type: string description: The type of object enum: - - list - - conversation.list + - list + - conversation.list example: list pages: - "$ref": "#/components/schemas/cursor_pages" + '$ref': '#/components/schemas/cursor_pages' total_count: type: integer description: A count of the total number of objects. @@ -17532,8 +17951,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 @@ -17577,60 +17996,60 @@ components: type: string description: '' enum: - - phone_call_redirect + - phone_call_redirect default: phone_call_redirect example: phone_call_redirect phone: type: string description: Phone number in E.164 format, that has received the SMS to continue the conversation in the Messenger. - example: "+1 1234567890" + 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 @@ -17647,8 +18066,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 @@ -17656,19 +18075,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" + '$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: @@ -17676,7 +18095,7 @@ components: type: string description: The type of object. enum: - - segment + - segment example: segment id: type: string @@ -17698,8 +18117,8 @@ components: type: string description: 'Type of the contact: contact (lead) or user.' enum: - - contact - - user + - contact + - user example: contact count: type: integer @@ -17717,13 +18136,13 @@ components: type: string description: The type of the object enum: - - segment.list + - segment.list example: segment.list segments: type: array description: A list of Segment objects items: - "$ref": "#/components/schemas/segment" + '$ref': '#/components/schemas/segment' pages: type: object description: A pagination object, which may be empty, indicating no further @@ -17740,19 +18159,19 @@ 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: ">" + example: '>' value: type: string description: The value that you want to search on. @@ -17776,10 +18195,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. @@ -17794,7 +18213,7 @@ components: message_type: type: string enum: - - snoozed + - snoozed example: snoozed admin_id: type: string @@ -17806,9 +18225,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 @@ -17847,7 +18266,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: @@ -17863,25 +18282,25 @@ 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" + '$ref': '#/components/schemas/translation' translations: type: array description: An array of translations objects with the localised version of the subscription type in each available locale within your translation settings. items: - "$ref": "#/components/schemas/translation" + '$ref': '#/components/schemas/translation' consent_type: type: string description: Describes the type of consent. enum: - - opt_out - - opt_in + - opt_out + - opt_in example: opt_in content_types: type: array @@ -17890,8 +18309,8 @@ components: items: type: string enum: - - email - - sms_message + - email + - sms_message example: email subscription_type_list: title: Subscription Types @@ -17902,19 +18321,19 @@ components: type: string description: The type of the object enum: - - list + - list example: list data: type: array description: A list of subscription type objects associated with the workspace . items: - "$ref": "#/components/schemas/subscription_type" + '$ref': '#/components/schemas/subscription_type' tag: 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: @@ -17936,7 +18355,7 @@ components: description: The time when the tag was applied to the object example: 1663597223 applied_by: - "$ref": "#/components/schemas/reference" + '$ref': '#/components/schemas/reference' tag_company_request: description: You can tag a single company or a list of companies. type: object @@ -17961,8 +18380,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 @@ -17972,13 +18391,13 @@ components: type: string description: The type of the object enum: - - list + - list example: list data: type: array description: A list of tags objects associated with the workspace . items: - "$ref": "#/components/schemas/tag" + '$ref': '#/components/schemas/tag' tag_multiple_users_request: description: You can tag a list of users. type: object @@ -17997,8 +18416,8 @@ components: description: The Intercom defined id representing the user. example: 5f7f0d217289f8d2f4262080 required: - - name - - users + - name + - users tags: title: Tags type: object @@ -18008,18 +18427,18 @@ components: type: string description: The type of the object enum: - - tag.list + - tag.list example: tag.list tags: type: array description: A list of tags objects associated with the conversation. items: - "$ref": "#/components/schemas/tag" + '$ref': '#/components/schemas/tag' team: title: Team type: object x-tags: - - Teams + - Teams description: Teams are groups of admins in Intercom. properties: type: @@ -18038,11 +18457,11 @@ 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: - "$ref": "#/components/schemas/admin_priority_level" + '$ref': '#/components/schemas/admin_priority_level' team_list: title: Team List type: object @@ -18052,13 +18471,13 @@ components: type: string description: The type of the object enum: - - team.list + - team.list example: team.list teams: type: array description: A list of team objects items: - "$ref": "#/components/schemas/team" + '$ref': '#/components/schemas/team' team_priority_level: title: Team Priority Level type: object @@ -18070,7 +18489,7 @@ components: description: The primary team ids for the team nullable: true example: - - 814865 + - 814865 items: type: integer secondary_team_ids: @@ -18078,14 +18497,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: @@ -18093,7 +18512,7 @@ components: type: string description: Always ticket enum: - - ticket + - ticket default: ticket example: ticket id: @@ -18109,18 +18528,18 @@ 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" + '$ref': '#/components/schemas/ticket_custom_attributes' ticket_state: - "$ref": "#/components/schemas/ticket_state" + '$ref': '#/components/schemas/ticket_state' ticket_type: - "$ref": "#/components/schemas/ticket_type" + '$ref': '#/components/schemas/ticket_type' contacts: - "$ref": "#/components/schemas/ticket_contacts" + '$ref': '#/components/schemas/ticket_contacts' admin_assignee_id: type: string description: The id representing the admin assigned to the ticket. @@ -18151,9 +18570,9 @@ components: If null, the ticket is not currently snoozed. example: 1663597260 linked_objects: - "$ref": "#/components/schemas/linked_object_list" + '$ref': '#/components/schemas/linked_object_list' ticket_parts: - "$ref": "#/components/schemas/ticket_parts" + '$ref': '#/components/schemas/ticket_parts' is_shared: type: boolean description: Whether or not the ticket is shared with the customer. @@ -18162,20 +18581,20 @@ 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 description: The list of contacts affected by this ticket. items: - "$ref": "#/components/schemas/contact_reference" + '$ref': '#/components/schemas/contact_reference' ticket_custom_attributes: title: Ticket Attributes type: object @@ -18184,12 +18603,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 @@ -18202,24 +18621,24 @@ components: type: string description: Always ticket.list enum: - - ticket.list + - ticket.list example: ticket.list tickets: type: array description: The list of ticket objects items: - "$ref": "#/components/schemas/ticket" + '$ref': '#/components/schemas/ticket' total_count: type: integer description: A count of the total number of objects. example: 12345 pages: - "$ref": "#/components/schemas/cursor_pages" + '$ref': '#/components/schemas/cursor_pages' ticket_part: title: Ticket Part type: object x-tags: - - Tickets + - Tickets description: A Ticket Part represents a message in the ticket. properties: type: @@ -18238,23 +18657,23 @@ components: type: string nullable: true description: The message body, which may contain HTML. - example: "

Okay!

" + example: '

Okay!

' 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: @@ -18268,18 +18687,18 @@ components: description: The last time the ticket part was updated. example: 1663597260 assigned_to: - "$ref": "#/components/schemas/reference" + '$ref': '#/components/schemas/reference' nullable: true description: The id of the admin that was assigned the ticket by this ticket_part (null if there has been no change in assignment.) author: - "$ref": "#/components/schemas/ticket_part_author" + '$ref': '#/components/schemas/ticket_part_author' attachments: title: Ticket part attachments type: array description: A list of attachments for the part. items: - "$ref": "#/components/schemas/part_attachment" + '$ref': '#/components/schemas/part_attachment' external_id: type: string nullable: true @@ -18300,10 +18719,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 @@ -18328,7 +18747,7 @@ components: type: string description: '' enum: - - ticket_part.list + - ticket_part.list example: ticket_part.list ticket_parts: title: Tickt Parts @@ -18336,7 +18755,7 @@ components: description: A list of Ticket Part objects for each ticket. There is a limit of 500 parts. items: - "$ref": "#/components/schemas/ticket_part" + '$ref': '#/components/schemas/ticket_part' total_count: type: integer description: '' @@ -18352,7 +18771,7 @@ components: description: Always ticket_part example: ticket_part enum: - - ticket_part + - ticket_part id: type: string description: The id representing the part. @@ -18362,14 +18781,14 @@ components: description: Type of the part example: note enum: - - note - - comment - - quick_reply + - note + - comment + - quick_reply body: type: string nullable: true description: The message body, which may contain HTML. - example: "

Okay!

" + example: '

Okay!

' created_at: type: integer format: date-time @@ -18381,13 +18800,13 @@ components: description: The last time the note was updated. example: 1663597260 author: - "$ref": "#/components/schemas/ticket_part_author" + '$ref': '#/components/schemas/ticket_part_author' attachments: title: Ticket part attachments type: array description: A list of attachments for the part. items: - "$ref": "#/components/schemas/part_attachment" + '$ref': '#/components/schemas/part_attachment' redacted: type: boolean description: Whether or not the ticket part has been redacted. @@ -18405,11 +18824,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 @@ -18417,7 +18836,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: @@ -18435,10 +18854,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 @@ -18453,7 +18872,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: @@ -18471,10 +18890,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 @@ -18503,7 +18922,7 @@ components: description: A list of ticket type attributes associated with a given ticket type. items: - "$ref": "#/components/schemas/ticket_type" + '$ref': '#/components/schemas/ticket_type' ticket_state_list: title: Ticket States type: object @@ -18518,12 +18937,12 @@ components: type: array description: A list of ticket states associated with a given ticket type. items: - "$ref": "#/components/schemas/ticket_state_detailed" + '$ref': '#/components/schemas/ticket_state_detailed' ticket_type: 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 @@ -18541,9 +18960,9 @@ components: type: string description: Category of the Ticket Type. enum: - - Customer - - Back-office - - Tracker + - Customer + - Back-office + - Tracker example: Customer name: type: string @@ -18562,7 +18981,7 @@ components: description: The id of the workspace that the ticket type belongs to. example: ecahpwf5 ticket_type_attributes: - "$ref": "#/components/schemas/ticket_type_attribute_list" + '$ref': '#/components/schemas/ticket_type_attribute_list' ticket_states: title: Ticket States type: object @@ -18578,7 +18997,7 @@ components: description: A list of ticket states associated with a given ticket type. items: - "$ref": "#/components/schemas/ticket_state" + '$ref': '#/components/schemas/ticket_state' archived: type: boolean description: Whether the ticket type is archived or not. @@ -18687,7 +19106,7 @@ components: description: A list of ticket type attributes associated with a given ticket type. items: - "$ref": "#/components/schemas/ticket_type_attribute" + '$ref': '#/components/schemas/ticket_type_attribute' ticket_type_list: title: Ticket Types type: object @@ -18702,7 +19121,7 @@ components: type: array description: A list of ticket_types associated with a given workspace. items: - "$ref": "#/components/schemas/ticket_type" + '$ref': '#/components/schemas/ticket_type' translation: title: Translation type: object @@ -18750,8 +19169,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 @@ -18772,7 +19191,7 @@ components: type: string description: The content of the article. For multilingual articles, this will be the body of the default language's content. - example: "

This is the body in html

" + example: '

This is the body in html

' author_id: type: integer description: The id of the author of the article. For multilingual articles, @@ -18785,8 +19204,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 @@ -18798,7 +19217,7 @@ components: description: The type of parent, which can either be a `collection` or `section`. example: collection translated_content: - "$ref": "#/components/schemas/article_translated_content" + '$ref': '#/components/schemas/article_translated_content' update_collection_request: description: You can update a collection type: object @@ -18816,7 +19235,7 @@ components: example: English description translated_content: nullable: true - "$ref": "#/components/schemas/group_translated_content" + '$ref': '#/components/schemas/group_translated_content' parent_id: type: string nullable: true @@ -18842,7 +19261,7 @@ components: type: string nullable: true description: The contacts phone - example: "+353871234567" + example: '+353871234567' name: type: string nullable: true @@ -18892,16 +19311,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: @@ -18910,8 +19329,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 @@ -18922,7 +19341,7 @@ components: description: Mark a conversation as read within Intercom. example: true custom_attributes: - "$ref": "#/components/schemas/custom_attributes" + '$ref': '#/components/schemas/custom_attributes' update_data_attribute_request: description: '' type: object @@ -18943,8 +19362,8 @@ components: items: type: string example: - - option1 - - option2 + - option1 + - option2 messenger_writable: type: boolean description: Can this attribute be updated by the Messenger @@ -18962,7 +19381,7 @@ components: html: type: string description: The body of the external page in HTML. - example: "

Hello world!

" + example: '

Hello world!

' url: type: string description: The URL of the external page. This will be used by Fin to link @@ -18978,7 +19397,7 @@ components: type: string description: Always en enum: - - en + - en default: en example: en source_id: @@ -18996,11 +19415,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 @@ -19121,9 +19540,9 @@ components: type: string description: Category of the Ticket Type. enum: - - Customer - - Back-office - - Tracker + - Customer + - Back-office + - Tracker example: Customer icon: type: string @@ -19168,10 +19587,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 @@ -19243,12 +19662,12 @@ components: type: string description: The type of the object enum: - - company.list + - company.list example: company.list companies: type: array items: - "$ref": "#/components/schemas/company" + '$ref': '#/components/schemas/company' location_data: type: object properties: @@ -19316,7 +19735,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 @@ -19346,7 +19765,7 @@ components: type: string description: The type of the object enum: - - tag.list + - tag.list example: tag.list tags: type: array @@ -19356,7 +19775,7 @@ components: type: string description: The type of the object enum: - - tag + - tag example: tag id: type: string @@ -19373,7 +19792,7 @@ components: type: string description: The type of the object enum: - - segment.list + - segment.list example: segment.list segments: type: array @@ -19432,7 +19851,7 @@ components: type: string description: The type of object which was deleted enum: - - visitor + - visitor example: visitor user_id: type: string @@ -19443,82 +19862,82 @@ components: type: http scheme: bearer servers: -- url: https://api.intercom.io - description: The production API server -- url: https://api.eu.intercom.io - description: The european API server -- url: https://api.au.intercom.io - description: The australian API server + - 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 - 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: 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. -   +   - *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: 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. -- name: Data Attributes - description: Everything about your Data Attributes -- name: Data Events - description: Everything about your Data Events -- name: Data Export - description: Everything about your Data Exports -- name: Help Center - description: Everything about your Help Center -- name: Messages - description: Everything about your messages -- name: News - description: Everything about your News - externalDocs: - description: News explained - url: https://www.intercom.com/help/en/articles/6362251-news-explained -- name: Notes - description: Everything about your Notes -- name: Segments - description: Everything about your Segments -- name: Subscription Types - description: Everything about subscription types -- name: Switch - description: Everything about Switch - externalDocs: - description: 'Meet Switch: from on hold to messaging in just a few taps' - url: https://www.intercom.com/switch -- name: Tags - description: Everything about tags -- name: Teams - description: Everything about your Teams -- name: 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: 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. + - name: Data Attributes + description: Everything about your Data Attributes + - name: Data Events + description: Everything about your Data Events + - name: Data Export + description: Everything about your Data Exports + - name: Help Center + description: Everything about your Help Center + - name: Messages + description: Everything about your messages + - name: News + description: Everything about your News + externalDocs: + description: News explained + url: https://www.intercom.com/help/en/articles/6362251-news-explained + - name: Notes + description: Everything about your Notes + - name: Segments + description: Everything about your Segments + - name: Subscription Types + description: Everything about subscription types + - name: Switch + description: Everything about Switch + externalDocs: + description: 'Meet Switch: from on hold to messaging in just a few taps' + url: https://www.intercom.com/switch + - name: Tags + description: Everything about tags + - name: Teams + description: Everything about your Teams + - name: 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