diff --git a/descriptions/0/api.intercom.io.yaml b/descriptions/0/api.intercom.io.yaml index 14e65ba..e7636ea 100644 --- a/descriptions/0/api.intercom.io.yaml +++ b/descriptions/0/api.intercom.io.yaml @@ -11,16 +11,16 @@ info: name: MIT url: https://spdx.org/licenses/MIT paths: - '/me': + "/me": get: 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 @@ -55,23 +55,23 @@ 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": 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. responses: @@ -91,7 +91,7 @@ paths: has_inbox_seat: true team_ids: [] schema: - '$ref': '#/components/schemas/admin' + "$ref": "#/components/schemas/admin" '404': description: Admin not found content: @@ -102,10 +102,10 @@ paths: type: error.list request_id: 23c329e4-2b87-4fb8-923c-2bca3f602ab0 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 +116,18 @@ paths: type: error.list request_id: fc4aae73-09d5-4309-945d-1447acb092d9 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 +157,32 @@ paths: value: away_mode_enabled: true away_mode_reassign: true - '/admins/activity_logs': + "/admins/activity_logs": 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 +201,38 @@ paths: per_page: 20 total_pages: 1 activity_logs: - - id: 6d2515fc-ce43-46da-bb18-c46cf4256642 - performed_by: - type: admin - id: '991266219' - email: admin5@email.com - ip: 127.0.0.1 - metadata: - before: before - after: after - created_at: 1690369389 - activity_type: app_name_change - activity_description: Ciaran5 Lee changed your app name from - before to after. - - id: 39a29c43-6fe1-4401-a4fa-fb2a15284948 - performed_by: - type: admin - id: '991266219' - 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: 1690369389 - 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: 6d2515fc-ce43-46da-bb18-c46cf4256642 + performed_by: + type: admin + id: '991266219' + email: admin5@email.com + ip: 127.0.0.1 + metadata: + before: before + after: after + created_at: 1690369389 + activity_type: app_name_change + activity_description: Ciaran5 Lee changed your app name from + before to after. + - id: 39a29c43-6fe1-4401-a4fa-fb2a15284948 + performed_by: + type: admin + id: '991266219' + 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: 1690369389 + 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" '401': description: Unauthorized content: @@ -243,20 +243,20 @@ paths: type: error.list request_id: 80bb77a9-c9c8-4225-ab00-66cb6ffd14ea errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' - '/admins': + "$ref": "#/components/schemas/error" + "/admins": 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 +269,16 @@ paths: value: type: admin.list admins: - - type: admin - email: admin7@email.com - id: '991266222' - name: Ciaran7 Lee - away_mode_enabled: false - away_mode_reassign: false - has_inbox_seat: true - team_ids: [] + - type: admin + email: admin7@email.com + id: '991266222' + name: Ciaran7 Lee + away_mode_enabled: false + away_mode_reassign: false + has_inbox_seat: true + team_ids: [] schema: - '$ref': '#/components/schemas/admin_list' + "$ref": "#/components/schemas/admin_list" '401': description: Unauthorized content: @@ -289,27 +289,27 @@ paths: type: error.list request_id: d68aa3be-cda9-4450-85a4-5fd66fc28ff1 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' - '/admins/{id}': + "$ref": "#/components/schemas/error" + "/admins/{id}": get: summary: Retrieve 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: 123 + schema: + type: integer tags: - - Admins + - Admins operationId: retrieveAdmin description: You can retrieve the details of a single admin. responses: @@ -329,7 +329,7 @@ paths: has_inbox_seat: true team_ids: [] schema: - '$ref': '#/components/schemas/admin' + "$ref": "#/components/schemas/admin" '404': description: Admin not found content: @@ -340,10 +340,10 @@ paths: type: error.list request_id: 85819234-2e0a-43a0-9d72-aff4f8db36ba 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 +354,20 @@ paths: type: error.list request_id: '019e9f5b-c4e4-48d5-81d9-7727134a944c' errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' - '/articles': + "$ref": "#/components/schemas/error" + "/articles": get: summary: List all articles parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Articles + - Articles operationId: listArticles description: "You can fetch a list of all articles by making a GET request to `https://api.intercom.io/articles`.\n\n> \U0001F4D8 How are the articles sorted @@ -390,21 +390,21 @@ paths: total_pages: 1 total_count: 1 data: - - id: '92828' - type: article - workspace_id: this_is_an_id22_that_should_be_at_least_4 - parent_id: 87783 - parent_type: collection - title: This is the article title - description: '' - body: '' - author_id: 991266227 - state: published - created_at: 1690369394 - updated_at: 1690369394 - url: http://help-center.test/myapp-22/en/articles/92828-this-is-the-article-title - schema: - '$ref': '#/components/schemas/article_list' + - id: '92828' + type: article + workspace_id: this_is_an_id22_that_should_be_at_least_4 + parent_id: 87783 + parent_type: collection + title: This is the article title + description: '' + body: '' + author_id: 991266227 + state: published + created_at: 1690369394 + updated_at: 1690369394 + url: http://help-center.test/myapp-22/en/articles/92828-this-is-the-article-title + schema: + "$ref": "#/components/schemas/article_list" '401': description: Unauthorized content: @@ -415,19 +415,19 @@ paths: type: error.list request_id: ed3e4a76-0ecf-4bea-b97c-ac446d64e556 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 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: @@ -460,7 +460,7 @@ paths: updated_at: 1690369396 url: http://help-center.test/myapp-26/en/articles/92831-thanks-for-everything schema: - '$ref': '#/components/schemas/article' + "$ref": "#/components/schemas/article" '400': description: Bad Request content: @@ -471,11 +471,11 @@ paths: type: error.list request_id: 7d3a15a2-83de-4e4a-9e24-f7e519533434 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: @@ -486,15 +486,15 @@ paths: type: error.list request_id: 1baf4fdf-f493-41db-b827-1c84742cab3a 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 @@ -520,23 +520,23 @@ paths: description: Description of the Article body: Body of the Article state: published - '/articles/{id}': + "/articles/{id}": get: summary: Retrieve an article parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The unique identifier for the article which is given by Intercom. - example: 123 - schema: - type: integer + - 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/`. @@ -570,7 +570,7 @@ paths: updated_at: 1690369398 url: http://help-center.test/myapp-32/en/articles/92834-this-is-the-article-title schema: - '$ref': '#/components/schemas/article' + "$ref": "#/components/schemas/article" '404': description: Article not found content: @@ -581,10 +581,10 @@ paths: type: error.list request_id: d015d260-df1e-4e93-83d3-4d98b86048d0 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: @@ -595,26 +595,26 @@ paths: type: error.list request_id: cb2e2aed-2dfb-462b-8000-70c79b810b5d errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' + "$ref": "#/components/schemas/error" put: 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/`. @@ -648,7 +648,7 @@ paths: updated_at: 1690369400 url: http://help-center.test/myapp-38/en/articles/92837-christmas-is-here schema: - '$ref': '#/components/schemas/article' + "$ref": "#/components/schemas/article" '404': description: Article Not Found content: @@ -659,10 +659,10 @@ paths: type: error.list request_id: 878dc62f-c0c4-42e6-8634-cb8eb289b928 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: @@ -673,42 +673,42 @@ paths: type: error.list request_id: 12d0a154-a966-4c73-ac5b-039a82f38f62 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: 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: @@ -723,7 +723,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: @@ -734,10 +734,10 @@ paths: type: error.list request_id: 9e78bb69-c3d5-4556-b077-b4a773271a3f 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: @@ -748,20 +748,20 @@ paths: type: error.list request_id: d100a500-538b-4563-a39e-c8f26ac49b71 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: 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`.\n\n> \U0001F4D8 How @@ -786,7 +786,7 @@ paths: per_page: 20 total_pages: 0 schema: - '$ref': '#/components/schemas/collection_list' + "$ref": "#/components/schemas/collection_list" '401': description: Unauthorized content: @@ -797,19 +797,19 @@ paths: type: error.list request_id: aad76bf4-e0ab-4be8-addc-1d23e70df647 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: @@ -831,7 +831,7 @@ paths: icon: book-bookmark parent_id: schema: - '$ref': '#/components/schemas/collection' + "$ref": "#/components/schemas/collection" '400': description: Bad Request content: @@ -842,10 +842,10 @@ paths: type: error.list request_id: 72fb3adc-9627-4052-b889-86ff24b7dc63 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: @@ -856,15 +856,15 @@ paths: type: error.list request_id: b512b68a-246c-4de3-983c-e6c708be3a34 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 @@ -874,23 +874,23 @@ paths: summary: Bad Request value: description: Missing required parameter - '/help_center/collections/{id}': + "/help_center/collections/{id}": get: summary: Retrieve 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/`. @@ -913,7 +913,7 @@ paths: icon: bookmark parent_id: schema: - '$ref': '#/components/schemas/collection' + "$ref": "#/components/schemas/collection" '404': description: Collection not found content: @@ -924,10 +924,10 @@ paths: type: error.list request_id: d0a06d00-9b56-4e98-a44f-2cb44299bdac 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: @@ -938,26 +938,26 @@ paths: type: error.list request_id: fccc8ee9-b56b-4d73-95ab-f8091cf72f09 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' + "$ref": "#/components/schemas/error" put: 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/`. @@ -980,7 +980,7 @@ paths: icon: folder parent_id: schema: - '$ref': '#/components/schemas/collection' + "$ref": "#/components/schemas/collection" '404': description: Collection Not Found content: @@ -991,10 +991,10 @@ paths: type: error.list request_id: c5ba2a03-c612-48f2-a50c-7732ff24241c 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: @@ -1005,15 +1005,15 @@ paths: type: error.list request_id: a1fbf183-8489-4542-bea6-f4b34d86a2a3 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 @@ -1026,19 +1026,19 @@ paths: 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/`. @@ -1054,7 +1054,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: @@ -1065,10 +1065,10 @@ paths: type: error.list request_id: 4c29ee5b-e01a-451b-aca0-eed9542cc233 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: @@ -1079,20 +1079,20 @@ paths: type: error.list request_id: c536e282-22ff-4b16-87bf-b0e16af24066 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 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.\n\n> \U0001F4D8 Companies with no users\n>\n> Companies will be only visible in Intercom when there @@ -1128,7 +1128,7 @@ paths: custom_attributes: creation_source: api schema: - '$ref': '#/components/schemas/company' + "$ref": "#/components/schemas/company" '400': description: Bad Request content: @@ -1139,10 +1139,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: @@ -1153,15 +1153,15 @@ paths: type: error.list request_id: bd19774d-4f25-4e9e-8b17-6a7265ae8d80 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 @@ -1176,35 +1176,35 @@ paths: get: summary: Retrieve a company parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: filter - in: query - style: form - required: true - schema: - type: object - oneOf: - - description: The `company_id` of the company to filter by. - title: Filter by company_id - properties: - company_id: - type: string - required: - - company_id - additionalProperties: false - - description: The `name` of the company to filter by. - title: Filter by name - properties: - name: - type: string - required: - - name - additionalProperties: false + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: filter + in: query + style: form + required: true + schema: + type: object + oneOf: + - description: The `company_id` of the company to filter by. + title: Filter by company_id + properties: + company_id: + type: string + required: + - company_id + additionalProperties: false + - description: The `name` of the company to filter by. + title: Filter by name + properties: + name: + type: string + required: + - name + additionalProperties: false tags: - - Companies + - Companies operationId: retrieveCompany description: | You can fetch a company by either passing in `company_id` or `name` as a query parameter. @@ -1240,7 +1240,7 @@ paths: plan: {} custom_attributes: {} schema: - '$ref': '#/components/schemas/company' + "$ref": "#/components/schemas/company" '404': description: Company Not Found content: @@ -1251,10 +1251,10 @@ paths: type: error.list request_id: cf540e5d-1484-489f-8eb4-0fbefeae134b 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: @@ -1265,27 +1265,27 @@ paths: type: error.list request_id: 8ccbcbcb-4665-444a-acd1-6e7efe620aa9 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 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: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + schema: + type: string tags: - - Companies + - Companies operationId: RetrieveACompanyById description: You can fetch a single company. responses: @@ -1316,7 +1316,7 @@ paths: plan: {} custom_attributes: {} schema: - '$ref': '#/components/schemas/company' + "$ref": "#/components/schemas/company" '404': description: Company Not Found content: @@ -1327,10 +1327,10 @@ paths: type: error.list request_id: b1d13c49-de7d-4a17-a545-9e305cf039ad 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: @@ -1341,26 +1341,26 @@ paths: type: error.list request_id: 18791b52-2b75-42f1-86e8-a0d67719f6a3 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' + "$ref": "#/components/schemas/error" put: 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: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + schema: + type: string tags: - - Companies + - Companies operationId: UpdateCompany description: You can update a single company responses: @@ -1391,7 +1391,7 @@ paths: plan: {} custom_attributes: {} schema: - '$ref': '#/components/schemas/company' + "$ref": "#/components/schemas/company" '404': description: Company Not Found content: @@ -1402,10 +1402,10 @@ paths: type: error.list request_id: da3d1bca-8a18-4bcf-9897-1ca7a11dc97f 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: @@ -1416,26 +1416,26 @@ paths: type: error.list request_id: b7dc7dae-bc66-4bbf-8062-27e69f748a21 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' + "$ref": "#/components/schemas/error" 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: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + schema: + type: string tags: - - Companies + - Companies operationId: deleteCompany description: You can delete a single company. responses: @@ -1450,7 +1450,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: @@ -1461,10 +1461,10 @@ paths: type: error.list request_id: 821bd913-672f-4274-98b4-503c9ae6e7f1 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: @@ -1475,28 +1475,28 @@ paths: type: error.list request_id: 3b71122e-04cc-46ac-b0e2-cd937866daa3 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: 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: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + 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: @@ -1516,7 +1516,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: @@ -1527,10 +1527,10 @@ paths: type: error.list request_id: f84d1e83-1f3d-4ae0-91fe-1e8348573405 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: @@ -1541,27 +1541,27 @@ paths: type: error.list request_id: fafdd20d-3102-4831-95f0-0239ff227dda 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: 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: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + schema: + type: string tags: - - Companies + - Companies operationId: ListAttachedSegmentsForCompanies description: You can fetch a list of all segments that belong to a company. responses: @@ -1575,7 +1575,7 @@ paths: type: list data: [] schema: - '$ref': '#/components/schemas/company_attached_segments' + "$ref": "#/components/schemas/company_attached_segments" '404': description: Company Not Found content: @@ -1586,10 +1586,10 @@ paths: type: error.list request_id: 97b6bf49-d080-4796-9ad7-064539668815 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: @@ -1600,65 +1600,65 @@ paths: type: error.list request_id: 61f60216-e7c3-46d7-a3a8-d6c4ef6b4cda 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: summary: List all companies parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: page - in: query - required: false - description: what page of results to fetch. Defaults to first page - example: first page - schema: - type: string - - name: per_page - in: query - required: false - description: how many results per page. Defaults to 15 - example: '15' - schema: - type: string - - 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: filter - in: query - style: form - required: true - schema: - type: object - oneOf: - - description: The `id` of the tag to filter by. - title: Filter by tag - properties: - tag_id: - type: string - required: - - tag_id - additionalProperties: false - - description: The `id` of the segment to filter by. - title: Filter by segment - properties: - segment_id: - type: string - required: - - segment_id - additionalProperties: false + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: page + in: query + required: false + description: what page of results to fetch. Defaults to first page + example: first page + schema: + type: string + - name: per_page + in: query + required: false + description: how many results per page. Defaults to 15 + example: '15' + schema: + type: string + - 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: filter + in: query + style: form + required: true + schema: + type: object + oneOf: + - description: The `id` of the tag to filter by. + title: Filter by tag + properties: + tag_id: + type: string + required: + - tag_id + additionalProperties: false + - description: The `id` of the segment to filter by. + title: Filter by segment + properties: + segment_id: + type: string + required: + - segment_id + additionalProperties: false 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.\n\nNote @@ -1677,25 +1677,25 @@ paths: value: type: list data: - - type: company - company_id: remote_companies_scroll_2 - id: 64c0fd9c35824d60a361f7a4 - app_id: this_is_an_id136_that_should_be_at_least_ - name: IntercomQATest1 - remote_created_at: 1690369436 - created_at: 1690369436 - updated_at: 1690369436 - 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: 64c0fd9c35824d60a361f7a4 + app_id: this_is_an_id136_that_should_be_at_least_ + name: IntercomQATest1 + remote_created_at: 1690369436 + created_at: 1690369436 + updated_at: 1690369436 + 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: @@ -1704,7 +1704,7 @@ paths: total_pages: 1 total_count: 1 schema: - '$ref': '#/components/schemas/company_list' + "$ref": "#/components/schemas/company_list" '401': description: Unauthorized content: @@ -1715,26 +1715,26 @@ paths: type: error.list request_id: 81dce88e-c4f5-4fa2-b3a7-e6e4113ece08 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: 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: " The `list all companies` functionality does not work well for huge datasets, and can result in errors and performance problems when @@ -1763,30 +1763,30 @@ paths: value: type: list data: - - type: company - company_id: remote_companies_scroll_2 - id: 64c0fd9d35824d60a361f7ac - app_id: this_is_an_id140_that_should_be_at_least_ - name: IntercomQATest1 - remote_created_at: 1690369437 - created_at: 1690369438 - updated_at: 1690369438 - 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: 64c0fd9d35824d60a361f7ac + app_id: this_is_an_id140_that_should_be_at_least_ + name: IntercomQATest1 + remote_created_at: 1690369437 + created_at: 1690369438 + updated_at: 1690369438 + 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: scroll_param: 6ed4eb2e-8e64-4697-b3f8-378d4dc86824 schema: - '$ref': '#/components/schemas/company_scroll' + "$ref": "#/components/schemas/company_scroll" '401': description: Unauthorized content: @@ -1797,27 +1797,27 @@ paths: type: error.list request_id: b831ede7-50cb-4473-a3ef-52714d1c8d78 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: 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: @@ -1848,7 +1848,7 @@ paths: plan: {} custom_attributes: {} schema: - '$ref': '#/components/schemas/company' + "$ref": "#/components/schemas/company" '404': description: Company Not Found content: @@ -1859,10 +1859,10 @@ paths: type: error.list request_id: be907fe7-e42d-41b5-88d4-c5f4373529c2 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: @@ -1873,17 +1873,17 @@ paths: type: error.list request_id: 15feb339-7481-44fd-8b01-77828ca0a2ae 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 @@ -1899,31 +1899,31 @@ paths: summary: Company Not Found value: id: 64c0fda135824d60a361f7b9 - '/contacts/{contact_id}/companies/{id}': + "/contacts/{contact_id}/companies/{id}": delete: 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: @@ -1954,7 +1954,7 @@ paths: plan: {} custom_attributes: {} schema: - '$ref': '#/components/schemas/company' + "$ref": "#/components/schemas/company" '404': description: Contact Not Found content: @@ -1965,17 +1965,17 @@ paths: type: error.list request_id: e5958c22-2b06-4efa-a2d8-710de85058f0 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: ff181297-5776-4778-ac1c-637edfb270c4 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: @@ -1986,28 +1986,28 @@ paths: type: error.list request_id: fd7d27db-b113-4018-9bf6-8837438d5e8f errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' - '/contacts/{contact_id}/companies': + "$ref": "#/components/schemas/error" + "/contacts/{contact_id}/companies": get: summary: List attached companies for contact parameters: - - name: contact_id - in: path - description: The unique identifier for the contact which is given by Intercom - example: 63a07ddf05a32042dffac965 - required: true - schema: - type: string - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' + - name: contact_id + in: path + description: The unique identifier for the contact which is given by Intercom + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Contacts - - Companies + - Contacts + - Companies operationId: listCompaniesForAContact description: You can fetch a list of companies that are associated to a contact. responses: @@ -2020,26 +2020,26 @@ paths: value: type: list data: - - type: company - company_id: '1' - id: 64c0fdb035824d60a361f7e7 - app_id: this_is_an_id158_that_should_be_at_least_ - name: company25 - remote_created_at: 1690369456 - created_at: 1690369456 - updated_at: 1690369456 - last_request_at: 1690196656 - 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: 64c0fdb035824d60a361f7e7 + app_id: this_is_an_id158_that_should_be_at_least_ + name: company25 + remote_created_at: 1690369456 + created_at: 1690369456 + updated_at: 1690369456 + last_request_at: 1690196656 + 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: @@ -2048,7 +2048,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: @@ -2059,10 +2059,10 @@ paths: type: error.list request_id: da3762e8-ef26-4da9-915d-250f42b51062 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: @@ -2073,27 +2073,27 @@ paths: type: error.list request_id: c2408d63-26e8-4d79-bb16-7731373ab611 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: 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: @@ -2106,48 +2106,48 @@ paths: value: type: list data: - - type: note - id: '405620' - created_at: 1689764659 - contact: - type: contact - id: 64c0fdb335824d60a361f7f2 - author: - type: admin - id: '991266304' - name: Ciaran89 Lee - email: admin89@email.com - away_mode_enabled: false - away_mode_reassign: false - body: '

This is a note.

' - - type: note - id: '405619' - created_at: 1689678259 - contact: - type: contact - id: 64c0fdb335824d60a361f7f2 - author: - type: admin - id: '991266304' - name: Ciaran89 Lee - email: admin89@email.com - away_mode_enabled: false - away_mode_reassign: false - body: '

This is a note.

' - - type: note - id: '405618' - created_at: 1689678259 - contact: - type: contact - id: 64c0fdb335824d60a361f7f2 - author: - type: admin - id: '991266304' - name: Ciaran89 Lee - email: admin89@email.com - away_mode_enabled: false - away_mode_reassign: false - body: '

This is a note.

' + - type: note + id: '405620' + created_at: 1689764659 + contact: + type: contact + id: 64c0fdb335824d60a361f7f2 + author: + type: admin + id: '991266304' + name: Ciaran89 Lee + email: admin89@email.com + away_mode_enabled: false + away_mode_reassign: false + body: "

This is a note.

" + - type: note + id: '405619' + created_at: 1689678259 + contact: + type: contact + id: 64c0fdb335824d60a361f7f2 + author: + type: admin + id: '991266304' + name: Ciaran89 Lee + email: admin89@email.com + away_mode_enabled: false + away_mode_reassign: false + body: "

This is a note.

" + - type: note + id: '405618' + created_at: 1689678259 + contact: + type: contact + id: 64c0fdb335824d60a361f7f2 + author: + type: admin + id: '991266304' + name: Ciaran89 Lee + email: admin89@email.com + away_mode_enabled: false + away_mode_reassign: false + body: "

This is a note.

" total_count: 3 pages: type: pages @@ -2156,7 +2156,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: @@ -2167,27 +2167,27 @@ paths: type: error.list request_id: 81833b92-e659-4a1d-86fd-1ad4fca2534f 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: 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: @@ -2211,9 +2211,9 @@ paths: email: admin91@email.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: @@ -2224,24 +2224,24 @@ paths: type: error.list request_id: 6064f90f-7126-4356-9135-0f219f1ed99f errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found Contact not found: value: type: error.list request_id: a0641e9a-fc4d-4c0f-89eb-17786f34b85e 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 @@ -2274,24 +2274,24 @@ paths: contact_id: 123 admin_id: 991266308 body: Hello - '/contacts/{contact_id}/segments': + "/contacts/{contact_id}/segments": get: summary: List attached segments for contact parameters: - - name: contact_id - in: path - description: The unique identifier for the contact which is given by Intercom - example: 63a07ddf05a32042dffac965 - required: true - schema: - type: string - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' + - 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: @@ -2304,14 +2304,14 @@ paths: value: type: list data: - - type: segment - id: 64c0fdb635824d60a361f7f7 - name: segment - created_at: 1690369462 - updated_at: 1690369462 - person_type: user - schema: - '$ref': '#/components/schemas/contact_segments' + - type: segment + id: 64c0fdb635824d60a361f7f7 + name: segment + created_at: 1690369462 + updated_at: 1690369462 + person_type: user + schema: + "$ref": "#/components/schemas/contact_segments" '404': description: Contact not found content: @@ -2322,10 +2322,10 @@ paths: type: error.list request_id: a9a78f80-2549-4ba4-9565-f58f6539ecef 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: @@ -2336,28 +2336,28 @@ paths: type: error.list request_id: 4a38981f-b91d-4b76-9fd2-0fbea2f10f84 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: 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. @@ -2377,36 +2377,36 @@ paths: value: type: list data: - - type: subscription - id: '440933' - 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: '440935' - 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: '440933' + 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: '440935' + 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: @@ -2417,10 +2417,10 @@ paths: type: error.list request_id: f167005d-c324-4d87-80f2-c406333f494e 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: @@ -2431,27 +2431,27 @@ paths: type: error.list request_id: 8bb90b09-35b1-40bf-80e6-9ef85257ad7d 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 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: @@ -2478,13 +2478,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: @@ -2495,17 +2495,17 @@ paths: type: error.list request_id: badcf98f-91bf-46b7-b1b6-5f55287eb816 errors: - - code: not_found - message: User Not Found + - code: not_found + message: User Not Found Resource not found: value: type: error.list request_id: d206f56a-9d00-4c7c-b974-d8c4613430d5 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: @@ -2516,18 +2516,18 @@ paths: type: error.list request_id: 58d08429-c10f-40d8-a009-ec3a459554ff 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 @@ -2554,32 +2554,32 @@ 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 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 @@ -2601,13 +2601,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: @@ -2618,17 +2618,17 @@ paths: type: error.list request_id: '04418cbf-8663-45eb-ac1b-1bd575742274' errors: - - code: not_found - message: User Not Found + - code: not_found + message: User Not Found Resource not found: value: type: error.list request_id: 91c237d7-2867-445c-8c64-0b13d6f34f60 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: @@ -2639,28 +2639,28 @@ paths: type: error.list request_id: bc0e7862-1426-4177-b47c-63cedd851ab6 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: 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. @@ -2674,11 +2674,11 @@ paths: value: type: list data: - - type: tag - id: '321873' - name: Manual tag + - type: tag + id: '321873' + name: Manual tag schema: - '$ref': '#/components/schemas/tag_list' + "$ref": "#/components/schemas/tag_list" '404': description: Contact not found content: @@ -2689,10 +2689,10 @@ paths: type: error.list request_id: d5d7f7e3-eb1f-4f7d-be70-b216701f62b2 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: @@ -2703,27 +2703,27 @@ paths: type: error.list request_id: db402be9-fdd3-4a82-969c-41048f472cd0 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 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. @@ -2739,7 +2739,7 @@ paths: id: '321874' name: Manual tag schema: - '$ref': '#/components/schemas/tag' + "$ref": "#/components/schemas/tag" '404': description: Tag not found content: @@ -2750,17 +2750,17 @@ paths: type: error.list request_id: 71d54485-f561-41a8-82c8-cc7692ffb6f4 errors: - - code: not_found - message: User Not Found + - code: not_found + message: User Not Found Tag not found: value: type: error.list request_id: c2597c8c-a47f-4e6f-8980-7b9b35fab3d9 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: @@ -2771,17 +2771,17 @@ paths: type: error.list request_id: 46eb7f29-713d-4633-ae09-ee10897883ef 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 @@ -2801,31 +2801,31 @@ paths: summary: Tag not found value: id: '123' - '/contacts/{contact_id}/tags/{id}': + "/contacts/{contact_id}/tags/{id}": delete: summary: Remove tag from a contact tags: - - Tags - - Contacts + - Tags + - Contacts parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: contact_id - in: path - description: The unique identifier for the contact which is given by Intercom - example: 63a07ddf05a32042dffac965 - required: true - schema: - type: string - - name: id - in: path - description: The unique identifier for the tag which is given by Intercom - example: '7522907' - required: true - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: contact_id + in: path + description: The unique identifier for the contact which is given by Intercom + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + - name: id + in: path + description: The unique identifier for the tag which is given by Intercom + example: '7522907' + required: true + schema: + type: string operationId: detachTagFromContact description: You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact. @@ -2841,7 +2841,7 @@ paths: id: '321877' name: Manual tag schema: - '$ref': '#/components/schemas/tag' + "$ref": "#/components/schemas/tag" '404': description: Tag not found content: @@ -2852,17 +2852,17 @@ paths: type: error.list request_id: deb0468f-e0dd-4485-aef5-7a9a1abe4a8c errors: - - code: not_found - message: User Not Found + - code: not_found + message: User Not Found Tag not found: value: type: error.list request_id: ee62b584-9a2c-4656-9705-7c962c8c0702 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: @@ -2873,27 +2873,27 @@ paths: type: error.list request_id: d9092479-ad5d-41d2-9182-41140acd012a 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: 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: @@ -2957,31 +2957,31 @@ paths: tags: type: list data: [] - url: '/contacts/64c0fdc335824d60a361f80e/tags' + url: "/contacts/64c0fdc335824d60a361f80e/tags" total_count: 0 has_more: false notes: type: list data: [] - url: '/contacts/64c0fdc335824d60a361f80e/notes' + url: "/contacts/64c0fdc335824d60a361f80e/notes" total_count: 0 has_more: false companies: type: list data: [] - url: '/contacts/64c0fdc335824d60a361f80e/companies' + url: "/contacts/64c0fdc335824d60a361f80e/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: '/contacts/64c0fdc335824d60a361f80e/subscriptions' + url: "/contacts/64c0fdc335824d60a361f80e/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: '/contacts/64c0fdc335824d60a361f80e/subscriptions' + url: "/contacts/64c0fdc335824d60a361f80e/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -2991,7 +2991,7 @@ paths: utm_term: referrer: schema: - '$ref': '#/components/schemas/contact' + "$ref": "#/components/schemas/contact" '401': description: Unauthorized content: @@ -3002,16 +3002,16 @@ paths: type: error.list request_id: 133d4a42-370d-4569-83aa-31d42a3bed20 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 @@ -3021,19 +3021,19 @@ paths: 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: @@ -3097,31 +3097,31 @@ paths: tags: type: list data: [] - url: '/contacts/64c0fdc435824d60a361f80f/tags' + url: "/contacts/64c0fdc435824d60a361f80f/tags" total_count: 0 has_more: false notes: type: list data: [] - url: '/contacts/64c0fdc435824d60a361f80f/notes' + url: "/contacts/64c0fdc435824d60a361f80f/notes" total_count: 0 has_more: false companies: type: list data: [] - url: '/contacts/64c0fdc435824d60a361f80f/companies' + url: "/contacts/64c0fdc435824d60a361f80f/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: '/contacts/64c0fdc435824d60a361f80f/subscriptions' + url: "/contacts/64c0fdc435824d60a361f80f/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: '/contacts/64c0fdc435824d60a361f80f/subscriptions' + url: "/contacts/64c0fdc435824d60a361f80f/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3131,7 +3131,7 @@ paths: utm_term: referrer: schema: - '$ref': '#/components/schemas/contact' + "$ref": "#/components/schemas/contact" '401': description: Unauthorized content: @@ -3142,25 +3142,25 @@ paths: type: error.list request_id: b5686b5e-4fec-45c2-96d9-99a4c831ada4 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' + "$ref": "#/components/schemas/error" delete: summary: Delete a contact parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - description: id - required: true - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: id + required: true + schema: + type: string tags: - - Contacts + - Contacts operationId: DeleteContact description: You can delete a single contact. responses: @@ -3176,7 +3176,7 @@ paths: type: contact deleted: true schema: - '$ref': '#/components/schemas/contact_deleted' + "$ref": "#/components/schemas/contact_deleted" '401': description: Unauthorized content: @@ -3187,20 +3187,20 @@ paths: type: error.list request_id: c35d57f9-eb51-414a-a944-8ebee61526f1 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: 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`. @@ -3265,31 +3265,31 @@ paths: tags: type: list data: [] - url: '/contacts/64c0fdc835824d60a361f812/tags' + url: "/contacts/64c0fdc835824d60a361f812/tags" total_count: 0 has_more: false notes: type: list data: [] - url: '/contacts/64c0fdc835824d60a361f812/notes' + url: "/contacts/64c0fdc835824d60a361f812/notes" total_count: 0 has_more: false companies: type: list data: [] - url: '/contacts/64c0fdc835824d60a361f812/companies' + url: "/contacts/64c0fdc835824d60a361f812/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: '/contacts/64c0fdc835824d60a361f812/subscriptions' + url: "/contacts/64c0fdc835824d60a361f812/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: '/contacts/64c0fdc835824d60a361f812/subscriptions' + url: "/contacts/64c0fdc835824d60a361f812/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3299,7 +3299,7 @@ paths: utm_term: referrer: schema: - '$ref': '#/components/schemas/contact' + "$ref": "#/components/schemas/contact" '401': description: Unauthorized content: @@ -3310,31 +3310,31 @@ paths: type: error.list request_id: 0fcaba65-a304-4339-beb5-a35343e78feb 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: 64c0fdc735824d60a361f811 into: 64c0fdc835824d60a361f812 - '/contacts/search': + "/contacts/search": post: summary: Search contacts parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Contacts + - Contacts operationId: SearchContacts description: "You can search for multiple contacts by the value of their attributes in order to fetch exactly who you want.\n\nTo search for contacts, you need @@ -3424,7 +3424,7 @@ paths: per_page: 50 total_pages: 0 schema: - '$ref': '#/components/schemas/contact_list' + "$ref": "#/components/schemas/contact_list" '401': description: Unauthorized content: @@ -3435,15 +3435,15 @@ paths: type: error.list request_id: a1eaf519-6b6c-45ee-829d-a684bba8233b 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 @@ -3451,27 +3451,27 @@ paths: query: operator: AND value: + - field: id + operator: "=" + value: 64c0fdc935824d60a361f815 + - operator: OR + value: - field: id - operator: '=' + operator: "=" value: 64c0fdc935824d60a361f815 - - operator: OR - value: - - field: id - operator: '=' - value: 64c0fdc935824d60a361f815 - - field: id - operator: '=' - value: 64c0fdc935824d60a361f815 - '/contacts': + - field: id + operator: "=" + value: 64c0fdc935824d60a361f815 + "/contacts": get: summary: List all contacts parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Contacts + - Contacts operationId: ListContacts description: You can fetch a list of all contacts. responses: @@ -3491,7 +3491,7 @@ paths: per_page: 10 total_pages: 0 schema: - '$ref': '#/components/schemas/contact_list' + "$ref": "#/components/schemas/contact_list" '401': description: Unauthorized content: @@ -3502,19 +3502,19 @@ paths: type: error.list request_id: 278cc283-f14c-4c51-a85a-2a766bd55e55 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 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: @@ -3578,31 +3578,31 @@ paths: tags: type: list data: [] - url: '/contacts/64c0fdcc35824d60a361f817/tags' + url: "/contacts/64c0fdcc35824d60a361f817/tags" total_count: 0 has_more: false notes: type: list data: [] - url: '/contacts/64c0fdcc35824d60a361f817/notes' + url: "/contacts/64c0fdcc35824d60a361f817/notes" total_count: 0 has_more: false companies: type: list data: [] - url: '/contacts/64c0fdcc35824d60a361f817/companies' + url: "/contacts/64c0fdcc35824d60a361f817/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: '/contacts/64c0fdcc35824d60a361f817/subscriptions' + url: "/contacts/64c0fdcc35824d60a361f817/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: '/contacts/64c0fdcc35824d60a361f817/subscriptions' + url: "/contacts/64c0fdcc35824d60a361f817/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3612,7 +3612,7 @@ paths: utm_term: referrer: schema: - '$ref': '#/components/schemas/contact' + "$ref": "#/components/schemas/contact" '401': description: Unauthorized content: @@ -3623,38 +3623,38 @@ paths: type: error.list request_id: 1c9d05f0-8bd0-46b9-a623-cc6e7804389f 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/{id}/archive': + "/contacts/{id}/archive": post: summary: Archive contact parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - description: id - example: 63a07ddf05a32042dffac965 - required: true - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: id + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string tags: - - Contacts + - Contacts operationId: ArchiveContact description: You can archive a single contact. responses: @@ -3670,24 +3670,24 @@ paths: type: contact archived: true schema: - '$ref': '#/components/schemas/contact_archived' - '/contacts/{id}/unarchive': + "$ref": "#/components/schemas/contact_archived" + "/contacts/{id}/unarchive": post: summary: Unarchive contact parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - description: id - example: 63a07ddf05a32042dffac965 - required: true - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: id + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string tags: - - Contacts + - Contacts operationId: UnarchiveContact description: You can unarchive a single contact. responses: @@ -3703,25 +3703,25 @@ 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: 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. @@ -3737,7 +3737,7 @@ paths: id: '321879' name: Manual tag schema: - '$ref': '#/components/schemas/tag' + "$ref": "#/components/schemas/tag" '404': description: Conversation not found content: @@ -3748,10 +3748,10 @@ paths: type: error.list request_id: c85fed74-ca18-4713-9bc4-21bfb9f88cba 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: @@ -3762,18 +3762,18 @@ paths: type: error.list request_id: 881a2ffa-6395-4112-84c1-b95b943d2cf0 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 @@ -3796,31 +3796,31 @@ paths: value: id: 321880 admin_id: 991266341 - '/conversations/{conversation_id}/tags/{id}': + "/conversations/{conversation_id}/tags/{id}": delete: 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. @@ -3836,7 +3836,7 @@ paths: id: '321882' name: Manual tag schema: - '$ref': '#/components/schemas/tag' + "$ref": "#/components/schemas/tag" '404': description: Tag not found content: @@ -3847,17 +3847,17 @@ paths: type: error.list request_id: aa2e532a-77d0-47a6-9acf-25e9e5e4d48b errors: - - code: not_found - message: Conversation not found + - code: not_found + message: Conversation not found Tag not found: value: type: error.list request_id: cc851bcd-a820-496a-ac4b-d0063e755a50 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: @@ -3868,17 +3868,17 @@ paths: type: error.list request_id: 3a631122-dc44-4ad6-a243-325ed26a0597 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 @@ -3898,30 +3898,30 @@ paths: summary: Tag not found value: admin_id: 991266346 - '/conversations': + "/conversations": get: 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. @@ -3943,57 +3943,57 @@ paths: total_pages: 1 total_count: 1 conversations: - - type: conversation - id: '715385' - created_at: 1690369493 - updated_at: 1690369493 - waiting_since: - snoozed_until: - source: - type: conversation - id: '403918065' - delivered_as: admin_initiated - subject: '' - body: '

this is the message body

' - author: - type: admin - id: '991266349' - name: Ciaran131 Lee - email: admin131@email.com - attachments: [] - url: - redacted: false + - type: conversation + id: '715385' + created_at: 1690369493 + updated_at: 1690369493 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918065' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991266349' + name: Ciaran131 Lee + email: admin131@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list contacts: - type: contact.list - contacts: - - type: contact - id: 64c0fdd535824d60a361f81d - 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 + - type: contact + id: 64c0fdd535824d60a361f81d + 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 schema: - '$ref': '#/components/schemas/paginated_response' + "$ref": "#/components/schemas/paginated_response" '401': description: Unauthorized content: @@ -4004,10 +4004,10 @@ paths: type: error.list request_id: 29553667-5bb2-48e7-a721-c36dee9662f5 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: @@ -4018,19 +4018,19 @@ paths: type: error.list request_id: cafc9c5a-61c4-4c6f-a65b-769647d02036 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: 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).\nThe conversation can be an in-app message only.\n\n> @@ -4054,7 +4054,7 @@ paths: message_type: inapp conversation_id: '715410' schema: - '$ref': '#/components/schemas/message' + "$ref": "#/components/schemas/message" '404': description: Contact Not Found content: @@ -4065,10 +4065,10 @@ paths: type: error.list request_id: 27e99fb1-dbff-494f-bd84-3cebc5b63b5c 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: @@ -4079,10 +4079,10 @@ paths: type: error.list request_id: 5dccc598-b1ca-43b5-90e7-82cdf7e0f904 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: @@ -4093,15 +4093,15 @@ paths: type: error.list request_id: 459940ee-0e85-4248-b74b-c776adebb7da 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 @@ -4117,30 +4117,30 @@ paths: type: user id: 123_doesnt_exist body: Hello there - '/conversations/{id}': + "/conversations/{id}": get: summary: Retrieve a conversation parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The id of the conversation to target - example: 123 - schema: - type: integer - - name: display_as - in: query - required: false - description: Set to plaintext to retrieve conversation messages in plain text. - example: plaintext - schema: - type: string + - 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: "\nYou can fetch the details of a single conversation.\n\nThis will return a single Conversation model with all its conversation parts.\n\n> @@ -4170,7 +4170,7 @@ paths: id: '403918079' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266363' @@ -4182,9 +4182,9 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c0fded35824d60a361f836 - external_id: '70' + - type: contact + id: 64c0fded35824d60a361f836 + external_id: '70' first_contact_reply: admin_assignee_id: team_assignee_id: @@ -4213,7 +4213,7 @@ paths: conversation_parts: [] total_count: 0 schema: - '$ref': '#/components/schemas/conversation' + "$ref": "#/components/schemas/conversation" '404': description: Not found content: @@ -4224,10 +4224,10 @@ paths: type: error.list request_id: eaecaddd-74dd-4119-adf5-5c7c875896fe 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: @@ -4238,10 +4238,10 @@ paths: type: error.list request_id: ae5cd02d-53db-4b80-8ba8-0eb105af5510 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: @@ -4252,33 +4252,33 @@ paths: type: error.list request_id: '08359342-20b1-482d-a865-d927cd3c58ac' 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: 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: "\nYou can update an existing conversation.\n\n> \U0001F4D8\n>\n> If you want to update a conversation with either a reply (or actions such @@ -4303,7 +4303,7 @@ paths: id: '403918083' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266371' @@ -4315,9 +4315,9 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c0fdf435824d60a361f83a - external_id: '70' + - type: contact + id: 64c0fdf435824d60a361f83a + external_id: '70' first_contact_reply: admin_assignee_id: team_assignee_id: @@ -4346,43 +4346,43 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '711348' - part_type: conversation_attribute_updated_by_admin - body: - created_at: 1690369525 - updated_at: 1690369525 - notified_at: 1690369525 - assigned_to: - author: - id: '991266372' - type: bot - name: Operator - email: operator+this_is_an_id292_that_should_be_at_least_@intercom.io - attachments: [] - external_id: - redacted: false - metadata: {} - - type: conversation_part - id: '711349' - part_type: conversation_attribute_updated_by_admin - body: - created_at: 1690369525 - updated_at: 1690369525 - notified_at: 1690369525 - assigned_to: - author: - id: '991266372' - type: bot - name: Operator - email: operator+this_is_an_id292_that_should_be_at_least_@intercom.io - attachments: [] - external_id: - redacted: false - metadata: {} + - type: conversation_part + id: '711348' + part_type: conversation_attribute_updated_by_admin + body: + created_at: 1690369525 + updated_at: 1690369525 + notified_at: 1690369525 + assigned_to: + author: + id: '991266372' + type: bot + name: Operator + email: operator+this_is_an_id292_that_should_be_at_least_@intercom.io + attachments: [] + external_id: + redacted: false + metadata: {} + - type: conversation_part + id: '711349' + part_type: conversation_attribute_updated_by_admin + body: + created_at: 1690369525 + updated_at: 1690369525 + notified_at: 1690369525 + assigned_to: + author: + id: '991266372' + type: bot + name: Operator + email: operator+this_is_an_id292_that_should_be_at_least_@intercom.io + attachments: [] + external_id: + redacted: false + metadata: {} total_count: 2 schema: - '$ref': '#/components/schemas/conversation' + "$ref": "#/components/schemas/conversation" '404': description: Not found content: @@ -4393,10 +4393,10 @@ paths: type: error.list request_id: be1f1070-4e8f-4582-92ed-e6122b083d0d 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: @@ -4407,10 +4407,10 @@ paths: type: error.list request_id: ca8bd6e9-aea1-45e0-a267-b484ad2c2bad 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: @@ -4421,15 +4421,15 @@ paths: type: error.list request_id: 2fe313ff-8fa8-4135-b7f1-83dc5828f7e5 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 @@ -4445,16 +4445,16 @@ paths: custom_attributes: issue_type: Billing priority: High - '/conversations/search': + "/conversations/search": post: summary: Search conversations parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Conversations + - Conversations operationId: searchConversations description: "You can search for multiple conversations by the value of their attributes in order to fetch exactly which ones you want.\n\nTo search for @@ -4537,62 +4537,62 @@ paths: total_pages: 1 total_count: 1 conversations: - - type: conversation - id: '715422' - created_at: 1690369532 - updated_at: 1690369532 - waiting_since: - snoozed_until: - source: - type: conversation - id: '403918087' - delivered_as: admin_initiated - subject: '' - body: '

this is the message body

' - author: - type: admin - id: '991266395' - name: Ciaran162 Lee - email: admin162@email.com - attachments: [] - url: - redacted: false + - type: conversation + id: '715422' + created_at: 1690369532 + updated_at: 1690369532 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918087' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991266395' + name: Ciaran162 Lee + email: admin162@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list contacts: - type: contact.list - contacts: - - type: contact - id: 64c0fdfc35824d60a361f83e - 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 + - type: contact + id: 64c0fdfc35824d60a361f83e + 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 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 @@ -4600,43 +4600,43 @@ paths: query: operator: AND value: + - field: id + operator: "=" + value: '715422' + - operator: OR + value: + - field: id + operator: "=" + value: '715422' - field: id - operator: '=' + operator: "=" value: '715422' - - operator: OR - value: - - field: id - operator: '=' - value: '715422' - - field: id - operator: '=' - value: '715422' - '/conversations/{id}/reply': + "/conversations/{id}/reply": post: summary: Reply to a conversation parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - schema: - oneOf: - - title: Conversation ID - type: string - description: The id of the conversation to target. - example: '123' - - title: The most recent conversation - type: string - enum: - - last - description: You can also reply to the most recent conversation on a workspace - by specifying `last` as the string. - example: last + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + schema: + oneOf: + - title: Conversation ID + type: string + description: The id of the conversation to target. + example: '123' + - title: The most recent conversation + type: string + enum: + - last + description: You can also reply to the most recent conversation on a workspace + by specifying `last` as the string. + example: last 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. @@ -4659,7 +4659,7 @@ paths: id: '403918090' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266397' @@ -4671,9 +4671,9 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c0fe0135824d60a361f845 - external_id: '70' + - type: contact + id: 64c0fe0135824d60a361f845 + external_id: '70' first_contact_reply: created_at: 1690369539 type: conversation @@ -4703,23 +4703,23 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '711351' - part_type: comment - body: '

Thanks again :)

' - created_at: 1690369539 - updated_at: 1690369539 - notified_at: 1690369539 - assigned_to: - author: - id: 64c0fe0135824d60a361f845 - type: user - name: Joe Bloggs - email: joe@bloggs.com - attachments: [] - external_id: - redacted: false - metadata: {} + - type: conversation_part + id: '711351' + part_type: comment + body: "

Thanks again :)

" + created_at: 1690369539 + updated_at: 1690369539 + notified_at: 1690369539 + assigned_to: + author: + id: 64c0fe0135824d60a361f845 + type: user + name: Joe Bloggs + email: joe@bloggs.com + attachments: [] + external_id: + redacted: false + metadata: {} total_count: 1 Admin note reply: value: @@ -4734,7 +4734,7 @@ paths: id: '403918091' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266399' @@ -4746,9 +4746,9 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c0fe0435824d60a361f846 - external_id: '70' + - type: contact + id: 64c0fe0435824d60a361f846 + external_id: '70' first_contact_reply: admin_assignee_id: team_assignee_id: @@ -4775,35 +4775,35 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '711352' - part_type: note - body: |- -

An Unordered HTML List

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

An Ordered HTML List

-
    -
  1. Coffee
    2. -
  2. Tea
    3. -
  3. Milk
    4. -
- created_at: 1690369541 - updated_at: 1690369541 - notified_at: 1690369541 - assigned_to: - author: - id: '991266399' - type: admin - name: Ciaran164 Lee - email: admin164@email.com - attachments: [] - external_id: - redacted: false - metadata: {} + - type: conversation_part + id: '711352' + part_type: note + body: |- +

An Unordered HTML List

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

An Ordered HTML List

+
    +
  1. Coffee
    2. +
  2. Tea
    3. +
  3. Milk
    4. +
+ created_at: 1690369541 + updated_at: 1690369541 + notified_at: 1690369541 + assigned_to: + author: + id: '991266399' + type: admin + name: Ciaran164 Lee + email: admin164@email.com + attachments: [] + external_id: + redacted: false + metadata: {} total_count: 1 Admin quick_reply reply: value: @@ -4818,7 +4818,7 @@ paths: id: '403918092' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266401' @@ -4830,9 +4830,9 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c0fe0635824d60a361f847 - external_id: '70' + - type: contact + id: 64c0fe0635824d60a361f847 + external_id: '70' first_contact_reply: admin_assignee_id: team_assignee_id: @@ -4859,23 +4859,23 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '711353' - part_type: quick_reply - body: - created_at: 1690369543 - updated_at: 1690369543 - notified_at: 1690369543 - assigned_to: - author: - id: '991266401' - type: admin - name: Ciaran165 Lee - email: admin165@email.com - attachments: [] - external_id: - redacted: false - metadata: {} + - type: conversation_part + id: '711353' + part_type: quick_reply + body: + created_at: 1690369543 + updated_at: 1690369543 + notified_at: 1690369543 + assigned_to: + author: + id: '991266401' + type: admin + name: Ciaran165 Lee + email: admin165@email.com + attachments: [] + external_id: + redacted: false + metadata: {} total_count: 1 User last conversation reply: value: @@ -4890,7 +4890,7 @@ paths: id: '403918093' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266403' @@ -4902,9 +4902,9 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c0fe0835824d60a361f848 - external_id: '70' + - type: contact + id: 64c0fe0835824d60a361f848 + external_id: '70' first_contact_reply: created_at: 1690369545 type: conversation @@ -4934,26 +4934,26 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '711354' - part_type: comment - body: '

Thanks again :)

' - created_at: 1690369545 - updated_at: 1690369545 - notified_at: 1690369545 - assigned_to: - author: - id: 64c0fe0835824d60a361f848 - type: user - name: Joe Bloggs - email: joe@bloggs.com - attachments: [] - external_id: - redacted: false - metadata: {} + - type: conversation_part + id: '711354' + part_type: comment + body: "

Thanks again :)

" + created_at: 1690369545 + updated_at: 1690369545 + notified_at: 1690369545 + assigned_to: + author: + id: 64c0fe0835824d60a361f848 + type: user + name: Joe Bloggs + email: joe@bloggs.com + attachments: [] + external_id: + redacted: false + metadata: {} total_count: 1 schema: - '$ref': '#/components/schemas/conversation' + "$ref": "#/components/schemas/conversation" '404': description: Not found content: @@ -4964,10 +4964,10 @@ paths: type: error.list request_id: 1b567cc6-22ad-4d9f-b526-d5acfa5be670 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: @@ -4978,10 +4978,10 @@ paths: type: error.list request_id: 699e72e2-55d9-4591-b46d-c1167d4cbc9d 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: @@ -4992,15 +4992,15 @@ paths: type: error.list request_id: 666a7d8c-123f-4cba-b281-1379080477c4 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 @@ -5026,10 +5026,10 @@ paths: type: admin admin_id: 991266401 reply_options: - - text: 'Yes' - uuid: 2e7c70f1-57b0-4f0f-833b-8e28536c6e6d - - text: 'No' - uuid: 54c536ab-3d23-4a10-8669-db964c6c2f6e + - text: 'Yes' + uuid: 2e7c70f1-57b0-4f0f-833b-8e28536c6e6d + - text: 'No' + uuid: 54c536ab-3d23-4a10-8669-db964c6c2f6e user_last_conversation_reply: summary: User last conversation reply value: @@ -5044,23 +5044,23 @@ paths: type: user intercom_user_id: 64c0fe0a35824d60a361f849 body: Thanks again :) - '/conversations/{id}/parts': + "/conversations/{id}/parts": post: summary: Manage a conversation parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The identifier for the conversation as given by Intercom. - example: '123' - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The identifier for the conversation as given by Intercom. + example: '123' + schema: + type: string tags: - - Conversations + - Conversations operationId: manageConversation description: | You can close a conversation. @@ -5086,7 +5086,7 @@ paths: id: '403918097' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266411' @@ -5098,9 +5098,9 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c0fe0f35824d60a361f84c - external_id: '70' + - type: contact + id: 64c0fe0f35824d60a361f84c + external_id: '70' first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5127,23 +5127,23 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '711355' - part_type: close - body: '

Goodbye :)

' - created_at: 1690369552 - updated_at: 1690369552 - notified_at: 1690369552 - assigned_to: - author: - id: '991266411' - type: admin - name: Ciaran170 Lee - email: admin170@email.com - attachments: [] - external_id: - redacted: false - metadata: {} + - type: conversation_part + id: '711355' + part_type: close + body: "

Goodbye :)

" + created_at: 1690369552 + updated_at: 1690369552 + notified_at: 1690369552 + assigned_to: + author: + id: '991266411' + type: admin + name: Ciaran170 Lee + email: admin170@email.com + attachments: [] + external_id: + redacted: false + metadata: {} total_count: 1 Snooze a conversation: value: @@ -5158,7 +5158,7 @@ paths: id: '403918098' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266413' @@ -5170,9 +5170,9 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c0fe1135824d60a361f84d - external_id: '70' + - type: contact + id: 64c0fe1135824d60a361f84d + external_id: '70' first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5199,23 +5199,23 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '711356' - part_type: snoozed - body: - created_at: 1690369554 - updated_at: 1690369554 - notified_at: 1690369554 - assigned_to: - author: - id: '991266413' - type: admin - name: Ciaran171 Lee - email: admin171@email.com - attachments: [] - external_id: - redacted: false - metadata: {} + - type: conversation_part + id: '711356' + part_type: snoozed + body: + created_at: 1690369554 + updated_at: 1690369554 + notified_at: 1690369554 + assigned_to: + author: + id: '991266413' + type: admin + name: Ciaran171 Lee + email: admin171@email.com + attachments: [] + external_id: + redacted: false + metadata: {} total_count: 1 Open a conversation: value: @@ -5230,7 +5230,7 @@ paths: id: '403918099' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266415' @@ -5242,9 +5242,9 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c0fe1635824d60a361f852 - external_id: '74' + - type: contact + id: 64c0fe1635824d60a361f852 + external_id: '74' first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5271,23 +5271,23 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '711358' - part_type: open - body: - created_at: 1690369561 - updated_at: 1690369561 - notified_at: 1690369561 - assigned_to: - author: - id: '991266415' - type: admin - name: Ciaran172 Lee - email: admin172@email.com - attachments: [] - external_id: - redacted: false - metadata: {} + - type: conversation_part + id: '711358' + part_type: open + body: + created_at: 1690369561 + updated_at: 1690369561 + notified_at: 1690369561 + assigned_to: + author: + id: '991266415' + type: admin + name: Ciaran172 Lee + email: admin172@email.com + attachments: [] + external_id: + redacted: false + metadata: {} total_count: 1 Assign a conversation: value: @@ -5302,7 +5302,7 @@ paths: id: '403918102' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266417' @@ -5314,9 +5314,9 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c0fe1935824d60a361f855 - external_id: '70' + - type: contact + id: 64c0fe1935824d60a361f855 + external_id: '70' first_contact_reply: admin_assignee_id: 991266417 team_assignee_id: @@ -5343,28 +5343,28 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '711359' - part_type: assign_and_reopen - body: - created_at: 1690369563 - updated_at: 1690369563 - notified_at: 1690369563 - assigned_to: - type: admin - id: '991266417' - author: - id: '991266417' - type: admin - name: Ciaran173 Lee - email: admin173@email.com - attachments: [] - external_id: - redacted: false - metadata: {} + - type: conversation_part + id: '711359' + part_type: assign_and_reopen + body: + created_at: 1690369563 + updated_at: 1690369563 + notified_at: 1690369563 + assigned_to: + type: admin + id: '991266417' + author: + id: '991266417' + type: admin + name: Ciaran173 Lee + email: admin173@email.com + attachments: [] + external_id: + redacted: false + metadata: {} total_count: 1 schema: - '$ref': '#/components/schemas/conversation' + "$ref": "#/components/schemas/conversation" '404': description: Not found content: @@ -5375,10 +5375,10 @@ paths: type: error.list request_id: 4d9f8828-de8c-41e7-94a0-49b04409fe79 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: @@ -5389,10 +5389,10 @@ paths: type: error.list request_id: 3d7415ef-0798-4500-bdcc-3f0ee98b19c6 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: @@ -5403,19 +5403,19 @@ paths: type: error.list request_id: 4c44ffb8-9798-4ddb-96b0-a89a3e6171dc 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 @@ -5449,23 +5449,23 @@ paths: type: admin admin_id: 991266419 body: Goodbye :) - '/conversations/{id}/run_assignment_rules': + "/conversations/{id}/run_assignment_rules": post: summary: Run Assignment Rules on a conversation parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The identifier for the conversation as given by Intercom. - example: '123' - schema: - type: string + - 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. @@ -5488,7 +5488,7 @@ paths: id: '403918106' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266425' @@ -5500,9 +5500,9 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c0fe2035824d60a361f859 - external_id: '70' + - type: contact + id: 64c0fe2035824d60a361f859 + external_id: '70' first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5529,28 +5529,28 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '711360' - part_type: default_assignment - body: - created_at: 1690369570 - updated_at: 1690369570 - notified_at: 1690369570 - assigned_to: - type: nobody_admin - id: - author: - id: '991266426' - type: bot - name: Operator - email: operator+this_is_an_id330_that_should_be_at_least_@intercom.io - attachments: [] - external_id: - redacted: false - metadata: {} + - type: conversation_part + id: '711360' + part_type: default_assignment + body: + created_at: 1690369570 + updated_at: 1690369570 + notified_at: 1690369570 + assigned_to: + type: nobody_admin + id: + author: + id: '991266426' + type: bot + name: Operator + email: operator+this_is_an_id330_that_should_be_at_least_@intercom.io + attachments: [] + external_id: + redacted: false + metadata: {} total_count: 1 schema: - '$ref': '#/components/schemas/conversation' + "$ref": "#/components/schemas/conversation" '404': description: Not found content: @@ -5561,10 +5561,10 @@ paths: type: error.list request_id: 1c1927a7-4eb8-4e8e-a2d5-861e3603bd80 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: @@ -5575,10 +5575,10 @@ paths: type: error.list request_id: 4ae27827-ed35-4bc2-8bc1-576dfbe743c3 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: @@ -5589,27 +5589,27 @@ paths: type: error.list request_id: 30e1ad6b-40ac-4af4-8489-4986526875c6 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 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.\n\n> \U0001F6A7 Note about contacts @@ -5625,10 +5625,10 @@ paths: Attach a contact to a conversation: value: customers: - - type: user - id: 64c0fe2835824d60a361f85d + - type: user + id: 64c0fe2835824d60a361f85d schema: - '$ref': '#/components/schemas/conversation' + "$ref": "#/components/schemas/conversation" '404': description: Not found content: @@ -5639,10 +5639,10 @@ paths: type: error.list request_id: 7621d0db-cb96-4e63-86e9-34115055da37 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: @@ -5653,10 +5653,10 @@ paths: type: error.list request_id: cd96d496-24a3-4f0f-97b4-8fba8aa53011 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: @@ -5667,15 +5667,15 @@ paths: type: error.list request_id: 194b715f-91dd-4c09-bc09-aa2826a4de0b 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 @@ -5689,30 +5689,30 @@ paths: admin_id: 991266435 customer: intercom_user_id: 64c0fe2a35824d60a361f85e - '/conversations/{conversation_id}/customers/{contact_id}': + "/conversations/{conversation_id}/customers/{contact_id}": delete: summary: Detach a contact from a group conversation parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: conversation_id - in: path - required: true - description: The identifier for the conversation as given by Intercom. - example: '123' - schema: - type: string - - name: contact_id - in: path - required: true - description: The identifier for the contact as given by Intercom. - example: '123' - schema: - type: string + - 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.\n\n> \U0001F6A7 Note about contacts @@ -5728,10 +5728,10 @@ paths: Detach a contact from a group conversation: value: customers: - - type: user - id: 64c0fe3535824d60a361f868 + - type: user + id: 64c0fe3535824d60a361f868 schema: - '$ref': '#/components/schemas/conversation' + "$ref": "#/components/schemas/conversation" '404': description: Contact not found content: @@ -5742,17 +5742,17 @@ paths: type: error.list request_id: a524c5fd-51b1-4739-a620-0528e6404b2b errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found Contact not found: value: type: error.list request_id: d07b7af1-4dd2-4798-a86b-c6192b96e7f6 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: @@ -5763,10 +5763,10 @@ paths: type: error.list request_id: 88e05251-7d60-4c56-84d7-00fa6beb6d33 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: @@ -5777,10 +5777,10 @@ paths: type: error.list request_id: 52906cdf-1eb1-41b0-98a8-1a69a88149b4 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: @@ -5791,15 +5791,15 @@ paths: type: error.list request_id: 5251091c-99e3-4ff9-ba6d-e1e504ca5fdb 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 @@ -5825,16 +5825,16 @@ paths: admin_id: 991266447 customer: intercom_user_id: 64c0fe4235824d60a361f877 - '/conversations/redact': + "/conversations/redact": post: summary: Redact a conversation part parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Conversations + - Conversations operationId: redactConversation description: "You can redact a conversation part or the source message of a conversation (as seen in the source object).\n\n> \U0001F4D8 Which parts and @@ -5861,7 +5861,7 @@ paths: id: '403918132' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266453' @@ -5873,9 +5873,9 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c0fe5435824d60a361f88c - external_id: '70' + - type: contact + id: 64c0fe5435824d60a361f88c + external_id: '70' first_contact_reply: created_at: 1690369621 type: conversation @@ -5905,26 +5905,26 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '711368' - part_type: comment - body: '

This message was deleted

' - created_at: 1690369621 - updated_at: 1690369622 - notified_at: 1690369621 - assigned_to: - author: - id: 64c0fe5435824d60a361f88c - type: user - name: Joe Bloggs - email: joe@bloggs.com - attachments: [] - external_id: - redacted: true - metadata: {} + - type: conversation_part + id: '711368' + part_type: comment + body: "

This message was deleted

" + created_at: 1690369621 + updated_at: 1690369622 + notified_at: 1690369621 + assigned_to: + author: + id: 64c0fe5435824d60a361f88c + type: user + name: Joe Bloggs + email: joe@bloggs.com + attachments: [] + external_id: + redacted: true + metadata: {} total_count: 1 schema: - '$ref': '#/components/schemas/conversation' + "$ref": "#/components/schemas/conversation" '404': description: Not found content: @@ -5935,10 +5935,10 @@ paths: type: error.list request_id: e4bc6246-8919-485f-837d-420e4eb00258 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: @@ -5949,15 +5949,15 @@ paths: type: error.list request_id: a0f72a50-f754-47ca-8d5f-6cbe50087025 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 @@ -5971,23 +5971,23 @@ paths: type: conversation_part conversation_id: really_123_doesnt_exist conversation_part_id: really_123_doesnt_exist - '/conversations/{id}/convert': + "/conversations/{id}/convert": post: summary: Convert a conversation to a ticket parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The id of the conversation to target - example: 123 - schema: - type: integer + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The id of the conversation to target + example: 123 + schema: + type: integer tags: - - Conversations + - Conversations description: You can convert a conversation to a ticket. responses: '200': @@ -6020,9 +6020,9 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c0fe5a35824d60a361f88f - external_id: '70' + - type: contact + id: 64c0fe5a35824d60a361f88f + external_id: '70' admin_assignee_id: '0' team_assignee_id: '0' created_at: 1690369629 @@ -6030,33 +6030,33 @@ paths: ticket_parts: type: ticket_part.list ticket_parts: - - type: ticket_part - id: '711370' - part_type: comment - body: '

Comment for message

' - created_at: 1690369626 - updated_at: 1690369626 - author: - id: 64c0fe5a35824d60a361f88f - type: user - name: Joe Bloggs - email: joe@bloggs.com - attachments: [] - redacted: false - - type: ticket_part - id: '711371' - part_type: ticket_state_updated_by_admin - ticket_state: submitted - previous_ticket_state: submitted - created_at: 1690369629 - updated_at: 1690369629 - author: - id: '991266463' - type: bot - name: Operator - email: operator+this_is_an_id364_that_should_be_at_least_@intercom.io - attachments: [] - redacted: false + - type: ticket_part + id: '711370' + part_type: comment + body: "

Comment for message

" + created_at: 1690369626 + updated_at: 1690369626 + author: + id: 64c0fe5a35824d60a361f88f + type: user + name: Joe Bloggs + email: joe@bloggs.com + attachments: [] + redacted: false + - type: ticket_part + id: '711371' + part_type: ticket_state_updated_by_admin + ticket_state: submitted + previous_ticket_state: submitted + created_at: 1690369629 + updated_at: 1690369629 + author: + id: '991266463' + type: bot + name: Operator + email: operator+this_is_an_id364_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false total_count: 2 open: true linked_objects: @@ -6067,7 +6067,7 @@ paths: category: Customer is_shared: true schema: - '$ref': '#/components/schemas/ticket' + "$ref": "#/components/schemas/ticket" '400': description: Bad request content: @@ -6078,15 +6078,15 @@ paths: type: error.list request_id: 5701951d-e438-4b46-b8d3-0a6452ca98e9 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 @@ -6096,35 +6096,35 @@ paths: summary: Bad request value: ticket_type_id: '766841' - '/data_attributes': + "/data_attributes": get: summary: List all data attributes parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: model - in: query - required: false - description: Specify the data attribute model to return. - schema: - type: string - enum: - - contact - - company - - conversation - example: company - - name: include_archived - in: query - required: false - description: Include archived attributes in the list. By default we return - only non archived data attributes. - example: false - schema: - type: boolean + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: model + in: query + required: false + description: Specify the data attribute model to return. + schema: + type: string + enum: + - contact + - company + - conversation + example: company + - name: include_archived + in: query + required: false + description: Include archived attributes in the list. By default we return + only non archived data attributes. + example: false + schema: + type: boolean tags: - - Data Attributes + - Data Attributes operationId: lisDataAttributes description: You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations. @@ -6138,206 +6138,206 @@ 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - custom: false - archived: false - model: company - - id: 188690 - 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 - custom: true - archived: false - admin_id: '991266471' - created_at: 1690369632 - updated_at: 1690369632 - 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 - 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 - 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 - 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 - 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 - 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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 + custom: false + archived: false + model: company + - id: 188690 + 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 + custom: true + archived: false + admin_id: '991266471' + created_at: 1690369632 + updated_at: 1690369632 + 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 + 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 + 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 + 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 + 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 + custom: false + archived: false + model: company schema: - '$ref': '#/components/schemas/data_attribute_list' + "$ref": "#/components/schemas/data_attribute_list" '401': description: Unauthorized content: @@ -6348,19 +6348,19 @@ paths: type: error.list request_id: 356c6802-b8c0-4745-9860-f9f2eacd978a 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 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: @@ -6386,7 +6386,7 @@ paths: updated_at: 1690369633 model: company schema: - '$ref': '#/components/schemas/data_attribute' + "$ref": "#/components/schemas/data_attribute" '400': description: Too few options for list content: @@ -6397,42 +6397,42 @@ paths: type: error.list request_id: cbd757ac-02ec-4ffa-aee1-2d521b771af4 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: 6f100457-60c6-4719-b09a-c2bc3ed8f446 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: 26db0c6b-29d8-4f62-81fc-11533dde05ea 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: 9b664a92-c961-401b-b131-ce46fe645c4a 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: 3672febf-74a3-477c-bad0-e171727584cc 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: @@ -6443,15 +6443,15 @@ paths: type: error.list request_id: 12cf05f6-008c-491d-81ee-77bf4bdc72ae 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 @@ -6468,7 +6468,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: @@ -6488,25 +6488,25 @@ paths: value: description: Just a plain old ring options: - - value: 1-10 + - value: 1-10 archived: false - '/data_attributes/{id}': + "/data_attributes/{id}": put: summary: Update a data attribute parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The data attribute id - example: 1 - schema: - type: integer + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The data attribute id + example: 1 + schema: + type: integer tags: - - Data Attributes + - Data Attributes operationId: updateDataAttribute description: "\nYou can update a data attribute.\n\n> \U0001F6A7 Updating the data type is not possible\n>\n> It is currently a dangerous action to execute @@ -6528,8 +6528,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 custom: true @@ -6539,7 +6539,7 @@ paths: updated_at: 1690369637 model: company schema: - '$ref': '#/components/schemas/data_attribute' + "$ref": "#/components/schemas/data_attribute" '400': description: Too few options in list content: @@ -6550,10 +6550,10 @@ paths: type: error.list request_id: 7e3ecf1a-3bb9-405e-9de1-3023aece33ea 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: @@ -6564,10 +6564,10 @@ paths: type: error.list request_id: 651377a7-4521-4e7c-8d0b-967e71f289fd 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: @@ -6578,11 +6578,11 @@ paths: type: error.list request_id: 939ec6bd-2d08-4782-a30a-06e709428832 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: @@ -6593,23 +6593,23 @@ paths: type: error.list request_id: fcb11937-8251-42b5-aaff-6cf603ea226e 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 @@ -6623,24 +6623,24 @@ 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 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: "\nYou will need an Access Token that has write permissions to send Events. Once you have a key you can submit events via POST to the Events @@ -6712,65 +6712,65 @@ paths: type: error.list request_id: ce362fa1-9f2a-48b1-acf8-f7b197c8dbde 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: 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 @@ -6800,7 +6800,7 @@ paths: intercom_user_id: 64c0fe6e35824d60a361f8a5 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 schema: - '$ref': '#/components/schemas/data_event_summary' + "$ref": "#/components/schemas/data_event_summary" '401': description: Unauthorized content: @@ -6811,20 +6811,20 @@ paths: type: error.list request_id: d59e2c7d-cd34-4272-bced-5b9a565d6035 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: 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 @@ -6842,25 +6842,25 @@ paths: type: error.list request_id: f9b13dd3-8ffc-4d11-a7d4-d93c16323052 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 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: create data export 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 @@ -6889,34 +6889,34 @@ 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: 1690351648 created_at_before: 1690369648 - '/export/content/data/{job_identifier}': + "/export/content/data/{job_identifier}": get: summary: Show content data export parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: job_identifier - in: path - description: job_identifier - required: true - schema: - type: string + - 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: get data export 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}` @@ -6939,23 +6939,23 @@ 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 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: Cancel data export description: You can cancel your job responses: @@ -6971,23 +6971,23 @@ 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 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: Download data export 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: @@ -6998,16 +6998,16 @@ paths: responses: '200': description: successful - '/messages': + "/messages": post: summary: Create a message parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Messages + - Messages operationId: createMessage description: "You can create a message that has been initiated by an admin. The conversation can be either an in-app message or an email.\n\n> \U0001F6A7 @@ -7056,7 +7056,7 @@ paths: 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: @@ -7067,17 +7067,17 @@ paths: type: error.list request_id: d84e5767-32ee-4d57-93d4-0c63ba6f9fef 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: 5d884605-3435-4772-b44a-56b102dbbc0c 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: @@ -7088,10 +7088,10 @@ paths: type: error.list request_id: 6ce5f07f-82c0-4fc9-b497-14b75d1554c4 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: @@ -7102,10 +7102,10 @@ paths: type: error.list request_id: 5bf155b3-5bcf-48b2-acf3-892feafbd165 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: @@ -7116,15 +7116,15 @@ paths: type: error.list request_id: 92c2f13c-a1dc-4c07-9555-3da29067239f 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 @@ -7188,16 +7188,16 @@ paths: message_type: email body: subject: heyy - '/news/news_items': + "/news/news_items": get: summary: List all news items parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - News + - News operationId: listNewsItems description: You can fetch a list of all news items responses: @@ -7215,45 +7215,45 @@ paths: total_pages: 1 type: pages data: - - id: '398556' - type: news-item - workspace_id: this_is_an_id436_that_should_be_at_least_ - title: We have news - body: '

Hello there,

' - sender_id: 991266519 - state: draft - labels: [] - cover_image_url: - reactions: - - - - - - - - - deliver_silently: false - created_at: 1690369684 - updated_at: 1690369684 - newsfeed_assignments: [] - - id: '398555' - type: news-item - workspace_id: this_is_an_id436_that_should_be_at_least_ - title: We have news - body: '

Hello there,

' - sender_id: 991266517 - state: draft - labels: [] - cover_image_url: - reactions: - - - - - - - - - deliver_silently: false - created_at: 1690369683 - updated_at: 1690369683 - newsfeed_assignments: [] + - id: '398556' + type: news-item + workspace_id: this_is_an_id436_that_should_be_at_least_ + title: We have news + body: "

Hello there,

" + sender_id: 991266519 + state: draft + labels: [] + cover_image_url: + reactions: + - + - + - + - + deliver_silently: false + created_at: 1690369684 + updated_at: 1690369684 + newsfeed_assignments: [] + - id: '398555' + type: news-item + workspace_id: this_is_an_id436_that_should_be_at_least_ + title: We have news + body: "

Hello there,

" + sender_id: 991266517 + state: draft + labels: [] + cover_image_url: + reactions: + - + - + - + - + deliver_silently: false + created_at: 1690369683 + updated_at: 1690369683 + newsfeed_assignments: [] total_count: 2 schema: - '$ref': '#/components/schemas/paginated_response' + "$ref": "#/components/schemas/paginated_response" '401': description: Unauthorized content: @@ -7264,19 +7264,19 @@ paths: type: error.list request_id: 895081b5-9882-4910-baf1-03c0c3b30ba4 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 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: @@ -7291,25 +7291,25 @@ paths: type: news-item workspace_id: this_is_an_id440_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: 991266526 state: live labels: - - New - - Product - - Update + - New + - Product + - Update cover_image_url: reactions: - - "\U0001F606" - - "\U0001F605" + - "\U0001F606" + - "\U0001F605" deliver_silently: true created_at: 1690369685 updated_at: 1690369685 newsfeed_assignments: - - newsfeed_id: 403602 - published_at: 1664638214 + - newsfeed_id: 403602 + published_at: 1664638214 schema: - '$ref': '#/components/schemas/news_item' + "$ref": "#/components/schemas/news_item" '401': description: Unauthorized content: @@ -7320,51 +7320,51 @@ paths: type: error.list request_id: 2248ff03-d960-4f73-a16c-958bc795faad 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: 991266526 deliver_silently: true reactions: - - "\U0001F606" - - "\U0001F605" + - "\U0001F606" + - "\U0001F605" state: live newsfeed_assignments: - - newsfeed_id: 403602 - published_at: 1664638214 - '/news/news_items/{id}': + - newsfeed_id: 403602 + published_at: 1664638214 + "/news/news_items/{id}": get: summary: Retrieve a news item parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The unique identifier for the news item which is given by Intercom. - example: 123 - schema: - type: integer + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the news item which is given by Intercom. + example: 123 + schema: + type: integer tags: - - News + - News operationId: retrieveNewsItem description: You can fetch the details of a single news item. responses: @@ -7379,24 +7379,24 @@ paths: type: news-item workspace_id: this_is_an_id444_that_should_be_at_least_ title: We have news - body: '

Hello there,

' + body: "

Hello there,

" sender_id: 991266529 state: live labels: [] cover_image_url: reactions: - - - - - - - - + - + - + - + - deliver_silently: false created_at: 1690369686 updated_at: 1690369686 newsfeed_assignments: - - newsfeed_id: 403604 - published_at: 1690369687 + - newsfeed_id: 403604 + published_at: 1690369687 schema: - '$ref': '#/components/schemas/news_item' + "$ref": "#/components/schemas/news_item" '404': description: News Item Not Found content: @@ -7407,10 +7407,10 @@ paths: type: error.list request_id: 94cb6b18-54ec-44f2-b09c-520b4974c4c3 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: @@ -7421,26 +7421,26 @@ paths: type: error.list request_id: 22617d3f-7545-40ed-b3e1-1653ea96b7ba errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' + "$ref": "#/components/schemas/error" put: summary: Update a news item parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The unique identifier for the news item which is given by Intercom. - example: 123 - schema: - type: integer + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the news item which is given by Intercom. + example: 123 + schema: + type: integer tags: - - News + - News operationId: updateNewsItem responses: '200': @@ -7454,20 +7454,20 @@ paths: type: news-item workspace_id: this_is_an_id450_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: 991266537 state: live labels: [] cover_image_url: reactions: - - "\U0001F61D" - - "\U0001F602" + - "\U0001F61D" + - "\U0001F602" deliver_silently: false created_at: 1690369688 updated_at: 1690369689 newsfeed_assignments: [] schema: - '$ref': '#/components/schemas/news_item' + "$ref": "#/components/schemas/news_item" '404': description: News Item Not Found content: @@ -7478,10 +7478,10 @@ paths: type: error.list request_id: f180f566-5589-4f72-8ad3-79a0dc933c0d 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: @@ -7492,50 +7492,50 @@ paths: type: error.list request_id: 562476e5-0102-464f-89f0-a82b0a4756f3 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: 991266537 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: 991266540 reactions: - - "\U0001F61D" - - "\U0001F602" + - "\U0001F61D" + - "\U0001F602" delete: summary: Delete a news item parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The unique identifier for the news item which is given by Intercom. - example: 123 - schema: - type: integer + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the news item which is given by Intercom. + example: 123 + schema: + type: integer tags: - - News + - News operationId: deleteNewsItem description: You can delete a single news item. responses: @@ -7550,7 +7550,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: @@ -7561,10 +7561,10 @@ paths: type: error.list request_id: 8027aaf1-7572-4505-a579-fd07f54d7ac6 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: @@ -7575,28 +7575,28 @@ paths: type: error.list request_id: 5e1ee197-95cd-445b-8aa3-93398bc309e4 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: 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 @@ -7617,7 +7617,7 @@ paths: data: [] total_count: 0 schema: - '$ref': '#/components/schemas/paginated_response' + "$ref": "#/components/schemas/paginated_response" '401': description: Unauthorized content: @@ -7628,20 +7628,20 @@ paths: type: error.list request_id: 2d3748f2-11c7-4651-ae97-164128bc72fe 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: 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: @@ -7659,19 +7659,19 @@ paths: total_pages: 1 type: pages data: - - id: '403617' - type: newsfeed - name: Visitor Feed - created_at: 1690369693 - updated_at: 1690369693 - - id: '403618' - type: newsfeed - name: Visitor Feed - created_at: 1690369693 - updated_at: 1690369693 + - id: '403617' + type: newsfeed + name: Visitor Feed + created_at: 1690369693 + updated_at: 1690369693 + - id: '403618' + type: newsfeed + name: Visitor Feed + created_at: 1690369693 + updated_at: 1690369693 total_count: 2 schema: - '$ref': '#/components/schemas/paginated_response' + "$ref": "#/components/schemas/paginated_response" '401': description: Unauthorized content: @@ -7682,28 +7682,28 @@ paths: type: error.list request_id: 50817bd4-03f7-4421-b524-6545bc2dfa1a 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: 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: @@ -7720,7 +7720,7 @@ paths: created_at: 1690369694 updated_at: 1690369694 schema: - '$ref': '#/components/schemas/newsfeed' + "$ref": "#/components/schemas/newsfeed" '401': description: Unauthorized content: @@ -7731,27 +7731,27 @@ paths: type: error.list request_id: 62c1d570-90a2-4c2f-ba51-915e39713f2f 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 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: @@ -7775,9 +7775,9 @@ paths: email: admin281@email.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: @@ -7788,10 +7788,10 @@ paths: type: error.list request_id: 397fe7ac-9526-4668-a528-8ce01a17b63f 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: @@ -7802,27 +7802,27 @@ paths: type: error.list request_id: f1e32e54-85bf-4268-9a2b-3bd8a3a4ca3a 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: 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: @@ -7835,20 +7835,20 @@ paths: value: type: segment.list segments: - - type: segment - id: 64c0fea635824d60a361f911 - name: John segment - created_at: 1690369702 - updated_at: 1690369702 - person_type: user - - type: segment - id: 64c0fea735824d60a361f912 - name: Jane segment - created_at: 1690369703 - updated_at: 1690369703 - person_type: user - schema: - '$ref': '#/components/schemas/segment_list' + - type: segment + id: 64c0fea635824d60a361f911 + name: John segment + created_at: 1690369702 + updated_at: 1690369702 + person_type: user + - type: segment + id: 64c0fea735824d60a361f912 + name: Jane segment + created_at: 1690369703 + updated_at: 1690369703 + person_type: user + schema: + "$ref": "#/components/schemas/segment_list" '401': description: Unauthorized content: @@ -7859,27 +7859,27 @@ paths: type: error.list request_id: b3a33cc5-4593-4719-b6e3-5d4eae567cdb 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 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: @@ -7897,7 +7897,7 @@ paths: updated_at: 1690369703 person_type: user schema: - '$ref': '#/components/schemas/segment' + "$ref": "#/components/schemas/segment" '404': description: Segment not found content: @@ -7908,10 +7908,10 @@ paths: type: error.list request_id: 88d8da90-dd0e-4cb4-a645-8099ae23d316 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: @@ -7922,20 +7922,20 @@ paths: type: error.list request_id: 14b65227-5ed6-440a-a1c5-43232d14b0d2 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: 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. @@ -7949,22 +7949,22 @@ paths: value: type: list data: - - type: subscription - id: '440977' - 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: '440977' + 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: @@ -7975,20 +7975,20 @@ paths: type: error.list request_id: 2f06aa27-3f23-44e5-bc18-9f07ee2e7e35 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: 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. @@ -8006,7 +8006,7 @@ paths: url: http://via.intercom.io/msgr/432f4c18-52f2-4d83-a6cf-6421ec12ad1f type: phone_call_redirect schema: - '$ref': '#/components/schemas/phone_switch' + "$ref": "#/components/schemas/phone_switch" '400': description: bad request - invalid number content: @@ -8038,54 +8038,54 @@ paths: type: error.list request_id: 80289bb5-4c9a-4c58-9dbc-7ab93ccaa18a 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: 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: @@ -8098,11 +8098,11 @@ paths: value: type: list data: - - type: tag - id: '321903' - name: Manual tag 1 + - type: tag + id: '321903' + name: Manual tag 1 schema: - '$ref': '#/components/schemas/tag_list' + "$ref": "#/components/schemas/tag_list" '401': description: Unauthorized content: @@ -8113,19 +8113,19 @@ paths: type: error.list request_id: 13e3a8fc-b3e5-4a95-afbb-8a588326d578 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: @@ -8153,7 +8153,7 @@ paths: id: '321906' name: test schema: - '$ref': '#/components/schemas/tag' + "$ref": "#/components/schemas/tag" '400': description: Invalid parameters content: @@ -8164,10 +8164,10 @@ paths: type: error.list request_id: 96743dad-c11a-4553-bce7-b7e4c704ef1f 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: @@ -8178,17 +8178,17 @@ paths: type: error.list request_id: 2a3d8237-422a-4d9b-ba38-433054036c9e 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: 6afbd421-991b-4b19-a68d-c255772c80df 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: @@ -8199,19 +8199,19 @@ paths: type: error.list request_id: 2499a0f5-bc1f-44ab-a6c3-7b7568cc5d5b 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 @@ -8226,30 +8226,30 @@ paths: value: name: test companies: - - company_id: '123' + - company_id: '123' user_not_found: summary: User not found value: name: test users: - - id: '123' - '/tags/{id}': + - id: '123' + "/tags/{id}": get: summary: Find a specific tag parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - description: The unique identifier of a given tag - example: '123' - required: true - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: The unique identifier of a given tag + example: '123' + required: true + schema: + type: string tags: - - Tags + - Tags operationId: findTag description: | You can fetch the details of tags that are on the workspace by their id. @@ -8266,7 +8266,7 @@ paths: id: '321914' name: Manual tag schema: - '$ref': '#/components/schemas/tag' + "$ref": "#/components/schemas/tag" '404': description: Tag not found content: @@ -8277,10 +8277,10 @@ paths: type: error.list request_id: d8aaa2df-14a6-4c07-928e-7c23bf79b272 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: @@ -8291,26 +8291,26 @@ paths: type: error.list request_id: 73d1bf5f-3afa-4c78-bd48-0574bfcfe7d9 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' + "$ref": "#/components/schemas/error" delete: summary: Delete tag parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - description: The unique identifier of a given tag - example: '123' - required: true - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: The unique identifier of a given tag + example: '123' + required: true + schema: + type: string tags: - - Tags + - Tags operationId: deleteTag description: You can delete the details of tags that are on the workspace by passing in the id. @@ -8327,10 +8327,10 @@ paths: type: error.list request_id: 43fb5175-c1d4-469d-97a4-8d6c3cbffcb9 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: @@ -8341,11 +8341,11 @@ paths: type: error.list request_id: 2ac77092-04a8-4718-a1bf-61b17ebe9b43 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: @@ -8356,20 +8356,20 @@ paths: type: error.list request_id: 9dc1cdb0-823f-4099-bdcd-1890b7a350be 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: 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: @@ -8383,7 +8383,7 @@ paths: type: team.list teams: [] schema: - '$ref': '#/components/schemas/team_list' + "$ref": "#/components/schemas/team_list" '401': description: Unauthorized content: @@ -8394,27 +8394,27 @@ paths: type: error.list request_id: 9be46769-ff52-483b-b99b-81b6a404b1e9 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 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. @@ -8431,7 +8431,7 @@ paths: name: team 1 admin_ids: [] schema: - '$ref': '#/components/schemas/team' + "$ref": "#/components/schemas/team" '404': description: Team not found content: @@ -8442,10 +8442,10 @@ paths: type: error.list request_id: ab3e4fea-603f-4f17-bb0c-44b6e330d674 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: @@ -8456,26 +8456,26 @@ paths: type: error.list request_id: e592052a-2460-4829-8e40-297be59fbf8d 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: 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: @@ -8505,7 +8505,7 @@ paths: created_at: 1690369726 updated_at: 1690369726 schema: - '$ref': '#/components/schemas/ticket_type_attribute' + "$ref": "#/components/schemas/ticket_type_attribute" '401': description: Unauthorized content: @@ -8516,15 +8516,15 @@ paths: type: error.list request_id: 563ca5d9-6954-45f8-9bad-229c54ca6eaa 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 @@ -8533,29 +8533,29 @@ 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: 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: @@ -8583,7 +8583,7 @@ paths: created_at: 1690369727 updated_at: 1690369727 schema: - '$ref': '#/components/schemas/ticket_type_attribute' + "$ref": "#/components/schemas/ticket_type_attribute" '401': description: Unauthorized content: @@ -8594,30 +8594,30 @@ paths: type: error.list request_id: 53d40f08-ddad-40f9-9b00-88bb67f45fe7 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: 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 description: You can get a list of all ticket types for a workspace. responses: '200': @@ -8629,39 +8629,39 @@ paths: value: type: list data: - - type: ticket_type - id: '766846' - name: Bug Report - description: Bug Report Template - icon: "\U0001F39F️" - workspace_id: this_is_an_id550_that_should_be_at_least_ - archived: false - created_at: 1690369727 - updated_at: 1690369727 - is_internal: false - ticket_type_attributes: - type: list - data: - - type: ticket_type_attribute - id: '164488' - workspace_id: this_is_an_id550_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: 766846 - archived: false - created_at: 1690369727 - updated_at: 1690369727 - category: Customer - schema: - '$ref': '#/components/schemas/ticket_type_list' + - type: ticket_type + id: '766846' + name: Bug Report + description: Bug Report Template + icon: "\U0001F39F️" + workspace_id: this_is_an_id550_that_should_be_at_least_ + archived: false + created_at: 1690369727 + updated_at: 1690369727 + is_internal: false + ticket_type_attributes: + type: list + data: + - type: ticket_type_attribute + id: '164488' + workspace_id: this_is_an_id550_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: 766846 + archived: false + created_at: 1690369727 + updated_at: 1690369727 + category: Customer + schema: + "$ref": "#/components/schemas/ticket_type_list" '401': description: Unauthorized content: @@ -8672,19 +8672,19 @@ paths: type: error.list request_id: 3dc91b2c-a2fa-471f-b6fc-6183fd89ced6 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 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 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: _default_title_ and _default_description_.\n> For the `icon` propery, use @@ -8712,7 +8712,7 @@ paths: data: [] category: Customer schema: - '$ref': '#/components/schemas/ticket_type' + "$ref": "#/components/schemas/ticket_type" '401': description: Unauthorized content: @@ -8723,15 +8723,15 @@ paths: type: error.list request_id: 43a8f89e-eb40-4195-8c44-0954c078c6b3 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 @@ -8740,22 +8740,22 @@ paths: description: Customer Report Template icon: "\U0001F39F️" category: Customer - '/ticket_types/{id}': + "/ticket_types/{id}": get: summary: Retrieve a ticket type parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The unique identifier for the ticket type which is given by Intercom. - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the ticket type which is given by Intercom. + schema: + type: string tags: - - Ticket Types + - Ticket Types description: You can fetch the details of a single ticket type. responses: '200': @@ -8778,26 +8778,26 @@ paths: ticket_type_attributes: type: list data: - - type: ticket_type_attribute - id: '164492' - workspace_id: this_is_an_id558_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: 766851 - archived: false - created_at: 1690369729 - updated_at: 1690369729 + - type: ticket_type_attribute + id: '164492' + workspace_id: this_is_an_id558_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: 766851 + archived: false + created_at: 1690369729 + updated_at: 1690369729 category: Customer schema: - '$ref': '#/components/schemas/ticket_type' + "$ref": "#/components/schemas/ticket_type" '401': description: Unauthorized content: @@ -8808,25 +8808,25 @@ paths: type: error.list request_id: c434a423-4a97-406d-bcf0-5ff05db707f8 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' + "$ref": "#/components/schemas/error" put: summary: Update a ticket type parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The unique identifier for the ticket type which is given by Intercom. - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the ticket type which is given by Intercom. + schema: + type: string tags: - - Ticket Types + - Ticket Types 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" responses: @@ -8850,26 +8850,26 @@ paths: ticket_type_attributes: type: list data: - - type: ticket_type_attribute - id: '164494' - workspace_id: this_is_an_id562_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: 766853 - archived: false - created_at: 1690369731 - updated_at: 1690369731 + - type: ticket_type_attribute + id: '164494' + workspace_id: this_is_an_id562_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: 766853 + archived: false + created_at: 1690369731 + updated_at: 1690369731 category: Customer schema: - '$ref': '#/components/schemas/ticket_type' + "$ref": "#/components/schemas/ticket_type" '401': description: Unauthorized content: @@ -8880,41 +8880,41 @@ paths: type: error.list request_id: a3bf24b3-8198-442b-bb84-c3fb52fd93be 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: 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: '200': description: Admin quick_reply reply @@ -8926,7 +8926,7 @@ paths: type: ticket_part id: '711374' part_type: comment - body: '

Thanks again :)

' + body: "

Thanks again :)

" created_at: 1690369733 updated_at: 1690369733 author: @@ -8978,7 +8978,7 @@ paths: attachments: [] redacted: false schema: - '$ref': '#/components/schemas/ticket_reply' + "$ref": "#/components/schemas/ticket_reply" '404': description: Not found content: @@ -8989,10 +8989,10 @@ paths: type: error.list request_id: e2ad3ece-e925-4a98-934c-84686d99e572 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: @@ -9003,15 +9003,15 @@ paths: type: error.list request_id: 7bc5f60e-4e91-489a-b9e6-db19673641e9 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_reply_request' + "$ref": "#/components/schemas/create_ticket_reply_request" examples: user_reply: summary: User reply @@ -9037,10 +9037,10 @@ paths: type: admin admin_id: 991266632 reply_options: - - text: 'Yes' - uuid: 3ca3de08-5294-445c-bffe-86bbdbe832f9 - - text: 'No' - uuid: a37cb564-04fe-4f10-89b1-718892e36bf1 + - text: 'Yes' + uuid: 3ca3de08-5294-445c-bffe-86bbdbe832f9 + - text: 'No' + uuid: a37cb564-04fe-4f10-89b1-718892e36bf1 not_found: summary: Not found value: @@ -9048,24 +9048,24 @@ paths: type: user intercom_user_id: 64c0feca35824d60a361f947 body: Thanks again :) - '/tickets/{ticket_id}/tags': + "/tickets/{ticket_id}/tags": post: summary: Add tag to a ticket parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: ticket_id - in: path - description: ticket_id - example: '64619700005694' - required: true - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: ticket_id + in: path + description: ticket_id + example: '64619700005694' + required: true + schema: + type: string tags: - - Tags - - Tickets + - Tags + - Tickets operationId: attachTagToTicket description: You can tag a specific ticket. This will return a tag object for the tag that was added to the ticket. @@ -9081,7 +9081,7 @@ paths: id: '321922' name: Manual tag schema: - '$ref': '#/components/schemas/tag' + "$ref": "#/components/schemas/tag" '404': description: Ticket not found content: @@ -9092,10 +9092,10 @@ paths: type: error.list request_id: b1607c16-384a-4685-8114-a77c2d722aa7 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: @@ -9106,18 +9106,18 @@ paths: type: error.list request_id: 13607e4a-92ed-4d3b-9b15-d3ef20f94f0d 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 @@ -9140,31 +9140,31 @@ paths: value: id: 321923 admin_id: 991266645 - '/tickets/{ticket_id}/tags/{id}': + "/tickets/{ticket_id}/tags/{id}": delete: summary: Remove tag from a ticket parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: ticket_id - in: path - description: ticket_id - example: '64619700005694' - required: true - schema: - type: string - - name: id - in: path - description: The unique identifier for the tag which is given by Intercom - example: '7522907' - required: true - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: ticket_id + in: path + description: ticket_id + example: '64619700005694' + required: true + schema: + type: string + - name: id + in: path + description: The unique identifier for the tag which is given by Intercom + example: '7522907' + required: true + schema: + type: string tags: - - Tags - - Tickets + - Tags + - Tickets operationId: detachTagFromTicket description: You can remove tag from a specific ticket. This will return a tag object for the tag that was removed from the ticket. @@ -9180,7 +9180,7 @@ paths: id: '321925' name: Manual tag schema: - '$ref': '#/components/schemas/tag' + "$ref": "#/components/schemas/tag" '404': description: Tag not found content: @@ -9191,17 +9191,17 @@ paths: type: error.list request_id: 48c0047a-1d45-4799-8210-1808cb02bb2d 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: 45fc35d2-7b69-4271-a55f-d8fd518fe018 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: @@ -9212,17 +9212,17 @@ paths: type: error.list request_id: 4b21b00d-14e9-44d6-b04f-78113735788f 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 @@ -9242,16 +9242,16 @@ paths: summary: Tag not found value: admin_id: 991266657 - '/tickets': + "/tickets": post: summary: Create a ticket parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Tickets + - Tickets description: You can create a new ticket. responses: '200': @@ -9282,47 +9282,47 @@ paths: ticket_type_attributes: type: list data: - - type: ticket_type_attribute - id: '164504' - workspace_id: this_is_an_id590_that_should_be_at_least_ - name: 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: 766867 - archived: false - created_at: 1690369748 - updated_at: 1690369748 - - type: ticket_type_attribute - id: '164505' - workspace_id: this_is_an_id590_that_should_be_at_least_ - name: 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: 766867 - archived: false - created_at: 1690369748 - updated_at: 1690369748 + - type: ticket_type_attribute + id: '164504' + workspace_id: this_is_an_id590_that_should_be_at_least_ + name: 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: 766867 + archived: false + created_at: 1690369748 + updated_at: 1690369748 + - type: ticket_type_attribute + id: '164505' + workspace_id: this_is_an_id590_that_should_be_at_least_ + name: 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: 766867 + archived: false + created_at: 1690369748 + updated_at: 1690369748 category: Back-office contacts: type: contact.list contacts: - - type: contact - id: 64c0fed535824d60a361f950 - external_id: '70' + - type: contact + id: 64c0fed535824d60a361f950 + external_id: '70' admin_assignee_id: '0' team_assignee_id: '0' created_at: 1690369749 @@ -9330,20 +9330,20 @@ paths: ticket_parts: type: ticket_part.list ticket_parts: - - type: ticket_part - id: '711379' - part_type: ticket_state_updated_by_admin - ticket_state: submitted - previous_ticket_state: submitted - created_at: 1690369749 - updated_at: 1690369749 - author: - id: '991266669' - type: bot - name: Operator - email: operator+this_is_an_id590_that_should_be_at_least_@intercom.io - attachments: [] - redacted: false + - type: ticket_part + id: '711379' + part_type: ticket_state_updated_by_admin + ticket_state: submitted + previous_ticket_state: submitted + created_at: 1690369749 + updated_at: 1690369749 + author: + id: '991266669' + type: bot + name: Operator + email: operator+this_is_an_id590_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false total_count: 1 open: true linked_objects: @@ -9354,7 +9354,7 @@ paths: category: Back-office is_shared: false schema: - '$ref': '#/components/schemas/ticket' + "$ref": "#/components/schemas/ticket" '401': description: Unauthorized content: @@ -9365,41 +9365,41 @@ paths: type: error.list request_id: 84be7dfa-2253-4fb2-af9d-738b38f360ea 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_request' + "$ref": "#/components/schemas/create_ticket_request" examples: successful_response: summary: Successful response value: ticket_type_id: 766867 contacts: - - id: 64c0fed535824d60a361f950 + - id: 64c0fed535824d60a361f950 ticket_attributes: title: example description: there is a problem - '/tickets/{id}': + "/tickets/{id}": put: summary: Update a ticket parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The unique identifier for the ticket which is given by Intercom - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the ticket which is given by Intercom + schema: + type: string tags: - - Tickets + - Tickets description: You can update a ticket. responses: '200': @@ -9430,47 +9430,47 @@ paths: ticket_type_attributes: type: list data: - - type: ticket_type_attribute - id: '164509' - workspace_id: this_is_an_id594_that_should_be_at_least_ - name: 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: 766869 - archived: false - created_at: 1690369751 - updated_at: 1690369751 - - type: ticket_type_attribute - id: '164510' - workspace_id: this_is_an_id594_that_should_be_at_least_ - name: 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: 766869 - archived: false - created_at: 1690369751 - updated_at: 1690369751 + - type: ticket_type_attribute + id: '164509' + workspace_id: this_is_an_id594_that_should_be_at_least_ + name: 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: 766869 + archived: false + created_at: 1690369751 + updated_at: 1690369751 + - type: ticket_type_attribute + id: '164510' + workspace_id: this_is_an_id594_that_should_be_at_least_ + name: 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: 766869 + archived: false + created_at: 1690369751 + updated_at: 1690369751 category: Back-office contacts: type: contact.list contacts: - - type: contact - id: 64c0fed735824d60a361f951 - external_id: 94208649-1d7f-4a23-801b-ed4213e3c80b + - type: contact + id: 64c0fed735824d60a361f951 + external_id: 94208649-1d7f-4a23-801b-ed4213e3c80b admin_assignee_id: '991266683' team_assignee_id: '0' created_at: 1690369751 @@ -9478,85 +9478,85 @@ paths: ticket_parts: type: ticket_part.list ticket_parts: - - type: ticket_part - id: '711380' - part_type: ticket_state_updated_by_admin - ticket_state: submitted - previous_ticket_state: submitted - created_at: 1690369751 - updated_at: 1690369751 - author: - id: '991266681' - type: admin - name: Ciaran390 Lee - email: admin390@email.com - attachments: [] - redacted: false - - type: ticket_part - id: '711381' - part_type: ticket_attribute_updated_by_admin - created_at: 1690369752 - updated_at: 1690369752 - author: - id: '991266682' - type: bot - name: Operator - email: operator+this_is_an_id594_that_should_be_at_least_@intercom.io - attachments: [] - redacted: false - - type: ticket_part - id: '711382' - part_type: ticket_attribute_updated_by_admin - created_at: 1690369752 - updated_at: 1690369752 - author: - id: '991266682' - type: bot - name: Operator - email: operator+this_is_an_id594_that_should_be_at_least_@intercom.io - attachments: [] - redacted: false - - type: ticket_part - id: '711383' - part_type: ticket_state_updated_by_admin - ticket_state: in_progress - previous_ticket_state: submitted - created_at: 1690369753 - updated_at: 1690369753 - author: - id: '991266682' - type: bot - name: Operator - email: operator+this_is_an_id594_that_should_be_at_least_@intercom.io - attachments: [] - redacted: false - - type: ticket_part - id: '711384' - part_type: assignment - created_at: 1690369753 - updated_at: 1690369753 - assigned_to: - type: admin - id: '991266683' - author: - id: '991266681' - type: admin - name: Ciaran390 Lee - email: admin390@email.com - attachments: [] - redacted: false - - type: ticket_part - id: '711385' - part_type: snoozed - created_at: 1690369753 - updated_at: 1690369753 - author: - id: '991266682' - type: bot - name: Operator - email: operator+this_is_an_id594_that_should_be_at_least_@intercom.io - attachments: [] - redacted: false + - type: ticket_part + id: '711380' + part_type: ticket_state_updated_by_admin + ticket_state: submitted + previous_ticket_state: submitted + created_at: 1690369751 + updated_at: 1690369751 + author: + id: '991266681' + type: admin + name: Ciaran390 Lee + email: admin390@email.com + attachments: [] + redacted: false + - type: ticket_part + id: '711381' + part_type: ticket_attribute_updated_by_admin + created_at: 1690369752 + updated_at: 1690369752 + author: + id: '991266682' + type: bot + name: Operator + email: operator+this_is_an_id594_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false + - type: ticket_part + id: '711382' + part_type: ticket_attribute_updated_by_admin + created_at: 1690369752 + updated_at: 1690369752 + author: + id: '991266682' + type: bot + name: Operator + email: operator+this_is_an_id594_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false + - type: ticket_part + id: '711383' + part_type: ticket_state_updated_by_admin + ticket_state: in_progress + previous_ticket_state: submitted + created_at: 1690369753 + updated_at: 1690369753 + author: + id: '991266682' + type: bot + name: Operator + email: operator+this_is_an_id594_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false + - type: ticket_part + id: '711384' + part_type: assignment + created_at: 1690369753 + updated_at: 1690369753 + assigned_to: + type: admin + id: '991266683' + author: + id: '991266681' + type: admin + name: Ciaran390 Lee + email: admin390@email.com + attachments: [] + redacted: false + - type: ticket_part + id: '711385' + part_type: snoozed + created_at: 1690369753 + updated_at: 1690369753 + author: + id: '991266682' + type: bot + name: Operator + email: operator+this_is_an_id594_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false total_count: 6 open: true snoozed_until: 1690473600 @@ -9568,7 +9568,7 @@ paths: category: Back-office is_shared: false schema: - '$ref': '#/components/schemas/ticket' + "$ref": "#/components/schemas/ticket" '404': description: Assignee not found content: @@ -9579,15 +9579,15 @@ paths: type: error.list request_id: 243bd1a4-ec0a-4b05-aeb8-29d687796376 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: 29e35ff1-e7e2-4ecd-be58-1d8d46dadb92 errors: - - code: assignee_not_found - message: Assignee not found + - code: assignee_not_found + message: Assignee not found '401': description: Unauthorized content: @@ -9598,15 +9598,15 @@ paths: type: error.list request_id: 248c094a-bd8b-42e0-b7f3-5bad01dae8ab 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 @@ -9643,18 +9643,18 @@ paths: get: summary: Retrieve a ticket parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The unique identifier for the ticket which is given by Intercom. - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the ticket which is given by Intercom. + schema: + type: string tags: - - Tickets + - Tickets description: You can fetch the details of a single ticket. responses: '200': @@ -9685,47 +9685,47 @@ paths: ticket_type_attributes: type: list data: - - type: ticket_type_attribute - id: '164520' - workspace_id: this_is_an_id602_that_should_be_at_least_ - name: 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: 766873 - archived: false - created_at: 1690369758 - updated_at: 1690369758 - - type: ticket_type_attribute - id: '164521' - workspace_id: this_is_an_id602_that_should_be_at_least_ - name: 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: 766873 - archived: false - created_at: 1690369758 - updated_at: 1690369758 + - type: ticket_type_attribute + id: '164520' + workspace_id: this_is_an_id602_that_should_be_at_least_ + name: 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: 766873 + archived: false + created_at: 1690369758 + updated_at: 1690369758 + - type: ticket_type_attribute + id: '164521' + workspace_id: this_is_an_id602_that_should_be_at_least_ + name: 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: 766873 + archived: false + created_at: 1690369758 + updated_at: 1690369758 category: Back-office contacts: type: contact.list contacts: - - type: contact - id: 64c0fedf35824d60a361f954 - external_id: fbd20e3e-ab4b-42ab-b348-5168016c8adb + - type: contact + id: 64c0fedf35824d60a361f954 + external_id: fbd20e3e-ab4b-42ab-b348-5168016c8adb admin_assignee_id: '0' team_assignee_id: '0' created_at: 1690369759 @@ -9733,20 +9733,20 @@ paths: ticket_parts: type: ticket_part.list ticket_parts: - - type: ticket_part - id: '711388' - part_type: ticket_state_updated_by_admin - ticket_state: submitted - previous_ticket_state: submitted - created_at: 1690369759 - updated_at: 1690369759 - author: - id: '991266710' - type: admin - name: Ciaran416 Lee - email: admin416@email.com - attachments: [] - redacted: false + - type: ticket_part + id: '711388' + part_type: ticket_state_updated_by_admin + ticket_state: submitted + previous_ticket_state: submitted + created_at: 1690369759 + updated_at: 1690369759 + author: + id: '991266710' + type: admin + name: Ciaran416 Lee + email: admin416@email.com + attachments: [] + redacted: false total_count: 1 open: true linked_objects: @@ -9757,7 +9757,7 @@ paths: category: Back-office is_shared: false schema: - '$ref': '#/components/schemas/ticket' + "$ref": "#/components/schemas/ticket" '401': description: Unauthorized content: @@ -9768,20 +9768,20 @@ paths: type: error.list request_id: 5c3e5211-d761-4f6f-b58e-252c48c86443 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: summary: Search tickets 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.\n\nTo search for tickets, you send a POST request to https://api.intercom.io/tickets/search. This will accept @@ -9829,105 +9829,105 @@ paths: total_pages: 1 total_count: 1 tickets: - - type: ticket - id: '715541' - friendly_id: '713379' - ticket_attributes: - title: attribute_value - description: - ticket_state: submitted - ticket_type: - type: ticket_type - id: '766875' - name: my-ticket-type-23 - description: my ticket type description is awesome. - icon: "\U0001F981" - workspace_id: this_is_an_id606_that_should_be_at_least_ - archived: false - created_at: 1690369761 - updated_at: 1690369761 - is_internal: false - ticket_type_attributes: - type: list - data: - - type: ticket_type_attribute - id: '164525' - workspace_id: this_is_an_id606_that_should_be_at_least_ - name: 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: 766875 - archived: false - created_at: 1690369761 - updated_at: 1690369761 - - type: ticket_type_attribute - id: '164526' - workspace_id: this_is_an_id606_that_should_be_at_least_ - name: 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: 766875 - archived: false - created_at: 1690369761 - updated_at: 1690369761 - category: Back-office - contacts: - type: contact.list - contacts: - - type: contact - id: 64c0fee135824d60a361f955 - external_id: 58069364-4e93-4f5b-af6a-452ebc969a3b - admin_assignee_id: '0' - team_assignee_id: '0' - created_at: 1690369762 + - type: ticket + id: '715541' + friendly_id: '713379' + ticket_attributes: + title: attribute_value + description: + ticket_state: submitted + ticket_type: + type: ticket_type + id: '766875' + name: my-ticket-type-23 + description: my ticket type description is awesome. + icon: "\U0001F981" + workspace_id: this_is_an_id606_that_should_be_at_least_ + archived: false + created_at: 1690369761 updated_at: 1690369761 - ticket_parts: - type: ticket_part.list - ticket_parts: - - type: ticket_part - id: '711389' - part_type: ticket_state_updated_by_admin - ticket_state: submitted - previous_ticket_state: submitted - created_at: 1690369762 - updated_at: 1690369762 - author: - id: '991266723' - type: admin - name: Ciaran428 Lee - email: admin428@email.com - attachments: [] - redacted: false - total_count: 1 - open: true - linked_objects: + is_internal: false + ticket_type_attributes: type: list - data: [] - total_count: 0 - has_more: false + data: + - type: ticket_type_attribute + id: '164525' + workspace_id: this_is_an_id606_that_should_be_at_least_ + name: 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: 766875 + archived: false + created_at: 1690369761 + updated_at: 1690369761 + - type: ticket_type_attribute + id: '164526' + workspace_id: this_is_an_id606_that_should_be_at_least_ + name: 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: 766875 + archived: false + created_at: 1690369761 + updated_at: 1690369761 category: Back-office - is_shared: false + contacts: + type: contact.list + contacts: + - type: contact + id: 64c0fee135824d60a361f955 + external_id: 58069364-4e93-4f5b-af6a-452ebc969a3b + admin_assignee_id: '0' + team_assignee_id: '0' + created_at: 1690369762 + updated_at: 1690369761 + ticket_parts: + type: ticket_part.list + ticket_parts: + - type: ticket_part + id: '711389' + part_type: ticket_state_updated_by_admin + ticket_state: submitted + previous_ticket_state: submitted + created_at: 1690369762 + updated_at: 1690369762 + author: + id: '991266723' + type: admin + name: Ciaran428 Lee + email: admin428@email.com + attachments: [] + redacted: false + total_count: 1 + open: true + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + category: Back-office + is_shared: false schema: - '$ref': '#/components/schemas/ticket_list' + "$ref": "#/components/schemas/ticket_list" requestBody: content: application/json: schema: - '$ref': '#/components/schemas/search_request' + "$ref": "#/components/schemas/search_request" examples: successful: summary: successful @@ -9935,27 +9935,27 @@ paths: query: operator: AND value: + - field: id + operator: "=" + value: '715541' + - operator: OR + value: - field: id - operator: '=' + operator: "=" value: '715541' - - operator: OR - value: - - field: id - operator: '=' - value: '715541' - - field: id - operator: '=' - value: '715541' - '/visitors': + - field: id + operator: "=" + value: '715541' + "/visitors": put: 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. @@ -10015,7 +10015,7 @@ paths: utm_term: do_not_track: schema: - '$ref': '#/components/schemas/visitor' + "$ref": "#/components/schemas/visitor" '404': description: visitor Not Found content: @@ -10026,10 +10026,10 @@ paths: type: error.list request_id: efb93aec-39ae-4788-b7bb-5e6970f72aa3 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: @@ -10040,15 +10040,15 @@ paths: type: error.list request_id: 24d6fc02-2209-47f7-9e3d-e8aeb26519f5 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 @@ -10063,18 +10063,18 @@ paths: get: summary: Retrieve a visitor with User ID parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: user_id - in: query - description: The user_id of the Visitor you want to retrieve. - required: true - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: user_id + in: query + description: The user_id of the Visitor you want to retrieve. + required: true + schema: + type: string tags: - - Visitors + - Visitors operationId: retrieveVisitorWithUserId description: You can fetch the details of a single visitor. responses: @@ -10129,7 +10129,7 @@ paths: utm_term: do_not_track: schema: - '$ref': '#/components/schemas/visitor' + "$ref": "#/components/schemas/visitor" '404': description: Visitor not found content: @@ -10140,10 +10140,10 @@ paths: type: error.list request_id: 850c8a27-c389-4050-a8b5-04a42ae95dc5 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: @@ -10154,27 +10154,27 @@ paths: type: error.list request_id: 157b56f1-010e-467c-a27d-208643ff7260 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' - '/visitors/{id}': + "$ref": "#/components/schemas/error" + "/visitors/{id}": get: summary: Retrieve a visitor with ID parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: Id provided by Intercom. - example: 5e1c4c1c-7b1e-4b5d-8c1c-5e1c4c1c7b1e - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: Id provided by Intercom. + example: 5e1c4c1c-7b1e-4b5d-8c1c-5e1c4c1c7b1e + schema: + type: string tags: - - Visitors + - Visitors operationId: retrieveVisitor description: You can fetch the details of a single visitor. responses: @@ -10229,7 +10229,7 @@ paths: utm_term: do_not_track: schema: - '$ref': '#/components/schemas/visitor' + "$ref": "#/components/schemas/visitor" '404': description: Visitor not found content: @@ -10240,10 +10240,10 @@ paths: type: error.list request_id: d21f7914-2615-4d67-a6d8-ddf3a8fb0428 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: @@ -10254,26 +10254,26 @@ paths: type: error.list request_id: ef0837ea-d1b1-4dea-8eba-07f9e23318ec errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' + "$ref": "#/components/schemas/error" delete: summary: Delete a visitor parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: Id provided by Intercom. - example: 5e1c4c1c-7b1e-4b5d-8c1c-5e1c4c1c7b1e - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: Id provided by Intercom. + example: 5e1c4c1c-7b1e-4b5d-8c1c-5e1c4c1c7b1e + schema: + type: string tags: - - Visitors + - Visitors operationId: deleteVisitor description: You can delete a single visitor. responses: @@ -10328,7 +10328,7 @@ paths: utm_term: do_not_track: schema: - '$ref': '#/components/schemas/visitor_deleted_object' + "$ref": "#/components/schemas/visitor_deleted_object" '404': description: Visitor Not Found content: @@ -10339,10 +10339,10 @@ paths: type: error.list request_id: 61ef6fb5-a29f-49b6-b7d6-964f054fcbf0 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: @@ -10353,20 +10353,20 @@ paths: type: error.list request_id: a2f85f6e-46bd-4846-94c9-885e155cfd0b 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: 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 @@ -10425,7 +10425,7 @@ paths: utm_term: do_not_track: schema: - '$ref': '#/components/schemas/contact' + "$ref": "#/components/schemas/contact" '401': description: Unauthorized content: @@ -10436,15 +10436,15 @@ paths: type: error.list request_id: 924631f8-ca45-4cf6-8a67-ee3659504627 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 @@ -10497,73 +10497,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 @@ -10580,12 +10580,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" addressable_list: title: Addressable List type: object @@ -10605,7 +10605,7 @@ 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 @@ -10652,7 +10652,7 @@ components: type: array description: This object represents the avatar associated with the admin. example: - - 814865 + - 814865 items: type: integer avatar: @@ -10662,7 +10662,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 @@ -10677,7 +10677,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 @@ -10689,7 +10689,7 @@ components: description: The primary admin ids for the team nullable: true example: - - 493881 + - 493881 items: type: integer secondary_admin_ids: @@ -10697,7 +10697,7 @@ components: description: The secondary admin ids for the team nullable: true example: - - 814865 + - 814865 items: type: integer admin_reply_conversation_request: @@ -10708,14 +10708,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 @@ -10745,8 +10745,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 @@ -10756,9 +10756,9 @@ components: format: uri maxItems: 5 required: - - message_type - - type - - admin_id + - message_type + - type + - admin_id admin_reply_ticket_request: title: Admin Reply on ticket type: object @@ -10767,14 +10767,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 @@ -10804,8 +10804,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 @@ -10815,9 +10815,9 @@ components: format: uri maxItems: 5 required: - - message_type - - type - - admin_id + - message_type + - type + - admin_id admin_with_app: title: Admin type: object @@ -10864,7 +10864,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: @@ -10889,7 +10889,7 @@ components: nullable: true example: true app: - '$ref': '#/components/schemas/app' + "$ref": "#/components/schemas/app" nullable: true description: App that the admin belongs to. app: @@ -10939,7 +10939,7 @@ components: type: string description: The type of object - `article`. enum: - - article + - article default: article example: article id: @@ -10978,8 +10978,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: @@ -11019,10 +11019,10 @@ components: example: en translated_content: nullable: true - '$ref': '#/components/schemas/article_translated_content' + "$ref": "#/components/schemas/article_translated_content" statistics: nullable: true - '$ref': '#/components/schemas/article_statistics' + "$ref": "#/components/schemas/article_statistics" article_content: title: Article Content type: object @@ -11033,8 +11033,8 @@ components: type: string description: The type of object - `article_content` . enum: - - - - article_content + - + - article_content example: article_content title: type: string @@ -11056,8 +11056,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 @@ -11082,10 +11082,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. @@ -11094,7 +11094,7 @@ components: type: array description: An array of Article objects items: - '$ref': '#/components/schemas/article' + "$ref": "#/components/schemas/article" article_statistics: title: Article Statistics type: object @@ -11105,7 +11105,7 @@ components: type: string description: The type of object - `article_statistics`. enum: - - article_statistics + - article_statistics default: article_statistics example: article_statistics views: @@ -11146,120 +11146,120 @@ components: type: string description: The type of object - article_translated_content. enum: - - - - article_translated_content + - + - article_translated_content example: article_translated_content 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 @@ -11268,13 +11268,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 @@ -11292,10 +11292,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 @@ -11308,38 +11308,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 @@ -11348,12 +11348,12 @@ components: message_type: type: string enum: - - close + - close example: close type: type: string enum: - - admin + - admin example: admin admin_id: type: string @@ -11363,11 +11363,11 @@ 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 @@ -11432,7 +11432,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 @@ -11448,10 +11448,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. @@ -11460,7 +11460,7 @@ components: type: array description: An array of collection objects items: - '$ref': '#/components/schemas/collection' + "$ref": "#/components/schemas/collection" company: title: Company type: object @@ -11473,7 +11473,7 @@ components: type: string description: Value is `company` enum: - - company + - company example: company id: type: string @@ -11564,12 +11564,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 @@ -11578,11 +11578,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 @@ -11592,19 +11592,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 @@ -11614,13 +11614,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: Companys type: object @@ -11630,10 +11630,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. @@ -11642,7 +11642,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 @@ -11655,14 +11655,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 @@ -11710,12 +11710,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 @@ -11742,52 +11742,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 @@ -11844,8 +11844,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 @@ -11876,7 +11876,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 @@ -11896,15 +11896,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 @@ -11914,7 +11914,7 @@ components: type: string description: always contact enum: - - contact + - contact example: contact id: type: string @@ -11939,19 +11939,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 @@ -11963,7 +11963,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 @@ -11983,7 +11983,7 @@ components: type: string description: always contact enum: - - contact + - contact example: contact id: type: string @@ -12008,19 +12008,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 @@ -12058,12 +12058,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 @@ -12083,7 +12083,7 @@ components: type: string description: always contact enum: - - contact + - contact example: contact id: type: string @@ -12097,202 +12097,202 @@ components: example: f3b87a2e09d514c6c2e79b9a contact_reply_conversation_request: title: Contact Reply - oneOf: - - title: Intercom User ID - type: object - description: Payload of the request to reply on behalf of a contact using - their `intercom_user_id` - properties: - message_type: - type: string - enum: - - comment - type: - type: string - enum: - - user - body: - type: string - description: The text body of the comment. - intercom_user_id: - type: string - description: The identifier for the contact as given by Intercom. - attachment_urls: - type: array - description: A list of image URLs that will be added as attachments. You - can include up to 5 URLs. - items: - type: string - format: uri - maxItems: 5 - required: - - message_type - - type - - body - - intercom_user_id - - title: User ID - type: object - description: Payload of the request to reply on behalf of a contact using - their `user_id` - properties: - message_type: - type: string - enum: - - comment - type: - type: string - enum: - - user - body: - type: string - description: The text body of the comment. - user_id: - type: string - description: The external_id you have defined for the contact. - attachment_urls: - type: array - description: A list of image URLs that will be added as attachments. You - can include up to 5 URLs. - items: - type: string - format: uri - maxItems: 5 - required: - - message_type - - type - - body - - user_id - - title: Email - type: object - description: Payload of the request to reply on behalf of a contact using - their `email` - properties: - message_type: - type: string - enum: - - comment - type: + oneOf: + - title: Intercom User ID + type: object + description: Payload of the request to reply on behalf of a contact using + their `intercom_user_id` + properties: + message_type: + type: string + enum: + - comment + type: + type: string + enum: + - user + body: + type: string + description: The text body of the comment. + intercom_user_id: + type: string + description: The identifier for the contact as given by Intercom. + attachment_urls: + type: array + description: A list of image URLs that will be added as attachments. You + can include up to 5 URLs. + items: type: string - enum: - - user - body: + format: uri + maxItems: 5 + required: + - message_type + - type + - body + - intercom_user_id + - title: User ID + type: object + description: Payload of the request to reply on behalf of a contact using + their `user_id` + properties: + message_type: + type: string + enum: + - comment + type: + type: string + enum: + - user + body: + type: string + description: The text body of the comment. + user_id: + type: string + description: The external_id you have defined for the contact. + attachment_urls: + type: array + description: A list of image URLs that will be added as attachments. You + can include up to 5 URLs. + items: type: string - description: The text body of the comment. - email: + format: uri + maxItems: 5 + required: + - message_type + - type + - body + - user_id + - title: Email + type: object + description: Payload of the request to reply on behalf of a contact using + their `email` + properties: + message_type: + type: string + enum: + - comment + type: + type: string + enum: + - user + body: + type: string + description: The text body of the comment. + email: + type: string + description: The email you have defined for the user. + attachment_urls: + type: array + description: A list of image URLs that will be added as attachments. You + can include up to 5 URLs. + items: type: string - description: The email you have defined for the user. - attachment_urls: - type: array - description: A list of image URLs that will be added as attachments. You - can include up to 5 URLs. - items: - type: string - format: uri - maxItems: 5 - required: - - message_type - - type - - body - - email + format: uri + maxItems: 5 + required: + - message_type + - type + - body + - email contact_reply_ticket_request: title: Contact Reply on ticket oneOf: - - title: Intercom User ID - type: object - description: Payload of the request to reply on behalf of a contact using - their `intercom_user_id` - properties: - message_type: - type: string - enum: - - comment - type: - type: string - enum: - - user - body: - type: string - description: The text body of the comment. - intercom_user_id: - type: string - description: The identifier for the contact as given by Intercom. - attachment_urls: - type: array - description: A list of image URLs that will be added as attachments. You - can include up to 5 URLs. - items: - type: string - format: uri - maxItems: 5 - required: - - message_type - - type - - body - - intercom_user_id - - title: User ID - type: object - description: Payload of the request to reply on behalf of a contact using - their `user_id` - properties: - message_type: - type: string - enum: - - comment - type: - type: string - enum: - - user - body: - type: string - description: The text body of the comment. - user_id: - type: string - description: The external_id you have defined for the contact. - attachment_urls: - type: array - description: A list of image URLs that will be added as attachments. You - can include up to 5 URLs. - items: - type: string - format: uri - maxItems: 5 - required: - - message_type - - type - - body - - user_id - - title: Email - type: object - description: Payload of the request to reply on behalf of a contact using - their `email` - properties: - message_type: - type: string - enum: - - comment - type: + - title: Intercom User ID + type: object + description: Payload of the request to reply on behalf of a contact using + their `intercom_user_id` + properties: + message_type: + type: string + enum: + - comment + type: + type: string + enum: + - user + body: + type: string + description: The text body of the comment. + intercom_user_id: + type: string + description: The identifier for the contact as given by Intercom. + attachment_urls: + type: array + description: A list of image URLs that will be added as attachments. You + can include up to 5 URLs. + items: type: string - enum: - - user - body: + format: uri + maxItems: 5 + required: + - message_type + - type + - body + - intercom_user_id + - title: User ID + type: object + description: Payload of the request to reply on behalf of a contact using + their `user_id` + properties: + message_type: + type: string + enum: + - comment + type: + type: string + enum: + - user + body: + type: string + description: The text body of the comment. + user_id: + type: string + description: The external_id you have defined for the contact. + attachment_urls: + type: array + description: A list of image URLs that will be added as attachments. You + can include up to 5 URLs. + items: type: string - description: The text body of the comment. - email: + format: uri + maxItems: 5 + required: + - message_type + - type + - body + - user_id + - title: Email + type: object + description: Payload of the request to reply on behalf of a contact using + their `email` + properties: + message_type: + type: string + enum: + - comment + type: + type: string + enum: + - user + body: + type: string + description: The text body of the comment. + email: + type: string + description: The email you have defined for the user. + attachment_urls: + type: array + description: A list of image URLs that will be added as attachments. You + can include up to 5 URLs. + items: type: string - description: The email you have defined for the user. - attachment_urls: - type: array - description: A list of image URLs that will be added as attachments. You - can include up to 5 URLs. - items: - type: string - format: uri - maxItems: 5 - required: - - message_type - - type - - body - - email + format: uri + maxItems: 5 + required: + - message_type + - type + - body + - email contact_segments: title: Segments type: object @@ -12302,13 +12302,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 @@ -12319,7 +12319,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 @@ -12331,12 +12331,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 @@ -12358,12 +12358,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 @@ -12383,7 +12383,7 @@ components: type: string description: always contact enum: - - contact + - contact example: contact id: type: string @@ -12453,9 +12453,9 @@ components: state: type: string enum: - - open - - closed - - snoozed + - open + - closed + - snoozed description: Can be set to "open", "closed" or "snoozed". example: open read: @@ -12465,8 +12465,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: @@ -12482,27 +12482,27 @@ 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" conversation_contacts: title: Contacts type: object @@ -12514,7 +12514,7 @@ components: type: string description: '' enum: - - contact.list + - contact.list example: contact.list contacts: type: array @@ -12522,7 +12522,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_first_contact_reply: title: First contact reply type: object @@ -12555,19 +12555,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 @@ -12590,7 +12590,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 @@ -12607,18 +12607,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 @@ -12663,7 +12663,7 @@ components: type: string description: '' enum: - - conversation_part.list + - conversation_part.list example: conversation_part.list conversation_parts: title: Conversation Parts @@ -12672,7 +12672,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: '' @@ -12700,9 +12700,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_source: title: Conversation source type: object @@ -12734,14 +12734,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 @@ -12867,7 +12867,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 @@ -12879,9 +12879,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 @@ -12911,10 +12911,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. @@ -12933,16 +12933,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 @@ -12963,7 +12963,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, @@ -12976,8 +12976,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 @@ -12989,10 +12989,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 @@ -13010,7 +13010,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 @@ -13018,7 +13018,7 @@ components: created as the first level collection. example: '6871118' required: - - name + - name create_contact_request: description: Payload to create a contact type: object @@ -13038,7 +13038,7 @@ components: type: string nullable: true description: The contacts phone - example: '+353871234567' + example: "+353871234567" name: type: string nullable: true @@ -13078,15 +13078,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_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 @@ -13100,9 +13100,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: @@ -13113,15 +13113,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 @@ -13135,20 +13135,20 @@ components: type: string description: The model that the data attribute belongs to. enum: - - contact - - company - - conversation + - contact + - company + - conversation 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 @@ -13161,12 +13161,12 @@ components: items: type: string example: - - option1 - - option2 + - option1 + - option2 required: - - name - - model - - data_type + - name + - model + - data_type create_data_event_request: description: '' type: object @@ -13205,21 +13205,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 @@ -13275,8 +13275,8 @@ components: as a unix timestamp. example: 1527811200 required: - - created_at_after - - created_at_before + - created_at_after + - created_at_before create_message_request: description: You can create a message type: object @@ -13287,8 +13287,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 @@ -13312,15 +13312,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 @@ -13330,16 +13330,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 create_conversation_without_contact_reply: type: boolean description: Whether a conversation should be opened in the inbox for the @@ -13347,20 +13347,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 @@ -13429,7 +13429,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 @@ -13440,11 +13440,11 @@ 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_section_request: description: You can create a Section type: object @@ -13461,16 +13461,16 @@ components: example: 18 translated_content: nullable: true - '$ref': '#/components/schemas/group_translated_content' + "$ref": "#/components/schemas/group_translated_content" required: - - name - - parent_id + - name + - parent_id create_ticket_reply_request: title: Create Ticket Reply Request Payload description: You can create a reply on a ticket. 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 @@ -13487,37 +13487,37 @@ 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' 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 @@ -13536,13 +13536,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 @@ -13584,9 +13584,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. @@ -13607,9 +13607,9 @@ components: type: string description: Category of the Ticket Type. enum: - - Customer - - Back-office - - Tracker + - Customer + - Back-office + - Tracker example: Customer icon: type: string @@ -13624,8 +13624,8 @@ components: example: false default: false required: - - name - - category + - name + - category cursor_pages: title: Cursor based pages type: object @@ -13639,13 +13639,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 @@ -13662,8 +13662,8 @@ 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 @@ -13692,32 +13692,32 @@ 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 @@ -13731,7 +13731,7 @@ components: type: string description: Value is `data_attribute`. enum: - - data_attribute + - data_attribute example: data_attribute id: type: integer @@ -13743,9 +13743,9 @@ components: description: Value is `contact` for user/lead attributes, `company` for company attributes and `conversation` for conversation attributes.. enum: - - contact - - company - - conversation + - contact + - company + - conversation example: contact name: type: string @@ -13769,11 +13769,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 @@ -13781,8 +13781,8 @@ components: items: type: string example: - - 'true' - - 'false' + - 'true' + - 'false' api_writable: type: boolean description: Can this attribute be updated through API @@ -13823,13 +13823,13 @@ 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 @@ -13840,7 +13840,7 @@ components: type: string description: The type of the object enum: - - event + - event example: event event_name: type: string @@ -13879,8 +13879,8 @@ components: example: invite_code: ADDAFRIEND required: - - event_name - - created_at + - event_name + - created_at data_event_list: title: Data Event List type: object @@ -13890,13 +13890,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 @@ -13916,7 +13916,7 @@ components: type: string description: The type of the object enum: - - event.summary + - event.summary example: event.summary email: type: string @@ -13934,7 +13934,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 @@ -13975,12 +13975,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: @@ -14101,7 +14101,7 @@ components: type: string description: The type of object which was deleted. - article enum: - - article + - article example: article deleted: type: boolean @@ -14121,7 +14121,7 @@ components: type: string description: The type of object which was deleted. - `collection` enum: - - collection + - collection example: collection deleted: type: boolean @@ -14140,7 +14140,7 @@ components: type: string description: The type of object which was deleted. - `company` enum: - - company + - company example: company deleted: type: boolean @@ -14160,7 +14160,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 @@ -14180,7 +14180,7 @@ components: type: string description: The type of object which was deleted. - `section` enum: - - section + - section example: section deleted: type: boolean @@ -14193,7 +14193,7 @@ components: description: The `id` of the admin who is performing the action. example: '5017690' required: - - admin_id + - admin_id error: type: object title: Error @@ -14232,10 +14232,10 @@ components: parameter that was in error. example: email required: - - code + - code required: - - type - - errors + - type + - errors file_attribute: title: File type: object @@ -14279,8 +14279,8 @@ components: type: string description: The type of object - `group_content` . enum: - - - - group_content + - + - group_content example: group_content name: type: string @@ -14289,7 +14289,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 @@ -14302,120 +14302,120 @@ 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" intercom_version: description: Intercom API version.
By default, it's equal to the version set in the app package. @@ -14423,22 +14423,22 @@ components: example: Unstable default: '2.9' 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' - - 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' + - Unstable linked_object: title: Linked Object type: object @@ -14448,8 +14448,8 @@ components: type: string description: ticket or conversation enum: - - ticket - - conversation + - ticket + - conversation example: ticket id: type: string @@ -14459,10 +14459,10 @@ components: type: string description: Category of the Linked Ticket Object. enum: - - Customer - - Back-office - - Tracker - - + - Customer + - Back-office + - Tracker + - example: Customer linked_object_list: title: Linked Objects @@ -14474,7 +14474,7 @@ components: type: string description: Always list. enum: - - list + - list example: list total_count: type: integer @@ -14488,7 +14488,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 @@ -14536,10 +14536,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 @@ -14548,33 +14548,33 @@ 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: type: object properties: 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 @@ -14586,7 +14586,7 @@ components: type: string description: The type of object. enum: - - news-item + - news-item example: news-item id: type: string @@ -14616,14 +14616,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. @@ -14675,7 +14675,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 @@ -14686,8 +14686,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 @@ -14700,9 +14700,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, @@ -14711,16 +14711,16 @@ 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 @@ -14738,7 +14738,7 @@ components: type: string description: The type of object. enum: - - newsfeed + - newsfeed example: newsfeed name: type: string @@ -14809,12 +14809,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 @@ -14829,13 +14829,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 @@ -14844,15 +14844,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 @@ -14865,7 +14865,7 @@ components: type: string example: pages enum: - - pages + - pages page: type: integer example: 1 @@ -14890,11 +14890,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. @@ -14904,8 +14904,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 @@ -14949,60 +14949,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 @@ -15019,8 +15019,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 @@ -15028,14 +15028,14 @@ 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 section: title: Section type: object @@ -15047,7 +15047,7 @@ components: type: string description: The type of object - `section`. enum: - - section + - section default: section example: section id: @@ -15095,10 +15095,10 @@ components: example: '1' parent_id: oneOf: - - type: integer - title: Integer - - type: string - title: String + - type: integer + title: Integer + - type: string + title: String description: The id of the parent section. example: 6871119 default_locale: @@ -15108,7 +15108,7 @@ components: example: en translated_content: nullable: true - '$ref': '#/components/schemas/group_translated_content' + "$ref": "#/components/schemas/group_translated_content" section_list: title: Sections type: object @@ -15118,10 +15118,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 sections. @@ -15130,7 +15130,7 @@ components: type: array description: An array of section objects items: - '$ref': '#/components/schemas/section' + "$ref": "#/components/schemas/section" segment: title: Segment type: object @@ -15142,7 +15142,7 @@ components: type: string description: The type of object. enum: - - segment + - segment example: segment id: type: string @@ -15164,8 +15164,8 @@ components: type: string description: 'Type of the contact: contact (lead) or user.' enum: - - contact - - user + - contact + - user example: contact count: type: integer @@ -15183,13 +15183,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 @@ -15204,18 +15204,18 @@ components: operator: type: string enum: - - '=' - - '!=' - - IN - - NIN - - '<' - - '>' - - '~' - - '!~' - - '^' - - '$' + - "=" + - "!=" + - IN + - NIN + - "<" + - ">" + - "~" + - "!~" + - "^" + - "$" description: The Intercom defined id representing the company. - example: '=' + example: "=" value: type: string description: The Intercom defined id representing the company. @@ -15239,10 +15239,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. @@ -15257,7 +15257,7 @@ components: message_type: type: string enum: - - snoozed + - snoozed example: snoozed admin_id: type: string @@ -15269,9 +15269,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 @@ -15321,25 +15321,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 @@ -15348,8 +15348,8 @@ components: items: type: string enum: - - email - - sms_message + - email + - sms_message example: email subscription_type_list: title: Subscription Types @@ -15360,14 +15360,14 @@ 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 @@ -15393,7 +15393,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 @@ -15418,8 +15418,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 @@ -15429,13 +15429,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 @@ -15454,8 +15454,8 @@ components: description: The Intercom defined id representing the user. example: 5f7f0d217289f8d2f4262080 required: - - name - - users + - name + - users tags: title: Tags type: object @@ -15465,13 +15465,13 @@ 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 @@ -15494,11 +15494,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 @@ -15508,13 +15508,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 @@ -15526,7 +15526,7 @@ components: description: The primary team ids for the team nullable: true example: - - 814865 + - 814865 items: type: integer secondary_team_ids: @@ -15534,7 +15534,7 @@ components: description: The secondary team ids for the team nullable: true example: - - 493881 + - 493881 items: type: integer ticket: @@ -15548,7 +15548,7 @@ components: type: string description: Always ticket enum: - - ticket + - ticket default: ticket example: ticket id: @@ -15563,25 +15563,25 @@ 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: type: string description: The state the ticket is currenly in enum: - - submitted - - in_progress - - waiting_on_customer - - resolved + - submitted + - in_progress + - waiting_on_customer + - resolved example: submitted 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. @@ -15612,9 +15612,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. @@ -15629,13 +15629,13 @@ components: 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 @@ -15644,12 +15644,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: name: example question: Can I have some help? @@ -15662,19 +15662,19 @@ 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 @@ -15697,23 +15697,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: @@ -15727,18 +15727,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 @@ -15759,10 +15759,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 @@ -15787,7 +15787,7 @@ components: type: string description: '' enum: - - ticket_part.list + - ticket_part.list example: ticket_part.list ticket_parts: title: Tickt Parts @@ -15795,7 +15795,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: '' @@ -15811,7 +15811,7 @@ components: description: Always ticket_part example: ticket_part enum: - - ticket_part + - ticket_part id: type: string description: The id representing the part. @@ -15821,14 +15821,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 @@ -15840,13 +15840,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. @@ -15864,11 +15864,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: name: example question: Can I have some help? @@ -15893,9 +15893,9 @@ components: type: string description: Category of the Ticket Type. enum: - - Customer - - Back-office - - Tracker + - Customer + - Back-office + - Tracker example: Customer name: type: string @@ -15914,7 +15914,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" archived: type: boolean description: Whether the ticket type is archived or not. @@ -16023,7 +16023,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 @@ -16037,7 +16037,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 @@ -16085,8 +16085,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 @@ -16107,7 +16107,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, @@ -16120,8 +16120,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 @@ -16133,7 +16133,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 @@ -16151,7 +16151,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 @@ -16177,7 +16177,7 @@ components: type: string nullable: true description: The contacts phone - example: '+353871234567' + example: "+353871234567" name: type: string nullable: true @@ -16226,7 +16226,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 @@ -16247,8 +16247,8 @@ components: items: type: string example: - - option1 - - option2 + - option1 + - option2 update_section_request: description: You can update a Section type: object @@ -16265,7 +16265,7 @@ components: example: 18 translated_content: nullable: true - '$ref': '#/components/schemas/group_translated_content' + "$ref": "#/components/schemas/group_translated_content" update_ticket_request: description: You can update a Ticket type: object @@ -16280,9 +16280,9 @@ components: state: type: string enum: - - in_progress - - waiting_on_customer - - resolved + - in_progress + - waiting_on_customer + - resolved description: The state of the ticket. example: submitted open: @@ -16390,9 +16390,9 @@ components: type: string description: Category of the Ticket Type. enum: - - Customer - - Back-office - - Tracker + - Customer + - Back-office + - Tracker example: Customer icon: type: string @@ -16437,10 +16437,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 @@ -16512,12 +16512,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: @@ -16585,7 +16585,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 @@ -16615,7 +16615,7 @@ components: type: string description: The type of the object enum: - - tag.list + - tag.list example: tag.list tags: type: array @@ -16625,7 +16625,7 @@ components: type: string description: The type of the object enum: - - tag + - tag example: tag id: type: string @@ -16642,7 +16642,7 @@ components: type: string description: The type of the object enum: - - segment.list + - segment.list example: segment.list segments: type: array @@ -16701,7 +16701,7 @@ components: type: string description: The type of object which was deleted enum: - - visitor + - visitor example: visitor user_id: type: string @@ -16712,63 +16712,63 @@ 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: Articles - description: Everything about your Articles - - name: Companies - description: Everything about your Companies - - name: Contacts - description: Everything about your contacts - - name: Conversations - description: Everything about your Conversations - externalDocs: - description: What is a conversation? - url: https://www.intercom.com/help/en/articles/4323904-what-is-a-conversation - - name: Data Attributes - description: Everything about your Data Attributes - - name: Data Events - description: Everything about your Data Events - - name: Data Export - description: Everything about your Data Exports - - name: Help Center - description: Everything about your Help Center - - name: Messages - description: Everything about your messages - - name: News - description: Everything about your News - externalDocs: - description: News explained - url: https://www.intercom.com/help/en/articles/6362251-news-explained - - name: Notes - description: Everything about your Notes - - name: Segments - description: Everything about your Segments - - name: Subscription Types - description: Everything about subscription types - - name: Switch - description: Everything about Switch - externalDocs: - description: 'Meet Switch: from on hold to messaging in just a few taps' - url: https://www.intercom.com/switch - - name: Tags - description: Everything about tags - - name: Teams - description: Everything about your Teams - - name: 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 +- name: Admins + description: Everything about your Admins +- name: Articles + description: Everything about your Articles +- name: Companies + description: Everything about your Companies +- name: Contacts + description: Everything about your contacts +- name: Conversations + description: Everything about your Conversations + externalDocs: + description: What is a conversation? + url: https://www.intercom.com/help/en/articles/4323904-what-is-a-conversation +- name: Data Attributes + description: Everything about your Data Attributes +- name: Data Events + description: Everything about your Data Events +- name: Data Export + description: Everything about your Data Exports +- name: Help Center + description: Everything about your Help Center +- name: Messages + description: Everything about your messages +- name: News + description: Everything about your News + externalDocs: + description: News explained + url: https://www.intercom.com/help/en/articles/6362251-news-explained +- name: Notes + description: Everything about your Notes +- name: Segments + description: Everything about your Segments +- name: Subscription Types + description: Everything about subscription types +- name: Switch + description: Everything about Switch + externalDocs: + description: 'Meet Switch: from on hold to messaging in just a few taps' + url: https://www.intercom.com/switch +- name: Tags + description: Everything about tags +- name: Teams + description: Everything about your Teams +- name: 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 diff --git a/descriptions/2.7/api.intercom.io.yaml b/descriptions/2.7/api.intercom.io.yaml index 430962a..2a1e2ef 100644 --- a/descriptions/2.7/api.intercom.io.yaml +++ b/descriptions/2.7/api.intercom.io.yaml @@ -11,16 +11,16 @@ info: name: MIT url: https://spdx.org/licenses/MIT paths: - '/me': + "/me": get: 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 @@ -55,23 +55,23 @@ 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": 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. responses: @@ -91,7 +91,7 @@ paths: has_inbox_seat: true team_ids: [] schema: - '$ref': '#/components/schemas/admin' + "$ref": "#/components/schemas/admin" '404': description: Admin not found content: @@ -102,10 +102,10 @@ paths: type: error.list request_id: 5dadca51-b5a7-4f75-9c5f-b3b4fc6bf23f 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 +116,18 @@ paths: type: error.list request_id: 9935d9fb-a95e-4d26-9b1b-13f6ae2d93c2 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 +157,32 @@ paths: value: away_mode_enabled: true away_mode_reassign: true - '/admins/activity_logs': + "/admins/activity_logs": 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 +201,38 @@ paths: per_page: 20 total_pages: 1 activity_logs: - - id: 68e14253-f484-4bf7-9e49-9372afc8ee25 - performed_by: - type: admin - id: '991266219' - email: admin5@email.com - ip: 127.0.0.1 - metadata: - before: before - after: after - created_at: 1690373912 - activity_type: app_name_change - activity_description: Ciaran5 Lee changed your app name from - before to after. - - id: 230711d9-b31e-4c6e-be64-e807975adcf3 - performed_by: - type: admin - id: '991266219' - 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: 1690373912 - 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: 68e14253-f484-4bf7-9e49-9372afc8ee25 + performed_by: + type: admin + id: '991266219' + email: admin5@email.com + ip: 127.0.0.1 + metadata: + before: before + after: after + created_at: 1690373912 + activity_type: app_name_change + activity_description: Ciaran5 Lee changed your app name from + before to after. + - id: 230711d9-b31e-4c6e-be64-e807975adcf3 + performed_by: + type: admin + id: '991266219' + 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: 1690373912 + 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" '401': description: Unauthorized content: @@ -243,20 +243,20 @@ paths: type: error.list request_id: beafa595-04cf-460e-a5e1-cd6549b691cd errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' - '/admins': + "$ref": "#/components/schemas/error" + "/admins": 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 +269,16 @@ paths: value: type: admin.list admins: - - type: admin - email: admin7@email.com - id: '991266222' - name: Ciaran7 Lee - away_mode_enabled: false - away_mode_reassign: false - has_inbox_seat: true - team_ids: [] + - type: admin + email: admin7@email.com + id: '991266222' + name: Ciaran7 Lee + away_mode_enabled: false + away_mode_reassign: false + has_inbox_seat: true + team_ids: [] schema: - '$ref': '#/components/schemas/admin_list' + "$ref": "#/components/schemas/admin_list" '401': description: Unauthorized content: @@ -289,27 +289,27 @@ paths: type: error.list request_id: 73654aaa-0c52-491e-9838-13734d2035a0 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' - '/admins/{id}': + "$ref": "#/components/schemas/error" + "/admins/{id}": get: summary: Retrieve 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: 123 + schema: + type: integer tags: - - Admins + - Admins operationId: retrieveAdmin description: You can retrieve the details of a single admin. responses: @@ -329,7 +329,7 @@ paths: has_inbox_seat: true team_ids: [] schema: - '$ref': '#/components/schemas/admin' + "$ref": "#/components/schemas/admin" '404': description: Admin not found content: @@ -340,10 +340,10 @@ paths: type: error.list request_id: 534c83e8-9eb0-43d1-a453-4e1772896831 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 +354,20 @@ paths: type: error.list request_id: ee97b65f-fe89-44c0-922d-2e0ce0fe39d9 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' - '/articles': + "$ref": "#/components/schemas/error" + "/articles": get: summary: List all articles parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Articles + - Articles operationId: listArticles description: "You can fetch a list of all articles by making a GET request to `https://api.intercom.io/articles`.\n\n> \U0001F4D8 How are the articles sorted @@ -390,21 +390,21 @@ paths: total_pages: 1 total_count: 1 data: - - id: '92828' - type: article - workspace_id: this_is_an_id22_that_should_be_at_least_4 - parent_id: 87783 - parent_type: collection - title: This is the article title - description: '' - body: '' - author_id: 991266227 - state: published - created_at: 1690373918 - updated_at: 1690373918 - url: http://help-center.test/myapp-22/en/articles/92828-this-is-the-article-title - schema: - '$ref': '#/components/schemas/article_list' + - id: '92828' + type: article + workspace_id: this_is_an_id22_that_should_be_at_least_4 + parent_id: 87783 + parent_type: collection + title: This is the article title + description: '' + body: '' + author_id: 991266227 + state: published + created_at: 1690373918 + updated_at: 1690373918 + url: http://help-center.test/myapp-22/en/articles/92828-this-is-the-article-title + schema: + "$ref": "#/components/schemas/article_list" '401': description: Unauthorized content: @@ -415,19 +415,19 @@ paths: type: error.list request_id: 46c1867a-6e39-428b-9408-38ebb6ec6a67 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 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: @@ -460,7 +460,7 @@ paths: updated_at: 1690373920 url: http://help-center.test/myapp-26/en/articles/92831-thanks-for-everything schema: - '$ref': '#/components/schemas/article' + "$ref": "#/components/schemas/article" '400': description: Bad Request content: @@ -471,11 +471,11 @@ paths: type: error.list request_id: '01687c8a-f96f-42ea-9066-d5f53b35af58' 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: @@ -486,15 +486,15 @@ paths: type: error.list request_id: a101e69e-8ca5-4cf1-9f76-aa3b6640c0aa 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 @@ -520,23 +520,23 @@ paths: description: Description of the Article body: Body of the Article state: published - '/articles/{id}': + "/articles/{id}": get: summary: Retrieve an article parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The unique identifier for the article which is given by Intercom. - example: 123 - schema: - type: integer + - 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/`. @@ -570,7 +570,7 @@ paths: updated_at: 1690373922 url: http://help-center.test/myapp-32/en/articles/92834-this-is-the-article-title schema: - '$ref': '#/components/schemas/article' + "$ref": "#/components/schemas/article" '404': description: Article not found content: @@ -581,10 +581,10 @@ paths: type: error.list request_id: 5dbe01da-4cff-42f9-8dd6-2ea21ee46031 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: @@ -595,26 +595,26 @@ paths: type: error.list request_id: 71ea6a61-0f41-46a3-9bac-f7e7d06df374 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' + "$ref": "#/components/schemas/error" put: 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/`. @@ -648,7 +648,7 @@ paths: updated_at: 1690373925 url: http://help-center.test/myapp-38/en/articles/92837-christmas-is-here schema: - '$ref': '#/components/schemas/article' + "$ref": "#/components/schemas/article" '404': description: Article Not Found content: @@ -659,10 +659,10 @@ paths: type: error.list request_id: 78ec57b7-5fca-4dad-bd9d-0bfd25a45c03 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: @@ -673,42 +673,42 @@ paths: type: error.list request_id: b9cda086-29ab-4012-aeba-0edf7aca6cf0 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: 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: @@ -723,7 +723,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: @@ -734,10 +734,10 @@ paths: type: error.list request_id: 1b49aaac-86a9-4175-ad76-c15d0fca491f 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: @@ -748,20 +748,20 @@ paths: type: error.list request_id: 80ac4bc1-9a83-4d1b-89d8-3357fc43cbe8 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: 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`.\n\n> \U0001F4D8 How @@ -786,7 +786,7 @@ paths: per_page: 20 total_pages: 0 schema: - '$ref': '#/components/schemas/collection_list' + "$ref": "#/components/schemas/collection_list" '401': description: Unauthorized content: @@ -797,19 +797,19 @@ paths: type: error.list request_id: ad43aec7-66b9-4fe4-a7ec-01119cdfe867 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: @@ -831,7 +831,7 @@ paths: icon: book-bookmark type: collection schema: - '$ref': '#/components/schemas/collection' + "$ref": "#/components/schemas/collection" '400': description: Bad Request content: @@ -842,10 +842,10 @@ paths: type: error.list request_id: 7301744c-48f3-4b90-b19a-e21fef17a238 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: @@ -856,15 +856,15 @@ paths: type: error.list request_id: fdd4be4e-b8cf-4a20-b2f5-9624abdaef00 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 @@ -874,23 +874,23 @@ paths: summary: Bad Request value: description: Missing required parameter - '/help_center/collections/{id}': + "/help_center/collections/{id}": get: summary: Retrieve 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/`. @@ -913,7 +913,7 @@ paths: icon: bookmark type: collection schema: - '$ref': '#/components/schemas/collection' + "$ref": "#/components/schemas/collection" '404': description: Collection not found content: @@ -924,10 +924,10 @@ paths: type: error.list request_id: 38e5f734-66f7-4f23-ab39-e24dcb8a8206 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: @@ -938,26 +938,26 @@ paths: type: error.list request_id: 4eb265d7-44c3-40db-b8fd-9b0e5d895c84 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' + "$ref": "#/components/schemas/error" put: 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/`. @@ -980,7 +980,7 @@ paths: icon: folder type: collection schema: - '$ref': '#/components/schemas/collection' + "$ref": "#/components/schemas/collection" '404': description: Collection Not Found content: @@ -991,10 +991,10 @@ paths: type: error.list request_id: 7614b828-aabf-4482-90a4-080406b9945c 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: @@ -1005,15 +1005,15 @@ paths: type: error.list request_id: 1694fc0e-7145-4072-a6f9-455b946312dc 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 @@ -1026,19 +1026,19 @@ paths: 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/`. @@ -1054,7 +1054,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: @@ -1065,10 +1065,10 @@ paths: type: error.list request_id: 68a21a71-5ffd-42fd-a1b9-6dc9b4bf3723 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: @@ -1079,20 +1079,20 @@ paths: type: error.list request_id: 282742aa-51d1-4072-ab3e-28b6f5d439b3 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' - '/help_center/sections': + "$ref": "#/components/schemas/error" + "/help_center/sections": get: summary: List all sections 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: listAllSections description: "You can fetch a list of all sections by making a GET request to `https://api.intercom.io/help_center/sections`.\n> \U0001F4D8 How are the @@ -1109,15 +1109,15 @@ paths: value: type: list data: - - id: '87827' - workspace_id: this_is_an_id78_that_should_be_at_least_4 - name: English section title - url: http://help-center.test/myapp-78/section-15 - order: 15 - created_at: 1690373937 - updated_at: 1690373937 - type: section - parent_id: 87826 + - id: '87827' + workspace_id: this_is_an_id78_that_should_be_at_least_4 + name: English section title + url: http://help-center.test/myapp-78/section-15 + order: 15 + created_at: 1690373937 + updated_at: 1690373937 + type: section + parent_id: 87826 total_count: 1 pages: type: pages @@ -1125,7 +1125,7 @@ paths: per_page: 20 total_pages: 1 schema: - '$ref': '#/components/schemas/section_list' + "$ref": "#/components/schemas/section_list" '401': description: Unauthorized content: @@ -1136,19 +1136,19 @@ paths: type: error.list request_id: 3ae4e37b-dcde-4b8b-9820-2f9271f2ac16 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 section 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: createSection description: You can create a new section by making a POST request to `https://api.intercom.io/help_center/sections.` responses: @@ -1169,7 +1169,7 @@ paths: type: section parent_id: '87830' schema: - '$ref': '#/components/schemas/section' + "$ref": "#/components/schemas/section" '401': description: Unauthorized content: @@ -1180,38 +1180,38 @@ paths: type: error.list request_id: e1723f6a-9409-4439-8dbd-2fe3f15cdae1 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_section_request' + "$ref": "#/components/schemas/create_section_request" examples: section_created: summary: section created value: name: Thanks for everything parent_id: 87830 - '/help_center/sections/{id}': + "/help_center/sections/{id}": get: summary: Retrieve a section parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The unique identifier for the section 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 section which is given by Intercom. + example: 123 + schema: + type: integer tags: - - Help Center + - Help Center operationId: retrieveSection description: You can fetch the details of a single section by making a GET request to `https://api.intercom.io/help_center/sections/`. @@ -1233,7 +1233,7 @@ paths: type: section parent_id: 87835 schema: - '$ref': '#/components/schemas/section' + "$ref": "#/components/schemas/section" '404': description: Section not found content: @@ -1244,10 +1244,10 @@ paths: type: error.list request_id: 9729fb14-3e40-45e3-8026-59a32834f2cb 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: @@ -1258,26 +1258,26 @@ paths: type: error.list request_id: c5b04140-8b2c-452b-b9fd-40dfa09c91e9 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' + "$ref": "#/components/schemas/error" put: summary: Update a section parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The unique identifier for the section 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 section which is given by Intercom. + example: 123 + schema: + type: integer tags: - - Help Center + - Help Center operationId: updateSection description: You can update the details of a single section by making a PUT request to `https://api.intercom.io/sections/`. @@ -1299,7 +1299,7 @@ paths: type: section parent_id: '87841' schema: - '$ref': '#/components/schemas/section' + "$ref": "#/components/schemas/section" '404': description: Section Not Found content: @@ -1310,10 +1310,10 @@ paths: type: error.list request_id: 5e8a1ac5-88f1-4f31-b230-1f8926751fe5 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: @@ -1324,15 +1324,15 @@ paths: type: error.list request_id: 61e69702-b3d0-48e4-ad26-2a97a75d6f23 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_section_request' + "$ref": "#/components/schemas/update_section_request" examples: successful: summary: successful @@ -1347,19 +1347,19 @@ paths: delete: summary: Delete a section parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The unique identifier for the section 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 section which is given by Intercom. + example: 123 + schema: + type: integer tags: - - Help Center + - Help Center operationId: deleteSection description: You can delete a single section by making a DELETE request to `https://api.intercom.io/sections/`. responses: @@ -1374,7 +1374,7 @@ paths: object: section deleted: true schema: - '$ref': '#/components/schemas/deleted_section_object' + "$ref": "#/components/schemas/deleted_section_object" '404': description: section Not Found content: @@ -1385,10 +1385,10 @@ paths: type: error.list request_id: 2571be13-24f1-4cda-adcb-b5cfb32623d1 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: @@ -1399,20 +1399,20 @@ paths: type: error.list request_id: 346c7bfb-69e5-4737-8854-2f01e0459c11 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 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.\n\n> \U0001F4D8 Companies with no users\n>\n> Companies will be only visible in Intercom when there @@ -1448,7 +1448,7 @@ paths: custom_attributes: creation_source: api schema: - '$ref': '#/components/schemas/company' + "$ref": "#/components/schemas/company" '400': description: Bad Request content: @@ -1459,10 +1459,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: @@ -1473,15 +1473,15 @@ paths: type: error.list request_id: 0efb1c40-0520-47ab-996e-b3b20903c10f 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 @@ -1496,35 +1496,35 @@ paths: get: summary: Retrieve a company parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: filter - in: query - style: form - required: true - schema: - type: object - oneOf: - - description: The `company_id` of the company to filter by. - title: Filter by company_id - properties: - company_id: - type: string - required: - - company_id - additionalProperties: false - - description: The `name` of the company to filter by. - title: Filter by name - properties: - name: - type: string - required: - - name - additionalProperties: false + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: filter + in: query + style: form + required: true + schema: + type: object + oneOf: + - description: The `company_id` of the company to filter by. + title: Filter by company_id + properties: + company_id: + type: string + required: + - company_id + additionalProperties: false + - description: The `name` of the company to filter by. + title: Filter by name + properties: + name: + type: string + required: + - name + additionalProperties: false tags: - - Companies + - Companies operationId: retrieveCompany description: | You can fetch a company by either passing in `company_id` or `name` as a query parameter. @@ -1560,7 +1560,7 @@ paths: plan: {} custom_attributes: {} schema: - '$ref': '#/components/schemas/company' + "$ref": "#/components/schemas/company" '404': description: Company Not Found content: @@ -1571,10 +1571,10 @@ paths: type: error.list request_id: d7a1d119-ed0b-4b83-bab5-0b4a3d3b1de4 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: @@ -1585,27 +1585,27 @@ paths: type: error.list request_id: 9ece0e49-1453-475d-a0b8-f3c20d53e721 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 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: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + schema: + type: string tags: - - Companies + - Companies operationId: RetrieveACompanyById description: You can fetch a single company. responses: @@ -1636,7 +1636,7 @@ paths: plan: {} custom_attributes: {} schema: - '$ref': '#/components/schemas/company' + "$ref": "#/components/schemas/company" '404': description: Company Not Found content: @@ -1647,10 +1647,10 @@ paths: type: error.list request_id: b40e15cb-8457-4482-8694-f9dc49f5dd33 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: @@ -1661,26 +1661,26 @@ paths: type: error.list request_id: 9c4ecbc9-8ece-45c8-bd50-b5afb36ef0be errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' + "$ref": "#/components/schemas/error" put: 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: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + schema: + type: string tags: - - Companies + - Companies operationId: UpdateCompany description: You can update a single company responses: @@ -1711,7 +1711,7 @@ paths: plan: {} custom_attributes: {} schema: - '$ref': '#/components/schemas/company' + "$ref": "#/components/schemas/company" '404': description: Company Not Found content: @@ -1722,10 +1722,10 @@ paths: type: error.list request_id: 23d4c1ec-0390-43a4-b1f0-42929186b1bc 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: @@ -1736,26 +1736,26 @@ paths: type: error.list request_id: 784466f3-0da7-4ed8-879e-8bb94eb250ee errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' + "$ref": "#/components/schemas/error" 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: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + schema: + type: string tags: - - Companies + - Companies operationId: deleteCompany description: You can delete a single company. responses: @@ -1770,7 +1770,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: @@ -1781,10 +1781,10 @@ paths: type: error.list request_id: 3163f31c-4778-4b1a-9067-11609e1754ff 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: @@ -1795,28 +1795,28 @@ paths: type: error.list request_id: fd0efbac-32d1-4979-8f6d-506bfdf99eaf 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: 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: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + 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: @@ -1836,7 +1836,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: @@ -1847,10 +1847,10 @@ paths: type: error.list request_id: 320943a8-35f6-4fe4-a772-184451a52bcc 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: @@ -1861,27 +1861,27 @@ paths: type: error.list request_id: a107d234-29d2-46d9-8501-610b0fc362de 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: 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: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + schema: + type: string tags: - - Companies + - Companies operationId: ListAttachedSegmentsForCompanies description: You can fetch a list of all segments that belong to a company. responses: @@ -1895,7 +1895,7 @@ paths: type: list data: [] schema: - '$ref': '#/components/schemas/company_attached_segments' + "$ref": "#/components/schemas/company_attached_segments" '404': description: Company Not Found content: @@ -1906,10 +1906,10 @@ paths: type: error.list request_id: e4304052-33bd-4594-824b-975c3132ea33 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: @@ -1920,65 +1920,65 @@ paths: type: error.list request_id: b8824d51-a4a9-4a3e-b54a-49944d555103 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: summary: List all companies parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: page - in: query - required: false - description: what page of results to fetch. Defaults to first page - example: first page - schema: - type: string - - name: per_page - in: query - required: false - description: how many results per page. Defaults to 15 - example: '15' - schema: - type: string - - 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: filter - in: query - style: form - required: true - schema: - type: object - oneOf: - - description: The `id` of the tag to filter by. - title: Filter by tag - properties: - tag_id: - type: string - required: - - tag_id - additionalProperties: false - - description: The `id` of the segment to filter by. - title: Filter by segment - properties: - segment_id: - type: string - required: - - segment_id - additionalProperties: false + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: page + in: query + required: false + description: what page of results to fetch. Defaults to first page + example: first page + schema: + type: string + - name: per_page + in: query + required: false + description: how many results per page. Defaults to 15 + example: '15' + schema: + type: string + - 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: filter + in: query + style: form + required: true + schema: + type: object + oneOf: + - description: The `id` of the tag to filter by. + title: Filter by tag + properties: + tag_id: + type: string + required: + - tag_id + additionalProperties: false + - description: The `id` of the segment to filter by. + title: Filter by segment + properties: + segment_id: + type: string + required: + - segment_id + additionalProperties: false 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.\n\nNote @@ -1997,25 +1997,25 @@ paths: value: type: list data: - - type: company - company_id: remote_companies_scroll_2 - id: 64c10f5235824d3e53560534 - app_id: this_is_an_id149_that_should_be_at_least_ - name: IntercomQATest1 - remote_created_at: 1690373970 - created_at: 1690373970 - updated_at: 1690373970 - 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: 64c10f5235824d3e53560534 + app_id: this_is_an_id149_that_should_be_at_least_ + name: IntercomQATest1 + remote_created_at: 1690373970 + created_at: 1690373970 + updated_at: 1690373970 + 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: @@ -2024,7 +2024,7 @@ paths: total_pages: 1 total_count: 1 schema: - '$ref': '#/components/schemas/company_list' + "$ref": "#/components/schemas/company_list" '401': description: Unauthorized content: @@ -2035,26 +2035,26 @@ paths: type: error.list request_id: fcef5fb3-48b0-49af-a99b-1801def1e5d5 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: 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: " The `list all companies` functionality does not work well for huge datasets, and can result in errors and performance problems when @@ -2083,30 +2083,30 @@ paths: value: type: list data: - - type: company - company_id: remote_companies_scroll_2 - id: 64c10f5435824d3e5356053c - app_id: this_is_an_id153_that_should_be_at_least_ - name: IntercomQATest1 - remote_created_at: 1690373972 - created_at: 1690373972 - updated_at: 1690373972 - 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: 64c10f5435824d3e5356053c + app_id: this_is_an_id153_that_should_be_at_least_ + name: IntercomQATest1 + remote_created_at: 1690373972 + created_at: 1690373972 + updated_at: 1690373972 + 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: scroll_param: 61d6299a-6933-4daf-b0c8-e26f39cc5644 schema: - '$ref': '#/components/schemas/company_scroll' + "$ref": "#/components/schemas/company_scroll" '401': description: Unauthorized content: @@ -2117,27 +2117,27 @@ paths: type: error.list request_id: 62d73434-8305-4c35-b1d9-5c392b1eefde 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: 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: @@ -2168,7 +2168,7 @@ paths: plan: {} custom_attributes: {} schema: - '$ref': '#/components/schemas/company' + "$ref": "#/components/schemas/company" '404': description: Company Not Found content: @@ -2179,10 +2179,10 @@ paths: type: error.list request_id: 8ad8b042-b9dd-4cf5-81ee-62ed2b58edfc 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: @@ -2193,17 +2193,17 @@ paths: type: error.list request_id: cc67b2d8-8a20-4cda-8166-659f9b4d000f 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 @@ -2219,31 +2219,31 @@ paths: summary: Company Not Found value: id: 64c10f5935824d3e53560549 - '/contacts/{contact_id}/companies/{id}': + "/contacts/{contact_id}/companies/{id}": delete: 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: @@ -2274,7 +2274,7 @@ paths: plan: {} custom_attributes: {} schema: - '$ref': '#/components/schemas/company' + "$ref": "#/components/schemas/company" '404': description: Contact Not Found content: @@ -2285,17 +2285,17 @@ paths: type: error.list request_id: f9d7cf22-251a-4b11-a08c-724d27510bd0 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: d7a810a5-6d91-4c16-8e7d-0122f2f0a76f 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: @@ -2306,28 +2306,28 @@ paths: type: error.list request_id: 73f789ed-c99a-4fc4-9ef6-274c6f277fa1 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' - '/contacts/{contact_id}/companies': + "$ref": "#/components/schemas/error" + "/contacts/{contact_id}/companies": get: summary: List attached companies for contact parameters: - - name: contact_id - in: path - description: The unique identifier for the contact which is given by Intercom - example: 63a07ddf05a32042dffac965 - required: true - schema: - type: string - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' + - name: contact_id + in: path + description: The unique identifier for the contact which is given by Intercom + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Contacts - - Companies + - Contacts + - Companies operationId: listCompaniesForAContact description: You can fetch a list of companies that are associated to a contact. responses: @@ -2340,26 +2340,26 @@ paths: value: type: list data: - - type: company - company_id: '1' - id: 64c10f6b35824d3e53560577 - app_id: this_is_an_id171_that_should_be_at_least_ - name: company25 - remote_created_at: 1690373995 - created_at: 1690373995 - updated_at: 1690373995 - last_request_at: 1690201195 - 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: 64c10f6b35824d3e53560577 + app_id: this_is_an_id171_that_should_be_at_least_ + name: company25 + remote_created_at: 1690373995 + created_at: 1690373995 + updated_at: 1690373995 + last_request_at: 1690201195 + 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: @@ -2368,7 +2368,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: @@ -2379,10 +2379,10 @@ paths: type: error.list request_id: 232e47da-0713-4bf1-9b9e-552bacabd760 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: @@ -2393,27 +2393,27 @@ paths: type: error.list request_id: 7be08fff-aa6d-41f3-b756-1efe894f1718 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: 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: @@ -2426,48 +2426,48 @@ paths: value: type: list data: - - type: note - id: '405620' - created_at: 1689769199 - contact: - type: contact - id: 64c10f6e35824d3e53560582 - author: - type: admin - id: '991266317' - name: Ciaran102 Lee - email: admin102@email.com - away_mode_enabled: false - away_mode_reassign: false - body: '

This is a note.

' - - type: note - id: '405619' - created_at: 1689682799 - contact: - type: contact - id: 64c10f6e35824d3e53560582 - author: - type: admin - id: '991266317' - name: Ciaran102 Lee - email: admin102@email.com - away_mode_enabled: false - away_mode_reassign: false - body: '

This is a note.

' - - type: note - id: '405618' - created_at: 1689682798 - contact: - type: contact - id: 64c10f6e35824d3e53560582 - author: - type: admin - id: '991266317' - name: Ciaran102 Lee - email: admin102@email.com - away_mode_enabled: false - away_mode_reassign: false - body: '

This is a note.

' + - type: note + id: '405620' + created_at: 1689769199 + contact: + type: contact + id: 64c10f6e35824d3e53560582 + author: + type: admin + id: '991266317' + name: Ciaran102 Lee + email: admin102@email.com + away_mode_enabled: false + away_mode_reassign: false + body: "

This is a note.

" + - type: note + id: '405619' + created_at: 1689682799 + contact: + type: contact + id: 64c10f6e35824d3e53560582 + author: + type: admin + id: '991266317' + name: Ciaran102 Lee + email: admin102@email.com + away_mode_enabled: false + away_mode_reassign: false + body: "

This is a note.

" + - type: note + id: '405618' + created_at: 1689682798 + contact: + type: contact + id: 64c10f6e35824d3e53560582 + author: + type: admin + id: '991266317' + name: Ciaran102 Lee + email: admin102@email.com + away_mode_enabled: false + away_mode_reassign: false + body: "

This is a note.

" total_count: 3 pages: type: pages @@ -2476,7 +2476,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: @@ -2487,27 +2487,27 @@ paths: type: error.list request_id: d915f781-c252-4e81-b811-e5ef3bb32f20 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: 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: @@ -2531,9 +2531,9 @@ paths: email: admin104@email.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: @@ -2544,24 +2544,24 @@ paths: type: error.list request_id: a1e09f62-ca53-47a6-a5cd-0d225aff31fd errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found Contact not found: value: type: error.list request_id: 29392678-b4a2-4aeb-864e-c63dede2e8b6 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 @@ -2594,24 +2594,24 @@ paths: contact_id: 123 admin_id: 991266321 body: Hello - '/contacts/{contact_id}/segments': + "/contacts/{contact_id}/segments": get: summary: List attached segments for contact parameters: - - name: contact_id - in: path - description: The unique identifier for the contact which is given by Intercom - example: 63a07ddf05a32042dffac965 - required: true - schema: - type: string - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' + - 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: @@ -2624,14 +2624,14 @@ paths: value: type: list data: - - type: segment - id: 64c10f7235824d3e53560587 - name: segment - created_at: 1690374002 - updated_at: 1690374002 - person_type: user - schema: - '$ref': '#/components/schemas/contact_segments' + - type: segment + id: 64c10f7235824d3e53560587 + name: segment + created_at: 1690374002 + updated_at: 1690374002 + person_type: user + schema: + "$ref": "#/components/schemas/contact_segments" '404': description: Contact not found content: @@ -2642,10 +2642,10 @@ paths: type: error.list request_id: ccc170e5-1034-4dbe-b813-7ea7d9b81899 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: @@ -2656,28 +2656,28 @@ paths: type: error.list request_id: 8beb12a6-4465-4dc7-98b0-86fce7cfc4dc 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: 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. @@ -2697,36 +2697,36 @@ paths: value: type: list data: - - type: subscription - id: '440933' - 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: '440935' - 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: '440933' + 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: '440935' + 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: @@ -2737,10 +2737,10 @@ paths: type: error.list request_id: b6bffae7-0271-4fd2-9063-9e8df8414a89 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: @@ -2751,27 +2751,27 @@ paths: type: error.list request_id: 7b4b4a2c-f572-4b5b-a408-c83581265f6f 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 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: @@ -2798,13 +2798,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: @@ -2815,17 +2815,17 @@ paths: type: error.list request_id: 31840b45-1292-4350-be8a-49466132e3ec errors: - - code: not_found - message: User Not Found + - code: not_found + message: User Not Found Resource not found: value: type: error.list request_id: 2a77f5d2-0ce2-4126-b777-116465628344 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: @@ -2836,18 +2836,18 @@ paths: type: error.list request_id: 2434bb96-a5e6-45e3-b3ff-78ecde02375f 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 @@ -2874,32 +2874,32 @@ 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 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 @@ -2921,13 +2921,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: @@ -2938,17 +2938,17 @@ paths: type: error.list request_id: '08071396-a681-4e65-bc7d-55fa0dc5a66d' errors: - - code: not_found - message: User Not Found + - code: not_found + message: User Not Found Resource not found: value: type: error.list request_id: e8662e2f-e8f9-4c9d-a4cc-b8361ae86c95 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: @@ -2959,28 +2959,28 @@ paths: type: error.list request_id: 71f5fee7-4748-41ff-8f2b-c2aa3800a187 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: 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. @@ -2994,11 +2994,11 @@ paths: value: type: list data: - - type: tag - id: '321873' - name: Manual tag + - type: tag + id: '321873' + name: Manual tag schema: - '$ref': '#/components/schemas/tag_list' + "$ref": "#/components/schemas/tag_list" '404': description: Contact not found content: @@ -3009,10 +3009,10 @@ paths: type: error.list request_id: 700994a2-df1e-4d4e-8909-d10711309cf5 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: @@ -3023,27 +3023,27 @@ paths: type: error.list request_id: 0b6c9309-b178-496f-b8dc-0b78f867c048 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 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. @@ -3059,7 +3059,7 @@ paths: id: '321874' name: Manual tag schema: - '$ref': '#/components/schemas/tag' + "$ref": "#/components/schemas/tag" '404': description: Tag not found content: @@ -3070,17 +3070,17 @@ paths: type: error.list request_id: deec987e-9e2f-4c03-95e9-c5edbe8fb20f errors: - - code: not_found - message: User Not Found + - code: not_found + message: User Not Found Tag not found: value: type: error.list request_id: 617346a6-3d03-474d-9ee8-9abd4802a419 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: @@ -3091,17 +3091,17 @@ paths: type: error.list request_id: 45ed2cc7-1bee-4d13-afcf-68f67d287e91 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 @@ -3121,31 +3121,31 @@ paths: summary: Tag not found value: id: '123' - '/contacts/{contact_id}/tags/{id}': + "/contacts/{contact_id}/tags/{id}": delete: summary: Remove tag from a contact tags: - - Tags - - Contacts + - Tags + - Contacts parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: contact_id - in: path - description: The unique identifier for the contact which is given by Intercom - example: 63a07ddf05a32042dffac965 - required: true - schema: - type: string - - name: id - in: path - description: The unique identifier for the tag which is given by Intercom - example: '7522907' - required: true - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: contact_id + in: path + description: The unique identifier for the contact which is given by Intercom + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + - name: id + in: path + description: The unique identifier for the tag which is given by Intercom + example: '7522907' + required: true + schema: + type: string operationId: detachTagFromContact description: You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact. @@ -3161,7 +3161,7 @@ paths: id: '321877' name: Manual tag schema: - '$ref': '#/components/schemas/tag' + "$ref": "#/components/schemas/tag" '404': description: Tag not found content: @@ -3172,17 +3172,17 @@ paths: type: error.list request_id: 8c472cda-1ef6-4a1d-ae02-49ad096d3f4e errors: - - code: not_found - message: User Not Found + - code: not_found + message: User Not Found Tag not found: value: type: error.list request_id: bded9369-c8cb-49c9-b93a-9e80fbbe5b84 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: @@ -3193,27 +3193,27 @@ paths: type: error.list request_id: baf35a03-5232-41b7-afcf-59a5799cb663 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: 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: @@ -3276,31 +3276,31 @@ paths: tags: type: list data: [] - url: '/contacts/64c10f8135824d3e5356059e/tags' + url: "/contacts/64c10f8135824d3e5356059e/tags" total_count: 0 has_more: false notes: type: list data: [] - url: '/contacts/64c10f8135824d3e5356059e/notes' + url: "/contacts/64c10f8135824d3e5356059e/notes" total_count: 0 has_more: false companies: type: list data: [] - url: '/contacts/64c10f8135824d3e5356059e/companies' + url: "/contacts/64c10f8135824d3e5356059e/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: '/contacts/64c10f8135824d3e5356059e/subscriptions' + url: "/contacts/64c10f8135824d3e5356059e/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: '/contacts/64c10f8135824d3e5356059e/subscriptions' + url: "/contacts/64c10f8135824d3e5356059e/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3310,7 +3310,7 @@ paths: utm_term: referrer: schema: - '$ref': '#/components/schemas/contact' + "$ref": "#/components/schemas/contact" '401': description: Unauthorized content: @@ -3321,16 +3321,16 @@ paths: type: error.list request_id: 16ec24eb-ae00-42c7-827d-126e745e2af5 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 @@ -3340,19 +3340,19 @@ paths: 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: @@ -3415,31 +3415,31 @@ paths: tags: type: list data: [] - url: '/contacts/64c10f8435824d3e5356059f/tags' + url: "/contacts/64c10f8435824d3e5356059f/tags" total_count: 0 has_more: false notes: type: list data: [] - url: '/contacts/64c10f8435824d3e5356059f/notes' + url: "/contacts/64c10f8435824d3e5356059f/notes" total_count: 0 has_more: false companies: type: list data: [] - url: '/contacts/64c10f8435824d3e5356059f/companies' + url: "/contacts/64c10f8435824d3e5356059f/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: '/contacts/64c10f8435824d3e5356059f/subscriptions' + url: "/contacts/64c10f8435824d3e5356059f/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: '/contacts/64c10f8435824d3e5356059f/subscriptions' + url: "/contacts/64c10f8435824d3e5356059f/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3449,7 +3449,7 @@ paths: utm_term: referrer: schema: - '$ref': '#/components/schemas/contact' + "$ref": "#/components/schemas/contact" '401': description: Unauthorized content: @@ -3460,25 +3460,25 @@ paths: type: error.list request_id: e96c472e-b9bb-45ff-9501-2c91a71f914c errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' + "$ref": "#/components/schemas/error" delete: summary: Delete a contact parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - description: id - required: true - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: id + required: true + schema: + type: string tags: - - Contacts + - Contacts operationId: DeleteContact description: You can delete a single contact. responses: @@ -3493,7 +3493,7 @@ paths: object: contact deleted: true schema: - '$ref': '#/components/schemas/contact_deleted' + "$ref": "#/components/schemas/contact_deleted" '401': description: Unauthorized content: @@ -3504,20 +3504,20 @@ paths: type: error.list request_id: 6961de23-2d6c-4f70-81e5-c4a895aa9e35 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: 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`. @@ -3581,31 +3581,31 @@ paths: tags: type: list data: [] - url: '/contacts/64c10f8935824d3e535605a2/tags' + url: "/contacts/64c10f8935824d3e535605a2/tags" total_count: 0 has_more: false notes: type: list data: [] - url: '/contacts/64c10f8935824d3e535605a2/notes' + url: "/contacts/64c10f8935824d3e535605a2/notes" total_count: 0 has_more: false companies: type: list data: [] - url: '/contacts/64c10f8935824d3e535605a2/companies' + url: "/contacts/64c10f8935824d3e535605a2/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: '/contacts/64c10f8935824d3e535605a2/subscriptions' + url: "/contacts/64c10f8935824d3e535605a2/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: '/contacts/64c10f8935824d3e535605a2/subscriptions' + url: "/contacts/64c10f8935824d3e535605a2/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3615,7 +3615,7 @@ paths: utm_term: referrer: schema: - '$ref': '#/components/schemas/contact' + "$ref": "#/components/schemas/contact" '401': description: Unauthorized content: @@ -3626,31 +3626,31 @@ paths: type: error.list request_id: 5e060068-c2be-4b69-af86-5d6882dceb25 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: 64c10f8935824d3e535605a1 into: 64c10f8935824d3e535605a2 - '/contacts/search': + "/contacts/search": post: summary: Search contacts parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Contacts + - Contacts operationId: SearchContacts description: "You can search for multiple contacts by the value of their attributes in order to fetch exactly who you want.\n\nTo search for contacts, you need @@ -3740,7 +3740,7 @@ paths: per_page: 50 total_pages: 0 schema: - '$ref': '#/components/schemas/contact_list' + "$ref": "#/components/schemas/contact_list" '401': description: Unauthorized content: @@ -3751,15 +3751,15 @@ paths: type: error.list request_id: 7d1ced2a-a5a4-47b0-977c-600a38455632 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 @@ -3767,27 +3767,27 @@ paths: query: operator: AND value: + - field: id + operator: "=" + value: 64c10f8b35824d3e535605a5 + - operator: OR + value: + - field: id + operator: "=" + value: 64c10f8b35824d3e535605a5 - field: id - operator: '=' + operator: "=" value: 64c10f8b35824d3e535605a5 - - operator: OR - value: - - field: id - operator: '=' - value: 64c10f8b35824d3e535605a5 - - field: id - operator: '=' - value: 64c10f8b35824d3e535605a5 - '/contacts': + "/contacts": get: summary: List all contacts parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Contacts + - Contacts operationId: ListContacts description: You can fetch a list of all contacts. responses: @@ -3807,7 +3807,7 @@ paths: per_page: 10 total_pages: 0 schema: - '$ref': '#/components/schemas/contact_list' + "$ref": "#/components/schemas/contact_list" '401': description: Unauthorized content: @@ -3818,19 +3818,19 @@ paths: type: error.list request_id: 73bf442e-00de-4ec1-ae96-455c40b67393 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 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: @@ -3893,31 +3893,31 @@ paths: tags: type: list data: [] - url: '/contacts/64c10f9035824d3e535605a7/tags' + url: "/contacts/64c10f9035824d3e535605a7/tags" total_count: 0 has_more: false notes: type: list data: [] - url: '/contacts/64c10f9035824d3e535605a7/notes' + url: "/contacts/64c10f9035824d3e535605a7/notes" total_count: 0 has_more: false companies: type: list data: [] - url: '/contacts/64c10f9035824d3e535605a7/companies' + url: "/contacts/64c10f9035824d3e535605a7/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: '/contacts/64c10f9035824d3e535605a7/subscriptions' + url: "/contacts/64c10f9035824d3e535605a7/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: '/contacts/64c10f9035824d3e535605a7/subscriptions' + url: "/contacts/64c10f9035824d3e535605a7/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3927,7 +3927,7 @@ paths: utm_term: referrer: schema: - '$ref': '#/components/schemas/contact' + "$ref": "#/components/schemas/contact" '401': description: Unauthorized content: @@ -3938,38 +3938,38 @@ paths: type: error.list request_id: 438622cc-8d5c-409b-9f98-8e99b6b1096f 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/{id}/archive': + "/contacts/{id}/archive": post: summary: Archive contact parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - description: id - example: 63a07ddf05a32042dffac965 - required: true - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: id + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string tags: - - Contacts + - Contacts operationId: ArchiveContact description: You can archive a single contact. responses: @@ -3984,24 +3984,24 @@ paths: object: contact archived: true schema: - '$ref': '#/components/schemas/contact_archived' - '/contacts/{id}/unarchive': + "$ref": "#/components/schemas/contact_archived" + "/contacts/{id}/unarchive": post: summary: Unarchive contact parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - description: id - example: 63a07ddf05a32042dffac965 - required: true - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: id + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string tags: - - Contacts + - Contacts operationId: UnarchiveContact description: You can unarchive a single contact. responses: @@ -4016,25 +4016,25 @@ paths: object: contact archived: false schema: - '$ref': '#/components/schemas/contact_unarchived' - '/conversations/{conversation_id}/tags': + "$ref": "#/components/schemas/contact_unarchived" + "/conversations/{conversation_id}/tags": post: 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. @@ -4050,7 +4050,7 @@ paths: id: '321879' name: Manual tag schema: - '$ref': '#/components/schemas/tag' + "$ref": "#/components/schemas/tag" '404': description: Conversation not found content: @@ -4061,10 +4061,10 @@ paths: type: error.list request_id: bcc9f283-37f3-4d19-912f-72e97f793e8e 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: @@ -4075,18 +4075,18 @@ paths: type: error.list request_id: 6be322a1-8a32-4bc8-827c-86e0ea9e8498 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 @@ -4109,31 +4109,31 @@ paths: value: id: 321880 admin_id: 991266354 - '/conversations/{conversation_id}/tags/{id}': + "/conversations/{conversation_id}/tags/{id}": delete: 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. @@ -4149,7 +4149,7 @@ paths: id: '321882' name: Manual tag schema: - '$ref': '#/components/schemas/tag' + "$ref": "#/components/schemas/tag" '404': description: Tag not found content: @@ -4160,17 +4160,17 @@ paths: type: error.list request_id: afd56763-81ad-4cc3-9781-64ed889698c5 errors: - - code: not_found - message: Conversation not found + - code: not_found + message: Conversation not found Tag not found: value: type: error.list request_id: 4407d11f-f798-4d84-b711-02e2ce883a20 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: @@ -4181,17 +4181,17 @@ paths: type: error.list request_id: 0c2475c6-4322-470d-af52-b69153a672fc 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 @@ -4211,30 +4211,30 @@ paths: summary: Tag not found value: admin_id: 991266359 - '/conversations': + "/conversations": get: 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. @@ -4256,50 +4256,50 @@ paths: total_pages: 1 total_count: 1 conversations: - - type: conversation - id: '715385' - created_at: 1690374044 - updated_at: 1690374044 - waiting_since: - snoozed_until: - source: - type: conversation - id: '403918065' - delivered_as: admin_initiated - subject: '' - body: '

this is the message body

' - author: - type: admin - id: '991266362' - name: Ciaran144 Lee - email: admin144@email.com - attachments: [] - url: - redacted: false + - type: conversation + id: '715385' + created_at: 1690374044 + updated_at: 1690374044 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918065' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991266362' + name: Ciaran144 Lee + email: admin144@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list contacts: - type: contact.list - contacts: - - type: contact - id: 64c10f9c35824d3e535605ad - first_contact_reply: - admin_assignee_id: - team_assignee_id: - open: false - state: closed - read: false - tags: - type: tag.list - tags: [] - priority: not_priority - sla_applied: - statistics: - conversation_rating: - teammates: - title: - custom_attributes: {} - topics: {} - schema: - '$ref': '#/components/schemas/paginated_response' + - type: contact + id: 64c10f9c35824d3e535605ad + first_contact_reply: + admin_assignee_id: + team_assignee_id: + open: false + state: closed + read: false + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + schema: + "$ref": "#/components/schemas/paginated_response" '401': description: Unauthorized content: @@ -4310,10 +4310,10 @@ paths: type: error.list request_id: 650444bd-b31b-4b1e-b9f0-e4e4e358dd04 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: @@ -4324,19 +4324,19 @@ paths: type: error.list request_id: 47036010-f131-4fa7-8e0a-3f3fa8df25f9 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: 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).\nThe conversation can be an in-app message only.\n\n> @@ -4360,7 +4360,7 @@ paths: message_type: inapp conversation_id: '715410' schema: - '$ref': '#/components/schemas/message' + "$ref": "#/components/schemas/message" '404': description: Contact Not Found content: @@ -4371,10 +4371,10 @@ paths: type: error.list request_id: 2e60a694-7f80-4edf-b77d-e6924733d2c5 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: @@ -4385,10 +4385,10 @@ paths: type: error.list request_id: d4b61905-0d3a-4fe1-9e2c-088a234a30e8 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: @@ -4399,15 +4399,15 @@ paths: type: error.list request_id: 62fe2427-e211-4291-9023-764b35d93761 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 @@ -4423,30 +4423,30 @@ paths: type: user id: 123_doesnt_exist body: Hello there - '/conversations/{id}': + "/conversations/{id}": get: summary: Retrieve a conversation parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The id of the conversation to target - example: 123 - schema: - type: integer - - name: display_as - in: query - required: false - description: Set to plaintext to retrieve conversation messages in plain text. - example: plaintext - schema: - type: string + - 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: "\nYou can fetch the details of a single conversation.\n\nThis will return a single Conversation model with all its conversation parts.\n\n> @@ -4476,7 +4476,7 @@ paths: id: '403918079' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266376' @@ -4488,8 +4488,8 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c10fbf35824d3e535605c6 + - type: contact + id: 64c10fbf35824d3e535605c6 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -4512,7 +4512,7 @@ paths: conversation_parts: [] total_count: 0 schema: - '$ref': '#/components/schemas/conversation' + "$ref": "#/components/schemas/conversation" '404': description: Not found content: @@ -4523,10 +4523,10 @@ paths: type: error.list request_id: 5d0d6ddd-6872-4554-aba4-2277018c3868 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: @@ -4537,10 +4537,10 @@ paths: type: error.list request_id: 2587a3c7-451a-4c7d-8bd0-338d91022933 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: @@ -4551,33 +4551,33 @@ paths: type: error.list request_id: 52906f5a-f77e-47e2-b248-f1bf62e4df4a 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: 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: "\nYou can update an existing conversation.\n\n> \U0001F4D8\n>\n> If you want to update a conversation with either a reply (or actions such @@ -4602,7 +4602,7 @@ paths: id: '403918083' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266384' @@ -4614,8 +4614,8 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c10fc835824d3e535605ca + - type: contact + id: 64c10fc835824d3e535605ca first_contact_reply: admin_assignee_id: team_assignee_id: @@ -4638,41 +4638,41 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '711348' - part_type: conversation_attribute_updated_by_admin - body: - created_at: 1690374090 - updated_at: 1690374090 - notified_at: 1690374090 - assigned_to: - author: - id: '991266385' - type: bot - name: Operator - email: operator+this_is_an_id305_that_should_be_at_least_@intercom.io - attachments: [] - external_id: - redacted: false - - type: conversation_part - id: '711349' - part_type: conversation_attribute_updated_by_admin - body: - created_at: 1690374090 - updated_at: 1690374090 - notified_at: 1690374090 - assigned_to: - author: - id: '991266385' - type: bot - name: Operator - email: operator+this_is_an_id305_that_should_be_at_least_@intercom.io - attachments: [] - external_id: - redacted: false + - type: conversation_part + id: '711348' + part_type: conversation_attribute_updated_by_admin + body: + created_at: 1690374090 + updated_at: 1690374090 + notified_at: 1690374090 + assigned_to: + author: + id: '991266385' + type: bot + name: Operator + email: operator+this_is_an_id305_that_should_be_at_least_@intercom.io + attachments: [] + external_id: + redacted: false + - type: conversation_part + id: '711349' + part_type: conversation_attribute_updated_by_admin + body: + created_at: 1690374090 + updated_at: 1690374090 + notified_at: 1690374090 + assigned_to: + author: + id: '991266385' + type: bot + name: Operator + email: operator+this_is_an_id305_that_should_be_at_least_@intercom.io + attachments: [] + external_id: + redacted: false total_count: 2 schema: - '$ref': '#/components/schemas/conversation' + "$ref": "#/components/schemas/conversation" '404': description: Not found content: @@ -4683,10 +4683,10 @@ paths: type: error.list request_id: '09a67332-a854-4897-8449-d280e616cd03' 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: @@ -4697,10 +4697,10 @@ paths: type: error.list request_id: d5f7f311-8495-4f46-92b4-dd46d495e758 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: @@ -4711,15 +4711,15 @@ paths: type: error.list request_id: 893c9895-bc67-4e3f-9ef5-4fd3d5923350 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 @@ -4735,16 +4735,16 @@ paths: custom_attributes: issue_type: Billing priority: High - '/conversations/search': + "/conversations/search": post: summary: Search conversations parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Conversations + - Conversations operationId: searchConversations description: "You can search for multiple conversations by the value of their attributes in order to fetch exactly which ones you want.\n\nTo search for @@ -4827,55 +4827,55 @@ paths: total_pages: 1 total_count: 1 conversations: - - type: conversation - id: '715422' - created_at: 1690374098 - updated_at: 1690374098 - waiting_since: - snoozed_until: - source: - type: conversation - id: '403918087' - delivered_as: admin_initiated - subject: '' - body: '

this is the message body

' - author: - type: admin - id: '991266408' - name: Ciaran175 Lee - email: admin175@email.com - attachments: [] - url: - redacted: false + - type: conversation + id: '715422' + created_at: 1690374098 + updated_at: 1690374098 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918087' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991266408' + name: Ciaran175 Lee + email: admin175@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list contacts: - type: contact.list - contacts: - - type: contact - id: 64c10fd235824d3e535605ce - first_contact_reply: - admin_assignee_id: - team_assignee_id: - open: false - state: closed - read: false - tags: - type: tag.list - tags: [] - priority: not_priority - sla_applied: - statistics: - conversation_rating: - teammates: - title: - custom_attributes: {} - topics: {} - schema: - '$ref': '#/components/schemas/conversation_list' + - type: contact + id: 64c10fd235824d3e535605ce + first_contact_reply: + admin_assignee_id: + team_assignee_id: + open: false + state: closed + read: false + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + schema: + "$ref": "#/components/schemas/conversation_list" requestBody: content: application/json: schema: - '$ref': '#/components/schemas/search_request' + "$ref": "#/components/schemas/search_request" examples: successful: summary: successful @@ -4883,43 +4883,43 @@ paths: query: operator: AND value: + - field: id + operator: "=" + value: '715422' + - operator: OR + value: + - field: id + operator: "=" + value: '715422' - field: id - operator: '=' + operator: "=" value: '715422' - - operator: OR - value: - - field: id - operator: '=' - value: '715422' - - field: id - operator: '=' - value: '715422' - '/conversations/{id}/reply': + "/conversations/{id}/reply": post: summary: Reply to a conversation parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - schema: - oneOf: - - title: Conversation ID - type: string - description: The id of the conversation to target. - example: '123' - - title: The most recent conversation - type: string - enum: - - last - description: You can also reply to the most recent conversation on a workspace - by specifying `last` as the string. - example: last + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + schema: + oneOf: + - title: Conversation ID + type: string + description: The id of the conversation to target. + example: '123' + - title: The most recent conversation + type: string + enum: + - last + description: You can also reply to the most recent conversation on a workspace + by specifying `last` as the string. + example: last 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. @@ -4942,7 +4942,7 @@ paths: id: '403918090' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266410' @@ -4954,8 +4954,8 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c10fd935824d3e535605d5 + - type: contact + id: 64c10fd935824d3e535605d5 first_contact_reply: created_at: 1690374107 type: conversation @@ -4979,22 +4979,22 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '711351' - part_type: comment - body: '

Thanks again :)

' - created_at: 1690374107 - updated_at: 1690374107 - notified_at: 1690374107 - assigned_to: - author: - id: 64c10fd935824d3e535605d5 - type: user - name: Joe Bloggs - email: joe@bloggs.com - attachments: [] - external_id: - redacted: false + - type: conversation_part + id: '711351' + part_type: comment + body: "

Thanks again :)

" + created_at: 1690374107 + updated_at: 1690374107 + notified_at: 1690374107 + assigned_to: + author: + id: 64c10fd935824d3e535605d5 + type: user + name: Joe Bloggs + email: joe@bloggs.com + attachments: [] + external_id: + redacted: false total_count: 1 Admin note reply: value: @@ -5009,7 +5009,7 @@ paths: id: '403918091' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266412' @@ -5021,8 +5021,8 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c10fdc35824d3e535605d6 + - type: contact + id: 64c10fdc35824d3e535605d6 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5043,34 +5043,34 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '711352' - part_type: note - body: |- -

An Unordered HTML List

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

An Ordered HTML List

-
    -
  1. Coffee
    2. -
  2. Tea
    3. -
  3. Milk
    4. -
- created_at: 1690374109 - updated_at: 1690374109 - notified_at: 1690374109 - assigned_to: - author: - id: '991266412' - type: admin - name: Ciaran177 Lee - email: admin177@email.com - attachments: [] - external_id: - redacted: false + - type: conversation_part + id: '711352' + part_type: note + body: |- +

An Unordered HTML List

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

An Ordered HTML List

+
    +
  1. Coffee
    2. +
  2. Tea
    3. +
  3. Milk
    4. +
+ created_at: 1690374109 + updated_at: 1690374109 + notified_at: 1690374109 + assigned_to: + author: + id: '991266412' + type: admin + name: Ciaran177 Lee + email: admin177@email.com + attachments: [] + external_id: + redacted: false total_count: 1 User last conversation reply: value: @@ -5085,7 +5085,7 @@ paths: id: '403918093' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266416' @@ -5097,8 +5097,8 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c10fe035824d3e535605d8 + - type: contact + id: 64c10fe035824d3e535605d8 first_contact_reply: created_at: 1690374114 type: conversation @@ -5122,25 +5122,25 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '711353' - part_type: comment - body: '

Thanks again :)

' - created_at: 1690374114 - updated_at: 1690374114 - notified_at: 1690374114 - assigned_to: - author: - id: 64c10fe035824d3e535605d8 - type: user - name: Joe Bloggs - email: joe@bloggs.com - attachments: [] - external_id: - redacted: false + - type: conversation_part + id: '711353' + part_type: comment + body: "

Thanks again :)

" + created_at: 1690374114 + updated_at: 1690374114 + notified_at: 1690374114 + assigned_to: + author: + id: 64c10fe035824d3e535605d8 + type: user + name: Joe Bloggs + email: joe@bloggs.com + attachments: [] + external_id: + redacted: false total_count: 1 schema: - '$ref': '#/components/schemas/conversation' + "$ref": "#/components/schemas/conversation" '404': description: Not found content: @@ -5151,10 +5151,10 @@ paths: type: error.list request_id: 2905243e-0f09-4211-8ca8-a1b405f795de 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: @@ -5165,10 +5165,10 @@ paths: type: error.list request_id: f2bc5a99-ba29-44a7-bd57-a9fa113fa4ec 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: @@ -5179,15 +5179,15 @@ paths: type: error.list request_id: ed4703fb-e355-46db-9373-22d279e9d60b 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 @@ -5220,23 +5220,23 @@ paths: type: user intercom_user_id: 64c10fe335824d3e535605d9 body: Thanks again :) - '/conversations/{id}/parts': + "/conversations/{id}/parts": post: summary: Manage a conversation parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The identifier for the conversation as given by Intercom. - example: '123' - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The identifier for the conversation as given by Intercom. + example: '123' + schema: + type: string tags: - - Conversations + - Conversations operationId: manageConversation description: | You can close a conversation. @@ -5262,7 +5262,7 @@ paths: id: '403918097' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266424' @@ -5274,8 +5274,8 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c10fe935824d3e535605dc + - type: contact + id: 64c10fe935824d3e535605dc first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5296,22 +5296,22 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '711354' - part_type: close - body: '

Goodbye :)

' - created_at: 1690374122 - updated_at: 1690374122 - notified_at: 1690374122 - assigned_to: - author: - id: '991266424' - type: admin - name: Ciaran183 Lee - email: admin183@email.com - attachments: [] - external_id: - redacted: false + - type: conversation_part + id: '711354' + part_type: close + body: "

Goodbye :)

" + created_at: 1690374122 + updated_at: 1690374122 + notified_at: 1690374122 + assigned_to: + author: + id: '991266424' + type: admin + name: Ciaran183 Lee + email: admin183@email.com + attachments: [] + external_id: + redacted: false total_count: 1 Snooze a conversation: value: @@ -5326,7 +5326,7 @@ paths: id: '403918098' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266426' @@ -5338,8 +5338,8 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c10feb35824d3e535605dd + - type: contact + id: 64c10feb35824d3e535605dd first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5360,22 +5360,22 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '711355' - part_type: snoozed - body: - created_at: 1690374125 - updated_at: 1690374125 - notified_at: 1690374125 - assigned_to: - author: - id: '991266426' - type: admin - name: Ciaran184 Lee - email: admin184@email.com - attachments: [] - external_id: - redacted: false + - type: conversation_part + id: '711355' + part_type: snoozed + body: + created_at: 1690374125 + updated_at: 1690374125 + notified_at: 1690374125 + assigned_to: + author: + id: '991266426' + type: admin + name: Ciaran184 Lee + email: admin184@email.com + attachments: [] + external_id: + redacted: false total_count: 1 Open a conversation: value: @@ -5390,7 +5390,7 @@ paths: id: '403918099' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266428' @@ -5402,8 +5402,8 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c10ff135824d3e535605e2 + - type: contact + id: 64c10ff135824d3e535605e2 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5424,22 +5424,22 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '711357' - part_type: open - body: - created_at: 1690374133 - updated_at: 1690374133 - notified_at: 1690374133 - assigned_to: - author: - id: '991266428' - type: admin - name: Ciaran185 Lee - email: admin185@email.com - attachments: [] - external_id: - redacted: false + - type: conversation_part + id: '711357' + part_type: open + body: + created_at: 1690374133 + updated_at: 1690374133 + notified_at: 1690374133 + assigned_to: + author: + id: '991266428' + type: admin + name: Ciaran185 Lee + email: admin185@email.com + attachments: [] + external_id: + redacted: false total_count: 1 Assign a conversation: value: @@ -5454,7 +5454,7 @@ paths: id: '403918102' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266430' @@ -5466,8 +5466,8 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c10ff635824d3e535605e5 + - type: contact + id: 64c10ff635824d3e535605e5 first_contact_reply: admin_assignee_id: 991266430 team_assignee_id: @@ -5488,27 +5488,27 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '711358' - part_type: assign_and_reopen - body: - created_at: 1690374135 - updated_at: 1690374135 - notified_at: 1690374135 - assigned_to: - type: admin - id: '991266430' - author: - id: '991266430' - type: admin - name: Ciaran186 Lee - email: admin186@email.com - attachments: [] - external_id: - redacted: false + - type: conversation_part + id: '711358' + part_type: assign_and_reopen + body: + created_at: 1690374135 + updated_at: 1690374135 + notified_at: 1690374135 + assigned_to: + type: admin + id: '991266430' + author: + id: '991266430' + type: admin + name: Ciaran186 Lee + email: admin186@email.com + attachments: [] + external_id: + redacted: false total_count: 1 schema: - '$ref': '#/components/schemas/conversation' + "$ref": "#/components/schemas/conversation" '404': description: Not found content: @@ -5519,10 +5519,10 @@ paths: type: error.list request_id: f8029f05-f709-493a-96fb-b2e44d32ede4 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: @@ -5533,10 +5533,10 @@ paths: type: error.list request_id: a084e0e5-be51-47fd-9fce-6ab7813d49df 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: @@ -5547,19 +5547,19 @@ paths: type: error.list request_id: ad8643c9-13f5-49c1-b95f-98b5e820d34b 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 @@ -5593,23 +5593,23 @@ paths: type: admin admin_id: 991266432 body: Goodbye :) - '/conversations/{id}/run_assignment_rules': + "/conversations/{id}/run_assignment_rules": post: summary: Run Assignment Rules on a conversation parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The identifier for the conversation as given by Intercom. - example: '123' - schema: - type: string + - 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. @@ -5632,7 +5632,7 @@ paths: id: '403918106' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266438' @@ -5644,8 +5644,8 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c10ffe35824d3e535605e9 + - type: contact + id: 64c10ffe35824d3e535605e9 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5666,27 +5666,27 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '711359' - part_type: default_assignment - body: - created_at: 1690374143 - updated_at: 1690374143 - notified_at: 1690374143 - assigned_to: - type: nobody_admin - id: - author: - id: '991266439' - type: bot - name: Operator - email: operator+this_is_an_id343_that_should_be_at_least_@intercom.io - attachments: [] - external_id: - redacted: false + - type: conversation_part + id: '711359' + part_type: default_assignment + body: + created_at: 1690374143 + updated_at: 1690374143 + notified_at: 1690374143 + assigned_to: + type: nobody_admin + id: + author: + id: '991266439' + type: bot + name: Operator + email: operator+this_is_an_id343_that_should_be_at_least_@intercom.io + attachments: [] + external_id: + redacted: false total_count: 1 schema: - '$ref': '#/components/schemas/conversation' + "$ref": "#/components/schemas/conversation" '404': description: Not found content: @@ -5697,10 +5697,10 @@ paths: type: error.list request_id: 51905192-7450-4e7e-8167-de57094200e9 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: @@ -5711,10 +5711,10 @@ paths: type: error.list request_id: a467d28e-4ecc-491d-a8c7-7aebf9ea8b9c 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: @@ -5725,27 +5725,27 @@ paths: type: error.list request_id: 021665f9-af68-429a-9b56-0d79e60845c3 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 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.\n\n> \U0001F6A7 Note about contacts @@ -5761,10 +5761,10 @@ paths: Attach a contact to a conversation: value: customers: - - type: user - id: 64c1100635824d3e535605ed + - type: user + id: 64c1100635824d3e535605ed schema: - '$ref': '#/components/schemas/conversation' + "$ref": "#/components/schemas/conversation" '404': description: Not found content: @@ -5775,10 +5775,10 @@ paths: type: error.list request_id: ad92d02c-a53f-4a2b-9645-041164195b67 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: @@ -5789,10 +5789,10 @@ paths: type: error.list request_id: b76776c1-82a4-4587-961d-ab8fd57f8816 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: @@ -5803,15 +5803,15 @@ paths: type: error.list request_id: 8d70cd46-9d4f-4458-8c1c-cb5e1a1b83bc 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 @@ -5825,30 +5825,30 @@ paths: admin_id: 991266448 customer: intercom_user_id: 64c1100935824d3e535605ee - '/conversations/{conversation_id}/customers/{contact_id}': + "/conversations/{conversation_id}/customers/{contact_id}": delete: summary: Detach a contact from a group conversation parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: conversation_id - in: path - required: true - description: The identifier for the conversation as given by Intercom. - example: '123' - schema: - type: string - - name: contact_id - in: path - required: true - description: The identifier for the contact as given by Intercom. - example: '123' - schema: - type: string + - 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.\n\n> \U0001F6A7 Note about contacts @@ -5864,10 +5864,10 @@ paths: Detach a contact from a group conversation: value: customers: - - type: user - id: 64c1101535824d3e535605f8 + - type: user + id: 64c1101535824d3e535605f8 schema: - '$ref': '#/components/schemas/conversation' + "$ref": "#/components/schemas/conversation" '404': description: Contact not found content: @@ -5878,17 +5878,17 @@ paths: type: error.list request_id: 19a83f2f-7e9e-49bc-a109-369b2843d939 errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found Contact not found: value: type: error.list request_id: add9c579-d0d6-4151-8caa-3eb0ee9025ff 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: @@ -5899,10 +5899,10 @@ paths: type: error.list request_id: 3c38ae2f-f02c-44db-ac02-8ea8529db449 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: @@ -5913,10 +5913,10 @@ paths: type: error.list request_id: 2c8980e1-fe01-4581-856e-2c2c1d6dc90a 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: @@ -5927,15 +5927,15 @@ paths: type: error.list request_id: 11a10f72-cd97-490f-bd3e-65f9788cf9e5 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 @@ -5961,16 +5961,16 @@ paths: admin_id: 991266460 customer: intercom_user_id: 64c1102435824d3e53560607 - '/conversations/redact': + "/conversations/redact": post: summary: Redact a conversation part parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Conversations + - Conversations operationId: redactConversation description: "You can redact a conversation part or the source message of a conversation (as seen in the source object).\n\n> \U0001F4D8 Which parts and @@ -5997,7 +5997,7 @@ paths: id: '403918132' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266466' @@ -6009,8 +6009,8 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c1103935824d3e5356061c + - type: contact + id: 64c1103935824d3e5356061c first_contact_reply: created_at: 1690374202 type: conversation @@ -6034,25 +6034,25 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '711367' - part_type: comment - body: '

This message was deleted

' - created_at: 1690374202 - updated_at: 1690374203 - notified_at: 1690374202 - assigned_to: - author: - id: 64c1103935824d3e5356061c - type: user - name: Joe Bloggs - email: joe@bloggs.com - attachments: [] - external_id: - redacted: true + - type: conversation_part + id: '711367' + part_type: comment + body: "

This message was deleted

" + created_at: 1690374202 + updated_at: 1690374203 + notified_at: 1690374202 + assigned_to: + author: + id: 64c1103935824d3e5356061c + type: user + name: Joe Bloggs + email: joe@bloggs.com + attachments: [] + external_id: + redacted: true total_count: 1 schema: - '$ref': '#/components/schemas/conversation' + "$ref": "#/components/schemas/conversation" '404': description: Not found content: @@ -6063,10 +6063,10 @@ paths: type: error.list request_id: 70e2786e-956c-4adc-b786-128eea87f81e 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: @@ -6077,15 +6077,15 @@ paths: type: error.list request_id: 66767843-cd15-4a05-8978-a0f18da32d67 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 @@ -6099,23 +6099,23 @@ paths: type: conversation_part conversation_id: really_123_doesnt_exist conversation_part_id: really_123_doesnt_exist - '/conversations/{id}/convert': + "/conversations/{id}/convert": post: summary: Convert a conversation to a ticket parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The id of the conversation to target - example: 123 - schema: - type: integer + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The id of the conversation to target + example: 123 + schema: + type: integer tags: - - Conversations + - Conversations description: You can convert a conversation to a ticket. responses: '200': @@ -6128,11 +6128,11 @@ paths: type: error.list request_id: acd49599-522f-40f4-ae85-727c22d1c4b9 errors: - - code: intercom_version_invalid - message: Requested resource is not available in current API - version + - code: intercom_version_invalid + message: Requested resource is not available in current API + version schema: - '$ref': '#/components/schemas/ticket' + "$ref": "#/components/schemas/ticket" '400': description: Bad request content: @@ -6143,16 +6143,16 @@ paths: type: error.list request_id: 7c5227c5-ca92-4f20-ad67-ae2f21e48742 errors: - - code: intercom_version_invalid - message: Requested resource is not available in current API - version + - code: intercom_version_invalid + message: Requested resource is not available in current API + version 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 @@ -6162,35 +6162,35 @@ paths: summary: Bad request value: ticket_type_id: '766841' - '/data_attributes': + "/data_attributes": get: summary: List all data attributes parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: model - in: query - required: false - description: Specify the data attribute model to return. - schema: - type: string - enum: - - contact - - company - - conversation - example: company - - name: include_archived - in: query - required: false - description: Include archived attributes in the list. By default we return - only non archived data attributes. - example: false - schema: - type: boolean + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: model + in: query + required: false + description: Specify the data attribute model to return. + schema: + type: string + enum: + - contact + - company + - conversation + example: company + - name: include_archived + in: query + required: false + description: Include archived attributes in the list. By default we return + only non archived data attributes. + example: false + schema: + type: boolean tags: - - Data Attributes + - Data Attributes operationId: lisDataAttributes description: You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations. @@ -6204,206 +6204,206 @@ 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - custom: false - archived: false - model: company - - id: 188690 - 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 - custom: true - archived: false - admin_id: '991266484' - created_at: 1690374214 - updated_at: 1690374214 - 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 - 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 - 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 - 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 - 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 - custom: false - archived: false - model: company - schema: - '$ref': '#/components/schemas/data_attribute_list' + - 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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 + custom: false + archived: false + model: company + - id: 188690 + 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 + custom: true + archived: false + admin_id: '991266484' + created_at: 1690374214 + updated_at: 1690374214 + 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 + 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 + 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 + 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 + 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 + custom: false + archived: false + model: company + schema: + "$ref": "#/components/schemas/data_attribute_list" '401': description: Unauthorized content: @@ -6414,19 +6414,19 @@ paths: type: error.list request_id: 10bab719-f5d4-48a0-a334-3644e594494b 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 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: @@ -6452,7 +6452,7 @@ paths: updated_at: 1690374215 model: company schema: - '$ref': '#/components/schemas/data_attribute' + "$ref": "#/components/schemas/data_attribute" '400': description: Too few options for list content: @@ -6463,42 +6463,42 @@ paths: type: error.list request_id: 401723ae-1943-4d2d-bb92-2cd42e6d65e3 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: 17ec49e4-7db9-4fc6-9c54-381df2bfd22c 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: 7781f978-3f12-414f-b32c-8d898c2d3d22 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: 311f1b61-bfa5-49c6-a88e-d35b091038b7 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: e7ac4b29-513a-4fd5-acb3-f609690a5adc 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: @@ -6509,15 +6509,15 @@ paths: type: error.list request_id: ebad8626-7084-48fe-8806-c5e730c1bdf3 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 @@ -6534,7 +6534,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: @@ -6554,25 +6554,25 @@ paths: value: description: Just a plain old ring options: - - value: 1-10 + - value: 1-10 archived: false - '/data_attributes/{id}': + "/data_attributes/{id}": put: summary: Update a data attribute parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The data attribute id - example: 1 - schema: - type: integer + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The data attribute id + example: 1 + schema: + type: integer tags: - - Data Attributes + - Data Attributes operationId: updateDataAttribute description: "\nYou can update a data attribute.\n\n> \U0001F6A7 Updating the data type is not possible\n>\n> It is currently a dangerous action to execute @@ -6594,8 +6594,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 custom: true @@ -6605,7 +6605,7 @@ paths: updated_at: 1690374219 model: company schema: - '$ref': '#/components/schemas/data_attribute' + "$ref": "#/components/schemas/data_attribute" '400': description: Too few options in list content: @@ -6616,10 +6616,10 @@ paths: type: error.list request_id: 3facb48a-e8c2-4cc0-a0b2-8ec6e54f8177 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: @@ -6630,10 +6630,10 @@ paths: type: error.list request_id: ef0b2533-d327-43c9-8fe9-a64bcde5a297 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: @@ -6644,11 +6644,11 @@ paths: type: error.list request_id: fd84acb4-8ecd-490f-a3b6-a987df90ff40 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: @@ -6659,23 +6659,23 @@ paths: type: error.list request_id: 35d92c0b-2357-463e-b19b-8dce0a7a706d 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 @@ -6689,24 +6689,24 @@ 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 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: "\nYou will need an Access Token that has write permissions to send Events. Once you have a key you can submit events via POST to the Events @@ -6778,65 +6778,65 @@ paths: type: error.list request_id: ee6d2f3d-e7e2-4136-9148-8659077d8252 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: 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 @@ -6866,7 +6866,7 @@ paths: intercom_user_id: 64c1105535824d3e53560635 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 schema: - '$ref': '#/components/schemas/data_event_summary' + "$ref": "#/components/schemas/data_event_summary" '401': description: Unauthorized content: @@ -6877,20 +6877,20 @@ paths: type: error.list request_id: dac2483c-d34b-4e49-b3c7-aeca9284b069 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: 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 @@ -6908,25 +6908,25 @@ paths: type: error.list request_id: 1174a464-3859-4a46-a660-e987f0cd2d21 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 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: create data export 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 @@ -6955,34 +6955,34 @@ 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: 1690356231 created_at_before: 1690374231 - '/export/content/data/{job_identifier}': + "/export/content/data/{job_identifier}": get: summary: Show content data export parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: job_identifier - in: path - description: job_identifier - required: true - schema: - type: string + - 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: get data export 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}` @@ -7005,23 +7005,23 @@ 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 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: Cancel data export description: You can cancel your job responses: @@ -7037,23 +7037,23 @@ 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 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: Download data export 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: @@ -7064,16 +7064,16 @@ paths: responses: '200': description: successful - '/messages': + "/messages": post: summary: Create a message parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Messages + - Messages operationId: createMessage description: "You can create a message that has been initiated by an admin. The conversation can be either an in-app message or an email.\n\n> \U0001F6A7 @@ -7122,7 +7122,7 @@ paths: 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: @@ -7133,17 +7133,17 @@ paths: type: error.list request_id: 42cb5c2f-5e09-4604-84bf-daea5bf1d708 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: f7933177-29bc-432e-ab13-2f5bbf8f4b67 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: @@ -7154,10 +7154,10 @@ paths: type: error.list request_id: e8f68bab-bcd8-4817-83d8-21e0836e7819 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: @@ -7168,10 +7168,10 @@ paths: type: error.list request_id: 8d820e7e-69f5-42e3-a429-a0635de2b5c7 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: @@ -7182,15 +7182,15 @@ paths: type: error.list request_id: ce0d0db1-8b13-49f2-9e40-5830ba048f25 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 @@ -7254,16 +7254,16 @@ paths: message_type: email body: subject: heyy - '/news/news_items': + "/news/news_items": get: summary: List all news items parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - News + - News operationId: listNewsItems description: You can fetch a list of all news items responses: @@ -7281,45 +7281,45 @@ paths: total_pages: 1 type: pages data: - - id: '398556' - type: news-item - workspace_id: this_is_an_id449_that_should_be_at_least_ - title: We have news - body: '

Hello there,

' - sender_id: 991266532 - state: draft - labels: [] - cover_image_url: - reactions: - - - - - - - - - deliver_silently: false - created_at: 1690374271 - updated_at: 1690374271 - newsfeed_assignments: [] - - id: '398555' - type: news-item - workspace_id: this_is_an_id449_that_should_be_at_least_ - title: We have news - body: '

Hello there,

' - sender_id: 991266530 - state: draft - labels: [] - cover_image_url: - reactions: - - - - - - - - - deliver_silently: false - created_at: 1690374270 - updated_at: 1690374270 - newsfeed_assignments: [] + - id: '398556' + type: news-item + workspace_id: this_is_an_id449_that_should_be_at_least_ + title: We have news + body: "

Hello there,

" + sender_id: 991266532 + state: draft + labels: [] + cover_image_url: + reactions: + - + - + - + - + deliver_silently: false + created_at: 1690374271 + updated_at: 1690374271 + newsfeed_assignments: [] + - id: '398555' + type: news-item + workspace_id: this_is_an_id449_that_should_be_at_least_ + title: We have news + body: "

Hello there,

" + sender_id: 991266530 + state: draft + labels: [] + cover_image_url: + reactions: + - + - + - + - + deliver_silently: false + created_at: 1690374270 + updated_at: 1690374270 + newsfeed_assignments: [] total_count: 2 schema: - '$ref': '#/components/schemas/paginated_response' + "$ref": "#/components/schemas/paginated_response" '401': description: Unauthorized content: @@ -7330,19 +7330,19 @@ paths: type: error.list request_id: 5d86edcc-13e6-4515-ab13-cbe2e40c3c39 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 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: @@ -7357,25 +7357,25 @@ paths: type: news-item workspace_id: this_is_an_id453_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: 991266539 state: live labels: - - New - - Product - - Update + - New + - Product + - Update cover_image_url: reactions: - - "\U0001F606" - - "\U0001F605" + - "\U0001F606" + - "\U0001F605" deliver_silently: true created_at: 1690374273 updated_at: 1690374273 newsfeed_assignments: - - newsfeed_id: 403602 - published_at: 1664638214 + - newsfeed_id: 403602 + published_at: 1664638214 schema: - '$ref': '#/components/schemas/news_item' + "$ref": "#/components/schemas/news_item" '401': description: Unauthorized content: @@ -7386,51 +7386,51 @@ paths: type: error.list request_id: b644bc9a-63fd-4c95-8f68-d21851dda7a2 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: 991266539 deliver_silently: true reactions: - - "\U0001F606" - - "\U0001F605" + - "\U0001F606" + - "\U0001F605" state: live newsfeed_assignments: - - newsfeed_id: 403602 - published_at: 1664638214 - '/news/news_items/{id}': + - newsfeed_id: 403602 + published_at: 1664638214 + "/news/news_items/{id}": get: summary: Retrieve a news item parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The unique identifier for the news item which is given by Intercom. - example: 123 - schema: - type: integer + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the news item which is given by Intercom. + example: 123 + schema: + type: integer tags: - - News + - News operationId: retrieveNewsItem description: You can fetch the details of a single news item. responses: @@ -7445,24 +7445,24 @@ paths: type: news-item workspace_id: this_is_an_id457_that_should_be_at_least_ title: We have news - body: '

Hello there,

' + body: "

Hello there,

" sender_id: 991266542 state: live labels: [] cover_image_url: reactions: - - - - - - - - + - + - + - + - deliver_silently: false created_at: 1690374274 updated_at: 1690374274 newsfeed_assignments: - - newsfeed_id: 403604 - published_at: 1690374274 + - newsfeed_id: 403604 + published_at: 1690374274 schema: - '$ref': '#/components/schemas/news_item' + "$ref": "#/components/schemas/news_item" '404': description: News Item Not Found content: @@ -7473,10 +7473,10 @@ paths: type: error.list request_id: 92270b7d-fa93-4e2d-95b5-aa30470360cc 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: @@ -7487,26 +7487,26 @@ paths: type: error.list request_id: 46cf38be-1e2f-4d27-aa4b-48417015a4d5 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' + "$ref": "#/components/schemas/error" put: summary: Update a news item parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The unique identifier for the news item which is given by Intercom. - example: 123 - schema: - type: integer + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the news item which is given by Intercom. + example: 123 + schema: + type: integer tags: - - News + - News operationId: updateNewsItem responses: '200': @@ -7520,20 +7520,20 @@ paths: type: news-item workspace_id: this_is_an_id463_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: 991266550 state: live labels: [] cover_image_url: reactions: - - "\U0001F61D" - - "\U0001F602" + - "\U0001F61D" + - "\U0001F602" deliver_silently: false created_at: 1690374275 updated_at: 1690374276 newsfeed_assignments: [] schema: - '$ref': '#/components/schemas/news_item' + "$ref": "#/components/schemas/news_item" '404': description: News Item Not Found content: @@ -7544,10 +7544,10 @@ paths: type: error.list request_id: b436c8fe-eeab-4f51-b066-b31bce367146 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: @@ -7558,50 +7558,50 @@ paths: type: error.list request_id: b78d2134-a213-4250-895f-ac80303e9257 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: 991266550 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: 991266553 reactions: - - "\U0001F61D" - - "\U0001F602" + - "\U0001F61D" + - "\U0001F602" delete: summary: Delete a news item parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The unique identifier for the news item which is given by Intercom. - example: 123 - schema: - type: integer + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the news item which is given by Intercom. + example: 123 + schema: + type: integer tags: - - News + - News operationId: deleteNewsItem description: You can delete a single news item. responses: @@ -7616,7 +7616,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: @@ -7627,10 +7627,10 @@ paths: type: error.list request_id: 4b8d6efe-4725-4266-8e29-09bd876dae23 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: @@ -7641,28 +7641,28 @@ paths: type: error.list request_id: 9446d354-49ad-4158-8a93-a6a0cca8d66d 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: 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 @@ -7683,7 +7683,7 @@ paths: data: [] total_count: 0 schema: - '$ref': '#/components/schemas/paginated_response' + "$ref": "#/components/schemas/paginated_response" '401': description: Unauthorized content: @@ -7694,20 +7694,20 @@ paths: type: error.list request_id: c26dd516-ab2d-4b72-9c42-a0725be83128 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: 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: @@ -7725,19 +7725,19 @@ paths: total_pages: 1 type: pages data: - - id: '403617' - type: newsfeed - name: Visitor Feed - created_at: 1690374281 - updated_at: 1690374281 - - id: '403618' - type: newsfeed - name: Visitor Feed - created_at: 1690374281 - updated_at: 1690374281 + - id: '403617' + type: newsfeed + name: Visitor Feed + created_at: 1690374281 + updated_at: 1690374281 + - id: '403618' + type: newsfeed + name: Visitor Feed + created_at: 1690374281 + updated_at: 1690374281 total_count: 2 schema: - '$ref': '#/components/schemas/paginated_response' + "$ref": "#/components/schemas/paginated_response" '401': description: Unauthorized content: @@ -7748,28 +7748,28 @@ paths: type: error.list request_id: abee926b-cf83-4bfc-a8d5-89ca46ccb25c 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: 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: @@ -7786,7 +7786,7 @@ paths: created_at: 1690374282 updated_at: 1690374282 schema: - '$ref': '#/components/schemas/newsfeed' + "$ref": "#/components/schemas/newsfeed" '401': description: Unauthorized content: @@ -7797,27 +7797,27 @@ paths: type: error.list request_id: 5c12f64a-0be6-47fb-81fc-8020bf77e15e 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 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: @@ -7841,9 +7841,9 @@ paths: email: admin294@email.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: @@ -7854,10 +7854,10 @@ paths: type: error.list request_id: 76d30e65-7754-4a1d-a569-8e90f2011b35 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: @@ -7868,27 +7868,27 @@ paths: type: error.list request_id: 555c8afe-7873-41b5-8164-621df5ed2df4 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: 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: @@ -7901,20 +7901,20 @@ paths: value: type: segment.list segments: - - type: segment - id: 64c1109235824d3e535606a1 - name: John segment - created_at: 1690374290 - updated_at: 1690374290 - person_type: user - - type: segment - id: 64c1109235824d3e535606a2 - name: Jane segment - created_at: 1690374290 - updated_at: 1690374290 - person_type: user - schema: - '$ref': '#/components/schemas/segment_list' + - type: segment + id: 64c1109235824d3e535606a1 + name: John segment + created_at: 1690374290 + updated_at: 1690374290 + person_type: user + - type: segment + id: 64c1109235824d3e535606a2 + name: Jane segment + created_at: 1690374290 + updated_at: 1690374290 + person_type: user + schema: + "$ref": "#/components/schemas/segment_list" '401': description: Unauthorized content: @@ -7925,27 +7925,27 @@ paths: type: error.list request_id: 6ac1dafd-41b4-44c5-9bc3-266992d12b98 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 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: @@ -7963,7 +7963,7 @@ paths: updated_at: 1690374291 person_type: user schema: - '$ref': '#/components/schemas/segment' + "$ref": "#/components/schemas/segment" '404': description: Segment not found content: @@ -7974,10 +7974,10 @@ paths: type: error.list request_id: fe733399-9a4f-4a13-acae-a07ae500edc5 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: @@ -7988,20 +7988,20 @@ paths: type: error.list request_id: 6f17821a-389c-4595-90d7-9ffd6f95d179 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: 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. @@ -8015,22 +8015,22 @@ paths: value: type: list data: - - type: subscription - id: '440977' - 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: '440977' + 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: @@ -8041,20 +8041,20 @@ paths: type: error.list request_id: 5d952ac5-c13b-4b95-8c7e-58d49e0c225b 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: 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. @@ -8072,7 +8072,7 @@ paths: url: http://via.intercom.io/msgr/ae99d0b8-fb49-4d60-97cb-10ac80698af4 type: phone_call_redirect schema: - '$ref': '#/components/schemas/phone_switch' + "$ref": "#/components/schemas/phone_switch" '400': description: bad request - invalid number content: @@ -8104,54 +8104,54 @@ paths: type: error.list request_id: 4e4e7074-8959-46e8-a394-73cc5f3f1c31 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: 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: @@ -8164,11 +8164,11 @@ paths: value: type: list data: - - type: tag - id: '321903' - name: Manual tag 1 + - type: tag + id: '321903' + name: Manual tag 1 schema: - '$ref': '#/components/schemas/tag_list' + "$ref": "#/components/schemas/tag_list" '401': description: Unauthorized content: @@ -8179,19 +8179,19 @@ paths: type: error.list request_id: 4dc1c130-f1f7-4676-9cc8-82b0e6d8fb96 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: @@ -8219,7 +8219,7 @@ paths: id: '321906' name: test schema: - '$ref': '#/components/schemas/tag' + "$ref": "#/components/schemas/tag" '400': description: Invalid parameters content: @@ -8230,10 +8230,10 @@ paths: type: error.list request_id: 4df88224-d16f-43ce-a826-bab07dc86d20 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: @@ -8244,17 +8244,17 @@ paths: type: error.list request_id: b26f5145-d288-4a5e-9f86-192941ce2499 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: 94379e69-906f-441e-bd66-4cc3d4e676c7 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: @@ -8265,19 +8265,19 @@ paths: type: error.list request_id: 3f234a0b-07b3-432d-a7d6-baf1dbbe3ab4 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 @@ -8292,30 +8292,30 @@ paths: value: name: test companies: - - company_id: '123' + - company_id: '123' user_not_found: summary: User not found value: name: test users: - - id: '123' - '/tags/{id}': + - id: '123' + "/tags/{id}": get: summary: Find a specific tag parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - description: The unique identifier of a given tag - example: '123' - required: true - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: The unique identifier of a given tag + example: '123' + required: true + schema: + type: string tags: - - Tags + - Tags operationId: findTag description: | You can fetch the details of tags that are on the workspace by their id. @@ -8332,7 +8332,7 @@ paths: id: '321914' name: Manual tag schema: - '$ref': '#/components/schemas/tag' + "$ref": "#/components/schemas/tag" '404': description: Tag not found content: @@ -8343,10 +8343,10 @@ paths: type: error.list request_id: c3e5da49-bb0a-4608-94d7-65752e36e195 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: @@ -8357,26 +8357,26 @@ paths: type: error.list request_id: ca1bcdc5-5203-4568-9f65-f360a8a8cfb0 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' + "$ref": "#/components/schemas/error" delete: summary: Delete tag parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - description: The unique identifier of a given tag - example: '123' - required: true - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: The unique identifier of a given tag + example: '123' + required: true + schema: + type: string tags: - - Tags + - Tags operationId: deleteTag description: You can delete the details of tags that are on the workspace by passing in the id. @@ -8393,10 +8393,10 @@ paths: type: error.list request_id: 8aabb73d-de5d-42b5-9ac8-a76ad57d6e76 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: @@ -8407,11 +8407,11 @@ paths: type: error.list request_id: 71079c44-1cc4-4baa-8ba6-0be5ac6b40c6 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: @@ -8422,20 +8422,20 @@ paths: type: error.list request_id: f647da34-d6e2-4715-9b7e-18272094ba20 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: 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: @@ -8449,7 +8449,7 @@ paths: type: team.list teams: [] schema: - '$ref': '#/components/schemas/team_list' + "$ref": "#/components/schemas/team_list" '401': description: Unauthorized content: @@ -8460,27 +8460,27 @@ paths: type: error.list request_id: 8ab08168-4bd4-4f6a-8259-f79f4b5fe5c1 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 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. @@ -8497,7 +8497,7 @@ paths: name: team 1 admin_ids: [] schema: - '$ref': '#/components/schemas/team' + "$ref": "#/components/schemas/team" '404': description: Team not found content: @@ -8508,10 +8508,10 @@ paths: type: error.list request_id: 36540036-7184-446a-845c-fc5ebf73815e 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: @@ -8522,28 +8522,28 @@ paths: type: error.list request_id: f77eb2ad-ec91-4564-83c5-1bd4b57f6876 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' - '/tickets/{ticket_id}/tags': + "$ref": "#/components/schemas/error" + "/tickets/{ticket_id}/tags": post: summary: Add tag to a ticket parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: ticket_id - in: path - description: ticket_id - example: '64619700005694' - required: true - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: ticket_id + in: path + description: ticket_id + example: '64619700005694' + required: true + schema: + type: string tags: - - Tags - - Tickets + - Tags + - Tickets operationId: attachTagToTicket description: You can tag a specific ticket. This will return a tag object for the tag that was added to the ticket. @@ -8558,11 +8558,11 @@ paths: type: error.list request_id: 9431026c-ed1e-4f42-93e5-b0b6c4488258 errors: - - code: intercom_version_invalid - message: Requested resource is not available in current API - version + - code: intercom_version_invalid + message: Requested resource is not available in current API + version schema: - '$ref': '#/components/schemas/tag' + "$ref": "#/components/schemas/tag" '404': description: Ticket not found content: @@ -8573,11 +8573,11 @@ paths: type: error.list request_id: b12a1769-bd7a-4977-be13-819dc9a15501 errors: - - code: intercom_version_invalid - message: Requested resource is not available in current API - version + - code: intercom_version_invalid + message: Requested resource is not available in current API + version schema: - '$ref': '#/components/schemas/error' + "$ref": "#/components/schemas/error" '401': description: Unauthorized content: @@ -8588,18 +8588,18 @@ paths: type: error.list request_id: be6513d5-eb05-4d8f-a674-96b1227a3ec9 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 @@ -8622,31 +8622,31 @@ paths: value: id: 321923 admin_id: 991266642 - '/tickets/{ticket_id}/tags/{id}': + "/tickets/{ticket_id}/tags/{id}": delete: summary: Remove tag from a ticket parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: ticket_id - in: path - description: ticket_id - example: '64619700005694' - required: true - schema: - type: string - - name: id - in: path - description: The unique identifier for the tag which is given by Intercom - example: '7522907' - required: true - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: ticket_id + in: path + description: ticket_id + example: '64619700005694' + required: true + schema: + type: string + - name: id + in: path + description: The unique identifier for the tag which is given by Intercom + example: '7522907' + required: true + schema: + type: string tags: - - Tags - - Tickets + - Tags + - Tickets operationId: detachTagFromTicket description: You can remove tag from a specific ticket. This will return a tag object for the tag that was removed from the ticket. @@ -8661,11 +8661,11 @@ paths: type: error.list request_id: '09c1c488-c2bd-48e2-af63-bca8de254bce' errors: - - code: intercom_version_invalid - message: Requested resource is not available in current API - version + - code: intercom_version_invalid + message: Requested resource is not available in current API + version schema: - '$ref': '#/components/schemas/tag' + "$ref": "#/components/schemas/tag" '404': description: Tag not found content: @@ -8676,19 +8676,19 @@ paths: type: error.list request_id: '087294bc-4832-458f-8fe0-fa7bf7a8576c' errors: - - code: intercom_version_invalid - message: Requested resource is not available in current API - version + - code: intercom_version_invalid + message: Requested resource is not available in current API + version Tag not found: value: type: error.list request_id: 3b341038-3445-46c3-8418-c09556b729fd errors: - - code: intercom_version_invalid - message: Requested resource is not available in current API - version + - code: intercom_version_invalid + message: Requested resource is not available in current API + version schema: - '$ref': '#/components/schemas/error' + "$ref": "#/components/schemas/error" '401': description: Unauthorized content: @@ -8699,17 +8699,17 @@ paths: type: error.list request_id: fdbe4c5d-425c-40f8-9de2-3b3ce4ceee1f 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 @@ -8729,16 +8729,16 @@ paths: summary: Tag not found value: admin_id: 991266654 - '/visitors': + "/visitors": put: 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. @@ -8798,7 +8798,7 @@ paths: utm_term: do_not_track: schema: - '$ref': '#/components/schemas/visitor' + "$ref": "#/components/schemas/visitor" '404': description: visitor Not Found content: @@ -8809,10 +8809,10 @@ paths: type: error.list request_id: fb7c84c9-ced7-451c-81bd-35ea556c1ae9 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: @@ -8823,15 +8823,15 @@ paths: type: error.list request_id: 9b5a615e-ad04-4e26-8ab9-274f759ce301 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 @@ -8846,18 +8846,18 @@ paths: get: summary: Retrieve a visitor with User ID parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: user_id - in: query - description: The user_id of the Visitor you want to retrieve. - required: true - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: user_id + in: query + description: The user_id of the Visitor you want to retrieve. + required: true + schema: + type: string tags: - - Visitors + - Visitors operationId: retrieveVisitorWithUserId description: You can fetch the details of a single visitor. responses: @@ -8912,7 +8912,7 @@ paths: utm_term: do_not_track: schema: - '$ref': '#/components/schemas/visitor' + "$ref": "#/components/schemas/visitor" '404': description: Visitor not found content: @@ -8923,10 +8923,10 @@ paths: type: error.list request_id: 2eb0d113-fbec-4d1f-932f-ab5d99bad909 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: @@ -8937,27 +8937,27 @@ paths: type: error.list request_id: e6609a7d-6665-4963-8344-5a277898bfcf errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' - '/visitors/{id}': + "$ref": "#/components/schemas/error" + "/visitors/{id}": get: summary: Retrieve a visitor with ID parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: Id provided by Intercom. - example: 5e1c4c1c-7b1e-4b5d-8c1c-5e1c4c1c7b1e - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: Id provided by Intercom. + example: 5e1c4c1c-7b1e-4b5d-8c1c-5e1c4c1c7b1e + schema: + type: string tags: - - Visitors + - Visitors operationId: retrieveVisitor description: You can fetch the details of a single visitor. responses: @@ -9012,7 +9012,7 @@ paths: utm_term: do_not_track: schema: - '$ref': '#/components/schemas/visitor' + "$ref": "#/components/schemas/visitor" '404': description: Visitor not found content: @@ -9023,10 +9023,10 @@ paths: type: error.list request_id: 902112d2-8908-4024-bfd5-c75163318d55 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: @@ -9037,26 +9037,26 @@ paths: type: error.list request_id: 3c554769-709f-4e64-bc25-3dadf329fe20 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' + "$ref": "#/components/schemas/error" delete: summary: Delete a visitor parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: Id provided by Intercom. - example: 5e1c4c1c-7b1e-4b5d-8c1c-5e1c4c1c7b1e - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: Id provided by Intercom. + example: 5e1c4c1c-7b1e-4b5d-8c1c-5e1c4c1c7b1e + schema: + type: string tags: - - Visitors + - Visitors operationId: deleteVisitor description: You can delete a single visitor. responses: @@ -9111,7 +9111,7 @@ paths: utm_term: do_not_track: schema: - '$ref': '#/components/schemas/visitor_deleted_object' + "$ref": "#/components/schemas/visitor_deleted_object" '404': description: Visitor Not Found content: @@ -9122,10 +9122,10 @@ paths: type: error.list request_id: d1c2faa1-a4cc-4fa1-820b-40b868c2cf0d 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: @@ -9136,20 +9136,20 @@ paths: type: error.list request_id: a0c4e999-c672-4283-9d2e-19d23dfe23c1 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: 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 @@ -9208,7 +9208,7 @@ paths: utm_term: do_not_track: schema: - '$ref': '#/components/schemas/contact' + "$ref": "#/components/schemas/contact" '401': description: Unauthorized content: @@ -9219,15 +9219,15 @@ paths: type: error.list request_id: 3f71a03e-8a76-42fc-9b01-c232c70a2d56 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 @@ -9280,73 +9280,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 @@ -9363,12 +9363,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" addressable_list: title: Addressable List type: object @@ -9388,7 +9388,7 @@ 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 @@ -9435,7 +9435,7 @@ components: type: array description: This object represents the avatar associated with the admin. example: - - 814865 + - 814865 items: type: integer avatar: @@ -9458,7 +9458,7 @@ components: type: array description: A list of admins associated with a given workspace. items: - '$ref': '#/components/schemas/admin' + "$ref": "#/components/schemas/admin" admin_reply_conversation_request: title: Admin Reply type: object @@ -9467,12 +9467,12 @@ components: message_type: type: string enum: - - comment - - note + - comment + - note type: type: string enum: - - admin + - admin example: admin body: type: string @@ -9492,9 +9492,9 @@ components: format: uri maxItems: 5 required: - - message_type - - type - - admin_id + - message_type + - type + - admin_id admin_reply_ticket_request: title: Admin Reply on ticket type: object @@ -9503,14 +9503,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 @@ -9540,8 +9540,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 @@ -9551,9 +9551,9 @@ components: format: uri maxItems: 5 required: - - message_type - - type - - admin_id + - message_type + - type + - admin_id admin_with_app: title: Admin type: object @@ -9600,7 +9600,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: @@ -9625,7 +9625,7 @@ components: nullable: true example: true app: - '$ref': '#/components/schemas/app' + "$ref": "#/components/schemas/app" nullable: true description: App that the admin belongs to. app: @@ -9675,7 +9675,7 @@ components: type: string description: The type of object - `article`. enum: - - article + - article default: article example: article id: @@ -9714,8 +9714,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: @@ -9755,10 +9755,10 @@ components: example: en translated_content: nullable: true - '$ref': '#/components/schemas/article_translated_content' + "$ref": "#/components/schemas/article_translated_content" statistics: nullable: true - '$ref': '#/components/schemas/article_statistics' + "$ref": "#/components/schemas/article_statistics" article_content: title: Article Content type: object @@ -9769,8 +9769,8 @@ components: type: string description: The type of object - `article_content` . enum: - - - - article_content + - + - article_content example: article_content title: type: string @@ -9792,8 +9792,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 @@ -9818,10 +9818,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. @@ -9830,7 +9830,7 @@ components: type: array description: An array of Article objects items: - '$ref': '#/components/schemas/article' + "$ref": "#/components/schemas/article" article_statistics: title: Article Statistics type: object @@ -9841,7 +9841,7 @@ components: type: string description: The type of object - `article_statistics`. enum: - - article_statistics + - article_statistics default: article_statistics example: article_statistics views: @@ -9882,120 +9882,120 @@ components: type: string description: The type of object - article_translated_content. enum: - - - - article_translated_content + - + - article_translated_content example: article_translated_content 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 @@ -10004,13 +10004,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 @@ -10028,10 +10028,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 @@ -10044,38 +10044,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 @@ -10084,12 +10084,12 @@ components: message_type: type: string enum: - - close + - close example: close type: type: string enum: - - admin + - admin example: admin admin_id: type: string @@ -10099,11 +10099,11 @@ 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 @@ -10168,12 +10168,12 @@ components: example: en translated_content: nullable: true - '$ref': '#/components/schemas/group_translated_content' + "$ref": "#/components/schemas/group_translated_content" type: type: string description: The type of object - `collection`. enum: - - collection + - collection default: collection example: collection collection_list: @@ -10185,10 +10185,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. @@ -10197,7 +10197,7 @@ components: type: array description: An array of collection objects items: - '$ref': '#/components/schemas/collection' + "$ref": "#/components/schemas/collection" company: title: Company type: object @@ -10210,7 +10210,7 @@ components: type: string description: Value is `company` enum: - - company + - company example: company id: type: string @@ -10301,12 +10301,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 @@ -10315,11 +10315,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 @@ -10329,19 +10329,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 @@ -10351,13 +10351,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: Companys type: object @@ -10367,10 +10367,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. @@ -10379,7 +10379,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 @@ -10392,14 +10392,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 @@ -10447,12 +10447,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 @@ -10479,52 +10479,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 @@ -10581,8 +10581,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 @@ -10613,7 +10613,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 @@ -10633,15 +10633,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 @@ -10651,7 +10651,7 @@ components: type: string description: always contact enum: - - contact + - contact example: contact id: type: string @@ -10676,19 +10676,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 @@ -10700,7 +10700,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 @@ -10720,7 +10720,7 @@ components: type: string description: always contact enum: - - contact + - contact example: contact id: type: string @@ -10745,19 +10745,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 @@ -10795,12 +10795,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 @@ -10820,7 +10820,7 @@ components: type: string description: always contact enum: - - contact + - contact example: contact id: type: string @@ -10835,201 +10835,201 @@ components: contact_reply_conversation_request: title: Contact Reply oneOf: - - title: Intercom User ID - type: object - description: Payload of the request to reply on behalf of a contact using - their `intercom_user_id` - properties: - message_type: - type: string - enum: - - comment - type: - type: string - enum: - - user - body: - type: string - description: The text body of the comment. - intercom_user_id: - type: string - description: The identifier for the contact as given by Intercom. - attachment_urls: - type: array - description: A list of image URLs that will be added as attachments. You - can include up to 5 URLs. - items: - type: string - format: uri - maxItems: 5 - required: - - message_type - - type - - body - - intercom_user_id - - title: User ID - type: object - description: Payload of the request to reply on behalf of a contact using - their `user_id` - properties: - message_type: - type: string - enum: - - comment - type: - type: string - enum: - - user - body: - type: string - description: The text body of the comment. - user_id: - type: string - description: The external_id you have defined for the contact. - attachment_urls: - type: array - description: A list of image URLs that will be added as attachments. You - can include up to 5 URLs. - items: - type: string - format: uri - maxItems: 5 - required: - - message_type - - type - - body - - user_id - - title: Email - type: object - description: Payload of the request to reply on behalf of a contact using - their `email` - properties: - message_type: - type: string - enum: - - comment - type: + - title: Intercom User ID + type: object + description: Payload of the request to reply on behalf of a contact using + their `intercom_user_id` + properties: + message_type: + type: string + enum: + - comment + type: + type: string + enum: + - user + body: + type: string + description: The text body of the comment. + intercom_user_id: + type: string + description: The identifier for the contact as given by Intercom. + attachment_urls: + type: array + description: A list of image URLs that will be added as attachments. You + can include up to 5 URLs. + items: type: string - enum: - - user - body: + format: uri + maxItems: 5 + required: + - message_type + - type + - body + - intercom_user_id + - title: User ID + type: object + description: Payload of the request to reply on behalf of a contact using + their `user_id` + properties: + message_type: + type: string + enum: + - comment + type: + type: string + enum: + - user + body: + type: string + description: The text body of the comment. + user_id: + type: string + description: The external_id you have defined for the contact. + attachment_urls: + type: array + description: A list of image URLs that will be added as attachments. You + can include up to 5 URLs. + items: type: string - description: The text body of the comment. - email: + format: uri + maxItems: 5 + required: + - message_type + - type + - body + - user_id + - title: Email + type: object + description: Payload of the request to reply on behalf of a contact using + their `email` + properties: + message_type: + type: string + enum: + - comment + type: + type: string + enum: + - user + body: + type: string + description: The text body of the comment. + email: + type: string + description: The email you have defined for the user. + attachment_urls: + type: array + description: A list of image URLs that will be added as attachments. You + can include up to 5 URLs. + items: type: string - description: The email you have defined for the user. - attachment_urls: - type: array - description: A list of image URLs that will be added as attachments. You - can include up to 5 URLs. - items: - type: string - format: uri - maxItems: 5 - required: - - message_type - - type - - body - - email + format: uri + maxItems: 5 + required: + - message_type + - type + - body + - email contact_reply_ticket_request: title: Contact Reply on ticket oneOf: - - title: Intercom User ID - type: object - description: Payload of the request to reply on behalf of a contact using - their `intercom_user_id` - properties: - message_type: - type: string - enum: - - comment - type: - type: string - enum: - - user - body: - type: string - description: The text body of the comment. - intercom_user_id: - type: string - description: The identifier for the contact as given by Intercom. - attachment_urls: - type: array - description: A list of image URLs that will be added as attachments. You - can include up to 5 URLs. - items: - type: string - format: uri - maxItems: 5 - required: - - message_type - - type - - body - - intercom_user_id - - title: User ID - type: object - description: Payload of the request to reply on behalf of a contact using - their `user_id` - properties: - message_type: - type: string - enum: - - comment - type: - type: string - enum: - - user - body: - type: string - description: The text body of the comment. - user_id: - type: string - description: The external_id you have defined for the contact. - attachment_urls: - type: array - description: A list of image URLs that will be added as attachments. You - can include up to 5 URLs. - items: - type: string - format: uri - maxItems: 5 - required: - - message_type - - type - - body - - user_id - - title: Email - type: object - description: Payload of the request to reply on behalf of a contact using - their `email` - properties: - message_type: - type: string - enum: - - comment - type: + - title: Intercom User ID + type: object + description: Payload of the request to reply on behalf of a contact using + their `intercom_user_id` + properties: + message_type: + type: string + enum: + - comment + type: + type: string + enum: + - user + body: + type: string + description: The text body of the comment. + intercom_user_id: + type: string + description: The identifier for the contact as given by Intercom. + attachment_urls: + type: array + description: A list of image URLs that will be added as attachments. You + can include up to 5 URLs. + items: type: string - enum: - - user - body: + format: uri + maxItems: 5 + required: + - message_type + - type + - body + - intercom_user_id + - title: User ID + type: object + description: Payload of the request to reply on behalf of a contact using + their `user_id` + properties: + message_type: + type: string + enum: + - comment + type: + type: string + enum: + - user + body: + type: string + description: The text body of the comment. + user_id: + type: string + description: The external_id you have defined for the contact. + attachment_urls: + type: array + description: A list of image URLs that will be added as attachments. You + can include up to 5 URLs. + items: type: string - description: The text body of the comment. - email: + format: uri + maxItems: 5 + required: + - message_type + - type + - body + - user_id + - title: Email + type: object + description: Payload of the request to reply on behalf of a contact using + their `email` + properties: + message_type: + type: string + enum: + - comment + type: + type: string + enum: + - user + body: + type: string + description: The text body of the comment. + email: + type: string + description: The email you have defined for the user. + attachment_urls: + type: array + description: A list of image URLs that will be added as attachments. You + can include up to 5 URLs. + items: type: string - description: The email you have defined for the user. - attachment_urls: - type: array - description: A list of image URLs that will be added as attachments. You - can include up to 5 URLs. - items: - type: string - format: uri - maxItems: 5 - required: - - message_type - - type - - body - - email + format: uri + maxItems: 5 + required: + - message_type + - type + - body + - email contact_segments: title: Segments type: object @@ -11039,13 +11039,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 @@ -11056,7 +11056,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 @@ -11068,12 +11068,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 @@ -11095,12 +11095,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 @@ -11120,7 +11120,7 @@ components: type: string description: always contact enum: - - contact + - contact example: contact id: type: string @@ -11190,9 +11190,9 @@ components: state: type: string enum: - - open - - closed - - snoozed + - open + - closed + - snoozed description: Can be set to "open", "closed" or "snoozed". example: open read: @@ -11202,8 +11202,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: @@ -11219,25 +11219,25 @@ 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" conversation_contacts: title: Contacts type: object @@ -11249,7 +11249,7 @@ components: type: string description: '' enum: - - contact.list + - contact.list example: contact.list contacts: type: array @@ -11257,7 +11257,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_first_contact_reply: title: First contact reply type: object @@ -11290,19 +11290,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 @@ -11325,7 +11325,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 @@ -11342,18 +11342,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 @@ -11398,7 +11398,7 @@ components: type: string description: '' enum: - - conversation_part.list + - conversation_part.list example: conversation_part.list conversation_parts: title: Conversation Parts @@ -11407,7 +11407,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: '' @@ -11435,9 +11435,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_source: title: Conversation source type: object @@ -11469,14 +11469,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 @@ -11602,7 +11602,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 @@ -11614,9 +11614,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 @@ -11646,10 +11646,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. @@ -11668,16 +11668,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 @@ -11698,7 +11698,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, @@ -11711,8 +11711,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 @@ -11724,10 +11724,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 @@ -11745,9 +11745,9 @@ components: example: English description translated_content: nullable: true - '$ref': '#/components/schemas/group_translated_content' + "$ref": "#/components/schemas/group_translated_content" required: - - name + - name create_contact_request: description: Payload to create a contact type: object @@ -11767,7 +11767,7 @@ components: type: string nullable: true description: The contacts phone - example: '+353871234567' + example: "+353871234567" name: type: string nullable: true @@ -11807,15 +11807,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_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 @@ -11829,9 +11829,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: @@ -11842,15 +11842,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 @@ -11864,20 +11864,20 @@ components: type: string description: The model that the data attribute belongs to. enum: - - contact - - company - - conversation + - contact + - company + - conversation 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 @@ -11890,12 +11890,12 @@ components: items: type: string example: - - option1 - - option2 + - option1 + - option2 required: - - name - - model - - data_type + - name + - model + - data_type create_data_event_request: description: '' type: object @@ -11934,21 +11934,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 @@ -12004,8 +12004,8 @@ components: as a unix timestamp. example: 1527811200 required: - - created_at_after - - created_at_before + - created_at_after + - created_at_before create_message_request: description: You can create a message type: object @@ -12016,8 +12016,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 @@ -12041,15 +12041,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 @@ -12059,16 +12059,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 create_conversation_without_contact_reply: type: boolean description: Whether a conversation should be opened in the inbox for the @@ -12076,20 +12076,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 @@ -12158,7 +12158,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 @@ -12169,11 +12169,11 @@ 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_section_request: description: You can create a Section type: object @@ -12190,16 +12190,16 @@ components: example: 18 translated_content: nullable: true - '$ref': '#/components/schemas/group_translated_content' + "$ref": "#/components/schemas/group_translated_content" required: - - name - - parent_id + - name + - parent_id create_ticket_reply_request: title: Create Ticket Reply Request Payload description: You can create a reply on a ticket. 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" cursor_pages: title: Cursor based pages type: object @@ -12213,13 +12213,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 @@ -12236,8 +12236,8 @@ 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 @@ -12266,32 +12266,32 @@ 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 @@ -12305,7 +12305,7 @@ components: type: string description: Value is `data_attribute`. enum: - - data_attribute + - data_attribute example: data_attribute id: type: integer @@ -12317,9 +12317,9 @@ components: description: Value is `contact` for user/lead attributes, `company` for company attributes and `conversation` for conversation attributes.. enum: - - contact - - company - - conversation + - contact + - company + - conversation example: contact name: type: string @@ -12343,11 +12343,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 @@ -12355,8 +12355,8 @@ components: items: type: string example: - - 'true' - - 'false' + - 'true' + - 'false' api_writable: type: boolean description: Can this attribute be updated through API @@ -12397,13 +12397,13 @@ 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 @@ -12414,7 +12414,7 @@ components: type: string description: The type of the object enum: - - event + - event example: event event_name: type: string @@ -12453,8 +12453,8 @@ components: example: invite_code: ADDAFRIEND required: - - event_name - - created_at + - event_name + - created_at data_event_list: title: Data Event List type: object @@ -12464,13 +12464,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 @@ -12490,7 +12490,7 @@ components: type: string description: The type of the object enum: - - event.summary + - event.summary example: event.summary email: type: string @@ -12508,7 +12508,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 @@ -12549,12 +12549,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: @@ -12675,7 +12675,7 @@ components: type: string description: The type of object which was deleted. - article enum: - - article + - article example: article deleted: type: boolean @@ -12695,7 +12695,7 @@ components: type: string description: The type of object which was deleted. - `collection` enum: - - collection + - collection example: collection deleted: type: boolean @@ -12714,7 +12714,7 @@ components: type: string description: The type of object which was deleted. - `company` enum: - - company + - company example: company deleted: type: boolean @@ -12734,7 +12734,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 @@ -12754,7 +12754,7 @@ components: type: string description: The type of object which was deleted. - `section` enum: - - section + - section example: section deleted: type: boolean @@ -12767,7 +12767,7 @@ components: description: The `id` of the admin who is performing the action. example: '5017690' required: - - admin_id + - admin_id error: type: object title: Error @@ -12806,10 +12806,10 @@ components: parameter that was in error. example: email required: - - code + - code required: - - type - - errors + - type + - errors file_attribute: title: File type: object @@ -12853,8 +12853,8 @@ components: type: string description: The type of object - `group_content` . enum: - - - - group_content + - + - group_content example: group_content name: type: string @@ -12863,7 +12863,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 @@ -12876,120 +12876,120 @@ 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" intercom_version: description: Intercom API version.
By default, it's equal to the version set in the app package. @@ -12997,22 +12997,22 @@ components: example: Unstable default: '2.9' 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' - - 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' + - Unstable merge_contacts_request: description: Merge contact data. type: object @@ -13060,10 +13060,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 @@ -13072,33 +13072,33 @@ 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: type: object properties: 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 @@ -13110,7 +13110,7 @@ components: type: string description: The type of object. enum: - - news-item + - news-item example: news-item id: type: string @@ -13140,14 +13140,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. @@ -13199,7 +13199,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 @@ -13210,8 +13210,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 @@ -13224,9 +13224,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, @@ -13235,16 +13235,16 @@ 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 @@ -13262,7 +13262,7 @@ components: type: string description: The type of object. enum: - - newsfeed + - newsfeed example: newsfeed name: type: string @@ -13333,12 +13333,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 @@ -13353,13 +13353,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 @@ -13368,15 +13368,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 @@ -13389,7 +13389,7 @@ components: type: string example: pages enum: - - pages + - pages page: type: integer example: 1 @@ -13414,11 +13414,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. @@ -13428,8 +13428,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 @@ -13473,60 +13473,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 @@ -13543,8 +13543,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 @@ -13552,14 +13552,14 @@ 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 section: title: Section type: object @@ -13571,7 +13571,7 @@ components: type: string description: The type of object - `section`. enum: - - section + - section default: section example: section id: @@ -13619,10 +13619,10 @@ components: example: '1' parent_id: oneOf: - - type: integer - title: Integer - - type: string - title: String + - type: integer + title: Integer + - type: string + title: String description: The id of the parent section. example: 6871119 default_locale: @@ -13632,7 +13632,7 @@ components: example: en translated_content: nullable: true - '$ref': '#/components/schemas/group_translated_content' + "$ref": "#/components/schemas/group_translated_content" section_list: title: Sections type: object @@ -13642,10 +13642,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 sections. @@ -13654,7 +13654,7 @@ components: type: array description: An array of section objects items: - '$ref': '#/components/schemas/section' + "$ref": "#/components/schemas/section" segment: title: Segment type: object @@ -13666,7 +13666,7 @@ components: type: string description: The type of object. enum: - - segment + - segment example: segment id: type: string @@ -13688,8 +13688,8 @@ components: type: string description: 'Type of the contact: contact (lead) or user.' enum: - - contact - - user + - contact + - user example: contact count: type: integer @@ -13707,13 +13707,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 @@ -13728,18 +13728,18 @@ components: operator: type: string enum: - - '=' - - '!=' - - IN - - NIN - - '<' - - '>' - - '~' - - '!~' - - '^' - - '$' + - "=" + - "!=" + - IN + - NIN + - "<" + - ">" + - "~" + - "!~" + - "^" + - "$" description: The Intercom defined id representing the company. - example: '=' + example: "=" value: type: string description: The Intercom defined id representing the company. @@ -13763,10 +13763,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. @@ -13781,7 +13781,7 @@ components: message_type: type: string enum: - - snoozed + - snoozed example: snoozed admin_id: type: string @@ -13793,9 +13793,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 @@ -13845,25 +13845,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 @@ -13872,8 +13872,8 @@ components: items: type: string enum: - - email - - sms_message + - email + - sms_message example: email subscription_type_list: title: Subscription Types @@ -13884,14 +13884,14 @@ 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 @@ -13917,7 +13917,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 @@ -13942,8 +13942,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 @@ -13953,13 +13953,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 @@ -13978,8 +13978,8 @@ components: description: The Intercom defined id representing the user. example: 5f7f0d217289f8d2f4262080 required: - - name - - users + - name + - users tags: title: Tags type: object @@ -13989,13 +13989,13 @@ 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 @@ -14018,7 +14018,7 @@ components: type: array description: The list of admin IDs that are a part of the team. example: - - 493881 + - 493881 items: type: integer team_list: @@ -14030,13 +14030,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" ticket_reply: title: A Ticket Part representing a note, comment, or quick_reply on a ticket type: object @@ -14048,7 +14048,7 @@ components: description: Always ticket_part example: ticket_part enum: - - ticket_part + - ticket_part id: type: string description: The id representing the part. @@ -14058,14 +14058,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 @@ -14077,13 +14077,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. @@ -14135,8 +14135,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 @@ -14157,7 +14157,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, @@ -14170,8 +14170,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 @@ -14183,7 +14183,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 @@ -14201,7 +14201,7 @@ components: example: English description translated_content: nullable: true - '$ref': '#/components/schemas/group_translated_content' + "$ref": "#/components/schemas/group_translated_content" update_contact_request: description: You can update a contact type: object @@ -14221,7 +14221,7 @@ components: type: string nullable: true description: The contacts phone - example: '+353871234567' + example: "+353871234567" name: type: string nullable: true @@ -14270,7 +14270,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 @@ -14291,8 +14291,8 @@ components: items: type: string example: - - option1 - - option2 + - option1 + - option2 update_section_request: description: You can update a Section type: object @@ -14309,7 +14309,7 @@ components: example: 18 translated_content: nullable: true - '$ref': '#/components/schemas/group_translated_content' + "$ref": "#/components/schemas/group_translated_content" update_ticket_type_attribute_request: description: You can update a Ticket Type Attribute type: object @@ -14389,9 +14389,9 @@ components: type: string description: Category of the Ticket Type. enum: - - Customer - - Back-office - - Tracker + - Customer + - Back-office + - Tracker example: Customer icon: type: string @@ -14436,10 +14436,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 @@ -14511,12 +14511,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: @@ -14584,7 +14584,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 @@ -14614,7 +14614,7 @@ components: type: string description: The type of the object enum: - - tag.list + - tag.list example: tag.list tags: type: array @@ -14624,7 +14624,7 @@ components: type: string description: The type of the object enum: - - tag + - tag example: tag id: type: string @@ -14641,7 +14641,7 @@ components: type: string description: The type of the object enum: - - segment.list + - segment.list example: segment.list segments: type: array @@ -14700,7 +14700,7 @@ components: type: string description: The type of object which was deleted enum: - - visitor + - visitor example: visitor user_id: type: string @@ -14711,61 +14711,61 @@ 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: Articles - description: Everything about your Articles - - name: Companies - description: Everything about your Companies - - name: Contacts - description: Everything about your contacts - - name: Conversations - description: Everything about your Conversations - externalDocs: - description: What is a conversation? - url: https://www.intercom.com/help/en/articles/4323904-what-is-a-conversation - - name: Data Attributes - description: Everything about your Data Attributes - - name: Data Events - description: Everything about your Data Events - - name: Data Export - description: Everything about your Data Exports - - name: Help Center - description: Everything about your Help Center - - name: Messages - description: Everything about your messages - - name: News - description: Everything about your News - externalDocs: - description: News explained - url: https://www.intercom.com/help/en/articles/6362251-news-explained - - name: Notes - description: Everything about your Notes - - name: Segments - description: Everything about your Segments - - name: Subscription Types - description: Everything about subscription types - - name: Switch - description: Everything about Switch - externalDocs: - description: 'Meet Switch: from on hold to messaging in just a few taps' - url: https://www.intercom.com/switch - - name: Tags - description: Everything about tags - - name: Teams - description: Everything about your Teams - - name: Ticket Type Attributes - description: Everything about your ticket type attributes - - name: Ticket Types - description: Everything about your ticket types - - name: Visitors - description: Everything about your Visitors +- name: Admins + description: Everything about your Admins +- name: Articles + description: Everything about your Articles +- name: Companies + description: Everything about your Companies +- name: Contacts + description: Everything about your contacts +- name: Conversations + description: Everything about your Conversations + externalDocs: + description: What is a conversation? + url: https://www.intercom.com/help/en/articles/4323904-what-is-a-conversation +- name: Data Attributes + description: Everything about your Data Attributes +- name: Data Events + description: Everything about your Data Events +- name: Data Export + description: Everything about your Data Exports +- name: Help Center + description: Everything about your Help Center +- name: Messages + description: Everything about your messages +- name: News + description: Everything about your News + externalDocs: + description: News explained + url: https://www.intercom.com/help/en/articles/6362251-news-explained +- name: Notes + description: Everything about your Notes +- name: Segments + description: Everything about your Segments +- name: Subscription Types + description: Everything about subscription types +- name: Switch + description: Everything about Switch + externalDocs: + description: 'Meet Switch: from on hold to messaging in just a few taps' + url: https://www.intercom.com/switch +- name: Tags + description: Everything about tags +- name: Teams + description: Everything about your Teams +- name: Ticket Type Attributes + description: Everything about your ticket type attributes +- name: Ticket Types + description: Everything about your ticket types +- name: Visitors + description: Everything about your Visitors diff --git a/descriptions/2.8/api.intercom.io.yaml b/descriptions/2.8/api.intercom.io.yaml index 790f773..038a977 100644 --- a/descriptions/2.8/api.intercom.io.yaml +++ b/descriptions/2.8/api.intercom.io.yaml @@ -11,16 +11,16 @@ info: name: MIT url: https://spdx.org/licenses/MIT paths: - '/me': + "/me": get: 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 @@ -55,23 +55,23 @@ 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": 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. responses: @@ -91,7 +91,7 @@ paths: has_inbox_seat: true team_ids: [] schema: - '$ref': '#/components/schemas/admin' + "$ref": "#/components/schemas/admin" '404': description: Admin not found content: @@ -102,10 +102,10 @@ paths: type: error.list request_id: 55bf18b1-9cf3-4cf1-9475-adeadbc268fd 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 +116,18 @@ paths: type: error.list request_id: 25d00a32-2f4a-4a42-8028-c1a55fc2279a 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 +157,32 @@ paths: value: away_mode_enabled: true away_mode_reassign: true - '/admins/activity_logs': + "/admins/activity_logs": 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 +201,38 @@ paths: per_page: 20 total_pages: 1 activity_logs: - - id: 4601bc04-8d79-449f-ae06-8f976765baf5 - performed_by: - type: admin - id: '991266219' - email: admin5@email.com - ip: 127.0.0.1 - metadata: - before: before - after: after - created_at: 1690375196 - activity_type: app_name_change - activity_description: Ciaran5 Lee changed your app name from - before to after. - - id: 7d86afa6-1e82-4e5b-8d2c-5c0d71d664cb - performed_by: - type: admin - id: '991266219' - 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: 1690375196 - 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: 4601bc04-8d79-449f-ae06-8f976765baf5 + performed_by: + type: admin + id: '991266219' + email: admin5@email.com + ip: 127.0.0.1 + metadata: + before: before + after: after + created_at: 1690375196 + activity_type: app_name_change + activity_description: Ciaran5 Lee changed your app name from + before to after. + - id: 7d86afa6-1e82-4e5b-8d2c-5c0d71d664cb + performed_by: + type: admin + id: '991266219' + 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: 1690375196 + 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" '401': description: Unauthorized content: @@ -243,20 +243,20 @@ paths: type: error.list request_id: 54996bee-89f3-4eb1-a42b-f44a8b8e590f errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' - '/admins': + "$ref": "#/components/schemas/error" + "/admins": 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 +269,16 @@ paths: value: type: admin.list admins: - - type: admin - email: admin7@email.com - id: '991266222' - name: Ciaran7 Lee - away_mode_enabled: false - away_mode_reassign: false - has_inbox_seat: true - team_ids: [] + - type: admin + email: admin7@email.com + id: '991266222' + name: Ciaran7 Lee + away_mode_enabled: false + away_mode_reassign: false + has_inbox_seat: true + team_ids: [] schema: - '$ref': '#/components/schemas/admin_list' + "$ref": "#/components/schemas/admin_list" '401': description: Unauthorized content: @@ -289,27 +289,27 @@ paths: type: error.list request_id: 4a00f9b6-72dd-42cc-af25-8fbd98e4e0df errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' - '/admins/{id}': + "$ref": "#/components/schemas/error" + "/admins/{id}": get: summary: Retrieve 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: 123 + schema: + type: integer tags: - - Admins + - Admins operationId: retrieveAdmin description: You can retrieve the details of a single admin. responses: @@ -329,7 +329,7 @@ paths: has_inbox_seat: true team_ids: [] schema: - '$ref': '#/components/schemas/admin' + "$ref": "#/components/schemas/admin" '404': description: Admin not found content: @@ -340,10 +340,10 @@ paths: type: error.list request_id: 67a10013-1285-4517-8346-fc272fb00a1a 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 +354,20 @@ paths: type: error.list request_id: bf25b774-b8e6-4b16-afcf-556cdb78b8af errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' - '/articles': + "$ref": "#/components/schemas/error" + "/articles": get: summary: List all articles parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Articles + - Articles operationId: listArticles description: "You can fetch a list of all articles by making a GET request to `https://api.intercom.io/articles`.\n\n> \U0001F4D8 How are the articles sorted @@ -390,21 +390,21 @@ paths: total_pages: 1 total_count: 1 data: - - id: '92828' - type: article - workspace_id: this_is_an_id22_that_should_be_at_least_4 - parent_id: 87783 - parent_type: collection - title: This is the article title - description: '' - body: '' - author_id: 991266227 - state: published - created_at: 1690375201 - updated_at: 1690375201 - url: http://help-center.test/myapp-22/en/articles/92828-this-is-the-article-title - schema: - '$ref': '#/components/schemas/article_list' + - id: '92828' + type: article + workspace_id: this_is_an_id22_that_should_be_at_least_4 + parent_id: 87783 + parent_type: collection + title: This is the article title + description: '' + body: '' + author_id: 991266227 + state: published + created_at: 1690375201 + updated_at: 1690375201 + url: http://help-center.test/myapp-22/en/articles/92828-this-is-the-article-title + schema: + "$ref": "#/components/schemas/article_list" '401': description: Unauthorized content: @@ -415,19 +415,19 @@ paths: type: error.list request_id: 283bfc99-ef85-45ae-929f-c65447ade265 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 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: @@ -460,7 +460,7 @@ paths: updated_at: 1690375203 url: http://help-center.test/myapp-26/en/articles/92831-thanks-for-everything schema: - '$ref': '#/components/schemas/article' + "$ref": "#/components/schemas/article" '400': description: Bad Request content: @@ -471,11 +471,11 @@ paths: type: error.list request_id: 2d88c894-a4ea-4d0a-b353-fbef5d36f587 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: @@ -486,15 +486,15 @@ paths: type: error.list request_id: 9714687f-8da3-4145-8040-0882e065e109 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 @@ -520,23 +520,23 @@ paths: description: Description of the Article body: Body of the Article state: published - '/articles/{id}': + "/articles/{id}": get: summary: Retrieve an article parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The unique identifier for the article which is given by Intercom. - example: 123 - schema: - type: integer + - 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/`. @@ -570,7 +570,7 @@ paths: updated_at: 1690375205 url: http://help-center.test/myapp-32/en/articles/92834-this-is-the-article-title schema: - '$ref': '#/components/schemas/article' + "$ref": "#/components/schemas/article" '404': description: Article not found content: @@ -581,10 +581,10 @@ paths: type: error.list request_id: 563ba9f4-321f-4794-b1c2-8c66509825cb 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: @@ -595,26 +595,26 @@ paths: type: error.list request_id: 87fd1e1b-e976-4132-a355-697cb256d522 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' + "$ref": "#/components/schemas/error" put: 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/`. @@ -648,7 +648,7 @@ paths: updated_at: 1690375209 url: http://help-center.test/myapp-38/en/articles/92837-christmas-is-here schema: - '$ref': '#/components/schemas/article' + "$ref": "#/components/schemas/article" '404': description: Article Not Found content: @@ -659,10 +659,10 @@ paths: type: error.list request_id: 35ef850f-3735-42b2-861d-935ef480b018 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: @@ -673,42 +673,42 @@ paths: type: error.list request_id: 5ea668f0-08a8-4692-a18e-5de4293c87ed 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: 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: @@ -723,7 +723,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: @@ -734,10 +734,10 @@ paths: type: error.list request_id: 12af59eb-7c2c-4397-99b3-406e9e58bf35 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: @@ -748,20 +748,20 @@ paths: type: error.list request_id: 80b071c1-5f8b-49c6-ba95-9bfcc6b7e40d 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: 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`.\n\n> \U0001F4D8 How @@ -786,7 +786,7 @@ paths: per_page: 20 total_pages: 0 schema: - '$ref': '#/components/schemas/collection_list' + "$ref": "#/components/schemas/collection_list" '401': description: Unauthorized content: @@ -797,19 +797,19 @@ paths: type: error.list request_id: df9d59d5-d4d4-4e0b-ac9b-140aba60b88a 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: @@ -831,7 +831,7 @@ paths: icon: book-bookmark type: collection schema: - '$ref': '#/components/schemas/collection' + "$ref": "#/components/schemas/collection" '400': description: Bad Request content: @@ -842,10 +842,10 @@ paths: type: error.list request_id: c51fbc76-78dc-4b26-8345-f3035ecb8ab9 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: @@ -856,15 +856,15 @@ paths: type: error.list request_id: 41b6315d-810d-4ee7-ba4e-558abd660464 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 @@ -874,23 +874,23 @@ paths: summary: Bad Request value: description: Missing required parameter - '/help_center/collections/{id}': + "/help_center/collections/{id}": get: summary: Retrieve 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/`. @@ -913,7 +913,7 @@ paths: icon: bookmark type: collection schema: - '$ref': '#/components/schemas/collection' + "$ref": "#/components/schemas/collection" '404': description: Collection not found content: @@ -924,10 +924,10 @@ paths: type: error.list request_id: 76d532f7-2777-4cb4-a4e6-45b6295d847a 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: @@ -938,26 +938,26 @@ paths: type: error.list request_id: 6c99e24e-1d70-4425-81bd-2b9ff7818e55 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' + "$ref": "#/components/schemas/error" put: 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/`. @@ -980,7 +980,7 @@ paths: icon: folder type: collection schema: - '$ref': '#/components/schemas/collection' + "$ref": "#/components/schemas/collection" '404': description: Collection Not Found content: @@ -991,10 +991,10 @@ paths: type: error.list request_id: 308c7b9f-463f-4b83-8ef0-230157b0018e 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: @@ -1005,15 +1005,15 @@ paths: type: error.list request_id: 3297d07c-e187-455f-9ba7-8b7651df17fb 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 @@ -1026,19 +1026,19 @@ paths: 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/`. @@ -1054,7 +1054,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: @@ -1065,10 +1065,10 @@ paths: type: error.list request_id: 2eb443d0-8daa-4c47-a162-7d473f703782 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: @@ -1079,20 +1079,20 @@ paths: type: error.list request_id: 9b8eae9b-12cb-41af-898f-aad0b1917bb1 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' - '/help_center/sections': + "$ref": "#/components/schemas/error" + "/help_center/sections": get: summary: List all sections 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: listAllSections description: "You can fetch a list of all sections by making a GET request to `https://api.intercom.io/help_center/sections`.\n> \U0001F4D8 How are the @@ -1109,15 +1109,15 @@ paths: value: type: list data: - - id: '87827' - workspace_id: this_is_an_id78_that_should_be_at_least_4 - name: English section title - url: http://help-center.test/myapp-78/section-15 - order: 15 - created_at: 1690375220 - updated_at: 1690375220 - type: section - parent_id: 87826 + - id: '87827' + workspace_id: this_is_an_id78_that_should_be_at_least_4 + name: English section title + url: http://help-center.test/myapp-78/section-15 + order: 15 + created_at: 1690375220 + updated_at: 1690375220 + type: section + parent_id: 87826 total_count: 1 pages: type: pages @@ -1125,7 +1125,7 @@ paths: per_page: 20 total_pages: 1 schema: - '$ref': '#/components/schemas/section_list' + "$ref": "#/components/schemas/section_list" '401': description: Unauthorized content: @@ -1136,19 +1136,19 @@ paths: type: error.list request_id: 37c10258-c0fa-4d65-ba21-6920e239c2af 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 section 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: createSection description: You can create a new section by making a POST request to `https://api.intercom.io/help_center/sections.` responses: @@ -1169,7 +1169,7 @@ paths: type: section parent_id: '87830' schema: - '$ref': '#/components/schemas/section' + "$ref": "#/components/schemas/section" '401': description: Unauthorized content: @@ -1180,38 +1180,38 @@ paths: type: error.list request_id: 8f1f6194-5860-4b84-ad56-0dbb7a66aa9e 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_section_request' + "$ref": "#/components/schemas/create_section_request" examples: section_created: summary: section created value: name: Thanks for everything parent_id: 87830 - '/help_center/sections/{id}': + "/help_center/sections/{id}": get: summary: Retrieve a section parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The unique identifier for the section 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 section which is given by Intercom. + example: 123 + schema: + type: integer tags: - - Help Center + - Help Center operationId: retrieveSection description: You can fetch the details of a single section by making a GET request to `https://api.intercom.io/help_center/sections/`. @@ -1233,7 +1233,7 @@ paths: type: section parent_id: 87835 schema: - '$ref': '#/components/schemas/section' + "$ref": "#/components/schemas/section" '404': description: Section not found content: @@ -1244,10 +1244,10 @@ paths: type: error.list request_id: c8ed513e-4a04-45e3-9271-96adb260609e 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: @@ -1258,26 +1258,26 @@ paths: type: error.list request_id: e916779f-42c8-408d-a6e3-594cebe52ce6 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' + "$ref": "#/components/schemas/error" put: summary: Update a section parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The unique identifier for the section 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 section which is given by Intercom. + example: 123 + schema: + type: integer tags: - - Help Center + - Help Center operationId: updateSection description: You can update the details of a single section by making a PUT request to `https://api.intercom.io/sections/`. @@ -1299,7 +1299,7 @@ paths: type: section parent_id: '87841' schema: - '$ref': '#/components/schemas/section' + "$ref": "#/components/schemas/section" '404': description: Section Not Found content: @@ -1310,10 +1310,10 @@ paths: type: error.list request_id: 943f36ee-f46b-4085-b10d-d629cb2f30f4 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: @@ -1324,15 +1324,15 @@ paths: type: error.list request_id: 5ff5caf9-cfd3-460b-8326-717ab0351221 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_section_request' + "$ref": "#/components/schemas/update_section_request" examples: successful: summary: successful @@ -1347,19 +1347,19 @@ paths: delete: summary: Delete a section parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The unique identifier for the section 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 section which is given by Intercom. + example: 123 + schema: + type: integer tags: - - Help Center + - Help Center operationId: deleteSection description: You can delete a single section by making a DELETE request to `https://api.intercom.io/sections/`. responses: @@ -1374,7 +1374,7 @@ paths: object: section deleted: true schema: - '$ref': '#/components/schemas/deleted_section_object' + "$ref": "#/components/schemas/deleted_section_object" '404': description: section Not Found content: @@ -1385,10 +1385,10 @@ paths: type: error.list request_id: e9e2bc26-0e7e-4294-bf74-3e12f9296ef7 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: @@ -1399,20 +1399,20 @@ paths: type: error.list request_id: 58753003-1acd-47dd-a067-f5c8bfd0935f 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 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.\n\n> \U0001F4D8 Companies with no users\n>\n> Companies will be only visible in Intercom when there @@ -1448,7 +1448,7 @@ paths: custom_attributes: creation_source: api schema: - '$ref': '#/components/schemas/company' + "$ref": "#/components/schemas/company" '400': description: Bad Request content: @@ -1459,10 +1459,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: @@ -1473,15 +1473,15 @@ paths: type: error.list request_id: c7df0d74-cf45-4899-99b9-d7d38e4cf20f 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 @@ -1496,35 +1496,35 @@ paths: get: summary: Retrieve a company parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: filter - in: query - style: form - required: true - schema: - type: object - oneOf: - - description: The `company_id` of the company to filter by. - title: Filter by company_id - properties: - company_id: - type: string - required: - - company_id - additionalProperties: false - - description: The `name` of the company to filter by. - title: Filter by name - properties: - name: - type: string - required: - - name - additionalProperties: false + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: filter + in: query + style: form + required: true + schema: + type: object + oneOf: + - description: The `company_id` of the company to filter by. + title: Filter by company_id + properties: + company_id: + type: string + required: + - company_id + additionalProperties: false + - description: The `name` of the company to filter by. + title: Filter by name + properties: + name: + type: string + required: + - name + additionalProperties: false tags: - - Companies + - Companies operationId: retrieveCompany description: | You can fetch a company by either passing in `company_id` or `name` as a query parameter. @@ -1560,7 +1560,7 @@ paths: plan: {} custom_attributes: {} schema: - '$ref': '#/components/schemas/company' + "$ref": "#/components/schemas/company" '404': description: Company Not Found content: @@ -1571,10 +1571,10 @@ paths: type: error.list request_id: 931452c0-88d1-4047-9062-c534676f0d2a 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: @@ -1585,27 +1585,27 @@ paths: type: error.list request_id: b76020d0-40f7-485d-a2e4-fd30752e4508 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 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: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + schema: + type: string tags: - - Companies + - Companies operationId: RetrieveACompanyById description: You can fetch a single company. responses: @@ -1636,7 +1636,7 @@ paths: plan: {} custom_attributes: {} schema: - '$ref': '#/components/schemas/company' + "$ref": "#/components/schemas/company" '404': description: Company Not Found content: @@ -1647,10 +1647,10 @@ paths: type: error.list request_id: e7fd1dc5-0739-47cc-8114-76cda066e3e5 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: @@ -1661,26 +1661,26 @@ paths: type: error.list request_id: bd49975b-3bef-4034-8ae6-37001870d3ba errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' + "$ref": "#/components/schemas/error" put: 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: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + schema: + type: string tags: - - Companies + - Companies operationId: UpdateCompany description: You can update a single company responses: @@ -1711,7 +1711,7 @@ paths: plan: {} custom_attributes: {} schema: - '$ref': '#/components/schemas/company' + "$ref": "#/components/schemas/company" '404': description: Company Not Found content: @@ -1722,10 +1722,10 @@ paths: type: error.list request_id: 74c6d296-b199-42f6-952a-c77aa0357f10 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: @@ -1736,26 +1736,26 @@ paths: type: error.list request_id: ce47dd3b-5654-4d55-930a-92cea731a1b9 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' + "$ref": "#/components/schemas/error" 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: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + schema: + type: string tags: - - Companies + - Companies operationId: deleteCompany description: You can delete a single company. responses: @@ -1770,7 +1770,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: @@ -1781,10 +1781,10 @@ paths: type: error.list request_id: f0593107-54dd-4480-95f5-28b8fb0a1550 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: @@ -1795,28 +1795,28 @@ paths: type: error.list request_id: 6460f8e8-fe51-40cc-b1d9-0c599a94d515 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: 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: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + 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: @@ -1836,7 +1836,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: @@ -1847,10 +1847,10 @@ paths: type: error.list request_id: 0c1891c2-c900-4871-82f5-5c4239f8c906 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: @@ -1861,27 +1861,27 @@ paths: type: error.list request_id: 44512be2-5da4-4e98-abd0-a02a64adb1cf 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: 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: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + schema: + type: string tags: - - Companies + - Companies operationId: ListAttachedSegmentsForCompanies description: You can fetch a list of all segments that belong to a company. responses: @@ -1895,7 +1895,7 @@ paths: type: list data: [] schema: - '$ref': '#/components/schemas/company_attached_segments' + "$ref": "#/components/schemas/company_attached_segments" '404': description: Company Not Found content: @@ -1906,10 +1906,10 @@ paths: type: error.list request_id: 60225409-cab4-48b8-94ad-4c7947bce8ce 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: @@ -1920,65 +1920,65 @@ paths: type: error.list request_id: eb41a1e3-933a-4b5d-b56c-c5420da3960f 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: summary: List all companies parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: page - in: query - required: false - description: what page of results to fetch. Defaults to first page - example: first page - schema: - type: string - - name: per_page - in: query - required: false - description: how many results per page. Defaults to 15 - example: '15' - schema: - type: string - - 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: filter - in: query - style: form - required: true - schema: - type: object - oneOf: - - description: The `id` of the tag to filter by. - title: Filter by tag - properties: - tag_id: - type: string - required: - - tag_id - additionalProperties: false - - description: The `id` of the segment to filter by. - title: Filter by segment - properties: - segment_id: - type: string - required: - - segment_id - additionalProperties: false + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: page + in: query + required: false + description: what page of results to fetch. Defaults to first page + example: first page + schema: + type: string + - name: per_page + in: query + required: false + description: how many results per page. Defaults to 15 + example: '15' + schema: + type: string + - 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: filter + in: query + style: form + required: true + schema: + type: object + oneOf: + - description: The `id` of the tag to filter by. + title: Filter by tag + properties: + tag_id: + type: string + required: + - tag_id + additionalProperties: false + - description: The `id` of the segment to filter by. + title: Filter by segment + properties: + segment_id: + type: string + required: + - segment_id + additionalProperties: false 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.\n\nNote @@ -1997,25 +1997,25 @@ paths: value: type: list data: - - type: company - company_id: remote_companies_scroll_2 - id: 64c1145535824d3ca2c56ec5 - app_id: this_is_an_id149_that_should_be_at_least_ - name: IntercomQATest1 - remote_created_at: 1690375253 - created_at: 1690375253 - updated_at: 1690375253 - 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: 64c1145535824d3ca2c56ec5 + app_id: this_is_an_id149_that_should_be_at_least_ + name: IntercomQATest1 + remote_created_at: 1690375253 + created_at: 1690375253 + updated_at: 1690375253 + 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: @@ -2024,7 +2024,7 @@ paths: total_pages: 1 total_count: 1 schema: - '$ref': '#/components/schemas/company_list' + "$ref": "#/components/schemas/company_list" '401': description: Unauthorized content: @@ -2035,26 +2035,26 @@ paths: type: error.list request_id: 0dc649b9-721b-4ba3-841f-ddf58f51443b 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: 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: " The `list all companies` functionality does not work well for huge datasets, and can result in errors and performance problems when @@ -2083,30 +2083,30 @@ paths: value: type: list data: - - type: company - company_id: remote_companies_scroll_2 - id: 64c1145735824d3ca2c56ecd - app_id: this_is_an_id153_that_should_be_at_least_ - name: IntercomQATest1 - remote_created_at: 1690375255 - created_at: 1690375255 - updated_at: 1690375255 - 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: 64c1145735824d3ca2c56ecd + app_id: this_is_an_id153_that_should_be_at_least_ + name: IntercomQATest1 + remote_created_at: 1690375255 + created_at: 1690375255 + updated_at: 1690375255 + 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: scroll_param: 3d527d66-c0de-493c-8033-343f940c8540 schema: - '$ref': '#/components/schemas/company_scroll' + "$ref": "#/components/schemas/company_scroll" '401': description: Unauthorized content: @@ -2117,27 +2117,27 @@ paths: type: error.list request_id: 286081ef-b205-4658-a690-1b36d48d7350 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: 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: @@ -2168,7 +2168,7 @@ paths: plan: {} custom_attributes: {} schema: - '$ref': '#/components/schemas/company' + "$ref": "#/components/schemas/company" '404': description: Company Not Found content: @@ -2179,10 +2179,10 @@ paths: type: error.list request_id: 630570d4-e923-4b89-9dff-cefb76cb8bb4 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: @@ -2193,17 +2193,17 @@ paths: type: error.list request_id: f20ff829-2e93-4a62-a6ec-375515f51c2f 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 @@ -2219,31 +2219,31 @@ paths: summary: Company Not Found value: id: 64c1145a35824d3ca2c56eda - '/contacts/{contact_id}/companies/{id}': + "/contacts/{contact_id}/companies/{id}": delete: 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: @@ -2274,7 +2274,7 @@ paths: plan: {} custom_attributes: {} schema: - '$ref': '#/components/schemas/company' + "$ref": "#/components/schemas/company" '404': description: Contact Not Found content: @@ -2285,17 +2285,17 @@ paths: type: error.list request_id: 37950dcb-ce0a-4c95-aee3-dda0ff7a3ca3 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: b7fcd0a4-d073-4fee-996d-4b8f0295ff32 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: @@ -2306,28 +2306,28 @@ paths: type: error.list request_id: c8deb3d7-43ac-461e-bfcc-3e52d184fc00 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' - '/contacts/{contact_id}/companies': + "$ref": "#/components/schemas/error" + "/contacts/{contact_id}/companies": get: summary: List attached companies for contact parameters: - - name: contact_id - in: path - description: The unique identifier for the contact which is given by Intercom - example: 63a07ddf05a32042dffac965 - required: true - schema: - type: string - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' + - name: contact_id + in: path + description: The unique identifier for the contact which is given by Intercom + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Contacts - - Companies + - Contacts + - Companies operationId: listCompaniesForAContact description: You can fetch a list of companies that are associated to a contact. responses: @@ -2340,26 +2340,26 @@ paths: value: type: list data: - - type: company - company_id: '1' - id: 64c1146b35824d3ca2c56f08 - app_id: this_is_an_id171_that_should_be_at_least_ - name: company25 - remote_created_at: 1690375275 - created_at: 1690375275 - updated_at: 1690375275 - last_request_at: 1690202475 - 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: 64c1146b35824d3ca2c56f08 + app_id: this_is_an_id171_that_should_be_at_least_ + name: company25 + remote_created_at: 1690375275 + created_at: 1690375275 + updated_at: 1690375275 + last_request_at: 1690202475 + 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: @@ -2368,7 +2368,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: @@ -2379,10 +2379,10 @@ paths: type: error.list request_id: 6b7a750c-97f8-41b7-8caa-89eb0b7bebc6 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: @@ -2393,27 +2393,27 @@ paths: type: error.list request_id: 5aa953d0-f373-452a-81f3-44ee486a3ad2 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: 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: @@ -2426,48 +2426,48 @@ paths: value: type: list data: - - type: note - id: '405620' - created_at: 1689770479 - contact: - type: contact - id: 64c1146f35824d3ca2c56f13 - author: - type: admin - id: '991266317' - name: Ciaran102 Lee - email: admin102@email.com - away_mode_enabled: false - away_mode_reassign: false - body: '

This is a note.

' - - type: note - id: '405619' - created_at: 1689684079 - contact: - type: contact - id: 64c1146f35824d3ca2c56f13 - author: - type: admin - id: '991266317' - name: Ciaran102 Lee - email: admin102@email.com - away_mode_enabled: false - away_mode_reassign: false - body: '

This is a note.

' - - type: note - id: '405618' - created_at: 1689684079 - contact: - type: contact - id: 64c1146f35824d3ca2c56f13 - author: - type: admin - id: '991266317' - name: Ciaran102 Lee - email: admin102@email.com - away_mode_enabled: false - away_mode_reassign: false - body: '

This is a note.

' + - type: note + id: '405620' + created_at: 1689770479 + contact: + type: contact + id: 64c1146f35824d3ca2c56f13 + author: + type: admin + id: '991266317' + name: Ciaran102 Lee + email: admin102@email.com + away_mode_enabled: false + away_mode_reassign: false + body: "

This is a note.

" + - type: note + id: '405619' + created_at: 1689684079 + contact: + type: contact + id: 64c1146f35824d3ca2c56f13 + author: + type: admin + id: '991266317' + name: Ciaran102 Lee + email: admin102@email.com + away_mode_enabled: false + away_mode_reassign: false + body: "

This is a note.

" + - type: note + id: '405618' + created_at: 1689684079 + contact: + type: contact + id: 64c1146f35824d3ca2c56f13 + author: + type: admin + id: '991266317' + name: Ciaran102 Lee + email: admin102@email.com + away_mode_enabled: false + away_mode_reassign: false + body: "

This is a note.

" total_count: 3 pages: type: pages @@ -2476,7 +2476,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: @@ -2487,27 +2487,27 @@ paths: type: error.list request_id: 36bfee41-704b-4497-878a-7fc87ad525f6 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: 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: @@ -2531,9 +2531,9 @@ paths: email: admin104@email.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: @@ -2544,24 +2544,24 @@ paths: type: error.list request_id: c52664cb-b12c-4309-95d2-c1ef9ed1325e errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found Contact not found: value: type: error.list request_id: d9b5215b-ed4e-47f9-87d3-54e35479445c 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 @@ -2594,24 +2594,24 @@ paths: contact_id: 123 admin_id: 991266321 body: Hello - '/contacts/{contact_id}/segments': + "/contacts/{contact_id}/segments": get: summary: List attached segments for contact parameters: - - name: contact_id - in: path - description: The unique identifier for the contact which is given by Intercom - example: 63a07ddf05a32042dffac965 - required: true - schema: - type: string - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' + - 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: @@ -2624,14 +2624,14 @@ paths: value: type: list data: - - type: segment - id: 64c1147135824d3ca2c56f18 - name: segment - created_at: 1690375282 - updated_at: 1690375282 - person_type: user - schema: - '$ref': '#/components/schemas/contact_segments' + - type: segment + id: 64c1147135824d3ca2c56f18 + name: segment + created_at: 1690375282 + updated_at: 1690375282 + person_type: user + schema: + "$ref": "#/components/schemas/contact_segments" '404': description: Contact not found content: @@ -2642,10 +2642,10 @@ paths: type: error.list request_id: b1db3f5c-4007-4c00-8d65-16e727814efe 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: @@ -2656,28 +2656,28 @@ paths: type: error.list request_id: dde75711-a209-42bd-b63d-9d7912b9f8a4 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: 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. @@ -2697,36 +2697,36 @@ paths: value: type: list data: - - type: subscription - id: '440933' - 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: '440935' - 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: '440933' + 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: '440935' + 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: @@ -2737,10 +2737,10 @@ paths: type: error.list request_id: 964e6249-d00c-4dbb-95b6-2d214291daa4 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: @@ -2751,27 +2751,27 @@ paths: type: error.list request_id: 58ff3c1b-891a-442e-8655-d9061d0fde42 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 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: @@ -2798,13 +2798,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: @@ -2815,17 +2815,17 @@ paths: type: error.list request_id: a85290e7-02fe-4763-9dec-4107dabe40bf errors: - - code: not_found - message: User Not Found + - code: not_found + message: User Not Found Resource not found: value: type: error.list request_id: 735a712a-13f5-423b-befa-0af698eadd2d 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: @@ -2836,18 +2836,18 @@ paths: type: error.list request_id: 7bc81d61-0f88-4353-b9ac-700f5fbd584e 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 @@ -2874,32 +2874,32 @@ 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 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 @@ -2921,13 +2921,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: @@ -2938,17 +2938,17 @@ paths: type: error.list request_id: fc9aa5aa-bb38-47a5-93e5-d201ba49b79b errors: - - code: not_found - message: User Not Found + - code: not_found + message: User Not Found Resource not found: value: type: error.list request_id: 4e52e5ff-0b8f-49b3-8fa1-afa0ad032cac 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: @@ -2959,28 +2959,28 @@ paths: type: error.list request_id: 898e6a36-b753-43e7-bc3f-2e47b6e761cf 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: 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. @@ -2994,11 +2994,11 @@ paths: value: type: list data: - - type: tag - id: '321873' - name: Manual tag + - type: tag + id: '321873' + name: Manual tag schema: - '$ref': '#/components/schemas/tag_list' + "$ref": "#/components/schemas/tag_list" '404': description: Contact not found content: @@ -3009,10 +3009,10 @@ paths: type: error.list request_id: 2a426e6e-90a8-4e0e-823a-567d51eaf90e 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: @@ -3023,27 +3023,27 @@ paths: type: error.list request_id: e8b90571-08b2-492a-b3c4-4491433a9ee3 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 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. @@ -3059,7 +3059,7 @@ paths: id: '321874' name: Manual tag schema: - '$ref': '#/components/schemas/tag' + "$ref": "#/components/schemas/tag" '404': description: Tag not found content: @@ -3070,17 +3070,17 @@ paths: type: error.list request_id: 032c5c50-79f9-44d8-83d2-909638c96a93 errors: - - code: not_found - message: User Not Found + - code: not_found + message: User Not Found Tag not found: value: type: error.list request_id: 639cb1fd-3d09-492a-b6a9-d0c87b45d2b5 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: @@ -3091,17 +3091,17 @@ paths: type: error.list request_id: 3dfe1c43-c84d-4012-b514-e85c01792de2 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 @@ -3121,31 +3121,31 @@ paths: summary: Tag not found value: id: '123' - '/contacts/{contact_id}/tags/{id}': + "/contacts/{contact_id}/tags/{id}": delete: summary: Remove tag from a contact tags: - - Tags - - Contacts + - Tags + - Contacts parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: contact_id - in: path - description: The unique identifier for the contact which is given by Intercom - example: 63a07ddf05a32042dffac965 - required: true - schema: - type: string - - name: id - in: path - description: The unique identifier for the tag which is given by Intercom - example: '7522907' - required: true - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: contact_id + in: path + description: The unique identifier for the contact which is given by Intercom + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + - name: id + in: path + description: The unique identifier for the tag which is given by Intercom + example: '7522907' + required: true + schema: + type: string operationId: detachTagFromContact description: You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact. @@ -3161,7 +3161,7 @@ paths: id: '321877' name: Manual tag schema: - '$ref': '#/components/schemas/tag' + "$ref": "#/components/schemas/tag" '404': description: Tag not found content: @@ -3172,17 +3172,17 @@ paths: type: error.list request_id: fa5c1659-2c5c-4f37-a4a5-3ef51cec6bc2 errors: - - code: not_found - message: User Not Found + - code: not_found + message: User Not Found Tag not found: value: type: error.list request_id: 94dc5eff-2e9f-487b-a088-fcd3fd2e5c4a 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: @@ -3193,27 +3193,27 @@ paths: type: error.list request_id: bd208a44-b3e7-484f-bbdb-8407bb352486 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: 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: @@ -3276,31 +3276,31 @@ paths: tags: type: list data: [] - url: '/contacts/64c1148035824d3ca2c56f2f/tags' + url: "/contacts/64c1148035824d3ca2c56f2f/tags" total_count: 0 has_more: false notes: type: list data: [] - url: '/contacts/64c1148035824d3ca2c56f2f/notes' + url: "/contacts/64c1148035824d3ca2c56f2f/notes" total_count: 0 has_more: false companies: type: list data: [] - url: '/contacts/64c1148035824d3ca2c56f2f/companies' + url: "/contacts/64c1148035824d3ca2c56f2f/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: '/contacts/64c1148035824d3ca2c56f2f/subscriptions' + url: "/contacts/64c1148035824d3ca2c56f2f/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: '/contacts/64c1148035824d3ca2c56f2f/subscriptions' + url: "/contacts/64c1148035824d3ca2c56f2f/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3310,7 +3310,7 @@ paths: utm_term: referrer: schema: - '$ref': '#/components/schemas/contact' + "$ref": "#/components/schemas/contact" '401': description: Unauthorized content: @@ -3321,16 +3321,16 @@ paths: type: error.list request_id: 8d6e29b1-7132-4070-b372-c55157e86c19 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 @@ -3340,19 +3340,19 @@ paths: 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: @@ -3415,31 +3415,31 @@ paths: tags: type: list data: [] - url: '/contacts/64c1148235824d3ca2c56f30/tags' + url: "/contacts/64c1148235824d3ca2c56f30/tags" total_count: 0 has_more: false notes: type: list data: [] - url: '/contacts/64c1148235824d3ca2c56f30/notes' + url: "/contacts/64c1148235824d3ca2c56f30/notes" total_count: 0 has_more: false companies: type: list data: [] - url: '/contacts/64c1148235824d3ca2c56f30/companies' + url: "/contacts/64c1148235824d3ca2c56f30/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: '/contacts/64c1148235824d3ca2c56f30/subscriptions' + url: "/contacts/64c1148235824d3ca2c56f30/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: '/contacts/64c1148235824d3ca2c56f30/subscriptions' + url: "/contacts/64c1148235824d3ca2c56f30/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3449,7 +3449,7 @@ paths: utm_term: referrer: schema: - '$ref': '#/components/schemas/contact' + "$ref": "#/components/schemas/contact" '401': description: Unauthorized content: @@ -3460,25 +3460,25 @@ paths: type: error.list request_id: e7ed8614-3fda-492e-9e57-1e865b432dd3 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' + "$ref": "#/components/schemas/error" delete: summary: Delete a contact parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - description: id - required: true - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: id + required: true + schema: + type: string tags: - - Contacts + - Contacts operationId: DeleteContact description: You can delete a single contact. responses: @@ -3493,7 +3493,7 @@ paths: object: contact deleted: true schema: - '$ref': '#/components/schemas/contact_deleted' + "$ref": "#/components/schemas/contact_deleted" '401': description: Unauthorized content: @@ -3504,20 +3504,20 @@ paths: type: error.list request_id: 45c5d4ac-37e5-4d16-b1af-362454f687b6 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: 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`. @@ -3581,31 +3581,31 @@ paths: tags: type: list data: [] - url: '/contacts/64c1148635824d3ca2c56f33/tags' + url: "/contacts/64c1148635824d3ca2c56f33/tags" total_count: 0 has_more: false notes: type: list data: [] - url: '/contacts/64c1148635824d3ca2c56f33/notes' + url: "/contacts/64c1148635824d3ca2c56f33/notes" total_count: 0 has_more: false companies: type: list data: [] - url: '/contacts/64c1148635824d3ca2c56f33/companies' + url: "/contacts/64c1148635824d3ca2c56f33/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: '/contacts/64c1148635824d3ca2c56f33/subscriptions' + url: "/contacts/64c1148635824d3ca2c56f33/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: '/contacts/64c1148635824d3ca2c56f33/subscriptions' + url: "/contacts/64c1148635824d3ca2c56f33/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3615,7 +3615,7 @@ paths: utm_term: referrer: schema: - '$ref': '#/components/schemas/contact' + "$ref": "#/components/schemas/contact" '401': description: Unauthorized content: @@ -3626,31 +3626,31 @@ paths: type: error.list request_id: 6753650b-41e9-4c2d-ba2f-535dab64dc6d 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: 64c1148635824d3ca2c56f32 into: 64c1148635824d3ca2c56f33 - '/contacts/search': + "/contacts/search": post: summary: Search contacts parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Contacts + - Contacts operationId: SearchContacts description: "You can search for multiple contacts by the value of their attributes in order to fetch exactly who you want.\n\nTo search for contacts, you need @@ -3740,7 +3740,7 @@ paths: per_page: 50 total_pages: 0 schema: - '$ref': '#/components/schemas/contact_list' + "$ref": "#/components/schemas/contact_list" '401': description: Unauthorized content: @@ -3751,15 +3751,15 @@ paths: type: error.list request_id: 5c47f659-8021-443e-bc67-047ab92a8e71 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 @@ -3767,27 +3767,27 @@ paths: query: operator: AND value: + - field: id + operator: "=" + value: 64c1148835824d3ca2c56f36 + - operator: OR + value: + - field: id + operator: "=" + value: 64c1148835824d3ca2c56f36 - field: id - operator: '=' + operator: "=" value: 64c1148835824d3ca2c56f36 - - operator: OR - value: - - field: id - operator: '=' - value: 64c1148835824d3ca2c56f36 - - field: id - operator: '=' - value: 64c1148835824d3ca2c56f36 - '/contacts': + "/contacts": get: summary: List all contacts parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Contacts + - Contacts operationId: ListContacts description: You can fetch a list of all contacts. responses: @@ -3807,7 +3807,7 @@ paths: per_page: 10 total_pages: 0 schema: - '$ref': '#/components/schemas/contact_list' + "$ref": "#/components/schemas/contact_list" '401': description: Unauthorized content: @@ -3818,19 +3818,19 @@ paths: type: error.list request_id: 2ea3ed1a-d902-4351-a095-e99a017899f1 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 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: @@ -3893,31 +3893,31 @@ paths: tags: type: list data: [] - url: '/contacts/64c1148b35824d3ca2c56f38/tags' + url: "/contacts/64c1148b35824d3ca2c56f38/tags" total_count: 0 has_more: false notes: type: list data: [] - url: '/contacts/64c1148b35824d3ca2c56f38/notes' + url: "/contacts/64c1148b35824d3ca2c56f38/notes" total_count: 0 has_more: false companies: type: list data: [] - url: '/contacts/64c1148b35824d3ca2c56f38/companies' + url: "/contacts/64c1148b35824d3ca2c56f38/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: '/contacts/64c1148b35824d3ca2c56f38/subscriptions' + url: "/contacts/64c1148b35824d3ca2c56f38/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: '/contacts/64c1148b35824d3ca2c56f38/subscriptions' + url: "/contacts/64c1148b35824d3ca2c56f38/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3927,7 +3927,7 @@ paths: utm_term: referrer: schema: - '$ref': '#/components/schemas/contact' + "$ref": "#/components/schemas/contact" '401': description: Unauthorized content: @@ -3938,38 +3938,38 @@ paths: type: error.list request_id: b3a9f37a-a3fc-41f5-a4fa-98964056b394 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/{id}/archive': + "/contacts/{id}/archive": post: summary: Archive contact parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - description: id - example: 63a07ddf05a32042dffac965 - required: true - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: id + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string tags: - - Contacts + - Contacts operationId: ArchiveContact description: You can archive a single contact. responses: @@ -3984,24 +3984,24 @@ paths: object: contact archived: true schema: - '$ref': '#/components/schemas/contact_archived' - '/contacts/{id}/unarchive': + "$ref": "#/components/schemas/contact_archived" + "/contacts/{id}/unarchive": post: summary: Unarchive contact parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - description: id - example: 63a07ddf05a32042dffac965 - required: true - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: id + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string tags: - - Contacts + - Contacts operationId: UnarchiveContact description: You can unarchive a single contact. responses: @@ -4016,25 +4016,25 @@ paths: object: contact archived: false schema: - '$ref': '#/components/schemas/contact_unarchived' - '/conversations/{conversation_id}/tags': + "$ref": "#/components/schemas/contact_unarchived" + "/conversations/{conversation_id}/tags": post: 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. @@ -4050,7 +4050,7 @@ paths: id: '321879' name: Manual tag schema: - '$ref': '#/components/schemas/tag' + "$ref": "#/components/schemas/tag" '404': description: Conversation not found content: @@ -4061,10 +4061,10 @@ paths: type: error.list request_id: b88acdc7-2ce7-4cc4-ae13-69f080d55471 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: @@ -4075,18 +4075,18 @@ paths: type: error.list request_id: 2c21f683-4e7e-4d39-a0ee-6a4a18b6378f 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 @@ -4109,31 +4109,31 @@ paths: value: id: 321880 admin_id: 991266354 - '/conversations/{conversation_id}/tags/{id}': + "/conversations/{conversation_id}/tags/{id}": delete: 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. @@ -4149,7 +4149,7 @@ paths: id: '321882' name: Manual tag schema: - '$ref': '#/components/schemas/tag' + "$ref": "#/components/schemas/tag" '404': description: Tag not found content: @@ -4160,17 +4160,17 @@ paths: type: error.list request_id: 4324518b-a471-4905-8c82-64ee8d296b1c errors: - - code: not_found - message: Conversation not found + - code: not_found + message: Conversation not found Tag not found: value: type: error.list request_id: 1d06af40-9ee7-4b55-9de7-605e9926ee16 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: @@ -4181,17 +4181,17 @@ paths: type: error.list request_id: 10aa0242-d7b5-4151-a8ca-96224fe64043 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 @@ -4211,30 +4211,30 @@ paths: summary: Tag not found value: admin_id: 991266359 - '/conversations': + "/conversations": get: 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. @@ -4256,50 +4256,50 @@ paths: total_pages: 1 total_count: 1 conversations: - - type: conversation - id: '715385' - created_at: 1690375317 - updated_at: 1690375317 - waiting_since: - snoozed_until: - source: - type: conversation - id: '403918065' - delivered_as: admin_initiated - subject: '' - body: '

this is the message body

' - author: - type: admin - id: '991266362' - name: Ciaran144 Lee - email: admin144@email.com - attachments: [] - url: - redacted: false + - type: conversation + id: '715385' + created_at: 1690375317 + updated_at: 1690375317 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918065' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991266362' + name: Ciaran144 Lee + email: admin144@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list contacts: - type: contact.list - contacts: - - type: contact - id: 64c1149535824d3ca2c56f3e - first_contact_reply: - admin_assignee_id: - team_assignee_id: - open: false - state: closed - read: false - tags: - type: tag.list - tags: [] - priority: not_priority - sla_applied: - statistics: - conversation_rating: - teammates: - title: - custom_attributes: {} - topics: {} - schema: - '$ref': '#/components/schemas/paginated_response' + - type: contact + id: 64c1149535824d3ca2c56f3e + first_contact_reply: + admin_assignee_id: + team_assignee_id: + open: false + state: closed + read: false + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + schema: + "$ref": "#/components/schemas/paginated_response" '401': description: Unauthorized content: @@ -4310,10 +4310,10 @@ paths: type: error.list request_id: ba2ebc42-acd8-435a-b514-291a6cd72a32 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: @@ -4324,19 +4324,19 @@ paths: type: error.list request_id: 01b54040-9a1b-4e75-9b13-66808f51550a 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: 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).\nThe conversation can be an in-app message only.\n\n> @@ -4360,7 +4360,7 @@ paths: message_type: inapp conversation_id: '715410' schema: - '$ref': '#/components/schemas/message' + "$ref": "#/components/schemas/message" '404': description: Contact Not Found content: @@ -4371,10 +4371,10 @@ paths: type: error.list request_id: f02bd37c-95f7-4d81-a290-2e55c0b6e3db 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: @@ -4385,10 +4385,10 @@ paths: type: error.list request_id: 7a30645d-2a0c-4d15-90fe-6e23a790268d 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: @@ -4399,15 +4399,15 @@ paths: type: error.list request_id: 3aeb9f7a-4ef7-4785-af06-62c1313710e8 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 @@ -4423,30 +4423,30 @@ paths: type: user id: 123_doesnt_exist body: Hello there - '/conversations/{id}': + "/conversations/{id}": get: summary: Retrieve a conversation parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The id of the conversation to target - example: 123 - schema: - type: integer - - name: display_as - in: query - required: false - description: Set to plaintext to retrieve conversation messages in plain text. - example: plaintext - schema: - type: string + - 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: "\nYou can fetch the details of a single conversation.\n\nThis will return a single Conversation model with all its conversation parts.\n\n> @@ -4476,7 +4476,7 @@ paths: id: '403918079' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266376' @@ -4488,8 +4488,8 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c114b235824d3ca2c56f57 + - type: contact + id: 64c114b235824d3ca2c56f57 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -4512,7 +4512,7 @@ paths: conversation_parts: [] total_count: 0 schema: - '$ref': '#/components/schemas/conversation' + "$ref": "#/components/schemas/conversation" '404': description: Not found content: @@ -4523,10 +4523,10 @@ paths: type: error.list request_id: 1a9c22a9-f202-4134-9335-b39733f40238 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: @@ -4537,10 +4537,10 @@ paths: type: error.list request_id: 23387fe4-d245-4a79-8da3-6e70903925e4 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: @@ -4551,33 +4551,33 @@ paths: type: error.list request_id: a05965f2-d475-4039-a8e6-18239a638cf6 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: 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: "\nYou can update an existing conversation.\n\n> \U0001F4D8\n>\n> If you want to update a conversation with either a reply (or actions such @@ -4602,7 +4602,7 @@ paths: id: '403918083' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266384' @@ -4614,8 +4614,8 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c114ba35824d3ca2c56f5b + - type: contact + id: 64c114ba35824d3ca2c56f5b first_contact_reply: admin_assignee_id: team_assignee_id: @@ -4638,41 +4638,41 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '711348' - part_type: conversation_attribute_updated_by_admin - body: - created_at: 1690375355 - updated_at: 1690375355 - notified_at: 1690375355 - assigned_to: - author: - id: '991266385' - type: bot - name: Operator - email: operator+this_is_an_id305_that_should_be_at_least_@intercom.io - attachments: [] - external_id: - redacted: false - - type: conversation_part - id: '711349' - part_type: conversation_attribute_updated_by_admin - body: - created_at: 1690375356 - updated_at: 1690375356 - notified_at: 1690375356 - assigned_to: - author: - id: '991266385' - type: bot - name: Operator - email: operator+this_is_an_id305_that_should_be_at_least_@intercom.io - attachments: [] - external_id: - redacted: false + - type: conversation_part + id: '711348' + part_type: conversation_attribute_updated_by_admin + body: + created_at: 1690375355 + updated_at: 1690375355 + notified_at: 1690375355 + assigned_to: + author: + id: '991266385' + type: bot + name: Operator + email: operator+this_is_an_id305_that_should_be_at_least_@intercom.io + attachments: [] + external_id: + redacted: false + - type: conversation_part + id: '711349' + part_type: conversation_attribute_updated_by_admin + body: + created_at: 1690375356 + updated_at: 1690375356 + notified_at: 1690375356 + assigned_to: + author: + id: '991266385' + type: bot + name: Operator + email: operator+this_is_an_id305_that_should_be_at_least_@intercom.io + attachments: [] + external_id: + redacted: false total_count: 2 schema: - '$ref': '#/components/schemas/conversation' + "$ref": "#/components/schemas/conversation" '404': description: Not found content: @@ -4683,10 +4683,10 @@ paths: type: error.list request_id: ca967e7a-1f98-4e30-adda-1307dc4caf91 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: @@ -4697,10 +4697,10 @@ paths: type: error.list request_id: 4145ee7c-aa3a-4b5a-a0cf-b096c76a2f2a 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: @@ -4711,15 +4711,15 @@ paths: type: error.list request_id: 10bca955-18f2-477a-865f-c0c7276cd0ed 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 @@ -4735,16 +4735,16 @@ paths: custom_attributes: issue_type: Billing priority: High - '/conversations/search': + "/conversations/search": post: summary: Search conversations parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Conversations + - Conversations operationId: searchConversations description: "You can search for multiple conversations by the value of their attributes in order to fetch exactly which ones you want.\n\nTo search for @@ -4827,55 +4827,55 @@ paths: total_pages: 1 total_count: 1 conversations: - - type: conversation - id: '715422' - created_at: 1690375363 - updated_at: 1690375363 - waiting_since: - snoozed_until: - source: - type: conversation - id: '403918087' - delivered_as: admin_initiated - subject: '' - body: '

this is the message body

' - author: - type: admin - id: '991266408' - name: Ciaran175 Lee - email: admin175@email.com - attachments: [] - url: - redacted: false + - type: conversation + id: '715422' + created_at: 1690375363 + updated_at: 1690375363 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918087' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991266408' + name: Ciaran175 Lee + email: admin175@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list contacts: - type: contact.list - contacts: - - type: contact - id: 64c114c235824d3ca2c56f5f - first_contact_reply: - admin_assignee_id: - team_assignee_id: - open: false - state: closed - read: false - tags: - type: tag.list - tags: [] - priority: not_priority - sla_applied: - statistics: - conversation_rating: - teammates: - title: - custom_attributes: {} - topics: {} - schema: - '$ref': '#/components/schemas/conversation_list' + - type: contact + id: 64c114c235824d3ca2c56f5f + first_contact_reply: + admin_assignee_id: + team_assignee_id: + open: false + state: closed + read: false + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + schema: + "$ref": "#/components/schemas/conversation_list" requestBody: content: application/json: schema: - '$ref': '#/components/schemas/search_request' + "$ref": "#/components/schemas/search_request" examples: successful: summary: successful @@ -4883,43 +4883,43 @@ paths: query: operator: AND value: + - field: id + operator: "=" + value: '715422' + - operator: OR + value: + - field: id + operator: "=" + value: '715422' - field: id - operator: '=' + operator: "=" value: '715422' - - operator: OR - value: - - field: id - operator: '=' - value: '715422' - - field: id - operator: '=' - value: '715422' - '/conversations/{id}/reply': + "/conversations/{id}/reply": post: summary: Reply to a conversation parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - schema: - oneOf: - - title: Conversation ID - type: string - description: The id of the conversation to target. - example: '123' - - title: The most recent conversation - type: string - enum: - - last - description: You can also reply to the most recent conversation on a workspace - by specifying `last` as the string. - example: last + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + schema: + oneOf: + - title: Conversation ID + type: string + description: The id of the conversation to target. + example: '123' + - title: The most recent conversation + type: string + enum: + - last + description: You can also reply to the most recent conversation on a workspace + by specifying `last` as the string. + example: last 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. @@ -4942,7 +4942,7 @@ paths: id: '403918090' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266410' @@ -4954,8 +4954,8 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c114c935824d3ca2c56f66 + - type: contact + id: 64c114c935824d3ca2c56f66 first_contact_reply: created_at: 1690375370 type: conversation @@ -4979,22 +4979,22 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '711351' - part_type: comment - body: '

Thanks again :)

' - created_at: 1690375370 - updated_at: 1690375370 - notified_at: 1690375370 - assigned_to: - author: - id: 64c114c935824d3ca2c56f66 - type: user - name: Joe Bloggs - email: joe@bloggs.com - attachments: [] - external_id: - redacted: false + - type: conversation_part + id: '711351' + part_type: comment + body: "

Thanks again :)

" + created_at: 1690375370 + updated_at: 1690375370 + notified_at: 1690375370 + assigned_to: + author: + id: 64c114c935824d3ca2c56f66 + type: user + name: Joe Bloggs + email: joe@bloggs.com + attachments: [] + external_id: + redacted: false total_count: 1 Admin note reply: value: @@ -5009,7 +5009,7 @@ paths: id: '403918091' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266412' @@ -5021,8 +5021,8 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c114cb35824d3ca2c56f67 + - type: contact + id: 64c114cb35824d3ca2c56f67 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5043,34 +5043,34 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '711352' - part_type: note - body: |- -

An Unordered HTML List

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

An Ordered HTML List

-
    -
  1. Coffee
    2. -
  2. Tea
    3. -
  3. Milk
    4. -
- created_at: 1690375373 - updated_at: 1690375373 - notified_at: 1690375373 - assigned_to: - author: - id: '991266412' - type: admin - name: Ciaran177 Lee - email: admin177@email.com - attachments: [] - external_id: - redacted: false + - type: conversation_part + id: '711352' + part_type: note + body: |- +

An Unordered HTML List

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

An Ordered HTML List

+
    +
  1. Coffee
    2. +
  2. Tea
    3. +
  3. Milk
    4. +
+ created_at: 1690375373 + updated_at: 1690375373 + notified_at: 1690375373 + assigned_to: + author: + id: '991266412' + type: admin + name: Ciaran177 Lee + email: admin177@email.com + attachments: [] + external_id: + redacted: false total_count: 1 User last conversation reply: value: @@ -5085,7 +5085,7 @@ paths: id: '403918093' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266416' @@ -5097,8 +5097,8 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c114cf35824d3ca2c56f69 + - type: contact + id: 64c114cf35824d3ca2c56f69 first_contact_reply: created_at: 1690375376 type: conversation @@ -5122,25 +5122,25 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '711353' - part_type: comment - body: '

Thanks again :)

' - created_at: 1690375376 - updated_at: 1690375376 - notified_at: 1690375376 - assigned_to: - author: - id: 64c114cf35824d3ca2c56f69 - type: user - name: Joe Bloggs - email: joe@bloggs.com - attachments: [] - external_id: - redacted: false + - type: conversation_part + id: '711353' + part_type: comment + body: "

Thanks again :)

" + created_at: 1690375376 + updated_at: 1690375376 + notified_at: 1690375376 + assigned_to: + author: + id: 64c114cf35824d3ca2c56f69 + type: user + name: Joe Bloggs + email: joe@bloggs.com + attachments: [] + external_id: + redacted: false total_count: 1 schema: - '$ref': '#/components/schemas/conversation' + "$ref": "#/components/schemas/conversation" '404': description: Not found content: @@ -5151,10 +5151,10 @@ paths: type: error.list request_id: e2dfd8bc-4bb5-4707-9dff-801ec31c5fac 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: @@ -5165,10 +5165,10 @@ paths: type: error.list request_id: 2c1d608c-c3a1-4263-ad31-ee006ca67f82 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: @@ -5179,15 +5179,15 @@ paths: type: error.list request_id: 9e0603a1-4715-44ce-b47f-417f148b163c 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 @@ -5220,23 +5220,23 @@ paths: type: user intercom_user_id: 64c114d135824d3ca2c56f6a body: Thanks again :) - '/conversations/{id}/parts': + "/conversations/{id}/parts": post: summary: Manage a conversation parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The identifier for the conversation as given by Intercom. - example: '123' - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The identifier for the conversation as given by Intercom. + example: '123' + schema: + type: string tags: - - Conversations + - Conversations operationId: manageConversation description: | You can close a conversation. @@ -5262,7 +5262,7 @@ paths: id: '403918097' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266424' @@ -5274,8 +5274,8 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c114d635824d3ca2c56f6d + - type: contact + id: 64c114d635824d3ca2c56f6d first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5296,22 +5296,22 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '711354' - part_type: close - body: '

Goodbye :)

' - created_at: 1690375384 - updated_at: 1690375384 - notified_at: 1690375384 - assigned_to: - author: - id: '991266424' - type: admin - name: Ciaran183 Lee - email: admin183@email.com - attachments: [] - external_id: - redacted: false + - type: conversation_part + id: '711354' + part_type: close + body: "

Goodbye :)

" + created_at: 1690375384 + updated_at: 1690375384 + notified_at: 1690375384 + assigned_to: + author: + id: '991266424' + type: admin + name: Ciaran183 Lee + email: admin183@email.com + attachments: [] + external_id: + redacted: false total_count: 1 Snooze a conversation: value: @@ -5326,7 +5326,7 @@ paths: id: '403918098' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266426' @@ -5338,8 +5338,8 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c114d935824d3ca2c56f6e + - type: contact + id: 64c114d935824d3ca2c56f6e first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5360,22 +5360,22 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '711355' - part_type: snoozed - body: - created_at: 1690375386 - updated_at: 1690375386 - notified_at: 1690375386 - assigned_to: - author: - id: '991266426' - type: admin - name: Ciaran184 Lee - email: admin184@email.com - attachments: [] - external_id: - redacted: false + - type: conversation_part + id: '711355' + part_type: snoozed + body: + created_at: 1690375386 + updated_at: 1690375386 + notified_at: 1690375386 + assigned_to: + author: + id: '991266426' + type: admin + name: Ciaran184 Lee + email: admin184@email.com + attachments: [] + external_id: + redacted: false total_count: 1 Open a conversation: value: @@ -5390,7 +5390,7 @@ paths: id: '403918099' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266428' @@ -5402,8 +5402,8 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c114de35824d3ca2c56f73 + - type: contact + id: 64c114de35824d3ca2c56f73 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5424,22 +5424,22 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '711357' - part_type: open - body: - created_at: 1690375393 - updated_at: 1690375393 - notified_at: 1690375393 - assigned_to: - author: - id: '991266428' - type: admin - name: Ciaran185 Lee - email: admin185@email.com - attachments: [] - external_id: - redacted: false + - type: conversation_part + id: '711357' + part_type: open + body: + created_at: 1690375393 + updated_at: 1690375393 + notified_at: 1690375393 + assigned_to: + author: + id: '991266428' + type: admin + name: Ciaran185 Lee + email: admin185@email.com + attachments: [] + external_id: + redacted: false total_count: 1 Assign a conversation: value: @@ -5454,7 +5454,7 @@ paths: id: '403918102' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266430' @@ -5466,8 +5466,8 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c114e235824d3ca2c56f76 + - type: contact + id: 64c114e235824d3ca2c56f76 first_contact_reply: admin_assignee_id: 991266430 team_assignee_id: @@ -5488,27 +5488,27 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '711358' - part_type: assign_and_reopen - body: - created_at: 1690375395 - updated_at: 1690375395 - notified_at: 1690375395 - assigned_to: - type: admin - id: '991266430' - author: - id: '991266430' - type: admin - name: Ciaran186 Lee - email: admin186@email.com - attachments: [] - external_id: - redacted: false + - type: conversation_part + id: '711358' + part_type: assign_and_reopen + body: + created_at: 1690375395 + updated_at: 1690375395 + notified_at: 1690375395 + assigned_to: + type: admin + id: '991266430' + author: + id: '991266430' + type: admin + name: Ciaran186 Lee + email: admin186@email.com + attachments: [] + external_id: + redacted: false total_count: 1 schema: - '$ref': '#/components/schemas/conversation' + "$ref": "#/components/schemas/conversation" '404': description: Not found content: @@ -5519,10 +5519,10 @@ paths: type: error.list request_id: 966e0126-4508-43c4-8d4a-1eb38a787a1a 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: @@ -5533,10 +5533,10 @@ paths: type: error.list request_id: 7747eefe-c5d9-4348-b393-d088bcd51cfb 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: @@ -5547,19 +5547,19 @@ paths: type: error.list request_id: e5c8b9b7-7c3f-4232-963b-91d04aea0a81 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 @@ -5593,23 +5593,23 @@ paths: type: admin admin_id: 991266432 body: Goodbye :) - '/conversations/{id}/run_assignment_rules': + "/conversations/{id}/run_assignment_rules": post: summary: Run Assignment Rules on a conversation parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The identifier for the conversation as given by Intercom. - example: '123' - schema: - type: string + - 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. @@ -5632,7 +5632,7 @@ paths: id: '403918106' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266438' @@ -5644,8 +5644,8 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c114e935824d3ca2c56f7a + - type: contact + id: 64c114e935824d3ca2c56f7a first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5666,27 +5666,27 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '711359' - part_type: default_assignment - body: - created_at: 1690375403 - updated_at: 1690375403 - notified_at: 1690375403 - assigned_to: - type: nobody_admin - id: - author: - id: '991266439' - type: bot - name: Operator - email: operator+this_is_an_id343_that_should_be_at_least_@intercom.io - attachments: [] - external_id: - redacted: false + - type: conversation_part + id: '711359' + part_type: default_assignment + body: + created_at: 1690375403 + updated_at: 1690375403 + notified_at: 1690375403 + assigned_to: + type: nobody_admin + id: + author: + id: '991266439' + type: bot + name: Operator + email: operator+this_is_an_id343_that_should_be_at_least_@intercom.io + attachments: [] + external_id: + redacted: false total_count: 1 schema: - '$ref': '#/components/schemas/conversation' + "$ref": "#/components/schemas/conversation" '404': description: Not found content: @@ -5697,10 +5697,10 @@ paths: type: error.list request_id: 21d7fb60-2445-45b9-bd8e-382b0f488985 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: @@ -5711,10 +5711,10 @@ paths: type: error.list request_id: fc88f150-2837-4036-ae4a-3381edec63b4 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: @@ -5725,27 +5725,27 @@ paths: type: error.list request_id: b821bc72-f899-4cec-be6f-178a72fd872b 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 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.\n\n> \U0001F6A7 Note about contacts @@ -5761,10 +5761,10 @@ paths: Attach a contact to a conversation: value: customers: - - type: user - id: 64c114f135824d3ca2c56f7e + - type: user + id: 64c114f135824d3ca2c56f7e schema: - '$ref': '#/components/schemas/conversation' + "$ref": "#/components/schemas/conversation" '404': description: Not found content: @@ -5775,10 +5775,10 @@ paths: type: error.list request_id: 6a3dee8c-ea4b-4457-a061-29913489f5a9 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: @@ -5789,10 +5789,10 @@ paths: type: error.list request_id: 71892374-07c6-469c-b195-73d3fa818838 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: @@ -5803,15 +5803,15 @@ paths: type: error.list request_id: 33fea739-c325-4351-9ac8-7cb0ea516dd2 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 @@ -5825,30 +5825,30 @@ paths: admin_id: 991266448 customer: intercom_user_id: 64c114f335824d3ca2c56f7f - '/conversations/{conversation_id}/customers/{contact_id}': + "/conversations/{conversation_id}/customers/{contact_id}": delete: summary: Detach a contact from a group conversation parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: conversation_id - in: path - required: true - description: The identifier for the conversation as given by Intercom. - example: '123' - schema: - type: string - - name: contact_id - in: path - required: true - description: The identifier for the contact as given by Intercom. - example: '123' - schema: - type: string + - 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.\n\n> \U0001F6A7 Note about contacts @@ -5864,10 +5864,10 @@ paths: Detach a contact from a group conversation: value: customers: - - type: user - id: 64c114fe35824d3ca2c56f89 + - type: user + id: 64c114fe35824d3ca2c56f89 schema: - '$ref': '#/components/schemas/conversation' + "$ref": "#/components/schemas/conversation" '404': description: Contact not found content: @@ -5878,17 +5878,17 @@ paths: type: error.list request_id: 68948547-8a75-4c56-b9dc-1c4e0cf0eb74 errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found Contact not found: value: type: error.list request_id: 77dabc5a-8790-447c-b13d-126917048c3a 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: @@ -5899,10 +5899,10 @@ paths: type: error.list request_id: f48a0c25-61e0-4401-b805-a38be4aad45e 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: @@ -5913,10 +5913,10 @@ paths: type: error.list request_id: e6d25d8e-c888-40c7-93a5-c593f13f6f61 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: @@ -5927,15 +5927,15 @@ paths: type: error.list request_id: 9509c9d5-dd6e-4a4e-a634-b45d0fe49454 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 @@ -5961,16 +5961,16 @@ paths: admin_id: 991266460 customer: intercom_user_id: 64c1150c35824d3ca2c56f98 - '/conversations/redact': + "/conversations/redact": post: summary: Redact a conversation part parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Conversations + - Conversations operationId: redactConversation description: "You can redact a conversation part or the source message of a conversation (as seen in the source object).\n\n> \U0001F4D8 Which parts and @@ -5997,7 +5997,7 @@ paths: id: '403918132' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266466' @@ -6009,8 +6009,8 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c1151f35824d3ca2c56fad + - type: contact + id: 64c1151f35824d3ca2c56fad first_contact_reply: created_at: 1690375456 type: conversation @@ -6034,25 +6034,25 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '711367' - part_type: comment - body: '

This message was deleted

' - created_at: 1690375456 - updated_at: 1690375457 - notified_at: 1690375456 - assigned_to: - author: - id: 64c1151f35824d3ca2c56fad - type: user - name: Joe Bloggs - email: joe@bloggs.com - attachments: [] - external_id: - redacted: true + - type: conversation_part + id: '711367' + part_type: comment + body: "

This message was deleted

" + created_at: 1690375456 + updated_at: 1690375457 + notified_at: 1690375456 + assigned_to: + author: + id: 64c1151f35824d3ca2c56fad + type: user + name: Joe Bloggs + email: joe@bloggs.com + attachments: [] + external_id: + redacted: true total_count: 1 schema: - '$ref': '#/components/schemas/conversation' + "$ref": "#/components/schemas/conversation" '404': description: Not found content: @@ -6063,10 +6063,10 @@ paths: type: error.list request_id: 5bd5b0f5-0581-4b49-bd95-f6eca135c470 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: @@ -6077,15 +6077,15 @@ paths: type: error.list request_id: 559cfc28-89bc-46f5-83b6-370bb95fa904 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 @@ -6099,23 +6099,23 @@ paths: type: conversation_part conversation_id: really_123_doesnt_exist conversation_part_id: really_123_doesnt_exist - '/conversations/{id}/convert': + "/conversations/{id}/convert": post: summary: Convert a conversation to a ticket parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The id of the conversation to target - example: 123 - schema: - type: integer + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The id of the conversation to target + example: 123 + schema: + type: integer tags: - - Conversations + - Conversations description: You can convert a conversation to a ticket. responses: '200': @@ -6128,11 +6128,11 @@ paths: type: error.list request_id: 1881ef50-f17d-460a-a66a-bb2244beb458 errors: - - code: intercom_version_invalid - message: Requested resource is not available in current API - version + - code: intercom_version_invalid + message: Requested resource is not available in current API + version schema: - '$ref': '#/components/schemas/ticket' + "$ref": "#/components/schemas/ticket" '400': description: Bad request content: @@ -6143,16 +6143,16 @@ paths: type: error.list request_id: 3abfd7db-358f-49fa-8828-2d29765f02fe errors: - - code: intercom_version_invalid - message: Requested resource is not available in current API - version + - code: intercom_version_invalid + message: Requested resource is not available in current API + version 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 @@ -6162,35 +6162,35 @@ paths: summary: Bad request value: ticket_type_id: '766841' - '/data_attributes': + "/data_attributes": get: summary: List all data attributes parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: model - in: query - required: false - description: Specify the data attribute model to return. - schema: - type: string - enum: - - contact - - company - - conversation - example: company - - name: include_archived - in: query - required: false - description: Include archived attributes in the list. By default we return - only non archived data attributes. - example: false - schema: - type: boolean + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: model + in: query + required: false + description: Specify the data attribute model to return. + schema: + type: string + enum: + - contact + - company + - conversation + example: company + - name: include_archived + in: query + required: false + description: Include archived attributes in the list. By default we return + only non archived data attributes. + example: false + schema: + type: boolean tags: - - Data Attributes + - Data Attributes operationId: lisDataAttributes description: You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations. @@ -6204,206 +6204,206 @@ 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - custom: false - archived: false - model: company - - id: 188690 - 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 - custom: true - archived: false - admin_id: '991266484' - created_at: 1690375468 - updated_at: 1690375468 - 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 - 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 - 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 - 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 - 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 - custom: false - archived: false - model: company - schema: - '$ref': '#/components/schemas/data_attribute_list' + - 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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 + custom: false + archived: false + model: company + - id: 188690 + 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 + custom: true + archived: false + admin_id: '991266484' + created_at: 1690375468 + updated_at: 1690375468 + 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 + 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 + 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 + 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 + 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 + custom: false + archived: false + model: company + schema: + "$ref": "#/components/schemas/data_attribute_list" '401': description: Unauthorized content: @@ -6414,19 +6414,19 @@ paths: type: error.list request_id: 1591c248-c02e-4d93-8168-096c9877b23d 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 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: @@ -6452,7 +6452,7 @@ paths: updated_at: 1690375469 model: company schema: - '$ref': '#/components/schemas/data_attribute' + "$ref": "#/components/schemas/data_attribute" '400': description: Too few options for list content: @@ -6463,42 +6463,42 @@ paths: type: error.list request_id: '08d7c0b9-4208-4325-a970-995d31e9b169' 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: c2f60de5-e5a1-4328-ad2d-f3a625b6dfa8 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: a9b6238c-b354-43f7-ac9e-1d6edf390395 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: 5c322d43-5cb1-46e0-bdfb-a5ac1caa73d5 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: b6f97ecc-03d0-4153-b95d-ec553fe398cd 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: @@ -6509,15 +6509,15 @@ paths: type: error.list request_id: 64148b55-f66a-453e-bc19-d0498176135a 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 @@ -6534,7 +6534,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: @@ -6554,25 +6554,25 @@ paths: value: description: Just a plain old ring options: - - value: 1-10 + - value: 1-10 archived: false - '/data_attributes/{id}': + "/data_attributes/{id}": put: summary: Update a data attribute parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The data attribute id - example: 1 - schema: - type: integer + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The data attribute id + example: 1 + schema: + type: integer tags: - - Data Attributes + - Data Attributes operationId: updateDataAttribute description: "\nYou can update a data attribute.\n\n> \U0001F6A7 Updating the data type is not possible\n>\n> It is currently a dangerous action to execute @@ -6594,8 +6594,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 custom: true @@ -6605,7 +6605,7 @@ paths: updated_at: 1690375473 model: company schema: - '$ref': '#/components/schemas/data_attribute' + "$ref": "#/components/schemas/data_attribute" '400': description: Too few options in list content: @@ -6616,10 +6616,10 @@ paths: type: error.list request_id: a759dd38-35ab-4b7c-bcb6-dfdad8853193 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: @@ -6630,10 +6630,10 @@ paths: type: error.list request_id: 30bb41ac-1633-4db8-87c3-345ace765819 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: @@ -6644,11 +6644,11 @@ paths: type: error.list request_id: cbdb17ac-7c8d-42d7-b2f6-4a6c7a42315f 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: @@ -6659,23 +6659,23 @@ paths: type: error.list request_id: 72908d54-32d6-40c9-9e1b-d28a748f47ab 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 @@ -6689,24 +6689,24 @@ 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 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: "\nYou will need an Access Token that has write permissions to send Events. Once you have a key you can submit events via POST to the Events @@ -6778,65 +6778,65 @@ paths: type: error.list request_id: b2ee5f9a-5c91-41b9-8c14-f54026ad0a13 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: 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 @@ -6866,7 +6866,7 @@ paths: intercom_user_id: 64c1153a35824d3ca2c56fc6 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 schema: - '$ref': '#/components/schemas/data_event_summary' + "$ref": "#/components/schemas/data_event_summary" '401': description: Unauthorized content: @@ -6877,20 +6877,20 @@ paths: type: error.list request_id: 579a233c-4214-473b-be0b-cf7144e5ee00 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: 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 @@ -6908,25 +6908,25 @@ paths: type: error.list request_id: 28f49cb7-8b2c-4b03-acaf-62e317c5632c 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 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: create data export 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 @@ -6955,34 +6955,34 @@ 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: 1690357485 created_at_before: 1690375485 - '/export/content/data/{job_identifier}': + "/export/content/data/{job_identifier}": get: summary: Show content data export parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: job_identifier - in: path - description: job_identifier - required: true - schema: - type: string + - 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: get data export 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}` @@ -7005,23 +7005,23 @@ 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 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: Cancel data export description: You can cancel your job responses: @@ -7037,23 +7037,23 @@ 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 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: Download data export 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: @@ -7064,16 +7064,16 @@ paths: responses: '200': description: successful - '/messages': + "/messages": post: summary: Create a message parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Messages + - Messages operationId: createMessage description: "You can create a message that has been initiated by an admin. The conversation can be either an in-app message or an email.\n\n> \U0001F6A7 @@ -7122,7 +7122,7 @@ paths: 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: @@ -7133,17 +7133,17 @@ paths: type: error.list request_id: e0861fbf-6acb-4b65-be31-03b78b973457 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: 49d4260c-ee68-4ebc-83f5-9aa32f1cc731 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: @@ -7154,10 +7154,10 @@ paths: type: error.list request_id: ef35c1ef-a72a-419e-a76a-671635de8d79 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: @@ -7168,10 +7168,10 @@ paths: type: error.list request_id: 06f054f1-1d06-414f-92db-84e2af6f832c 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: @@ -7182,15 +7182,15 @@ paths: type: error.list request_id: 4e3b451b-a11e-4995-90d9-faab62a94904 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 @@ -7254,16 +7254,16 @@ paths: message_type: email body: subject: heyy - '/news/news_items': + "/news/news_items": get: summary: List all news items parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - News + - News operationId: listNewsItems description: You can fetch a list of all news items responses: @@ -7281,45 +7281,45 @@ paths: total_pages: 1 type: pages data: - - id: '398555' - type: news-item - workspace_id: this_is_an_id449_that_should_be_at_least_ - title: We have news - body: '

Hello there,

' - sender_id: 991266530 - state: draft - labels: [] - cover_image_url: - reactions: - - - - - - - - - deliver_silently: false - created_at: 1690375522 - updated_at: 1690375522 - newsfeed_assignments: [] - - id: '398556' - type: news-item - workspace_id: this_is_an_id449_that_should_be_at_least_ - title: We have news - body: '

Hello there,

' - sender_id: 991266532 - state: draft - labels: [] - cover_image_url: - reactions: - - - - - - - - - deliver_silently: false - created_at: 1690375522 - updated_at: 1690375522 - newsfeed_assignments: [] + - id: '398555' + type: news-item + workspace_id: this_is_an_id449_that_should_be_at_least_ + title: We have news + body: "

Hello there,

" + sender_id: 991266530 + state: draft + labels: [] + cover_image_url: + reactions: + - + - + - + - + deliver_silently: false + created_at: 1690375522 + updated_at: 1690375522 + newsfeed_assignments: [] + - id: '398556' + type: news-item + workspace_id: this_is_an_id449_that_should_be_at_least_ + title: We have news + body: "

Hello there,

" + sender_id: 991266532 + state: draft + labels: [] + cover_image_url: + reactions: + - + - + - + - + deliver_silently: false + created_at: 1690375522 + updated_at: 1690375522 + newsfeed_assignments: [] total_count: 2 schema: - '$ref': '#/components/schemas/paginated_response' + "$ref": "#/components/schemas/paginated_response" '401': description: Unauthorized content: @@ -7330,19 +7330,19 @@ paths: type: error.list request_id: 4708bac6-c4c1-44cf-82d6-65b3b9d12f25 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 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: @@ -7357,25 +7357,25 @@ paths: type: news-item workspace_id: this_is_an_id453_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: 991266539 state: live labels: - - New - - Product - - Update + - New + - Product + - Update cover_image_url: reactions: - - "\U0001F606" - - "\U0001F605" + - "\U0001F606" + - "\U0001F605" deliver_silently: true created_at: 1690375524 updated_at: 1690375524 newsfeed_assignments: - - newsfeed_id: 403602 - published_at: 1664638214 + - newsfeed_id: 403602 + published_at: 1664638214 schema: - '$ref': '#/components/schemas/news_item' + "$ref": "#/components/schemas/news_item" '401': description: Unauthorized content: @@ -7386,51 +7386,51 @@ paths: type: error.list request_id: e31c044f-bb57-4455-ac58-5f32b38ce4c6 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: 991266539 deliver_silently: true reactions: - - "\U0001F606" - - "\U0001F605" + - "\U0001F606" + - "\U0001F605" state: live newsfeed_assignments: - - newsfeed_id: 403602 - published_at: 1664638214 - '/news/news_items/{id}': + - newsfeed_id: 403602 + published_at: 1664638214 + "/news/news_items/{id}": get: summary: Retrieve a news item parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The unique identifier for the news item which is given by Intercom. - example: 123 - schema: - type: integer + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the news item which is given by Intercom. + example: 123 + schema: + type: integer tags: - - News + - News operationId: retrieveNewsItem description: You can fetch the details of a single news item. responses: @@ -7445,24 +7445,24 @@ paths: type: news-item workspace_id: this_is_an_id457_that_should_be_at_least_ title: We have news - body: '

Hello there,

' + body: "

Hello there,

" sender_id: 991266542 state: live labels: [] cover_image_url: reactions: - - - - - - - - + - + - + - + - deliver_silently: false created_at: 1690375526 updated_at: 1690375526 newsfeed_assignments: - - newsfeed_id: 403604 - published_at: 1690375526 + - newsfeed_id: 403604 + published_at: 1690375526 schema: - '$ref': '#/components/schemas/news_item' + "$ref": "#/components/schemas/news_item" '404': description: News Item Not Found content: @@ -7473,10 +7473,10 @@ paths: type: error.list request_id: 3e33c01f-06e2-40ad-b70d-7382171f95cb 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: @@ -7487,26 +7487,26 @@ paths: type: error.list request_id: 6b17fda5-1fff-41fb-b8e4-61e28533170c errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' + "$ref": "#/components/schemas/error" put: summary: Update a news item parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The unique identifier for the news item which is given by Intercom. - example: 123 - schema: - type: integer + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the news item which is given by Intercom. + example: 123 + schema: + type: integer tags: - - News + - News operationId: updateNewsItem responses: '200': @@ -7520,20 +7520,20 @@ paths: type: news-item workspace_id: this_is_an_id463_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: 991266550 state: live labels: [] cover_image_url: reactions: - - "\U0001F61D" - - "\U0001F602" + - "\U0001F61D" + - "\U0001F602" deliver_silently: false created_at: 1690375528 updated_at: 1690375529 newsfeed_assignments: [] schema: - '$ref': '#/components/schemas/news_item' + "$ref": "#/components/schemas/news_item" '404': description: News Item Not Found content: @@ -7544,10 +7544,10 @@ paths: type: error.list request_id: af3b6f73-305d-423f-b22f-2d253d8c701b 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: @@ -7558,50 +7558,50 @@ paths: type: error.list request_id: 6112e7ef-97c1-4049-9a31-08b6b54a6694 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: 991266550 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: 991266553 reactions: - - "\U0001F61D" - - "\U0001F602" + - "\U0001F61D" + - "\U0001F602" delete: summary: Delete a news item parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The unique identifier for the news item which is given by Intercom. - example: 123 - schema: - type: integer + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the news item which is given by Intercom. + example: 123 + schema: + type: integer tags: - - News + - News operationId: deleteNewsItem description: You can delete a single news item. responses: @@ -7616,7 +7616,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: @@ -7627,10 +7627,10 @@ paths: type: error.list request_id: 4c60d271-077d-4a85-a426-6cf0a4687d4e 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: @@ -7641,28 +7641,28 @@ paths: type: error.list request_id: 7f73d1c9-9a4b-478d-9963-b356790e5024 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: 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 @@ -7683,7 +7683,7 @@ paths: data: [] total_count: 0 schema: - '$ref': '#/components/schemas/paginated_response' + "$ref": "#/components/schemas/paginated_response" '401': description: Unauthorized content: @@ -7694,20 +7694,20 @@ paths: type: error.list request_id: 51ca611e-b3af-4ccd-aa67-12bfc5d2df0c 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: 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: @@ -7725,19 +7725,19 @@ paths: total_pages: 1 type: pages data: - - id: '403617' - type: newsfeed - name: Visitor Feed - created_at: 1690375534 - updated_at: 1690375534 - - id: '403618' - type: newsfeed - name: Visitor Feed - created_at: 1690375534 - updated_at: 1690375534 + - id: '403617' + type: newsfeed + name: Visitor Feed + created_at: 1690375534 + updated_at: 1690375534 + - id: '403618' + type: newsfeed + name: Visitor Feed + created_at: 1690375534 + updated_at: 1690375534 total_count: 2 schema: - '$ref': '#/components/schemas/paginated_response' + "$ref": "#/components/schemas/paginated_response" '401': description: Unauthorized content: @@ -7748,28 +7748,28 @@ paths: type: error.list request_id: 92cbecc1-9d87-4aeb-b0b2-4a6e2f4b1ad7 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: 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: @@ -7786,7 +7786,7 @@ paths: created_at: 1690375535 updated_at: 1690375535 schema: - '$ref': '#/components/schemas/newsfeed' + "$ref": "#/components/schemas/newsfeed" '401': description: Unauthorized content: @@ -7797,27 +7797,27 @@ paths: type: error.list request_id: 4c2bee65-dfe8-4483-90c9-266303f91676 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 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: @@ -7841,9 +7841,9 @@ paths: email: admin294@email.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: @@ -7854,10 +7854,10 @@ paths: type: error.list request_id: c1bc3cd5-f449-43bb-bead-f1b62304350b 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: @@ -7868,27 +7868,27 @@ paths: type: error.list request_id: 5d1008f3-284a-4ef2-805d-dc98b19e4744 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: 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: @@ -7901,20 +7901,20 @@ paths: value: type: segment.list segments: - - type: segment - id: 64c1157835824d3ca2c57032 - name: John segment - created_at: 1690375544 - updated_at: 1690375544 - person_type: user - - type: segment - id: 64c1157835824d3ca2c57033 - name: Jane segment - created_at: 1690375544 - updated_at: 1690375544 - person_type: user - schema: - '$ref': '#/components/schemas/segment_list' + - type: segment + id: 64c1157835824d3ca2c57032 + name: John segment + created_at: 1690375544 + updated_at: 1690375544 + person_type: user + - type: segment + id: 64c1157835824d3ca2c57033 + name: Jane segment + created_at: 1690375544 + updated_at: 1690375544 + person_type: user + schema: + "$ref": "#/components/schemas/segment_list" '401': description: Unauthorized content: @@ -7925,27 +7925,27 @@ paths: type: error.list request_id: 6f7163f0-9310-4e59-8b21-3f69e9270e32 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 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: @@ -7963,7 +7963,7 @@ paths: updated_at: 1690375545 person_type: user schema: - '$ref': '#/components/schemas/segment' + "$ref": "#/components/schemas/segment" '404': description: Segment not found content: @@ -7974,10 +7974,10 @@ paths: type: error.list request_id: 8ff674b1-7d06-4a64-9def-e8f9beb330a3 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: @@ -7988,20 +7988,20 @@ paths: type: error.list request_id: ab2ff59e-690f-4908-b4da-d942455f5348 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: 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. @@ -8015,22 +8015,22 @@ paths: value: type: list data: - - type: subscription - id: '440977' - 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: '440977' + 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: @@ -8041,20 +8041,20 @@ paths: type: error.list request_id: d853ee5b-b563-4f29-aa1e-a8f2f75014c4 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: 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. @@ -8072,7 +8072,7 @@ paths: url: http://via.intercom.io/msgr/d07d54dd-e452-446f-82d1-5adc50b53654 type: phone_call_redirect schema: - '$ref': '#/components/schemas/phone_switch' + "$ref": "#/components/schemas/phone_switch" '400': description: bad request - invalid number content: @@ -8104,54 +8104,54 @@ paths: type: error.list request_id: 219b5863-316e-473c-ad9f-52c6d5a3550c 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: 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: @@ -8164,11 +8164,11 @@ paths: value: type: list data: - - type: tag - id: '321903' - name: Manual tag 1 + - type: tag + id: '321903' + name: Manual tag 1 schema: - '$ref': '#/components/schemas/tag_list' + "$ref": "#/components/schemas/tag_list" '401': description: Unauthorized content: @@ -8179,19 +8179,19 @@ paths: type: error.list request_id: fffa9097-9170-4a75-8c12-bdf00ea013a3 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: @@ -8219,7 +8219,7 @@ paths: id: '321906' name: test schema: - '$ref': '#/components/schemas/tag' + "$ref": "#/components/schemas/tag" '400': description: Invalid parameters content: @@ -8230,10 +8230,10 @@ paths: type: error.list request_id: 0c83d8a3-d93a-47d2-8ac1-a0ae5be79b2e 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: @@ -8244,17 +8244,17 @@ paths: type: error.list request_id: 72f25d60-ca7b-4bcf-b86b-afd79b5d0708 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: 696079ba-baef-4548-a7d4-8e37fbda8f5a 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: @@ -8265,19 +8265,19 @@ paths: type: error.list request_id: a1dfad50-759f-4f5e-9503-2223b4ac95a0 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 @@ -8292,30 +8292,30 @@ paths: value: name: test companies: - - company_id: '123' + - company_id: '123' user_not_found: summary: User not found value: name: test users: - - id: '123' - '/tags/{id}': + - id: '123' + "/tags/{id}": get: summary: Find a specific tag parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - description: The unique identifier of a given tag - example: '123' - required: true - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: The unique identifier of a given tag + example: '123' + required: true + schema: + type: string tags: - - Tags + - Tags operationId: findTag description: | You can fetch the details of tags that are on the workspace by their id. @@ -8332,7 +8332,7 @@ paths: id: '321914' name: Manual tag schema: - '$ref': '#/components/schemas/tag' + "$ref": "#/components/schemas/tag" '404': description: Tag not found content: @@ -8343,10 +8343,10 @@ paths: type: error.list request_id: 9bb10ff9-0e4d-44d3-81b6-3ebb00a1b7b3 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: @@ -8357,26 +8357,26 @@ paths: type: error.list request_id: 07b0a20d-56b3-44fa-a0f5-cc180f81b714 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' + "$ref": "#/components/schemas/error" delete: summary: Delete tag parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - description: The unique identifier of a given tag - example: '123' - required: true - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: The unique identifier of a given tag + example: '123' + required: true + schema: + type: string tags: - - Tags + - Tags operationId: deleteTag description: You can delete the details of tags that are on the workspace by passing in the id. @@ -8393,10 +8393,10 @@ paths: type: error.list request_id: 727deb0e-de65-4457-a14f-41a18023836a 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: @@ -8407,11 +8407,11 @@ paths: type: error.list request_id: 8ecc3526-4580-4efc-a69e-e1c6c9f9f332 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: @@ -8422,20 +8422,20 @@ paths: type: error.list request_id: 6a014985-6c86-4a02-a20b-da1cfdfb4583 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: 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: @@ -8449,7 +8449,7 @@ paths: type: team.list teams: [] schema: - '$ref': '#/components/schemas/team_list' + "$ref": "#/components/schemas/team_list" '401': description: Unauthorized content: @@ -8460,27 +8460,27 @@ paths: type: error.list request_id: ca4d63fa-17d7-4493-951c-aad126043c52 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 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. @@ -8497,7 +8497,7 @@ paths: name: team 1 admin_ids: [] schema: - '$ref': '#/components/schemas/team' + "$ref": "#/components/schemas/team" '404': description: Team not found content: @@ -8508,10 +8508,10 @@ paths: type: error.list request_id: 8fefec82-c096-4e57-a208-c5f01330d5e2 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: @@ -8522,28 +8522,28 @@ paths: type: error.list request_id: 4f938387-c209-4d94-a4c8-2efe8aee6406 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' - '/tickets/{ticket_id}/tags': + "$ref": "#/components/schemas/error" + "/tickets/{ticket_id}/tags": post: summary: Add tag to a ticket parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: ticket_id - in: path - description: ticket_id - example: '64619700005694' - required: true - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: ticket_id + in: path + description: ticket_id + example: '64619700005694' + required: true + schema: + type: string tags: - - Tags - - Tickets + - Tags + - Tickets operationId: attachTagToTicket description: You can tag a specific ticket. This will return a tag object for the tag that was added to the ticket. @@ -8558,11 +8558,11 @@ paths: type: error.list request_id: 1ce13c19-ba80-4cb0-ae0f-0333350aa7b2 errors: - - code: intercom_version_invalid - message: Requested resource is not available in current API - version + - code: intercom_version_invalid + message: Requested resource is not available in current API + version schema: - '$ref': '#/components/schemas/tag' + "$ref": "#/components/schemas/tag" '404': description: Ticket not found content: @@ -8573,11 +8573,11 @@ paths: type: error.list request_id: 6965a1b5-d438-4289-bc83-c05994b9a7a6 errors: - - code: intercom_version_invalid - message: Requested resource is not available in current API - version + - code: intercom_version_invalid + message: Requested resource is not available in current API + version schema: - '$ref': '#/components/schemas/error' + "$ref": "#/components/schemas/error" '401': description: Unauthorized content: @@ -8588,18 +8588,18 @@ paths: type: error.list request_id: 0d6825f3-927b-4a2f-8acf-4fef7de7ab74 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 @@ -8622,31 +8622,31 @@ paths: value: id: 321923 admin_id: 991266642 - '/tickets/{ticket_id}/tags/{id}': + "/tickets/{ticket_id}/tags/{id}": delete: summary: Remove tag from a ticket parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: ticket_id - in: path - description: ticket_id - example: '64619700005694' - required: true - schema: - type: string - - name: id - in: path - description: The unique identifier for the tag which is given by Intercom - example: '7522907' - required: true - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: ticket_id + in: path + description: ticket_id + example: '64619700005694' + required: true + schema: + type: string + - name: id + in: path + description: The unique identifier for the tag which is given by Intercom + example: '7522907' + required: true + schema: + type: string tags: - - Tags - - Tickets + - Tags + - Tickets operationId: detachTagFromTicket description: You can remove tag from a specific ticket. This will return a tag object for the tag that was removed from the ticket. @@ -8661,11 +8661,11 @@ paths: type: error.list request_id: f7e7bbdb-785d-40e9-a265-7439b770ff68 errors: - - code: intercom_version_invalid - message: Requested resource is not available in current API - version + - code: intercom_version_invalid + message: Requested resource is not available in current API + version schema: - '$ref': '#/components/schemas/tag' + "$ref": "#/components/schemas/tag" '404': description: Tag not found content: @@ -8676,19 +8676,19 @@ paths: type: error.list request_id: 15a49a98-d82b-483a-acc4-23f2347f7593 errors: - - code: intercom_version_invalid - message: Requested resource is not available in current API - version + - code: intercom_version_invalid + message: Requested resource is not available in current API + version Tag not found: value: type: error.list request_id: 89cd465e-bfee-4c57-bedc-7bbf0c366fd3 errors: - - code: intercom_version_invalid - message: Requested resource is not available in current API - version + - code: intercom_version_invalid + message: Requested resource is not available in current API + version schema: - '$ref': '#/components/schemas/error' + "$ref": "#/components/schemas/error" '401': description: Unauthorized content: @@ -8699,17 +8699,17 @@ paths: type: error.list request_id: 77f2e4df-77f7-46de-8b13-1384a6ec6eaf 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 @@ -8729,16 +8729,16 @@ paths: summary: Tag not found value: admin_id: 991266654 - '/visitors': + "/visitors": put: 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. @@ -8798,7 +8798,7 @@ paths: utm_term: do_not_track: schema: - '$ref': '#/components/schemas/visitor' + "$ref": "#/components/schemas/visitor" '404': description: visitor Not Found content: @@ -8809,10 +8809,10 @@ paths: type: error.list request_id: fd66f5fe-1c0c-43b6-b390-b5b1d3e064fc 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: @@ -8823,15 +8823,15 @@ paths: type: error.list request_id: 5c3aec06-1956-409c-b6eb-8d5efcaa038d 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 @@ -8846,18 +8846,18 @@ paths: get: summary: Retrieve a visitor with User ID parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: user_id - in: query - description: The user_id of the Visitor you want to retrieve. - required: true - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: user_id + in: query + description: The user_id of the Visitor you want to retrieve. + required: true + schema: + type: string tags: - - Visitors + - Visitors operationId: retrieveVisitorWithUserId description: You can fetch the details of a single visitor. responses: @@ -8912,7 +8912,7 @@ paths: utm_term: do_not_track: schema: - '$ref': '#/components/schemas/visitor' + "$ref": "#/components/schemas/visitor" '404': description: Visitor not found content: @@ -8923,10 +8923,10 @@ paths: type: error.list request_id: 23c16800-4e90-43d1-b001-22151bd182b3 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: @@ -8937,27 +8937,27 @@ paths: type: error.list request_id: 6a052fef-5e43-4692-bf4d-87474e603ad2 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' - '/visitors/{id}': + "$ref": "#/components/schemas/error" + "/visitors/{id}": get: summary: Retrieve a visitor with ID parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: Id provided by Intercom. - example: 5e1c4c1c-7b1e-4b5d-8c1c-5e1c4c1c7b1e - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: Id provided by Intercom. + example: 5e1c4c1c-7b1e-4b5d-8c1c-5e1c4c1c7b1e + schema: + type: string tags: - - Visitors + - Visitors operationId: retrieveVisitor description: You can fetch the details of a single visitor. responses: @@ -9012,7 +9012,7 @@ paths: utm_term: do_not_track: schema: - '$ref': '#/components/schemas/visitor' + "$ref": "#/components/schemas/visitor" '404': description: Visitor not found content: @@ -9023,10 +9023,10 @@ paths: type: error.list request_id: e4f79601-ba7c-4f36-84cb-41de87131830 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: @@ -9037,26 +9037,26 @@ paths: type: error.list request_id: 305755e1-af15-4d18-94ea-e11124064c63 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' + "$ref": "#/components/schemas/error" delete: summary: Delete a visitor parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: Id provided by Intercom. - example: 5e1c4c1c-7b1e-4b5d-8c1c-5e1c4c1c7b1e - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: Id provided by Intercom. + example: 5e1c4c1c-7b1e-4b5d-8c1c-5e1c4c1c7b1e + schema: + type: string tags: - - Visitors + - Visitors operationId: deleteVisitor description: You can delete a single visitor. responses: @@ -9111,7 +9111,7 @@ paths: utm_term: do_not_track: schema: - '$ref': '#/components/schemas/visitor_deleted_object' + "$ref": "#/components/schemas/visitor_deleted_object" '404': description: Visitor Not Found content: @@ -9122,10 +9122,10 @@ paths: type: error.list request_id: '08bd9146-6297-4a07-aaa0-c1bd8c7ae2af' 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: @@ -9136,20 +9136,20 @@ paths: type: error.list request_id: bb84ee9a-a515-4a99-a9df-2f2d33b81bf8 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: 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 @@ -9208,7 +9208,7 @@ paths: utm_term: do_not_track: schema: - '$ref': '#/components/schemas/contact' + "$ref": "#/components/schemas/contact" '401': description: Unauthorized content: @@ -9219,15 +9219,15 @@ paths: type: error.list request_id: 5a2dcb6f-4242-4bcd-b65c-257a0f059962 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 @@ -9280,73 +9280,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 @@ -9363,12 +9363,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" addressable_list: title: Addressable List type: object @@ -9388,7 +9388,7 @@ 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 @@ -9435,7 +9435,7 @@ components: type: array description: This object represents the avatar associated with the admin. example: - - 814865 + - 814865 items: type: integer avatar: @@ -9445,7 +9445,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 @@ -9460,7 +9460,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 @@ -9472,7 +9472,7 @@ components: description: The primary admin ids for the team nullable: true example: - - 493881 + - 493881 items: type: integer secondary_admin_ids: @@ -9480,7 +9480,7 @@ components: description: The secondary admin ids for the team nullable: true example: - - 814865 + - 814865 items: type: integer admin_reply_conversation_request: @@ -9491,12 +9491,12 @@ components: message_type: type: string enum: - - comment - - note + - comment + - note type: type: string enum: - - admin + - admin example: admin body: type: string @@ -9516,9 +9516,9 @@ components: format: uri maxItems: 5 required: - - message_type - - type - - admin_id + - message_type + - type + - admin_id admin_reply_ticket_request: title: Admin Reply on ticket type: object @@ -9527,14 +9527,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 @@ -9564,8 +9564,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 @@ -9575,9 +9575,9 @@ components: format: uri maxItems: 5 required: - - message_type - - type - - admin_id + - message_type + - type + - admin_id admin_with_app: title: Admin type: object @@ -9624,7 +9624,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: @@ -9649,7 +9649,7 @@ components: nullable: true example: true app: - '$ref': '#/components/schemas/app' + "$ref": "#/components/schemas/app" nullable: true description: App that the admin belongs to. app: @@ -9699,7 +9699,7 @@ components: type: string description: The type of object - `article`. enum: - - article + - article default: article example: article id: @@ -9738,8 +9738,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: @@ -9779,10 +9779,10 @@ components: example: en translated_content: nullable: true - '$ref': '#/components/schemas/article_translated_content' + "$ref": "#/components/schemas/article_translated_content" statistics: nullable: true - '$ref': '#/components/schemas/article_statistics' + "$ref": "#/components/schemas/article_statistics" article_content: title: Article Content type: object @@ -9793,8 +9793,8 @@ components: type: string description: The type of object - `article_content` . enum: - - - - article_content + - + - article_content example: article_content title: type: string @@ -9816,8 +9816,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 @@ -9842,10 +9842,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. @@ -9854,7 +9854,7 @@ components: type: array description: An array of Article objects items: - '$ref': '#/components/schemas/article' + "$ref": "#/components/schemas/article" article_statistics: title: Article Statistics type: object @@ -9865,7 +9865,7 @@ components: type: string description: The type of object - `article_statistics`. enum: - - article_statistics + - article_statistics default: article_statistics example: article_statistics views: @@ -9906,120 +9906,120 @@ components: type: string description: The type of object - article_translated_content. enum: - - - - article_translated_content + - + - article_translated_content example: article_translated_content 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 @@ -10028,13 +10028,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 @@ -10052,10 +10052,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 @@ -10068,38 +10068,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 @@ -10108,12 +10108,12 @@ components: message_type: type: string enum: - - close + - close example: close type: type: string enum: - - admin + - admin example: admin admin_id: type: string @@ -10123,11 +10123,11 @@ 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 @@ -10192,12 +10192,12 @@ components: example: en translated_content: nullable: true - '$ref': '#/components/schemas/group_translated_content' + "$ref": "#/components/schemas/group_translated_content" type: type: string description: The type of object - `collection`. enum: - - collection + - collection default: collection example: collection collection_list: @@ -10209,10 +10209,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. @@ -10221,7 +10221,7 @@ components: type: array description: An array of collection objects items: - '$ref': '#/components/schemas/collection' + "$ref": "#/components/schemas/collection" company: title: Company type: object @@ -10234,7 +10234,7 @@ components: type: string description: Value is `company` enum: - - company + - company example: company id: type: string @@ -10325,12 +10325,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 @@ -10339,11 +10339,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 @@ -10353,19 +10353,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 @@ -10375,13 +10375,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: Companys type: object @@ -10391,10 +10391,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. @@ -10403,7 +10403,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 @@ -10416,14 +10416,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 @@ -10471,12 +10471,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 @@ -10503,52 +10503,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 @@ -10605,8 +10605,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 @@ -10637,7 +10637,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 @@ -10657,15 +10657,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 @@ -10675,7 +10675,7 @@ components: type: string description: always contact enum: - - contact + - contact example: contact id: type: string @@ -10700,19 +10700,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 @@ -10724,7 +10724,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 @@ -10744,7 +10744,7 @@ components: type: string description: always contact enum: - - contact + - contact example: contact id: type: string @@ -10769,19 +10769,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 @@ -10819,12 +10819,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 @@ -10844,7 +10844,7 @@ components: type: string description: always contact enum: - - contact + - contact example: contact id: type: string @@ -10859,201 +10859,201 @@ components: contact_reply_conversation_request: title: Contact Reply oneOf: - - title: Intercom User ID - type: object - description: Payload of the request to reply on behalf of a contact using - their `intercom_user_id` - properties: - message_type: - type: string - enum: - - comment - type: - type: string - enum: - - user - body: - type: string - description: The text body of the comment. - intercom_user_id: - type: string - description: The identifier for the contact as given by Intercom. - attachment_urls: - type: array - description: A list of image URLs that will be added as attachments. You - can include up to 5 URLs. - items: - type: string - format: uri - maxItems: 5 - required: - - message_type - - type - - body - - intercom_user_id - - title: User ID - type: object - description: Payload of the request to reply on behalf of a contact using - their `user_id` - properties: - message_type: - type: string - enum: - - comment - type: - type: string - enum: - - user - body: - type: string - description: The text body of the comment. - user_id: - type: string - description: The external_id you have defined for the contact. - attachment_urls: - type: array - description: A list of image URLs that will be added as attachments. You - can include up to 5 URLs. - items: - type: string - format: uri - maxItems: 5 - required: - - message_type - - type - - body - - user_id - - title: Email - type: object - description: Payload of the request to reply on behalf of a contact using - their `email` - properties: - message_type: - type: string - enum: - - comment - type: + - title: Intercom User ID + type: object + description: Payload of the request to reply on behalf of a contact using + their `intercom_user_id` + properties: + message_type: + type: string + enum: + - comment + type: + type: string + enum: + - user + body: + type: string + description: The text body of the comment. + intercom_user_id: + type: string + description: The identifier for the contact as given by Intercom. + attachment_urls: + type: array + description: A list of image URLs that will be added as attachments. You + can include up to 5 URLs. + items: type: string - enum: - - user - body: + format: uri + maxItems: 5 + required: + - message_type + - type + - body + - intercom_user_id + - title: User ID + type: object + description: Payload of the request to reply on behalf of a contact using + their `user_id` + properties: + message_type: + type: string + enum: + - comment + type: + type: string + enum: + - user + body: + type: string + description: The text body of the comment. + user_id: + type: string + description: The external_id you have defined for the contact. + attachment_urls: + type: array + description: A list of image URLs that will be added as attachments. You + can include up to 5 URLs. + items: type: string - description: The text body of the comment. - email: + format: uri + maxItems: 5 + required: + - message_type + - type + - body + - user_id + - title: Email + type: object + description: Payload of the request to reply on behalf of a contact using + their `email` + properties: + message_type: + type: string + enum: + - comment + type: + type: string + enum: + - user + body: + type: string + description: The text body of the comment. + email: + type: string + description: The email you have defined for the user. + attachment_urls: + type: array + description: A list of image URLs that will be added as attachments. You + can include up to 5 URLs. + items: type: string - description: The email you have defined for the user. - attachment_urls: - type: array - description: A list of image URLs that will be added as attachments. You - can include up to 5 URLs. - items: - type: string - format: uri - maxItems: 5 - required: - - message_type - - type - - body - - email + format: uri + maxItems: 5 + required: + - message_type + - type + - body + - email contact_reply_ticket_request: title: Contact Reply on ticket oneOf: - - title: Intercom User ID - type: object - description: Payload of the request to reply on behalf of a contact using - their `intercom_user_id` - properties: - message_type: - type: string - enum: - - comment - type: - type: string - enum: - - user - body: - type: string - description: The text body of the comment. - intercom_user_id: - type: string - description: The identifier for the contact as given by Intercom. - attachment_urls: - type: array - description: A list of image URLs that will be added as attachments. You - can include up to 5 URLs. - items: - type: string - format: uri - maxItems: 5 - required: - - message_type - - type - - body - - intercom_user_id - - title: User ID - type: object - description: Payload of the request to reply on behalf of a contact using - their `user_id` - properties: - message_type: - type: string - enum: - - comment - type: - type: string - enum: - - user - body: - type: string - description: The text body of the comment. - user_id: - type: string - description: The external_id you have defined for the contact. - attachment_urls: - type: array - description: A list of image URLs that will be added as attachments. You - can include up to 5 URLs. - items: - type: string - format: uri - maxItems: 5 - required: - - message_type - - type - - body - - user_id - - title: Email - type: object - description: Payload of the request to reply on behalf of a contact using - their `email` - properties: - message_type: - type: string - enum: - - comment - type: + - title: Intercom User ID + type: object + description: Payload of the request to reply on behalf of a contact using + their `intercom_user_id` + properties: + message_type: + type: string + enum: + - comment + type: + type: string + enum: + - user + body: + type: string + description: The text body of the comment. + intercom_user_id: + type: string + description: The identifier for the contact as given by Intercom. + attachment_urls: + type: array + description: A list of image URLs that will be added as attachments. You + can include up to 5 URLs. + items: type: string - enum: - - user - body: + format: uri + maxItems: 5 + required: + - message_type + - type + - body + - intercom_user_id + - title: User ID + type: object + description: Payload of the request to reply on behalf of a contact using + their `user_id` + properties: + message_type: + type: string + enum: + - comment + type: + type: string + enum: + - user + body: + type: string + description: The text body of the comment. + user_id: + type: string + description: The external_id you have defined for the contact. + attachment_urls: + type: array + description: A list of image URLs that will be added as attachments. You + can include up to 5 URLs. + items: type: string - description: The text body of the comment. - email: + format: uri + maxItems: 5 + required: + - message_type + - type + - body + - user_id + - title: Email + type: object + description: Payload of the request to reply on behalf of a contact using + their `email` + properties: + message_type: + type: string + enum: + - comment + type: + type: string + enum: + - user + body: + type: string + description: The text body of the comment. + email: + type: string + description: The email you have defined for the user. + attachment_urls: + type: array + description: A list of image URLs that will be added as attachments. You + can include up to 5 URLs. + items: type: string - description: The email you have defined for the user. - attachment_urls: - type: array - description: A list of image URLs that will be added as attachments. You - can include up to 5 URLs. - items: - type: string - format: uri - maxItems: 5 - required: - - message_type - - type - - body - - email + format: uri + maxItems: 5 + required: + - message_type + - type + - body + - email contact_segments: title: Segments type: object @@ -11063,13 +11063,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 @@ -11080,7 +11080,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 @@ -11092,12 +11092,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 @@ -11119,12 +11119,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 @@ -11144,7 +11144,7 @@ components: type: string description: always contact enum: - - contact + - contact example: contact id: type: string @@ -11214,9 +11214,9 @@ components: state: type: string enum: - - open - - closed - - snoozed + - open + - closed + - snoozed description: Can be set to "open", "closed" or "snoozed". example: open read: @@ -11226,8 +11226,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: @@ -11243,25 +11243,25 @@ 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" conversation_contacts: title: Contacts type: object @@ -11273,7 +11273,7 @@ components: type: string description: '' enum: - - contact.list + - contact.list example: contact.list contacts: type: array @@ -11281,7 +11281,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_first_contact_reply: title: First contact reply type: object @@ -11314,19 +11314,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 @@ -11349,7 +11349,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 @@ -11366,18 +11366,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 @@ -11422,7 +11422,7 @@ components: type: string description: '' enum: - - conversation_part.list + - conversation_part.list example: conversation_part.list conversation_parts: title: Conversation Parts @@ -11431,7 +11431,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: '' @@ -11459,9 +11459,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_source: title: Conversation source type: object @@ -11493,14 +11493,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 @@ -11626,7 +11626,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 @@ -11638,9 +11638,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 @@ -11670,10 +11670,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. @@ -11692,16 +11692,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 @@ -11722,7 +11722,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, @@ -11735,8 +11735,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 @@ -11748,10 +11748,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 @@ -11769,9 +11769,9 @@ components: example: English description translated_content: nullable: true - '$ref': '#/components/schemas/group_translated_content' + "$ref": "#/components/schemas/group_translated_content" required: - - name + - name create_contact_request: description: Payload to create a contact type: object @@ -11791,7 +11791,7 @@ components: type: string nullable: true description: The contacts phone - example: '+353871234567' + example: "+353871234567" name: type: string nullable: true @@ -11831,15 +11831,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_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 @@ -11853,9 +11853,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: @@ -11866,15 +11866,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 @@ -11888,20 +11888,20 @@ components: type: string description: The model that the data attribute belongs to. enum: - - contact - - company - - conversation + - contact + - company + - conversation 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 @@ -11914,12 +11914,12 @@ components: items: type: string example: - - option1 - - option2 + - option1 + - option2 required: - - name - - model - - data_type + - name + - model + - data_type create_data_event_request: description: '' type: object @@ -11958,21 +11958,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 @@ -12028,8 +12028,8 @@ components: as a unix timestamp. example: 1527811200 required: - - created_at_after - - created_at_before + - created_at_after + - created_at_before create_message_request: description: You can create a message type: object @@ -12040,8 +12040,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 @@ -12065,15 +12065,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 @@ -12083,16 +12083,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 create_conversation_without_contact_reply: type: boolean description: Whether a conversation should be opened in the inbox for the @@ -12100,20 +12100,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 @@ -12182,7 +12182,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 @@ -12193,11 +12193,11 @@ 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_section_request: description: You can create a Section type: object @@ -12214,16 +12214,16 @@ components: example: 18 translated_content: nullable: true - '$ref': '#/components/schemas/group_translated_content' + "$ref": "#/components/schemas/group_translated_content" required: - - name - - parent_id + - name + - parent_id create_ticket_reply_request: title: Create Ticket Reply Request Payload description: You can create a reply on a ticket. 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" cursor_pages: title: Cursor based pages type: object @@ -12237,13 +12237,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 @@ -12260,8 +12260,8 @@ 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 @@ -12290,32 +12290,32 @@ 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 @@ -12329,7 +12329,7 @@ components: type: string description: Value is `data_attribute`. enum: - - data_attribute + - data_attribute example: data_attribute id: type: integer @@ -12341,9 +12341,9 @@ components: description: Value is `contact` for user/lead attributes, `company` for company attributes and `conversation` for conversation attributes.. enum: - - contact - - company - - conversation + - contact + - company + - conversation example: contact name: type: string @@ -12367,11 +12367,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 @@ -12379,8 +12379,8 @@ components: items: type: string example: - - 'true' - - 'false' + - 'true' + - 'false' api_writable: type: boolean description: Can this attribute be updated through API @@ -12421,13 +12421,13 @@ 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 @@ -12438,7 +12438,7 @@ components: type: string description: The type of the object enum: - - event + - event example: event event_name: type: string @@ -12477,8 +12477,8 @@ components: example: invite_code: ADDAFRIEND required: - - event_name - - created_at + - event_name + - created_at data_event_list: title: Data Event List type: object @@ -12488,13 +12488,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 @@ -12514,7 +12514,7 @@ components: type: string description: The type of the object enum: - - event.summary + - event.summary example: event.summary email: type: string @@ -12532,7 +12532,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 @@ -12573,12 +12573,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: @@ -12699,7 +12699,7 @@ components: type: string description: The type of object which was deleted. - article enum: - - article + - article example: article deleted: type: boolean @@ -12719,7 +12719,7 @@ components: type: string description: The type of object which was deleted. - `collection` enum: - - collection + - collection example: collection deleted: type: boolean @@ -12738,7 +12738,7 @@ components: type: string description: The type of object which was deleted. - `company` enum: - - company + - company example: company deleted: type: boolean @@ -12758,7 +12758,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 @@ -12778,7 +12778,7 @@ components: type: string description: The type of object which was deleted. - `section` enum: - - section + - section example: section deleted: type: boolean @@ -12791,7 +12791,7 @@ components: description: The `id` of the admin who is performing the action. example: '5017690' required: - - admin_id + - admin_id error: type: object title: Error @@ -12830,10 +12830,10 @@ components: parameter that was in error. example: email required: - - code + - code required: - - type - - errors + - type + - errors file_attribute: title: File type: object @@ -12877,8 +12877,8 @@ components: type: string description: The type of object - `group_content` . enum: - - - - group_content + - + - group_content example: group_content name: type: string @@ -12887,7 +12887,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 @@ -12900,120 +12900,120 @@ 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" intercom_version: description: Intercom API version.
By default, it's equal to the version set in the app package. @@ -13021,22 +13021,22 @@ components: example: Unstable default: '2.9' 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' - - 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' + - Unstable merge_contacts_request: description: Merge contact data. type: object @@ -13084,10 +13084,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 @@ -13096,33 +13096,33 @@ 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: type: object properties: 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 @@ -13134,7 +13134,7 @@ components: type: string description: The type of object. enum: - - news-item + - news-item example: news-item id: type: string @@ -13164,14 +13164,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. @@ -13223,7 +13223,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 @@ -13234,8 +13234,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 @@ -13248,9 +13248,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, @@ -13259,16 +13259,16 @@ 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 @@ -13286,7 +13286,7 @@ components: type: string description: The type of object. enum: - - newsfeed + - newsfeed example: newsfeed name: type: string @@ -13357,12 +13357,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 @@ -13377,13 +13377,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 @@ -13392,15 +13392,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 @@ -13413,7 +13413,7 @@ components: type: string example: pages enum: - - pages + - pages page: type: integer example: 1 @@ -13438,11 +13438,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. @@ -13452,8 +13452,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 @@ -13497,60 +13497,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 @@ -13567,8 +13567,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 @@ -13576,14 +13576,14 @@ 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 section: title: Section type: object @@ -13595,7 +13595,7 @@ components: type: string description: The type of object - `section`. enum: - - section + - section default: section example: section id: @@ -13643,10 +13643,10 @@ components: example: '1' parent_id: oneOf: - - type: integer - title: Integer - - type: string - title: String + - type: integer + title: Integer + - type: string + title: String description: The id of the parent section. example: 6871119 default_locale: @@ -13656,7 +13656,7 @@ components: example: en translated_content: nullable: true - '$ref': '#/components/schemas/group_translated_content' + "$ref": "#/components/schemas/group_translated_content" section_list: title: Sections type: object @@ -13666,10 +13666,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 sections. @@ -13678,7 +13678,7 @@ components: type: array description: An array of section objects items: - '$ref': '#/components/schemas/section' + "$ref": "#/components/schemas/section" segment: title: Segment type: object @@ -13690,7 +13690,7 @@ components: type: string description: The type of object. enum: - - segment + - segment example: segment id: type: string @@ -13712,8 +13712,8 @@ components: type: string description: 'Type of the contact: contact (lead) or user.' enum: - - contact - - user + - contact + - user example: contact count: type: integer @@ -13731,13 +13731,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 @@ -13752,18 +13752,18 @@ components: operator: type: string enum: - - '=' - - '!=' - - IN - - NIN - - '<' - - '>' - - '~' - - '!~' - - '^' - - '$' + - "=" + - "!=" + - IN + - NIN + - "<" + - ">" + - "~" + - "!~" + - "^" + - "$" description: The Intercom defined id representing the company. - example: '=' + example: "=" value: type: string description: The Intercom defined id representing the company. @@ -13787,10 +13787,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. @@ -13805,7 +13805,7 @@ components: message_type: type: string enum: - - snoozed + - snoozed example: snoozed admin_id: type: string @@ -13817,9 +13817,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 @@ -13869,25 +13869,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 @@ -13896,8 +13896,8 @@ components: items: type: string enum: - - email - - sms_message + - email + - sms_message example: email subscription_type_list: title: Subscription Types @@ -13908,14 +13908,14 @@ 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 @@ -13941,7 +13941,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 @@ -13966,8 +13966,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 @@ -13977,13 +13977,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 @@ -14002,8 +14002,8 @@ components: description: The Intercom defined id representing the user. example: 5f7f0d217289f8d2f4262080 required: - - name - - users + - name + - users tags: title: Tags type: object @@ -14013,13 +14013,13 @@ 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 @@ -14042,11 +14042,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 @@ -14056,13 +14056,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 @@ -14074,7 +14074,7 @@ components: description: The primary team ids for the team nullable: true example: - - 814865 + - 814865 items: type: integer secondary_team_ids: @@ -14082,7 +14082,7 @@ components: description: The secondary team ids for the team nullable: true example: - - 493881 + - 493881 items: type: integer ticket_reply: @@ -14096,7 +14096,7 @@ components: description: Always ticket_part example: ticket_part enum: - - ticket_part + - ticket_part id: type: string description: The id representing the part. @@ -14106,14 +14106,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 @@ -14125,13 +14125,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. @@ -14183,8 +14183,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 @@ -14205,7 +14205,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, @@ -14218,8 +14218,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 @@ -14231,7 +14231,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 @@ -14249,7 +14249,7 @@ components: example: English description translated_content: nullable: true - '$ref': '#/components/schemas/group_translated_content' + "$ref": "#/components/schemas/group_translated_content" update_contact_request: description: You can update a contact type: object @@ -14269,7 +14269,7 @@ components: type: string nullable: true description: The contacts phone - example: '+353871234567' + example: "+353871234567" name: type: string nullable: true @@ -14318,7 +14318,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 @@ -14339,8 +14339,8 @@ components: items: type: string example: - - option1 - - option2 + - option1 + - option2 update_section_request: description: You can update a Section type: object @@ -14357,7 +14357,7 @@ components: example: 18 translated_content: nullable: true - '$ref': '#/components/schemas/group_translated_content' + "$ref": "#/components/schemas/group_translated_content" update_ticket_type_attribute_request: description: You can update a Ticket Type Attribute type: object @@ -14437,9 +14437,9 @@ components: type: string description: Category of the Ticket Type. enum: - - Customer - - Back-office - - Tracker + - Customer + - Back-office + - Tracker example: Customer icon: type: string @@ -14484,10 +14484,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 @@ -14559,12 +14559,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: @@ -14632,7 +14632,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 @@ -14662,7 +14662,7 @@ components: type: string description: The type of the object enum: - - tag.list + - tag.list example: tag.list tags: type: array @@ -14672,7 +14672,7 @@ components: type: string description: The type of the object enum: - - tag + - tag example: tag id: type: string @@ -14689,7 +14689,7 @@ components: type: string description: The type of the object enum: - - segment.list + - segment.list example: segment.list segments: type: array @@ -14748,7 +14748,7 @@ components: type: string description: The type of object which was deleted enum: - - visitor + - visitor example: visitor user_id: type: string @@ -14759,61 +14759,61 @@ 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: Articles - description: Everything about your Articles - - name: Companies - description: Everything about your Companies - - name: Contacts - description: Everything about your contacts - - name: Conversations - description: Everything about your Conversations - externalDocs: - description: What is a conversation? - url: https://www.intercom.com/help/en/articles/4323904-what-is-a-conversation - - name: Data Attributes - description: Everything about your Data Attributes - - name: Data Events - description: Everything about your Data Events - - name: Data Export - description: Everything about your Data Exports - - name: Help Center - description: Everything about your Help Center - - name: Messages - description: Everything about your messages - - name: News - description: Everything about your News - externalDocs: - description: News explained - url: https://www.intercom.com/help/en/articles/6362251-news-explained - - name: Notes - description: Everything about your Notes - - name: Segments - description: Everything about your Segments - - name: Subscription Types - description: Everything about subscription types - - name: Switch - description: Everything about Switch - externalDocs: - description: 'Meet Switch: from on hold to messaging in just a few taps' - url: https://www.intercom.com/switch - - name: Tags - description: Everything about tags - - name: Teams - description: Everything about your Teams - - name: Ticket Type Attributes - description: Everything about your ticket type attributes - - name: Ticket Types - description: Everything about your ticket types - - name: Visitors - description: Everything about your Visitors +- name: Admins + description: Everything about your Admins +- name: Articles + description: Everything about your Articles +- name: Companies + description: Everything about your Companies +- name: Contacts + description: Everything about your contacts +- name: Conversations + description: Everything about your Conversations + externalDocs: + description: What is a conversation? + url: https://www.intercom.com/help/en/articles/4323904-what-is-a-conversation +- name: Data Attributes + description: Everything about your Data Attributes +- name: Data Events + description: Everything about your Data Events +- name: Data Export + description: Everything about your Data Exports +- name: Help Center + description: Everything about your Help Center +- name: Messages + description: Everything about your messages +- name: News + description: Everything about your News + externalDocs: + description: News explained + url: https://www.intercom.com/help/en/articles/6362251-news-explained +- name: Notes + description: Everything about your Notes +- name: Segments + description: Everything about your Segments +- name: Subscription Types + description: Everything about subscription types +- name: Switch + description: Everything about Switch + externalDocs: + description: 'Meet Switch: from on hold to messaging in just a few taps' + url: https://www.intercom.com/switch +- name: Tags + description: Everything about tags +- name: Teams + description: Everything about your Teams +- name: Ticket Type Attributes + description: Everything about your ticket type attributes +- name: Ticket Types + description: Everything about your ticket types +- name: Visitors + description: Everything about your Visitors diff --git a/descriptions/2.9/api.intercom.io.yaml b/descriptions/2.9/api.intercom.io.yaml index 8716b1e..8a27a0c 100644 --- a/descriptions/2.9/api.intercom.io.yaml +++ b/descriptions/2.9/api.intercom.io.yaml @@ -11,16 +11,16 @@ info: name: MIT url: https://spdx.org/licenses/MIT paths: - '/me': + "/me": get: 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 @@ -55,23 +55,23 @@ 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": 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. responses: @@ -91,7 +91,7 @@ paths: has_inbox_seat: true team_ids: [] schema: - '$ref': '#/components/schemas/admin' + "$ref": "#/components/schemas/admin" '404': description: Admin not found content: @@ -102,10 +102,10 @@ paths: type: error.list request_id: 03373da0-fc72-4b54-9228-8a1b9a96cc19 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 +116,18 @@ paths: type: error.list request_id: 4ef53cc1-8fa7-4755-a227-7d342c65734b 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 +157,32 @@ paths: value: away_mode_enabled: true away_mode_reassign: true - '/admins/activity_logs': + "/admins/activity_logs": 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 +201,38 @@ paths: per_page: 20 total_pages: 1 activity_logs: - - id: 5dabb3b4-513a-4693-9307-0bf64e5ea5b7 - performed_by: - type: admin - id: '991266219' - email: admin5@email.com - ip: 127.0.0.1 - metadata: - before: before - after: after - created_at: 1690375752 - activity_type: app_name_change - activity_description: Ciaran5 Lee changed your app name from - before to after. - - id: 919b6905-9df9-4c15-adf5-f66519bbd3a4 - performed_by: - type: admin - id: '991266219' - 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: 1690375752 - 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: 5dabb3b4-513a-4693-9307-0bf64e5ea5b7 + performed_by: + type: admin + id: '991266219' + email: admin5@email.com + ip: 127.0.0.1 + metadata: + before: before + after: after + created_at: 1690375752 + activity_type: app_name_change + activity_description: Ciaran5 Lee changed your app name from + before to after. + - id: 919b6905-9df9-4c15-adf5-f66519bbd3a4 + performed_by: + type: admin + id: '991266219' + 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: 1690375752 + 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" '401': description: Unauthorized content: @@ -243,20 +243,20 @@ paths: type: error.list request_id: b4f3911f-b42d-4ad8-9308-5262bc74b902 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' - '/admins': + "$ref": "#/components/schemas/error" + "/admins": 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 +269,16 @@ paths: value: type: admin.list admins: - - type: admin - email: admin7@email.com - id: '991266222' - name: Ciaran7 Lee - away_mode_enabled: false - away_mode_reassign: false - has_inbox_seat: true - team_ids: [] + - type: admin + email: admin7@email.com + id: '991266222' + name: Ciaran7 Lee + away_mode_enabled: false + away_mode_reassign: false + has_inbox_seat: true + team_ids: [] schema: - '$ref': '#/components/schemas/admin_list' + "$ref": "#/components/schemas/admin_list" '401': description: Unauthorized content: @@ -289,27 +289,27 @@ paths: type: error.list request_id: 8c50cfb3-e8fb-4455-a0af-19970a7649bc errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' - '/admins/{id}': + "$ref": "#/components/schemas/error" + "/admins/{id}": get: summary: Retrieve 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: 123 + schema: + type: integer tags: - - Admins + - Admins operationId: retrieveAdmin description: You can retrieve the details of a single admin. responses: @@ -329,7 +329,7 @@ paths: has_inbox_seat: true team_ids: [] schema: - '$ref': '#/components/schemas/admin' + "$ref": "#/components/schemas/admin" '404': description: Admin not found content: @@ -340,10 +340,10 @@ paths: type: error.list request_id: 1da035c3-0cb7-4870-860c-59a6a3355535 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 +354,20 @@ paths: type: error.list request_id: 5cd1a80c-a069-4be5-8883-7a0fa6e8de8e errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' - '/articles': + "$ref": "#/components/schemas/error" + "/articles": get: summary: List all articles parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Articles + - Articles operationId: listArticles description: "You can fetch a list of all articles by making a GET request to `https://api.intercom.io/articles`.\n\n> \U0001F4D8 How are the articles sorted @@ -390,21 +390,21 @@ paths: total_pages: 1 total_count: 1 data: - - id: '92828' - type: article - workspace_id: this_is_an_id22_that_should_be_at_least_4 - parent_id: 87783 - parent_type: collection - title: This is the article title - description: '' - body: '' - author_id: 991266227 - state: published - created_at: 1690375756 - updated_at: 1690375756 - url: http://help-center.test/myapp-22/en/articles/92828-this-is-the-article-title - schema: - '$ref': '#/components/schemas/article_list' + - id: '92828' + type: article + workspace_id: this_is_an_id22_that_should_be_at_least_4 + parent_id: 87783 + parent_type: collection + title: This is the article title + description: '' + body: '' + author_id: 991266227 + state: published + created_at: 1690375756 + updated_at: 1690375756 + url: http://help-center.test/myapp-22/en/articles/92828-this-is-the-article-title + schema: + "$ref": "#/components/schemas/article_list" '401': description: Unauthorized content: @@ -415,19 +415,19 @@ paths: type: error.list request_id: 85f5c262-e9e8-49c9-b8e7-5865e0af86b9 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 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: @@ -460,7 +460,7 @@ paths: updated_at: 1690375758 url: http://help-center.test/myapp-26/en/articles/92831-thanks-for-everything schema: - '$ref': '#/components/schemas/article' + "$ref": "#/components/schemas/article" '400': description: Bad Request content: @@ -471,11 +471,11 @@ paths: type: error.list request_id: 31c16e05-55f1-40c8-9895-4c5f60989b5c 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: @@ -486,15 +486,15 @@ paths: type: error.list request_id: 178eee51-3193-4728-873f-c65c1d83c376 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 @@ -520,23 +520,23 @@ paths: description: Description of the Article body: Body of the Article state: published - '/articles/{id}': + "/articles/{id}": get: summary: Retrieve an article parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The unique identifier for the article which is given by Intercom. - example: 123 - schema: - type: integer + - 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/`. @@ -570,7 +570,7 @@ paths: updated_at: 1690375761 url: http://help-center.test/myapp-32/en/articles/92834-this-is-the-article-title schema: - '$ref': '#/components/schemas/article' + "$ref": "#/components/schemas/article" '404': description: Article not found content: @@ -581,10 +581,10 @@ paths: type: error.list request_id: f4dd371f-ec20-4174-b2b2-b975c4e3f31c 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: @@ -595,26 +595,26 @@ paths: type: error.list request_id: 34b0030c-27d2-4afd-ba6f-652d2ca45e4d errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' + "$ref": "#/components/schemas/error" put: 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/`. @@ -648,7 +648,7 @@ paths: updated_at: 1690375763 url: http://help-center.test/myapp-38/en/articles/92837-christmas-is-here schema: - '$ref': '#/components/schemas/article' + "$ref": "#/components/schemas/article" '404': description: Article Not Found content: @@ -659,10 +659,10 @@ paths: type: error.list request_id: d3b177ee-c022-4f69-8f70-449ef2d53195 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: @@ -673,42 +673,42 @@ paths: type: error.list request_id: 80e95c62-cfe1-4104-8606-700c71e1cb5e 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: 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: @@ -723,7 +723,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: @@ -734,10 +734,10 @@ paths: type: error.list request_id: bb348428-0c88-40f5-a182-ebe014d8596d 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: @@ -748,20 +748,20 @@ paths: type: error.list request_id: b979520e-8df1-4cc5-93a1-6a0a5a23222e 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: 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`.\n\n> \U0001F4D8 How @@ -786,7 +786,7 @@ paths: per_page: 20 total_pages: 0 schema: - '$ref': '#/components/schemas/collection_list' + "$ref": "#/components/schemas/collection_list" '401': description: Unauthorized content: @@ -797,19 +797,19 @@ paths: type: error.list request_id: 7829d955-bbbe-47e8-a36a-02facc443dea 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: @@ -831,7 +831,7 @@ paths: icon: book-bookmark type: collection schema: - '$ref': '#/components/schemas/collection' + "$ref": "#/components/schemas/collection" '400': description: Bad Request content: @@ -842,10 +842,10 @@ paths: type: error.list request_id: 7629d7b1-6540-4537-8c52-a77c7666520d 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: @@ -856,15 +856,15 @@ paths: type: error.list request_id: 66e13942-f9a5-444a-bfed-fedb332ade18 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 @@ -874,23 +874,23 @@ paths: summary: Bad Request value: description: Missing required parameter - '/help_center/collections/{id}': + "/help_center/collections/{id}": get: summary: Retrieve 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/`. @@ -913,7 +913,7 @@ paths: icon: bookmark type: collection schema: - '$ref': '#/components/schemas/collection' + "$ref": "#/components/schemas/collection" '404': description: Collection not found content: @@ -924,10 +924,10 @@ paths: type: error.list request_id: 65d41f8a-a485-46a2-93f8-a348b1cf2619 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: @@ -938,26 +938,26 @@ paths: type: error.list request_id: 000d5f22-7ad5-4c8b-a408-6c2cdb12d2ef errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' + "$ref": "#/components/schemas/error" put: 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/`. @@ -980,7 +980,7 @@ paths: icon: folder type: collection schema: - '$ref': '#/components/schemas/collection' + "$ref": "#/components/schemas/collection" '404': description: Collection Not Found content: @@ -991,10 +991,10 @@ paths: type: error.list request_id: 54690e9f-ed02-40be-b8bc-928274b8a969 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: @@ -1005,15 +1005,15 @@ paths: type: error.list request_id: 45f717cc-c242-4c8e-8000-136ab0a57959 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 @@ -1026,19 +1026,19 @@ paths: 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/`. @@ -1054,7 +1054,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: @@ -1065,10 +1065,10 @@ paths: type: error.list request_id: c89b29ad-d980-4aa1-8f04-a55198e77d0d 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: @@ -1079,20 +1079,20 @@ paths: type: error.list request_id: c055f8d0-45e1-4b33-8386-55f37601899e errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' - '/help_center/sections': + "$ref": "#/components/schemas/error" + "/help_center/sections": get: summary: List all sections 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: listAllSections description: "You can fetch a list of all sections by making a GET request to `https://api.intercom.io/help_center/sections`.\n> \U0001F4D8 How are the @@ -1109,15 +1109,15 @@ paths: value: type: list data: - - id: '87827' - workspace_id: this_is_an_id78_that_should_be_at_least_4 - name: English section title - url: http://help-center.test/myapp-78/section-15 - order: 15 - created_at: 1690375775 - updated_at: 1690375775 - type: section - parent_id: 87826 + - id: '87827' + workspace_id: this_is_an_id78_that_should_be_at_least_4 + name: English section title + url: http://help-center.test/myapp-78/section-15 + order: 15 + created_at: 1690375775 + updated_at: 1690375775 + type: section + parent_id: 87826 total_count: 1 pages: type: pages @@ -1125,7 +1125,7 @@ paths: per_page: 20 total_pages: 1 schema: - '$ref': '#/components/schemas/section_list' + "$ref": "#/components/schemas/section_list" '401': description: Unauthorized content: @@ -1136,19 +1136,19 @@ paths: type: error.list request_id: dd8cba0d-b84e-450e-a239-733ee0934f59 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 section 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: createSection description: You can create a new section by making a POST request to `https://api.intercom.io/help_center/sections.` responses: @@ -1169,7 +1169,7 @@ paths: type: section parent_id: '87830' schema: - '$ref': '#/components/schemas/section' + "$ref": "#/components/schemas/section" '401': description: Unauthorized content: @@ -1180,38 +1180,38 @@ paths: type: error.list request_id: b9306a5c-50d2-4fc2-a6f1-7211c185f9ea 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_section_request' + "$ref": "#/components/schemas/create_section_request" examples: section_created: summary: section created value: name: Thanks for everything parent_id: 87830 - '/help_center/sections/{id}': + "/help_center/sections/{id}": get: summary: Retrieve a section parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The unique identifier for the section 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 section which is given by Intercom. + example: 123 + schema: + type: integer tags: - - Help Center + - Help Center operationId: retrieveSection description: You can fetch the details of a single section by making a GET request to `https://api.intercom.io/help_center/sections/`. @@ -1233,7 +1233,7 @@ paths: type: section parent_id: 87835 schema: - '$ref': '#/components/schemas/section' + "$ref": "#/components/schemas/section" '404': description: Section not found content: @@ -1244,10 +1244,10 @@ paths: type: error.list request_id: 7ae5bec5-20e2-4d21-87e4-538f876be572 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: @@ -1258,26 +1258,26 @@ paths: type: error.list request_id: 8c32db73-1290-4a87-bc6c-59c33dfd7823 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' + "$ref": "#/components/schemas/error" put: summary: Update a section parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The unique identifier for the section 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 section which is given by Intercom. + example: 123 + schema: + type: integer tags: - - Help Center + - Help Center operationId: updateSection description: You can update the details of a single section by making a PUT request to `https://api.intercom.io/sections/`. @@ -1299,7 +1299,7 @@ paths: type: section parent_id: '87841' schema: - '$ref': '#/components/schemas/section' + "$ref": "#/components/schemas/section" '404': description: Section Not Found content: @@ -1310,10 +1310,10 @@ paths: type: error.list request_id: 13c56331-6b54-4642-8f26-5c957a39f24c 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: @@ -1324,15 +1324,15 @@ paths: type: error.list request_id: 8bd9967d-b34f-478f-865e-3ede3fc506a4 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_section_request' + "$ref": "#/components/schemas/update_section_request" examples: successful: summary: successful @@ -1347,19 +1347,19 @@ paths: delete: summary: Delete a section parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The unique identifier for the section 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 section which is given by Intercom. + example: 123 + schema: + type: integer tags: - - Help Center + - Help Center operationId: deleteSection description: You can delete a single section by making a DELETE request to `https://api.intercom.io/sections/`. responses: @@ -1374,7 +1374,7 @@ paths: object: section deleted: true schema: - '$ref': '#/components/schemas/deleted_section_object' + "$ref": "#/components/schemas/deleted_section_object" '404': description: section Not Found content: @@ -1385,10 +1385,10 @@ paths: type: error.list request_id: 45b740e7-1634-4e92-999e-e8878a85b1ba 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: @@ -1399,20 +1399,20 @@ paths: type: error.list request_id: 969d8788-107e-42d8-a714-2c9f83b4ad98 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 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.\n\n> \U0001F4D8 Companies with no users\n>\n> Companies will be only visible in Intercom when there @@ -1448,7 +1448,7 @@ paths: custom_attributes: creation_source: api schema: - '$ref': '#/components/schemas/company' + "$ref": "#/components/schemas/company" '400': description: Bad Request content: @@ -1459,10 +1459,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: @@ -1473,15 +1473,15 @@ paths: type: error.list request_id: 80059ffc-b716-4ad1-b4ae-2e7b9936dfa3 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 @@ -1496,35 +1496,35 @@ paths: get: summary: Retrieve a company parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: filter - in: query - style: form - required: true - schema: - type: object - oneOf: - - description: The `company_id` of the company to filter by. - title: Filter by company_id - properties: - company_id: - type: string - required: - - company_id - additionalProperties: false - - description: The `name` of the company to filter by. - title: Filter by name - properties: - name: - type: string - required: - - name - additionalProperties: false + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: filter + in: query + style: form + required: true + schema: + type: object + oneOf: + - description: The `company_id` of the company to filter by. + title: Filter by company_id + properties: + company_id: + type: string + required: + - company_id + additionalProperties: false + - description: The `name` of the company to filter by. + title: Filter by name + properties: + name: + type: string + required: + - name + additionalProperties: false tags: - - Companies + - Companies operationId: retrieveCompany description: | You can fetch a company by either passing in `company_id` or `name` as a query parameter. @@ -1560,7 +1560,7 @@ paths: plan: {} custom_attributes: {} schema: - '$ref': '#/components/schemas/company' + "$ref": "#/components/schemas/company" '404': description: Company Not Found content: @@ -1571,10 +1571,10 @@ paths: type: error.list request_id: 65e19381-431d-46e8-9141-27445efb9f5c 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: @@ -1585,27 +1585,27 @@ paths: type: error.list request_id: f10060ac-cad7-4fb1-8ab9-a235c6b74ea5 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 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: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + schema: + type: string tags: - - Companies + - Companies operationId: RetrieveACompanyById description: You can fetch a single company. responses: @@ -1636,7 +1636,7 @@ paths: plan: {} custom_attributes: {} schema: - '$ref': '#/components/schemas/company' + "$ref": "#/components/schemas/company" '404': description: Company Not Found content: @@ -1647,10 +1647,10 @@ paths: type: error.list request_id: fdbb19f1-cc16-42c7-adcc-01bf5d4c2641 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: @@ -1661,26 +1661,26 @@ paths: type: error.list request_id: b2bc30cc-7bbf-4e36-9c8b-fe997f79ea82 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' + "$ref": "#/components/schemas/error" put: 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: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + schema: + type: string tags: - - Companies + - Companies operationId: UpdateCompany description: You can update a single company responses: @@ -1711,7 +1711,7 @@ paths: plan: {} custom_attributes: {} schema: - '$ref': '#/components/schemas/company' + "$ref": "#/components/schemas/company" '404': description: Company Not Found content: @@ -1722,10 +1722,10 @@ paths: type: error.list request_id: 8b30c5e5-6659-4d7a-8755-15dc4d3da1fe 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: @@ -1736,26 +1736,26 @@ paths: type: error.list request_id: 2ee66332-4a2b-44a2-8ce6-191d6c967891 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' + "$ref": "#/components/schemas/error" 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: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + schema: + type: string tags: - - Companies + - Companies operationId: deleteCompany description: You can delete a single company. responses: @@ -1770,7 +1770,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: @@ -1781,10 +1781,10 @@ paths: type: error.list request_id: bd5faf91-4843-4553-a49c-d570e9cee588 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: @@ -1795,28 +1795,28 @@ paths: type: error.list request_id: d7ade383-1a5d-483f-a50a-f2da22fe6b99 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: 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: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + 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: @@ -1836,7 +1836,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: @@ -1847,10 +1847,10 @@ paths: type: error.list request_id: c3759b88-221a-4fa3-862e-160f0c2c8ff4 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: @@ -1861,27 +1861,27 @@ paths: type: error.list request_id: 95f53484-9fda-4e69-ad70-c5f7692dfa61 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: 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: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + schema: + type: string tags: - - Companies + - Companies operationId: ListAttachedSegmentsForCompanies description: You can fetch a list of all segments that belong to a company. responses: @@ -1895,7 +1895,7 @@ paths: type: list data: [] schema: - '$ref': '#/components/schemas/company_attached_segments' + "$ref": "#/components/schemas/company_attached_segments" '404': description: Company Not Found content: @@ -1906,10 +1906,10 @@ paths: type: error.list request_id: b1cb7d3f-64aa-4e81-ab33-067baa202fde 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: @@ -1920,65 +1920,65 @@ paths: type: error.list request_id: e524036f-bc35-4684-bfda-d896b03b466d 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: summary: List all companies parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: page - in: query - required: false - description: what page of results to fetch. Defaults to first page - example: first page - schema: - type: string - - name: per_page - in: query - required: false - description: how many results per page. Defaults to 15 - example: '15' - schema: - type: string - - 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: filter - in: query - style: form - required: true - schema: - type: object - oneOf: - - description: The `id` of the tag to filter by. - title: Filter by tag - properties: - tag_id: - type: string - required: - - tag_id - additionalProperties: false - - description: The `id` of the segment to filter by. - title: Filter by segment - properties: - segment_id: - type: string - required: - - segment_id - additionalProperties: false + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: page + in: query + required: false + description: what page of results to fetch. Defaults to first page + example: first page + schema: + type: string + - name: per_page + in: query + required: false + description: how many results per page. Defaults to 15 + example: '15' + schema: + type: string + - 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: filter + in: query + style: form + required: true + schema: + type: object + oneOf: + - description: The `id` of the tag to filter by. + title: Filter by tag + properties: + tag_id: + type: string + required: + - tag_id + additionalProperties: false + - description: The `id` of the segment to filter by. + title: Filter by segment + properties: + segment_id: + type: string + required: + - segment_id + additionalProperties: false 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.\n\nNote @@ -1997,25 +1997,25 @@ paths: value: type: list data: - - type: company - company_id: remote_companies_scroll_2 - id: 64c1167d35824d3d6bb50564 - app_id: this_is_an_id149_that_should_be_at_least_ - name: IntercomQATest1 - remote_created_at: 1690375805 - created_at: 1690375805 - updated_at: 1690375805 - 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: 64c1167d35824d3d6bb50564 + app_id: this_is_an_id149_that_should_be_at_least_ + name: IntercomQATest1 + remote_created_at: 1690375805 + created_at: 1690375805 + updated_at: 1690375805 + 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: @@ -2024,7 +2024,7 @@ paths: total_pages: 1 total_count: 1 schema: - '$ref': '#/components/schemas/company_list' + "$ref": "#/components/schemas/company_list" '401': description: Unauthorized content: @@ -2035,26 +2035,26 @@ paths: type: error.list request_id: ebf78278-0bb9-44f1-9e52-4769a61ba827 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: 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: " The `list all companies` functionality does not work well for huge datasets, and can result in errors and performance problems when @@ -2083,30 +2083,30 @@ paths: value: type: list data: - - type: company - company_id: remote_companies_scroll_2 - id: 64c1167f35824d3d6bb5056c - app_id: this_is_an_id153_that_should_be_at_least_ - name: IntercomQATest1 - remote_created_at: 1690375807 - created_at: 1690375807 - updated_at: 1690375807 - 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: 64c1167f35824d3d6bb5056c + app_id: this_is_an_id153_that_should_be_at_least_ + name: IntercomQATest1 + remote_created_at: 1690375807 + created_at: 1690375807 + updated_at: 1690375807 + 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: scroll_param: 6fff991f-6613-4f11-8416-4122de33fc15 schema: - '$ref': '#/components/schemas/company_scroll' + "$ref": "#/components/schemas/company_scroll" '401': description: Unauthorized content: @@ -2117,27 +2117,27 @@ paths: type: error.list request_id: c5f55b9b-5f3d-4c8c-8b90-1b0986fcffb0 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: 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: @@ -2168,7 +2168,7 @@ paths: plan: {} custom_attributes: {} schema: - '$ref': '#/components/schemas/company' + "$ref": "#/components/schemas/company" '404': description: Company Not Found content: @@ -2179,10 +2179,10 @@ paths: type: error.list request_id: edd1859d-bb85-4b9d-b69e-4929b9ccb1e9 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: @@ -2193,17 +2193,17 @@ paths: type: error.list request_id: 55788134-c588-4407-b133-3677bdd56d71 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 @@ -2219,31 +2219,31 @@ paths: summary: Company Not Found value: id: 64c1168235824d3d6bb50579 - '/contacts/{contact_id}/companies/{id}': + "/contacts/{contact_id}/companies/{id}": delete: 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: @@ -2274,7 +2274,7 @@ paths: plan: {} custom_attributes: {} schema: - '$ref': '#/components/schemas/company' + "$ref": "#/components/schemas/company" '404': description: Contact Not Found content: @@ -2285,17 +2285,17 @@ paths: type: error.list request_id: c29063ca-7238-46c3-a255-e835644e6da1 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: 04f66fa4-5a89-4085-a6e1-05c574036e80 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: @@ -2306,28 +2306,28 @@ paths: type: error.list request_id: e87e10d7-f7cf-4308-b338-77d24493b339 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' - '/contacts/{contact_id}/companies': + "$ref": "#/components/schemas/error" + "/contacts/{contact_id}/companies": get: summary: List attached companies for contact parameters: - - name: contact_id - in: path - description: The unique identifier for the contact which is given by Intercom - example: 63a07ddf05a32042dffac965 - required: true - schema: - type: string - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' + - name: contact_id + in: path + description: The unique identifier for the contact which is given by Intercom + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Contacts - - Companies + - Contacts + - Companies operationId: listCompaniesForAContact description: You can fetch a list of companies that are associated to a contact. responses: @@ -2340,26 +2340,26 @@ paths: value: type: list data: - - type: company - company_id: '1' - id: 64c1169435824d3d6bb505a7 - app_id: this_is_an_id171_that_should_be_at_least_ - name: company25 - remote_created_at: 1690375828 - created_at: 1690375828 - updated_at: 1690375828 - last_request_at: 1690203028 - 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: 64c1169435824d3d6bb505a7 + app_id: this_is_an_id171_that_should_be_at_least_ + name: company25 + remote_created_at: 1690375828 + created_at: 1690375828 + updated_at: 1690375828 + last_request_at: 1690203028 + 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: @@ -2368,7 +2368,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: @@ -2379,10 +2379,10 @@ paths: type: error.list request_id: fc5c409f-2656-4480-98e6-41b5f05881f5 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: @@ -2393,27 +2393,27 @@ paths: type: error.list request_id: '069f825b-579c-4dcc-bacf-b66aa969ad7b' 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: 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: @@ -2426,48 +2426,48 @@ paths: value: type: list data: - - type: note - id: '405620' - created_at: 1689771030 - contact: - type: contact - id: 64c1169635824d3d6bb505b2 - author: - type: admin - id: '991266317' - name: Ciaran102 Lee - email: admin102@email.com - away_mode_enabled: false - away_mode_reassign: false - body: '

This is a note.

' - - type: note - id: '405619' - created_at: 1689684630 - contact: - type: contact - id: 64c1169635824d3d6bb505b2 - author: - type: admin - id: '991266317' - name: Ciaran102 Lee - email: admin102@email.com - away_mode_enabled: false - away_mode_reassign: false - body: '

This is a note.

' - - type: note - id: '405618' - created_at: 1689684630 - contact: - type: contact - id: 64c1169635824d3d6bb505b2 - author: - type: admin - id: '991266317' - name: Ciaran102 Lee - email: admin102@email.com - away_mode_enabled: false - away_mode_reassign: false - body: '

This is a note.

' + - type: note + id: '405620' + created_at: 1689771030 + contact: + type: contact + id: 64c1169635824d3d6bb505b2 + author: + type: admin + id: '991266317' + name: Ciaran102 Lee + email: admin102@email.com + away_mode_enabled: false + away_mode_reassign: false + body: "

This is a note.

" + - type: note + id: '405619' + created_at: 1689684630 + contact: + type: contact + id: 64c1169635824d3d6bb505b2 + author: + type: admin + id: '991266317' + name: Ciaran102 Lee + email: admin102@email.com + away_mode_enabled: false + away_mode_reassign: false + body: "

This is a note.

" + - type: note + id: '405618' + created_at: 1689684630 + contact: + type: contact + id: 64c1169635824d3d6bb505b2 + author: + type: admin + id: '991266317' + name: Ciaran102 Lee + email: admin102@email.com + away_mode_enabled: false + away_mode_reassign: false + body: "

This is a note.

" total_count: 3 pages: type: pages @@ -2476,7 +2476,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: @@ -2487,27 +2487,27 @@ paths: type: error.list request_id: 2e0b3234-7e90-4c1f-98a4-08c30e02864e 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: 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: @@ -2531,9 +2531,9 @@ paths: email: admin104@email.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: @@ -2544,24 +2544,24 @@ paths: type: error.list request_id: 67cafacf-81c8-482c-be24-f9e83c55e487 errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found Contact not found: value: type: error.list request_id: ca4c4249-7484-464b-8a57-9197a9eabd15 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 @@ -2594,24 +2594,24 @@ paths: contact_id: 123 admin_id: 991266321 body: Hello - '/contacts/{contact_id}/segments': + "/contacts/{contact_id}/segments": get: summary: List attached segments for contact parameters: - - name: contact_id - in: path - description: The unique identifier for the contact which is given by Intercom - example: 63a07ddf05a32042dffac965 - required: true - schema: - type: string - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' + - 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: @@ -2624,14 +2624,14 @@ paths: value: type: list data: - - type: segment - id: 64c1169935824d3d6bb505b7 - name: segment - created_at: 1690375833 - updated_at: 1690375833 - person_type: user - schema: - '$ref': '#/components/schemas/contact_segments' + - type: segment + id: 64c1169935824d3d6bb505b7 + name: segment + created_at: 1690375833 + updated_at: 1690375833 + person_type: user + schema: + "$ref": "#/components/schemas/contact_segments" '404': description: Contact not found content: @@ -2642,10 +2642,10 @@ paths: type: error.list request_id: b490ef32-f815-4835-ad9d-af51e63812c0 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: @@ -2656,28 +2656,28 @@ paths: type: error.list request_id: 5dc449bf-5597-49d5-8432-c5396c16d7b1 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: 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. @@ -2697,36 +2697,36 @@ paths: value: type: list data: - - type: subscription - id: '440933' - 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: '440935' - 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: '440933' + 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: '440935' + 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: @@ -2737,10 +2737,10 @@ paths: type: error.list request_id: d4dbf01c-ab9f-48ee-b8ef-dd06a2b58c99 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: @@ -2751,27 +2751,27 @@ paths: type: error.list request_id: b489a2e0-6a26-4bd9-bea1-12d305f3a481 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 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: @@ -2798,13 +2798,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: @@ -2815,17 +2815,17 @@ paths: type: error.list request_id: 24b5514a-aec7-4405-ab47-7428a7bfc63a errors: - - code: not_found - message: User Not Found + - code: not_found + message: User Not Found Resource not found: value: type: error.list request_id: c038c27c-0c0d-42ad-a607-30365090f254 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: @@ -2836,18 +2836,18 @@ paths: type: error.list request_id: 6b16133b-7e2c-41c5-a752-383dfb18a170 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 @@ -2874,32 +2874,32 @@ 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 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 @@ -2921,13 +2921,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: @@ -2938,17 +2938,17 @@ paths: type: error.list request_id: 4bccb8c4-4678-4631-a2ae-5dfbfd576b70 errors: - - code: not_found - message: User Not Found + - code: not_found + message: User Not Found Resource not found: value: type: error.list request_id: 40b0c71c-c202-4658-8680-f1b32da507d3 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: @@ -2959,28 +2959,28 @@ paths: type: error.list request_id: 275b87c7-965d-4a89-b406-7edf95d5c0f4 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: 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. @@ -2994,11 +2994,11 @@ paths: value: type: list data: - - type: tag - id: '321873' - name: Manual tag + - type: tag + id: '321873' + name: Manual tag schema: - '$ref': '#/components/schemas/tag_list' + "$ref": "#/components/schemas/tag_list" '404': description: Contact not found content: @@ -3009,10 +3009,10 @@ paths: type: error.list request_id: 7901c41f-c6ad-490f-9fae-a980356e4c5a 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: @@ -3023,27 +3023,27 @@ paths: type: error.list request_id: 625008c4-b95b-48e4-9afb-5874f7a2a5de 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 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. @@ -3059,7 +3059,7 @@ paths: id: '321874' name: Manual tag schema: - '$ref': '#/components/schemas/tag' + "$ref": "#/components/schemas/tag" '404': description: Tag not found content: @@ -3070,17 +3070,17 @@ paths: type: error.list request_id: f9840d50-2c56-45d8-bba0-bcb0ca356db6 errors: - - code: not_found - message: User Not Found + - code: not_found + message: User Not Found Tag not found: value: type: error.list request_id: f552d980-6710-42af-becd-8865ee94234e 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: @@ -3091,17 +3091,17 @@ paths: type: error.list request_id: 86e8fe31-d662-4dc8-96ed-e112f8e0463c 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 @@ -3121,31 +3121,31 @@ paths: summary: Tag not found value: id: '123' - '/contacts/{contact_id}/tags/{id}': + "/contacts/{contact_id}/tags/{id}": delete: summary: Remove tag from a contact tags: - - Tags - - Contacts + - Tags + - Contacts parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: contact_id - in: path - description: The unique identifier for the contact which is given by Intercom - example: 63a07ddf05a32042dffac965 - required: true - schema: - type: string - - name: id - in: path - description: The unique identifier for the tag which is given by Intercom - example: '7522907' - required: true - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: contact_id + in: path + description: The unique identifier for the contact which is given by Intercom + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + - name: id + in: path + description: The unique identifier for the tag which is given by Intercom + example: '7522907' + required: true + schema: + type: string operationId: detachTagFromContact description: You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact. @@ -3161,7 +3161,7 @@ paths: id: '321877' name: Manual tag schema: - '$ref': '#/components/schemas/tag' + "$ref": "#/components/schemas/tag" '404': description: Tag not found content: @@ -3172,17 +3172,17 @@ paths: type: error.list request_id: 3fadb2e2-8f7a-4185-be01-f4c8b705bd4b errors: - - code: not_found - message: User Not Found + - code: not_found + message: User Not Found Tag not found: value: type: error.list request_id: 01dae0f2-2d13-4444-8e7c-ecb7e42860ee 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: @@ -3193,27 +3193,27 @@ paths: type: error.list request_id: ebe7fc72-41f5-457f-be36-c48dc2c4d384 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: 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: @@ -3276,31 +3276,31 @@ paths: tags: type: list data: [] - url: '/contacts/64c116a635824d3d6bb505ce/tags' + url: "/contacts/64c116a635824d3d6bb505ce/tags" total_count: 0 has_more: false notes: type: list data: [] - url: '/contacts/64c116a635824d3d6bb505ce/notes' + url: "/contacts/64c116a635824d3d6bb505ce/notes" total_count: 0 has_more: false companies: type: list data: [] - url: '/contacts/64c116a635824d3d6bb505ce/companies' + url: "/contacts/64c116a635824d3d6bb505ce/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: '/contacts/64c116a635824d3d6bb505ce/subscriptions' + url: "/contacts/64c116a635824d3d6bb505ce/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: '/contacts/64c116a635824d3d6bb505ce/subscriptions' + url: "/contacts/64c116a635824d3d6bb505ce/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3310,7 +3310,7 @@ paths: utm_term: referrer: schema: - '$ref': '#/components/schemas/contact' + "$ref": "#/components/schemas/contact" '401': description: Unauthorized content: @@ -3321,16 +3321,16 @@ paths: type: error.list request_id: 94b40023-7ddb-4788-b52f-7775e2f6a286 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 @@ -3340,19 +3340,19 @@ paths: 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: @@ -3415,31 +3415,31 @@ paths: tags: type: list data: [] - url: '/contacts/64c116a835824d3d6bb505cf/tags' + url: "/contacts/64c116a835824d3d6bb505cf/tags" total_count: 0 has_more: false notes: type: list data: [] - url: '/contacts/64c116a835824d3d6bb505cf/notes' + url: "/contacts/64c116a835824d3d6bb505cf/notes" total_count: 0 has_more: false companies: type: list data: [] - url: '/contacts/64c116a835824d3d6bb505cf/companies' + url: "/contacts/64c116a835824d3d6bb505cf/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: '/contacts/64c116a835824d3d6bb505cf/subscriptions' + url: "/contacts/64c116a835824d3d6bb505cf/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: '/contacts/64c116a835824d3d6bb505cf/subscriptions' + url: "/contacts/64c116a835824d3d6bb505cf/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3449,7 +3449,7 @@ paths: utm_term: referrer: schema: - '$ref': '#/components/schemas/contact' + "$ref": "#/components/schemas/contact" '401': description: Unauthorized content: @@ -3460,25 +3460,25 @@ paths: type: error.list request_id: db5295b8-fb24-4d1b-9d44-4160231da6b5 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' + "$ref": "#/components/schemas/error" delete: summary: Delete a contact parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - description: id - required: true - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: id + required: true + schema: + type: string tags: - - Contacts + - Contacts operationId: DeleteContact description: You can delete a single contact. responses: @@ -3493,7 +3493,7 @@ paths: object: contact deleted: true schema: - '$ref': '#/components/schemas/contact_deleted' + "$ref": "#/components/schemas/contact_deleted" '401': description: Unauthorized content: @@ -3504,20 +3504,20 @@ paths: type: error.list request_id: 6d711e42-2b7b-4d2c-838e-284cd7ea4644 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: 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`. @@ -3581,31 +3581,31 @@ paths: tags: type: list data: [] - url: '/contacts/64c116ab35824d3d6bb505d2/tags' + url: "/contacts/64c116ab35824d3d6bb505d2/tags" total_count: 0 has_more: false notes: type: list data: [] - url: '/contacts/64c116ab35824d3d6bb505d2/notes' + url: "/contacts/64c116ab35824d3d6bb505d2/notes" total_count: 0 has_more: false companies: type: list data: [] - url: '/contacts/64c116ab35824d3d6bb505d2/companies' + url: "/contacts/64c116ab35824d3d6bb505d2/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: '/contacts/64c116ab35824d3d6bb505d2/subscriptions' + url: "/contacts/64c116ab35824d3d6bb505d2/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: '/contacts/64c116ab35824d3d6bb505d2/subscriptions' + url: "/contacts/64c116ab35824d3d6bb505d2/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3615,7 +3615,7 @@ paths: utm_term: referrer: schema: - '$ref': '#/components/schemas/contact' + "$ref": "#/components/schemas/contact" '401': description: Unauthorized content: @@ -3626,31 +3626,31 @@ paths: type: error.list request_id: bb2e0f34-e2c7-4de3-a42b-c719ea232351 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: 64c116ab35824d3d6bb505d1 into: 64c116ab35824d3d6bb505d2 - '/contacts/search': + "/contacts/search": post: summary: Search contacts parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Contacts + - Contacts operationId: SearchContacts description: "You can search for multiple contacts by the value of their attributes in order to fetch exactly who you want.\n\nTo search for contacts, you need @@ -3740,7 +3740,7 @@ paths: per_page: 50 total_pages: 0 schema: - '$ref': '#/components/schemas/contact_list' + "$ref": "#/components/schemas/contact_list" '401': description: Unauthorized content: @@ -3751,15 +3751,15 @@ paths: type: error.list request_id: 867e0d6d-e138-48cd-9ecc-7fc9a273eeae 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 @@ -3767,27 +3767,27 @@ paths: query: operator: AND value: + - field: id + operator: "=" + value: 64c116ae35824d3d6bb505d5 + - operator: OR + value: - field: id - operator: '=' + operator: "=" value: 64c116ae35824d3d6bb505d5 - - operator: OR - value: - - field: id - operator: '=' - value: 64c116ae35824d3d6bb505d5 - - field: id - operator: '=' - value: 64c116ae35824d3d6bb505d5 - '/contacts': + - field: id + operator: "=" + value: 64c116ae35824d3d6bb505d5 + "/contacts": get: summary: List all contacts parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Contacts + - Contacts operationId: ListContacts description: You can fetch a list of all contacts. responses: @@ -3807,7 +3807,7 @@ paths: per_page: 10 total_pages: 0 schema: - '$ref': '#/components/schemas/contact_list' + "$ref": "#/components/schemas/contact_list" '401': description: Unauthorized content: @@ -3818,19 +3818,19 @@ paths: type: error.list request_id: 1b553b1c-f188-4fa6-ae69-64c0fb0ad98a 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 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: @@ -3893,31 +3893,31 @@ paths: tags: type: list data: [] - url: '/contacts/64c116b135824d3d6bb505d7/tags' + url: "/contacts/64c116b135824d3d6bb505d7/tags" total_count: 0 has_more: false notes: type: list data: [] - url: '/contacts/64c116b135824d3d6bb505d7/notes' + url: "/contacts/64c116b135824d3d6bb505d7/notes" total_count: 0 has_more: false companies: type: list data: [] - url: '/contacts/64c116b135824d3d6bb505d7/companies' + url: "/contacts/64c116b135824d3d6bb505d7/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: '/contacts/64c116b135824d3d6bb505d7/subscriptions' + url: "/contacts/64c116b135824d3d6bb505d7/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: '/contacts/64c116b135824d3d6bb505d7/subscriptions' + url: "/contacts/64c116b135824d3d6bb505d7/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3927,7 +3927,7 @@ paths: utm_term: referrer: schema: - '$ref': '#/components/schemas/contact' + "$ref": "#/components/schemas/contact" '401': description: Unauthorized content: @@ -3938,38 +3938,38 @@ paths: type: error.list request_id: 71f01ef9-f62b-4389-9949-22ec66fbb6c5 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/{id}/archive': + "/contacts/{id}/archive": post: summary: Archive contact parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - description: id - example: 63a07ddf05a32042dffac965 - required: true - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: id + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string tags: - - Contacts + - Contacts operationId: ArchiveContact description: You can archive a single contact. responses: @@ -3984,24 +3984,24 @@ paths: object: contact archived: true schema: - '$ref': '#/components/schemas/contact_archived' - '/contacts/{id}/unarchive': + "$ref": "#/components/schemas/contact_archived" + "/contacts/{id}/unarchive": post: summary: Unarchive contact parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - description: id - example: 63a07ddf05a32042dffac965 - required: true - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: id + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string tags: - - Contacts + - Contacts operationId: UnarchiveContact description: You can unarchive a single contact. responses: @@ -4016,25 +4016,25 @@ paths: object: contact archived: false schema: - '$ref': '#/components/schemas/contact_unarchived' - '/conversations/{conversation_id}/tags': + "$ref": "#/components/schemas/contact_unarchived" + "/conversations/{conversation_id}/tags": post: 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. @@ -4050,7 +4050,7 @@ paths: id: '321879' name: Manual tag schema: - '$ref': '#/components/schemas/tag' + "$ref": "#/components/schemas/tag" '404': description: Conversation not found content: @@ -4061,10 +4061,10 @@ paths: type: error.list request_id: 49f8c5ab-d7d5-4383-a6f9-467396f74c99 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: @@ -4075,18 +4075,18 @@ paths: type: error.list request_id: 0d003f19-a77e-4074-bffb-260510188429 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 @@ -4109,31 +4109,31 @@ paths: value: id: 321880 admin_id: 991266354 - '/conversations/{conversation_id}/tags/{id}': + "/conversations/{conversation_id}/tags/{id}": delete: 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. @@ -4149,7 +4149,7 @@ paths: id: '321882' name: Manual tag schema: - '$ref': '#/components/schemas/tag' + "$ref": "#/components/schemas/tag" '404': description: Tag not found content: @@ -4160,17 +4160,17 @@ paths: type: error.list request_id: 5d821453-cbca-4e6e-b495-4621fbb2a95f errors: - - code: not_found - message: Conversation not found + - code: not_found + message: Conversation not found Tag not found: value: type: error.list request_id: 389d1193-b588-45bf-9aae-5fd0ea173304 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: @@ -4181,17 +4181,17 @@ paths: type: error.list request_id: 96843ebc-a192-4057-8d35-ccf1848d840e 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 @@ -4211,30 +4211,30 @@ paths: summary: Tag not found value: admin_id: 991266359 - '/conversations': + "/conversations": get: 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. @@ -4256,51 +4256,51 @@ paths: total_pages: 1 total_count: 1 conversations: - - type: conversation - id: '715385' - created_at: 1690375866 - updated_at: 1690375866 - waiting_since: - snoozed_until: - source: - type: conversation - id: '403918065' - delivered_as: admin_initiated - subject: '' - body: '

this is the message body

' - author: - type: admin - id: '991266362' - name: Ciaran144 Lee - email: admin144@email.com - attachments: [] - url: - redacted: false + - type: conversation + id: '715385' + created_at: 1690375866 + updated_at: 1690375866 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918065' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991266362' + name: Ciaran144 Lee + email: admin144@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list contacts: - type: contact.list - contacts: - - type: contact - id: 64c116ba35824d3d6bb505dd - 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: - schema: - '$ref': '#/components/schemas/paginated_response' + - type: contact + id: 64c116ba35824d3d6bb505dd + 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: + schema: + "$ref": "#/components/schemas/paginated_response" '401': description: Unauthorized content: @@ -4311,10 +4311,10 @@ paths: type: error.list request_id: a73206d7-f172-45aa-9932-8b2be93188b3 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: @@ -4325,19 +4325,19 @@ paths: type: error.list request_id: dc4f1850-cc49-45cd-be3d-0222298cf34d 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: 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).\nThe conversation can be an in-app message only.\n\n> @@ -4361,7 +4361,7 @@ paths: message_type: inapp conversation_id: '715410' schema: - '$ref': '#/components/schemas/message' + "$ref": "#/components/schemas/message" '404': description: Contact Not Found content: @@ -4372,10 +4372,10 @@ paths: type: error.list request_id: 629cedeb-4c20-4f1c-8485-bbbcde5dd29a 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: @@ -4386,10 +4386,10 @@ paths: type: error.list request_id: c8a7b881-3eb7-4214-8ae1-c5945fb80d4c 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: @@ -4400,15 +4400,15 @@ paths: type: error.list request_id: 527cfc56-2e48-4735-be33-b57a7dfb329e 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 @@ -4424,30 +4424,30 @@ paths: type: user id: 123_doesnt_exist body: Hello there - '/conversations/{id}': + "/conversations/{id}": get: summary: Retrieve a conversation parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The id of the conversation to target - example: 123 - schema: - type: integer - - name: display_as - in: query - required: false - description: Set to plaintext to retrieve conversation messages in plain text. - example: plaintext - schema: - type: string + - 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: "\nYou can fetch the details of a single conversation.\n\nThis will return a single Conversation model with all its conversation parts.\n\n> @@ -4477,7 +4477,7 @@ paths: id: '403918079' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266376' @@ -4489,8 +4489,8 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c116d835824d3d6bb505f6 + - type: contact + id: 64c116d835824d3d6bb505f6 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -4514,7 +4514,7 @@ paths: conversation_parts: [] total_count: 0 schema: - '$ref': '#/components/schemas/conversation' + "$ref": "#/components/schemas/conversation" '404': description: Not found content: @@ -4525,10 +4525,10 @@ paths: type: error.list request_id: 1042aed9-dc9e-4d3d-a40c-3d8b3a3287c2 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: @@ -4539,10 +4539,10 @@ paths: type: error.list request_id: fcc2a781-771a-4de6-b483-b9685d18edfc 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: @@ -4553,33 +4553,33 @@ paths: type: error.list request_id: bc786fb2-221c-48a7-98f4-248b3317e16c 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: 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: "\nYou can update an existing conversation.\n\n> \U0001F4D8\n>\n> If you want to update a conversation with either a reply (or actions such @@ -4604,7 +4604,7 @@ paths: id: '403918083' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266384' @@ -4616,8 +4616,8 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c116df35824d3d6bb505fa + - type: contact + id: 64c116df35824d3d6bb505fa first_contact_reply: admin_assignee_id: team_assignee_id: @@ -4641,41 +4641,41 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '711348' - part_type: conversation_attribute_updated_by_admin - body: - created_at: 1690375905 - updated_at: 1690375905 - notified_at: 1690375905 - assigned_to: - author: - id: '991266385' - type: bot - name: Operator - email: operator+this_is_an_id305_that_should_be_at_least_@intercom.io - attachments: [] - external_id: - redacted: false - - type: conversation_part - id: '711349' - part_type: conversation_attribute_updated_by_admin - body: - created_at: 1690375905 - updated_at: 1690375905 - notified_at: 1690375905 - assigned_to: - author: - id: '991266385' - type: bot - name: Operator - email: operator+this_is_an_id305_that_should_be_at_least_@intercom.io - attachments: [] - external_id: - redacted: false + - type: conversation_part + id: '711348' + part_type: conversation_attribute_updated_by_admin + body: + created_at: 1690375905 + updated_at: 1690375905 + notified_at: 1690375905 + assigned_to: + author: + id: '991266385' + type: bot + name: Operator + email: operator+this_is_an_id305_that_should_be_at_least_@intercom.io + attachments: [] + external_id: + redacted: false + - type: conversation_part + id: '711349' + part_type: conversation_attribute_updated_by_admin + body: + created_at: 1690375905 + updated_at: 1690375905 + notified_at: 1690375905 + assigned_to: + author: + id: '991266385' + type: bot + name: Operator + email: operator+this_is_an_id305_that_should_be_at_least_@intercom.io + attachments: [] + external_id: + redacted: false total_count: 2 schema: - '$ref': '#/components/schemas/conversation' + "$ref": "#/components/schemas/conversation" '404': description: Not found content: @@ -4686,10 +4686,10 @@ paths: type: error.list request_id: 656daf92-f2c9-4229-8a6d-48a0146ad142 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: @@ -4700,10 +4700,10 @@ paths: type: error.list request_id: 6628f08c-ff06-4565-941b-cf39d9cf2674 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: @@ -4714,15 +4714,15 @@ paths: type: error.list request_id: a0fa6731-abce-47f7-a546-9b87e80abc28 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 @@ -4738,16 +4738,16 @@ paths: custom_attributes: issue_type: Billing priority: High - '/conversations/search': + "/conversations/search": post: summary: Search conversations parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Conversations + - Conversations operationId: searchConversations description: "You can search for multiple conversations by the value of their attributes in order to fetch exactly which ones you want.\n\nTo search for @@ -4830,56 +4830,56 @@ paths: total_pages: 1 total_count: 1 conversations: - - type: conversation - id: '715422' - created_at: 1690375912 - updated_at: 1690375912 - waiting_since: - snoozed_until: - source: - type: conversation - id: '403918087' - delivered_as: admin_initiated - subject: '' - body: '

this is the message body

' - author: - type: admin - id: '991266408' - name: Ciaran175 Lee - email: admin175@email.com - attachments: [] - url: - redacted: false + - type: conversation + id: '715422' + created_at: 1690375912 + updated_at: 1690375912 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918087' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991266408' + name: Ciaran175 Lee + email: admin175@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list contacts: - type: contact.list - contacts: - - type: contact - id: 64c116e835824d3d6bb505fe - 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: - schema: - '$ref': '#/components/schemas/conversation_list' + - type: contact + id: 64c116e835824d3d6bb505fe + 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: + schema: + "$ref": "#/components/schemas/conversation_list" requestBody: content: application/json: schema: - '$ref': '#/components/schemas/search_request' + "$ref": "#/components/schemas/search_request" examples: successful: summary: successful @@ -4887,43 +4887,43 @@ paths: query: operator: AND value: + - field: id + operator: "=" + value: '715422' + - operator: OR + value: + - field: id + operator: "=" + value: '715422' - field: id - operator: '=' + operator: "=" value: '715422' - - operator: OR - value: - - field: id - operator: '=' - value: '715422' - - field: id - operator: '=' - value: '715422' - '/conversations/{id}/reply': + "/conversations/{id}/reply": post: summary: Reply to a conversation parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - schema: - oneOf: - - title: Conversation ID - type: string - description: The id of the conversation to target. - example: '123' - - title: The most recent conversation - type: string - enum: - - last - description: You can also reply to the most recent conversation on a workspace - by specifying `last` as the string. - example: last + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + schema: + oneOf: + - title: Conversation ID + type: string + description: The id of the conversation to target. + example: '123' + - title: The most recent conversation + type: string + enum: + - last + description: You can also reply to the most recent conversation on a workspace + by specifying `last` as the string. + example: last 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. @@ -4946,7 +4946,7 @@ paths: id: '403918090' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266410' @@ -4958,8 +4958,8 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c116ee35824d3d6bb50605 + - type: contact + id: 64c116ee35824d3d6bb50605 first_contact_reply: created_at: 1690375920 type: conversation @@ -4984,22 +4984,22 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '711351' - part_type: comment - body: '

Thanks again :)

' - created_at: 1690375920 - updated_at: 1690375920 - notified_at: 1690375920 - assigned_to: - author: - id: 64c116ee35824d3d6bb50605 - type: user - name: Joe Bloggs - email: joe@bloggs.com - attachments: [] - external_id: - redacted: false + - type: conversation_part + id: '711351' + part_type: comment + body: "

Thanks again :)

" + created_at: 1690375920 + updated_at: 1690375920 + notified_at: 1690375920 + assigned_to: + author: + id: 64c116ee35824d3d6bb50605 + type: user + name: Joe Bloggs + email: joe@bloggs.com + attachments: [] + external_id: + redacted: false total_count: 1 Admin note reply: value: @@ -5014,7 +5014,7 @@ paths: id: '403918091' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266412' @@ -5026,8 +5026,8 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c116f135824d3d6bb50606 + - type: contact + id: 64c116f135824d3d6bb50606 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5049,34 +5049,34 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '711352' - part_type: note - body: |- -

An Unordered HTML List

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

An Ordered HTML List

-
    -
  1. Coffee
    2. -
  2. Tea
    3. -
  3. Milk
    4. -
- created_at: 1690375922 - updated_at: 1690375922 - notified_at: 1690375922 - assigned_to: - author: - id: '991266412' - type: admin - name: Ciaran177 Lee - email: admin177@email.com - attachments: [] - external_id: - redacted: false + - type: conversation_part + id: '711352' + part_type: note + body: |- +

An Unordered HTML List

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

An Ordered HTML List

+
    +
  1. Coffee
    2. +
  2. Tea
    3. +
  3. Milk
    4. +
+ created_at: 1690375922 + updated_at: 1690375922 + notified_at: 1690375922 + assigned_to: + author: + id: '991266412' + type: admin + name: Ciaran177 Lee + email: admin177@email.com + attachments: [] + external_id: + redacted: false total_count: 1 User last conversation reply: value: @@ -5091,7 +5091,7 @@ paths: id: '403918093' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266416' @@ -5103,8 +5103,8 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c116f435824d3d6bb50608 + - type: contact + id: 64c116f435824d3d6bb50608 first_contact_reply: created_at: 1690375925 type: conversation @@ -5129,25 +5129,25 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '711353' - part_type: comment - body: '

Thanks again :)

' - created_at: 1690375925 - updated_at: 1690375925 - notified_at: 1690375925 - assigned_to: - author: - id: 64c116f435824d3d6bb50608 - type: user - name: Joe Bloggs - email: joe@bloggs.com - attachments: [] - external_id: - redacted: false + - type: conversation_part + id: '711353' + part_type: comment + body: "

Thanks again :)

" + created_at: 1690375925 + updated_at: 1690375925 + notified_at: 1690375925 + assigned_to: + author: + id: 64c116f435824d3d6bb50608 + type: user + name: Joe Bloggs + email: joe@bloggs.com + attachments: [] + external_id: + redacted: false total_count: 1 schema: - '$ref': '#/components/schemas/conversation' + "$ref": "#/components/schemas/conversation" '404': description: Not found content: @@ -5158,10 +5158,10 @@ paths: type: error.list request_id: 6a6a6bc5-f8d9-424d-8cd3-8cb32a18c054 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: @@ -5172,10 +5172,10 @@ paths: type: error.list request_id: 521c6862-11a4-439b-a341-d87507557b47 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: @@ -5186,15 +5186,15 @@ paths: type: error.list request_id: 88d25e86-1821-4c43-a958-9c1ac1ba7f70 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 @@ -5227,23 +5227,23 @@ paths: type: user intercom_user_id: 64c116f635824d3d6bb50609 body: Thanks again :) - '/conversations/{id}/parts': + "/conversations/{id}/parts": post: summary: Manage a conversation parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The identifier for the conversation as given by Intercom. - example: '123' - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The identifier for the conversation as given by Intercom. + example: '123' + schema: + type: string tags: - - Conversations + - Conversations operationId: manageConversation description: | You can close a conversation. @@ -5269,7 +5269,7 @@ paths: id: '403918097' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266424' @@ -5281,8 +5281,8 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c116fc35824d3d6bb5060c + - type: contact + id: 64c116fc35824d3d6bb5060c first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5304,22 +5304,22 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '711354' - part_type: close - body: '

Goodbye :)

' - created_at: 1690375933 - updated_at: 1690375933 - notified_at: 1690375933 - assigned_to: - author: - id: '991266424' - type: admin - name: Ciaran183 Lee - email: admin183@email.com - attachments: [] - external_id: - redacted: false + - type: conversation_part + id: '711354' + part_type: close + body: "

Goodbye :)

" + created_at: 1690375933 + updated_at: 1690375933 + notified_at: 1690375933 + assigned_to: + author: + id: '991266424' + type: admin + name: Ciaran183 Lee + email: admin183@email.com + attachments: [] + external_id: + redacted: false total_count: 1 Snooze a conversation: value: @@ -5334,7 +5334,7 @@ paths: id: '403918098' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266426' @@ -5346,8 +5346,8 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c116fe35824d3d6bb5060d + - type: contact + id: 64c116fe35824d3d6bb5060d first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5369,22 +5369,22 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '711355' - part_type: snoozed - body: - created_at: 1690375935 - updated_at: 1690375935 - notified_at: 1690375935 - assigned_to: - author: - id: '991266426' - type: admin - name: Ciaran184 Lee - email: admin184@email.com - attachments: [] - external_id: - redacted: false + - type: conversation_part + id: '711355' + part_type: snoozed + body: + created_at: 1690375935 + updated_at: 1690375935 + notified_at: 1690375935 + assigned_to: + author: + id: '991266426' + type: admin + name: Ciaran184 Lee + email: admin184@email.com + attachments: [] + external_id: + redacted: false total_count: 1 Open a conversation: value: @@ -5399,7 +5399,7 @@ paths: id: '403918099' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266428' @@ -5411,8 +5411,8 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c1170235824d3d6bb50612 + - type: contact + id: 64c1170235824d3d6bb50612 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5434,22 +5434,22 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '711357' - part_type: open - body: - created_at: 1690375942 - updated_at: 1690375942 - notified_at: 1690375942 - assigned_to: - author: - id: '991266428' - type: admin - name: Ciaran185 Lee - email: admin185@email.com - attachments: [] - external_id: - redacted: false + - type: conversation_part + id: '711357' + part_type: open + body: + created_at: 1690375942 + updated_at: 1690375942 + notified_at: 1690375942 + assigned_to: + author: + id: '991266428' + type: admin + name: Ciaran185 Lee + email: admin185@email.com + attachments: [] + external_id: + redacted: false total_count: 1 Assign a conversation: value: @@ -5464,7 +5464,7 @@ paths: id: '403918102' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266430' @@ -5476,8 +5476,8 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c1170735824d3d6bb50615 + - type: contact + id: 64c1170735824d3d6bb50615 first_contact_reply: admin_assignee_id: 991266430 team_assignee_id: @@ -5499,27 +5499,27 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '711358' - part_type: assign_and_reopen - body: - created_at: 1690375944 - updated_at: 1690375944 - notified_at: 1690375944 - assigned_to: - type: admin - id: '991266430' - author: - id: '991266430' - type: admin - name: Ciaran186 Lee - email: admin186@email.com - attachments: [] - external_id: - redacted: false + - type: conversation_part + id: '711358' + part_type: assign_and_reopen + body: + created_at: 1690375944 + updated_at: 1690375944 + notified_at: 1690375944 + assigned_to: + type: admin + id: '991266430' + author: + id: '991266430' + type: admin + name: Ciaran186 Lee + email: admin186@email.com + attachments: [] + external_id: + redacted: false total_count: 1 schema: - '$ref': '#/components/schemas/conversation' + "$ref": "#/components/schemas/conversation" '404': description: Not found content: @@ -5530,10 +5530,10 @@ paths: type: error.list request_id: 72d2350c-ba2d-4749-84d3-1b0b10cb826d 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: @@ -5544,10 +5544,10 @@ paths: type: error.list request_id: 80217bd9-1684-415b-bfbd-6dcceb8ae31f 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: @@ -5558,19 +5558,19 @@ paths: type: error.list request_id: ec28cafe-d3a5-492a-b65d-fd31a0357fc5 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 @@ -5604,23 +5604,23 @@ paths: type: admin admin_id: 991266432 body: Goodbye :) - '/conversations/{id}/run_assignment_rules': + "/conversations/{id}/run_assignment_rules": post: summary: Run Assignment Rules on a conversation parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The identifier for the conversation as given by Intercom. - example: '123' - schema: - type: string + - 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. @@ -5643,7 +5643,7 @@ paths: id: '403918106' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266438' @@ -5655,8 +5655,8 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c1170e35824d3d6bb50619 + - type: contact + id: 64c1170e35824d3d6bb50619 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5678,27 +5678,27 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '711359' - part_type: default_assignment - body: - created_at: 1690375951 - updated_at: 1690375951 - notified_at: 1690375951 - assigned_to: - type: nobody_admin - id: - author: - id: '991266439' - type: bot - name: Operator - email: operator+this_is_an_id343_that_should_be_at_least_@intercom.io - attachments: [] - external_id: - redacted: false + - type: conversation_part + id: '711359' + part_type: default_assignment + body: + created_at: 1690375951 + updated_at: 1690375951 + notified_at: 1690375951 + assigned_to: + type: nobody_admin + id: + author: + id: '991266439' + type: bot + name: Operator + email: operator+this_is_an_id343_that_should_be_at_least_@intercom.io + attachments: [] + external_id: + redacted: false total_count: 1 schema: - '$ref': '#/components/schemas/conversation' + "$ref": "#/components/schemas/conversation" '404': description: Not found content: @@ -5709,10 +5709,10 @@ paths: type: error.list request_id: 18b8992d-787e-498f-984c-4407d5ed7ebc 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: @@ -5723,10 +5723,10 @@ paths: type: error.list request_id: 5ec6b788-a425-49d4-8683-55e85a7be62b 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: @@ -5737,27 +5737,27 @@ paths: type: error.list request_id: '09f9b192-80d5-41a3-929f-485c1fdf9a72' 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 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.\n\n> \U0001F6A7 Note about contacts @@ -5773,10 +5773,10 @@ paths: Attach a contact to a conversation: value: customers: - - type: user - id: 64c1171535824d3d6bb5061d + - type: user + id: 64c1171535824d3d6bb5061d schema: - '$ref': '#/components/schemas/conversation' + "$ref": "#/components/schemas/conversation" '404': description: Not found content: @@ -5787,10 +5787,10 @@ paths: type: error.list request_id: ed4dd050-e1a0-4581-a615-a8a71235b636 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: @@ -5801,10 +5801,10 @@ paths: type: error.list request_id: 735d6cd5-a643-481d-81ae-36da9055a9cd 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: @@ -5815,15 +5815,15 @@ paths: type: error.list request_id: f34d9603-0aec-43b8-b602-391769137bb5 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 @@ -5837,30 +5837,30 @@ paths: admin_id: 991266448 customer: intercom_user_id: 64c1171735824d3d6bb5061e - '/conversations/{conversation_id}/customers/{contact_id}': + "/conversations/{conversation_id}/customers/{contact_id}": delete: summary: Detach a contact from a group conversation parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: conversation_id - in: path - required: true - description: The identifier for the conversation as given by Intercom. - example: '123' - schema: - type: string - - name: contact_id - in: path - required: true - description: The identifier for the contact as given by Intercom. - example: '123' - schema: - type: string + - 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.\n\n> \U0001F6A7 Note about contacts @@ -5876,10 +5876,10 @@ paths: Detach a contact from a group conversation: value: customers: - - type: user - id: 64c1172235824d3d6bb50628 + - type: user + id: 64c1172235824d3d6bb50628 schema: - '$ref': '#/components/schemas/conversation' + "$ref": "#/components/schemas/conversation" '404': description: Contact not found content: @@ -5890,17 +5890,17 @@ paths: type: error.list request_id: 1e05c786-e94d-4a14-a76a-0534fdd0aa30 errors: - - code: not_found - message: Resource Not Found + - code: not_found + message: Resource Not Found Contact not found: value: type: error.list request_id: 44fb4d66-9f36-42da-857c-a5423410bce3 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: @@ -5911,10 +5911,10 @@ paths: type: error.list request_id: e474641a-b720-4ad0-89a1-3da650035f5e 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: @@ -5925,10 +5925,10 @@ paths: type: error.list request_id: a12b8806-b2aa-40ba-835b-463fd4bd2e0f 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: @@ -5939,15 +5939,15 @@ paths: type: error.list request_id: 108a366f-0b89-4e98-9d3c-50e1526c12f9 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 @@ -5973,16 +5973,16 @@ paths: admin_id: 991266460 customer: intercom_user_id: 64c1172f35824d3d6bb50637 - '/conversations/redact': + "/conversations/redact": post: summary: Redact a conversation part parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Conversations + - Conversations operationId: redactConversation description: "You can redact a conversation part or the source message of a conversation (as seen in the source object).\n\n> \U0001F4D8 Which parts and @@ -6009,7 +6009,7 @@ paths: id: '403918132' delivered_as: admin_initiated subject: '' - body: '

this is the message body

' + body: "

this is the message body

" author: type: admin id: '991266466' @@ -6021,8 +6021,8 @@ paths: contacts: type: contact.list contacts: - - type: contact - id: 64c1174235824d3d6bb5064c + - type: contact + id: 64c1174235824d3d6bb5064c first_contact_reply: created_at: 1690376003 type: conversation @@ -6047,25 +6047,25 @@ paths: conversation_parts: type: conversation_part.list conversation_parts: - - type: conversation_part - id: '711367' - part_type: comment - body: '

This message was deleted

' - created_at: 1690376003 - updated_at: 1690376004 - notified_at: 1690376003 - assigned_to: - author: - id: 64c1174235824d3d6bb5064c - type: user - name: Joe Bloggs - email: joe@bloggs.com - attachments: [] - external_id: - redacted: true + - type: conversation_part + id: '711367' + part_type: comment + body: "

This message was deleted

" + created_at: 1690376003 + updated_at: 1690376004 + notified_at: 1690376003 + assigned_to: + author: + id: 64c1174235824d3d6bb5064c + type: user + name: Joe Bloggs + email: joe@bloggs.com + attachments: [] + external_id: + redacted: true total_count: 1 schema: - '$ref': '#/components/schemas/conversation' + "$ref": "#/components/schemas/conversation" '404': description: Not found content: @@ -6076,10 +6076,10 @@ paths: type: error.list request_id: c9fce3f2-fd5a-433e-841a-1cd19c03aaee 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: @@ -6090,15 +6090,15 @@ paths: type: error.list request_id: 94a41924-46bf-4bb0-986b-533fcdcb1a92 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 @@ -6112,23 +6112,23 @@ paths: type: conversation_part conversation_id: really_123_doesnt_exist conversation_part_id: really_123_doesnt_exist - '/conversations/{id}/convert': + "/conversations/{id}/convert": post: summary: Convert a conversation to a ticket parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The id of the conversation to target - example: 123 - schema: - type: integer + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The id of the conversation to target + example: 123 + schema: + type: integer tags: - - Conversations + - Conversations description: You can convert a conversation to a ticket. responses: '200': @@ -6141,11 +6141,11 @@ paths: type: error.list request_id: 6218a87a-02c0-4951-a3f9-c035d594f30c errors: - - code: intercom_version_invalid - message: Requested resource is not available in current API - version + - code: intercom_version_invalid + message: Requested resource is not available in current API + version schema: - '$ref': '#/components/schemas/ticket' + "$ref": "#/components/schemas/ticket" '400': description: Bad request content: @@ -6156,16 +6156,16 @@ paths: type: error.list request_id: f9f82edc-2c68-4416-be3a-e5368b5bdafb errors: - - code: intercom_version_invalid - message: Requested resource is not available in current API - version + - code: intercom_version_invalid + message: Requested resource is not available in current API + version 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 @@ -6175,35 +6175,35 @@ paths: summary: Bad request value: ticket_type_id: '766841' - '/data_attributes': + "/data_attributes": get: summary: List all data attributes parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: model - in: query - required: false - description: Specify the data attribute model to return. - schema: - type: string - enum: - - contact - - company - - conversation - example: company - - name: include_archived - in: query - required: false - description: Include archived attributes in the list. By default we return - only non archived data attributes. - example: false - schema: - type: boolean + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: model + in: query + required: false + description: Specify the data attribute model to return. + schema: + type: string + enum: + - contact + - company + - conversation + example: company + - name: include_archived + in: query + required: false + description: Include archived attributes in the list. By default we return + only non archived data attributes. + example: false + schema: + type: boolean tags: - - Data Attributes + - Data Attributes operationId: lisDataAttributes description: You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations. @@ -6217,206 +6217,206 @@ 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - custom: false - archived: false - model: company - - id: 188690 - 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 - custom: true - archived: false - admin_id: '991266484' - created_at: 1690376014 - updated_at: 1690376014 - 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 - 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 - 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 - 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 - 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 - 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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 + custom: false + archived: false + model: company + - id: 188690 + 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 + custom: true + archived: false + admin_id: '991266484' + created_at: 1690376014 + updated_at: 1690376014 + 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 + 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 + 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 + 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 + 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 + custom: false + archived: false + model: company schema: - '$ref': '#/components/schemas/data_attribute_list' + "$ref": "#/components/schemas/data_attribute_list" '401': description: Unauthorized content: @@ -6427,19 +6427,19 @@ paths: type: error.list request_id: 48125035-bac0-4c5d-92f2-a3d4fc50587d 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 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: @@ -6465,7 +6465,7 @@ paths: updated_at: 1690376016 model: company schema: - '$ref': '#/components/schemas/data_attribute' + "$ref": "#/components/schemas/data_attribute" '400': description: Too few options for list content: @@ -6476,42 +6476,42 @@ paths: type: error.list request_id: 45842367-0fd9-41a1-839e-bf0052987857 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: fba57225-68f9-4cf6-9f7a-e25973eb8961 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: 60068824-0ff7-433f-8cca-0af715f650e1 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: adac4f8f-6d55-4924-9ce5-39b0e344d453 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: cac3667a-233a-4a3c-a9c7-9fce5e81344c 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: @@ -6522,15 +6522,15 @@ paths: type: error.list request_id: 01f5808a-5414-46bf-bb30-0ff38046e995 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 @@ -6547,7 +6547,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: @@ -6567,25 +6567,25 @@ paths: value: description: Just a plain old ring options: - - value: 1-10 + - value: 1-10 archived: false - '/data_attributes/{id}': + "/data_attributes/{id}": put: summary: Update a data attribute parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The data attribute id - example: 1 - schema: - type: integer + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The data attribute id + example: 1 + schema: + type: integer tags: - - Data Attributes + - Data Attributes operationId: updateDataAttribute description: "\nYou can update a data attribute.\n\n> \U0001F6A7 Updating the data type is not possible\n>\n> It is currently a dangerous action to execute @@ -6607,8 +6607,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 custom: true @@ -6618,7 +6618,7 @@ paths: updated_at: 1690376019 model: company schema: - '$ref': '#/components/schemas/data_attribute' + "$ref": "#/components/schemas/data_attribute" '400': description: Too few options in list content: @@ -6629,10 +6629,10 @@ paths: type: error.list request_id: e400a721-3ce8-4b4f-a635-7d66b1ee1404 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: @@ -6643,10 +6643,10 @@ paths: type: error.list request_id: 2e97b6fe-b5c3-40cd-9dfd-e0bb11994158 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: @@ -6657,11 +6657,11 @@ paths: type: error.list request_id: 3214dd8b-5119-4c34-92d8-44c81399aac5 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: @@ -6672,23 +6672,23 @@ paths: type: error.list request_id: 8a9b6479-9c14-4c57-bb31-c34be8d3669a 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 @@ -6702,24 +6702,24 @@ 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 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: "\nYou will need an Access Token that has write permissions to send Events. Once you have a key you can submit events via POST to the Events @@ -6791,65 +6791,65 @@ paths: type: error.list request_id: 5e2192c1-2cf2-4893-98ce-2423a85b24f4 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: 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 @@ -6879,7 +6879,7 @@ paths: intercom_user_id: 64c1175c35824d3d6bb50665 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 schema: - '$ref': '#/components/schemas/data_event_summary' + "$ref": "#/components/schemas/data_event_summary" '401': description: Unauthorized content: @@ -6890,20 +6890,20 @@ paths: type: error.list request_id: b08e681c-4f1f-471f-849b-895af1af159c 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: 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 @@ -6921,25 +6921,25 @@ paths: type: error.list request_id: da845d1b-8321-4ef8-96a2-3983d23dacd0 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 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: create data export 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 @@ -6968,34 +6968,34 @@ 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: 1690358031 created_at_before: 1690376031 - '/export/content/data/{job_identifier}': + "/export/content/data/{job_identifier}": get: summary: Show content data export parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: job_identifier - in: path - description: job_identifier - required: true - schema: - type: string + - 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: get data export 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}` @@ -7018,23 +7018,23 @@ 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 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: Cancel data export description: You can cancel your job responses: @@ -7050,23 +7050,23 @@ 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 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: Download data export 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: @@ -7077,16 +7077,16 @@ paths: responses: '200': description: successful - '/messages': + "/messages": post: summary: Create a message parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Messages + - Messages operationId: createMessage description: "You can create a message that has been initiated by an admin. The conversation can be either an in-app message or an email.\n\n> \U0001F6A7 @@ -7135,7 +7135,7 @@ paths: 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: @@ -7146,17 +7146,17 @@ paths: type: error.list request_id: 57c71686-91ba-4e40-a8ad-44abd55dec6e 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: 38f1e066-233d-489f-8889-cd4cdc4eb47e 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: @@ -7167,10 +7167,10 @@ paths: type: error.list request_id: 15c57200-0c69-4eea-8c57-05a1c2195f87 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: @@ -7181,10 +7181,10 @@ paths: type: error.list request_id: 276b9197-fc1c-4aef-bcf9-9b4d3950a26a 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: @@ -7195,15 +7195,15 @@ paths: type: error.list request_id: fe693cb8-eb15-450e-8c1f-c424d801f5e2 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 @@ -7267,16 +7267,16 @@ paths: message_type: email body: subject: heyy - '/news/news_items': + "/news/news_items": get: summary: List all news items parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - News + - News operationId: listNewsItems description: You can fetch a list of all news items responses: @@ -7294,45 +7294,45 @@ paths: total_pages: 1 type: pages data: - - id: '398555' - type: news-item - workspace_id: this_is_an_id449_that_should_be_at_least_ - title: We have news - body: '

Hello there,

' - sender_id: 991266530 - state: draft - labels: [] - cover_image_url: - reactions: - - - - - - - - - deliver_silently: false - created_at: 1690376068 - updated_at: 1690376068 - newsfeed_assignments: [] - - id: '398556' - type: news-item - workspace_id: this_is_an_id449_that_should_be_at_least_ - title: We have news - body: '

Hello there,

' - sender_id: 991266532 - state: draft - labels: [] - cover_image_url: - reactions: - - - - - - - - - deliver_silently: false - created_at: 1690376068 - updated_at: 1690376068 - newsfeed_assignments: [] + - id: '398555' + type: news-item + workspace_id: this_is_an_id449_that_should_be_at_least_ + title: We have news + body: "

Hello there,

" + sender_id: 991266530 + state: draft + labels: [] + cover_image_url: + reactions: + - + - + - + - + deliver_silently: false + created_at: 1690376068 + updated_at: 1690376068 + newsfeed_assignments: [] + - id: '398556' + type: news-item + workspace_id: this_is_an_id449_that_should_be_at_least_ + title: We have news + body: "

Hello there,

" + sender_id: 991266532 + state: draft + labels: [] + cover_image_url: + reactions: + - + - + - + - + deliver_silently: false + created_at: 1690376068 + updated_at: 1690376068 + newsfeed_assignments: [] total_count: 2 schema: - '$ref': '#/components/schemas/paginated_response' + "$ref": "#/components/schemas/paginated_response" '401': description: Unauthorized content: @@ -7343,19 +7343,19 @@ paths: type: error.list request_id: ac490d07-73ca-42d8-84cc-a59a521c55ac 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 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: @@ -7370,25 +7370,25 @@ paths: type: news-item workspace_id: this_is_an_id453_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: 991266539 state: live labels: - - New - - Product - - Update + - New + - Product + - Update cover_image_url: reactions: - - "\U0001F606" - - "\U0001F605" + - "\U0001F606" + - "\U0001F605" deliver_silently: true created_at: 1690376070 updated_at: 1690376070 newsfeed_assignments: - - newsfeed_id: 403602 - published_at: 1664638214 + - newsfeed_id: 403602 + published_at: 1664638214 schema: - '$ref': '#/components/schemas/news_item' + "$ref": "#/components/schemas/news_item" '401': description: Unauthorized content: @@ -7399,51 +7399,51 @@ paths: type: error.list request_id: 78b3e6f9-c250-4187-ac27-52fd96c1af4d 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: 991266539 deliver_silently: true reactions: - - "\U0001F606" - - "\U0001F605" + - "\U0001F606" + - "\U0001F605" state: live newsfeed_assignments: - - newsfeed_id: 403602 - published_at: 1664638214 - '/news/news_items/{id}': + - newsfeed_id: 403602 + published_at: 1664638214 + "/news/news_items/{id}": get: summary: Retrieve a news item parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The unique identifier for the news item which is given by Intercom. - example: 123 - schema: - type: integer + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the news item which is given by Intercom. + example: 123 + schema: + type: integer tags: - - News + - News operationId: retrieveNewsItem description: You can fetch the details of a single news item. responses: @@ -7458,24 +7458,24 @@ paths: type: news-item workspace_id: this_is_an_id457_that_should_be_at_least_ title: We have news - body: '

Hello there,

' + body: "

Hello there,

" sender_id: 991266542 state: live labels: [] cover_image_url: reactions: - - - - - - - - + - + - + - + - deliver_silently: false created_at: 1690376071 updated_at: 1690376071 newsfeed_assignments: - - newsfeed_id: 403604 - published_at: 1690376071 + - newsfeed_id: 403604 + published_at: 1690376071 schema: - '$ref': '#/components/schemas/news_item' + "$ref": "#/components/schemas/news_item" '404': description: News Item Not Found content: @@ -7486,10 +7486,10 @@ paths: type: error.list request_id: 572a8489-53e8-4818-b204-1d5862d2a403 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: @@ -7500,26 +7500,26 @@ paths: type: error.list request_id: 8cab322b-d95a-4d7c-9f3b-fcbc503763d8 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' + "$ref": "#/components/schemas/error" put: summary: Update a news item parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The unique identifier for the news item which is given by Intercom. - example: 123 - schema: - type: integer + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the news item which is given by Intercom. + example: 123 + schema: + type: integer tags: - - News + - News operationId: updateNewsItem responses: '200': @@ -7533,20 +7533,20 @@ paths: type: news-item workspace_id: this_is_an_id463_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: 991266550 state: live labels: [] cover_image_url: reactions: - - "\U0001F61D" - - "\U0001F602" + - "\U0001F61D" + - "\U0001F602" deliver_silently: false created_at: 1690376073 updated_at: 1690376073 newsfeed_assignments: [] schema: - '$ref': '#/components/schemas/news_item' + "$ref": "#/components/schemas/news_item" '404': description: News Item Not Found content: @@ -7557,10 +7557,10 @@ paths: type: error.list request_id: 61cc0bc5-9114-4de3-8363-1a8264969dd2 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: @@ -7571,50 +7571,50 @@ paths: type: error.list request_id: 5dd44f0f-effc-4fd3-861a-4fe2f05ebfd6 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: 991266550 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: 991266553 reactions: - - "\U0001F61D" - - "\U0001F602" + - "\U0001F61D" + - "\U0001F602" delete: summary: Delete a news item parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The unique identifier for the news item which is given by Intercom. - example: 123 - schema: - type: integer + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the news item which is given by Intercom. + example: 123 + schema: + type: integer tags: - - News + - News operationId: deleteNewsItem description: You can delete a single news item. responses: @@ -7629,7 +7629,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: @@ -7640,10 +7640,10 @@ paths: type: error.list request_id: 164118b6-824a-4441-8bf9-f2faccc835c7 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: @@ -7654,28 +7654,28 @@ paths: type: error.list request_id: 559776c2-b59f-4c08-9c2d-8d1de37f958e 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: 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 @@ -7696,7 +7696,7 @@ paths: data: [] total_count: 0 schema: - '$ref': '#/components/schemas/paginated_response' + "$ref": "#/components/schemas/paginated_response" '401': description: Unauthorized content: @@ -7707,20 +7707,20 @@ paths: type: error.list request_id: df6e7c4a-af02-4dcc-b97c-d0c0194cac4f 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: 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: @@ -7738,19 +7738,19 @@ paths: total_pages: 1 type: pages data: - - id: '403617' - type: newsfeed - name: Visitor Feed - created_at: 1690376078 - updated_at: 1690376078 - - id: '403618' - type: newsfeed - name: Visitor Feed - created_at: 1690376078 - updated_at: 1690376078 + - id: '403617' + type: newsfeed + name: Visitor Feed + created_at: 1690376078 + updated_at: 1690376078 + - id: '403618' + type: newsfeed + name: Visitor Feed + created_at: 1690376078 + updated_at: 1690376078 total_count: 2 schema: - '$ref': '#/components/schemas/paginated_response' + "$ref": "#/components/schemas/paginated_response" '401': description: Unauthorized content: @@ -7761,28 +7761,28 @@ paths: type: error.list request_id: b62a1215-728f-44be-8310-bfad48eb4830 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: 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: @@ -7799,7 +7799,7 @@ paths: created_at: 1690376079 updated_at: 1690376079 schema: - '$ref': '#/components/schemas/newsfeed' + "$ref": "#/components/schemas/newsfeed" '401': description: Unauthorized content: @@ -7810,27 +7810,27 @@ paths: type: error.list request_id: 77f2416f-b1a1-4862-b141-cb4d46ea01d6 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 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: @@ -7854,9 +7854,9 @@ paths: email: admin294@email.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: @@ -7867,10 +7867,10 @@ paths: type: error.list request_id: 8ac61e6d-6966-4260-9a41-b0cb163ee9c2 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: @@ -7881,27 +7881,27 @@ paths: type: error.list request_id: a7cf97de-7462-49fe-afa8-93352890b390 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: 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: @@ -7914,20 +7914,20 @@ paths: value: type: segment.list segments: - - type: segment - id: 64c1179835824d3d6bb506d1 - name: John segment - created_at: 1690376088 - updated_at: 1690376088 - person_type: user - - type: segment - id: 64c1179835824d3d6bb506d2 - name: Jane segment - created_at: 1690376088 - updated_at: 1690376088 - person_type: user - schema: - '$ref': '#/components/schemas/segment_list' + - type: segment + id: 64c1179835824d3d6bb506d1 + name: John segment + created_at: 1690376088 + updated_at: 1690376088 + person_type: user + - type: segment + id: 64c1179835824d3d6bb506d2 + name: Jane segment + created_at: 1690376088 + updated_at: 1690376088 + person_type: user + schema: + "$ref": "#/components/schemas/segment_list" '401': description: Unauthorized content: @@ -7938,27 +7938,27 @@ paths: type: error.list request_id: 22ac7a0c-3616-45b5-93c6-c30d6981411c 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 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: @@ -7976,7 +7976,7 @@ paths: updated_at: 1690376089 person_type: user schema: - '$ref': '#/components/schemas/segment' + "$ref": "#/components/schemas/segment" '404': description: Segment not found content: @@ -7987,10 +7987,10 @@ paths: type: error.list request_id: 36d689e4-3d1f-4cf7-8e29-8e304cc1fd84 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: @@ -8001,20 +8001,20 @@ paths: type: error.list request_id: b691fd4c-20fe-4964-bcba-302cf21ab0f2 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: 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. @@ -8028,22 +8028,22 @@ paths: value: type: list data: - - type: subscription - id: '440977' - 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: '440977' + 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: @@ -8054,20 +8054,20 @@ paths: type: error.list request_id: 38fe4e88-5bcd-4164-86e6-f7c0a26c9310 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: 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. @@ -8085,7 +8085,7 @@ paths: url: http://via.intercom.io/msgr/af06a16e-b53c-4ce0-aef9-db63bc466be7 type: phone_call_redirect schema: - '$ref': '#/components/schemas/phone_switch' + "$ref": "#/components/schemas/phone_switch" '400': description: bad request - invalid number content: @@ -8117,54 +8117,54 @@ paths: type: error.list request_id: 074e94cb-b360-48bf-ac09-d36556b6c1b5 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: 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: @@ -8177,11 +8177,11 @@ paths: value: type: list data: - - type: tag - id: '321903' - name: Manual tag 1 + - type: tag + id: '321903' + name: Manual tag 1 schema: - '$ref': '#/components/schemas/tag_list' + "$ref": "#/components/schemas/tag_list" '401': description: Unauthorized content: @@ -8192,19 +8192,19 @@ paths: type: error.list request_id: 26f0717e-8921-4267-a3af-3e2eef0dd6ef 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: @@ -8232,7 +8232,7 @@ paths: id: '321906' name: test schema: - '$ref': '#/components/schemas/tag' + "$ref": "#/components/schemas/tag" '400': description: Invalid parameters content: @@ -8243,10 +8243,10 @@ paths: type: error.list request_id: 62e848a8-16a7-4b17-aee8-c81e84f97729 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: @@ -8257,17 +8257,17 @@ paths: type: error.list request_id: c95cdcaf-deb8-47bc-8ec7-509d6d257a9d 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: 4116d642-d5fa-43fc-8ed1-be4e5eca7eec 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: @@ -8278,19 +8278,19 @@ paths: type: error.list request_id: 282124d4-16f9-482a-b42e-b2852bf0a3a8 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 @@ -8305,30 +8305,30 @@ paths: value: name: test companies: - - company_id: '123' + - company_id: '123' user_not_found: summary: User not found value: name: test users: - - id: '123' - '/tags/{id}': + - id: '123' + "/tags/{id}": get: summary: Find a specific tag parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - description: The unique identifier of a given tag - example: '123' - required: true - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: The unique identifier of a given tag + example: '123' + required: true + schema: + type: string tags: - - Tags + - Tags operationId: findTag description: | You can fetch the details of tags that are on the workspace by their id. @@ -8345,7 +8345,7 @@ paths: id: '321914' name: Manual tag schema: - '$ref': '#/components/schemas/tag' + "$ref": "#/components/schemas/tag" '404': description: Tag not found content: @@ -8356,10 +8356,10 @@ paths: type: error.list request_id: 237ca963-d062-44e0-8bf9-29b61479388e 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: @@ -8370,26 +8370,26 @@ paths: type: error.list request_id: 443a77fa-fc0c-4c26-a248-6916f7ff6fef errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' + "$ref": "#/components/schemas/error" delete: summary: Delete tag parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - description: The unique identifier of a given tag - example: '123' - required: true - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: The unique identifier of a given tag + example: '123' + required: true + schema: + type: string tags: - - Tags + - Tags operationId: deleteTag description: You can delete the details of tags that are on the workspace by passing in the id. @@ -8406,10 +8406,10 @@ paths: type: error.list request_id: 20a1a36d-caa5-43dd-86d5-072e8f0bae3d 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: @@ -8420,11 +8420,11 @@ paths: type: error.list request_id: 14604dad-7f87-4272-965d-944024f5953b 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: @@ -8435,20 +8435,20 @@ paths: type: error.list request_id: 97643d06-6708-4f4e-9db4-7be7c88bed28 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: 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: @@ -8462,7 +8462,7 @@ paths: type: team.list teams: [] schema: - '$ref': '#/components/schemas/team_list' + "$ref": "#/components/schemas/team_list" '401': description: Unauthorized content: @@ -8473,27 +8473,27 @@ paths: type: error.list request_id: b458d83c-0e55-46f1-a532-52f5f8350969 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 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. @@ -8510,7 +8510,7 @@ paths: name: team 1 admin_ids: [] schema: - '$ref': '#/components/schemas/team' + "$ref": "#/components/schemas/team" '404': description: Team not found content: @@ -8521,10 +8521,10 @@ paths: type: error.list request_id: c43c4d13-2b65-4ba9-a336-3ba0cb432cdb 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: @@ -8535,26 +8535,26 @@ paths: type: error.list request_id: a8aabc1d-02a2-431a-a9a1-c780f6ed6a8c 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: 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: @@ -8584,7 +8584,7 @@ paths: created_at: 1690376112 updated_at: 1690376112 schema: - '$ref': '#/components/schemas/ticket_type_attribute' + "$ref": "#/components/schemas/ticket_type_attribute" '401': description: Unauthorized content: @@ -8595,15 +8595,15 @@ paths: type: error.list request_id: acdcd077-c709-437b-912f-4ee5e7b49e20 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 @@ -8612,29 +8612,29 @@ 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: 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: @@ -8662,7 +8662,7 @@ paths: created_at: 1690376113 updated_at: 1690376114 schema: - '$ref': '#/components/schemas/ticket_type_attribute' + "$ref": "#/components/schemas/ticket_type_attribute" '401': description: Unauthorized content: @@ -8673,30 +8673,30 @@ paths: type: error.list request_id: '0739ec1d-0bb4-4a6b-9cf1-4e71d5303232' 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: 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 description: You can get a list of all ticket types for a workspace. responses: '200': @@ -8708,38 +8708,38 @@ paths: value: type: list data: - - type: ticket_type - id: '766846' - name: Bug Report - description: Bug Report Template - icon: "\U0001F39F️" - workspace_id: this_is_an_id563_that_should_be_at_least_ - archived: false - created_at: 1690376114 - updated_at: 1690376114 - is_internal: false - ticket_type_attributes: - type: list - data: - - type: ticket_type_attribute - id: '164487' - workspace_id: this_is_an_id563_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: 766846 - archived: false - created_at: 1690376114 - updated_at: 1690376114 - schema: - '$ref': '#/components/schemas/ticket_type_list' + - type: ticket_type + id: '766846' + name: Bug Report + description: Bug Report Template + icon: "\U0001F39F️" + workspace_id: this_is_an_id563_that_should_be_at_least_ + archived: false + created_at: 1690376114 + updated_at: 1690376114 + is_internal: false + ticket_type_attributes: + type: list + data: + - type: ticket_type_attribute + id: '164487' + workspace_id: this_is_an_id563_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: 766846 + archived: false + created_at: 1690376114 + updated_at: 1690376114 + schema: + "$ref": "#/components/schemas/ticket_type_list" '401': description: Unauthorized content: @@ -8750,19 +8750,19 @@ paths: type: error.list request_id: 3114538d-d48b-4014-ab37-702501b0002e 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 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 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: _default_title_ and _default_description_.\n> For the `icon` propery, use @@ -8789,7 +8789,7 @@ paths: type: list data: [] schema: - '$ref': '#/components/schemas/ticket_type' + "$ref": "#/components/schemas/ticket_type" '401': description: Unauthorized content: @@ -8800,15 +8800,15 @@ paths: type: error.list request_id: c5f65002-2d03-46de-8f31-b4e4c743a59f 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 @@ -8817,22 +8817,22 @@ paths: description: Customer Report Template icon: "\U0001F39F️" category: Customer - '/ticket_types/{id}': + "/ticket_types/{id}": get: summary: Retrieve a ticket type parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The unique identifier for the ticket type which is given by Intercom. - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the ticket type which is given by Intercom. + schema: + type: string tags: - - Ticket Types + - Ticket Types description: You can fetch the details of a single ticket type. responses: '200': @@ -8855,25 +8855,25 @@ paths: ticket_type_attributes: type: list data: - - type: ticket_type_attribute - id: '164491' - workspace_id: this_is_an_id571_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: 766851 - archived: false - created_at: 1690376116 - updated_at: 1690376116 + - type: ticket_type_attribute + id: '164491' + workspace_id: this_is_an_id571_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: 766851 + archived: false + created_at: 1690376116 + updated_at: 1690376116 schema: - '$ref': '#/components/schemas/ticket_type' + "$ref": "#/components/schemas/ticket_type" '401': description: Unauthorized content: @@ -8884,25 +8884,25 @@ paths: type: error.list request_id: d2e67171-4e68-439e-bb77-d01b14f3fba8 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' + "$ref": "#/components/schemas/error" put: summary: Update a ticket type parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The unique identifier for the ticket type which is given by Intercom. - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the ticket type which is given by Intercom. + schema: + type: string tags: - - Ticket Types + - Ticket Types 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" responses: @@ -8926,25 +8926,25 @@ paths: ticket_type_attributes: type: list data: - - type: ticket_type_attribute - id: '164493' - workspace_id: this_is_an_id575_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: 766853 - archived: false - created_at: 1690376117 - updated_at: 1690376117 + - type: ticket_type_attribute + id: '164493' + workspace_id: this_is_an_id575_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: 766853 + archived: false + created_at: 1690376117 + updated_at: 1690376117 schema: - '$ref': '#/components/schemas/ticket_type' + "$ref": "#/components/schemas/ticket_type" '401': description: Unauthorized content: @@ -8955,41 +8955,41 @@ paths: type: error.list request_id: 9bfb8f0f-64aa-4ae9-8568-6c91563f7565 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: 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: '200': description: Admin quick_reply reply @@ -9001,8 +9001,8 @@ paths: type: error.list request_id: 299671c7-efe5-41ed-833c-2f25831bf34e errors: - - code: parameter_invalid - message: user is an invalid value for type + - code: parameter_invalid + message: user is an invalid value for type Admin note reply: value: type: ticket_part @@ -9035,10 +9035,10 @@ paths: type: error.list request_id: 9bbfdeae-f7a0-4c9b-b4e1-3d5c8c9aa250 errors: - - code: parameter_invalid - message: quick_reply is an invalid value for message_type + - code: parameter_invalid + message: quick_reply is an invalid value for message_type schema: - '$ref': '#/components/schemas/ticket_reply' + "$ref": "#/components/schemas/ticket_reply" '404': description: Not found content: @@ -9049,10 +9049,10 @@ paths: type: error.list request_id: fdfdc099-2c04-4b8c-bef2-67123ccb921b errors: - - code: parameter_invalid - message: user is an invalid value for type + - code: parameter_invalid + message: user is an invalid value for type schema: - '$ref': '#/components/schemas/error' + "$ref": "#/components/schemas/error" '401': description: Unauthorized content: @@ -9063,15 +9063,15 @@ paths: type: error.list request_id: 5ec99d1f-a092-4929-a310-3d175b107684 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_reply_request' + "$ref": "#/components/schemas/create_ticket_reply_request" examples: user_reply: summary: User reply @@ -9097,10 +9097,10 @@ paths: type: admin admin_id: 991266645 reply_options: - - text: 'Yes' - uuid: 6ac45212-2fb2-4f2a-a3b0-490b18f61c9b - - text: 'No' - uuid: fb86d3c8-076f-421a-892d-33e824916037 + - text: 'Yes' + uuid: 6ac45212-2fb2-4f2a-a3b0-490b18f61c9b + - text: 'No' + uuid: fb86d3c8-076f-421a-892d-33e824916037 not_found: summary: Not found value: @@ -9108,24 +9108,24 @@ paths: type: user intercom_user_id: 64c117bc35824d3d6bb50707 body: Thanks again :) - '/tickets/{ticket_id}/tags': + "/tickets/{ticket_id}/tags": post: summary: Add tag to a ticket parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: ticket_id - in: path - description: ticket_id - example: '64619700005694' - required: true - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: ticket_id + in: path + description: ticket_id + example: '64619700005694' + required: true + schema: + type: string tags: - - Tags - - Tickets + - Tags + - Tickets operationId: attachTagToTicket description: You can tag a specific ticket. This will return a tag object for the tag that was added to the ticket. @@ -9140,11 +9140,11 @@ paths: type: error.list request_id: 5a377ee6-86a7-4251-9e67-e337499f14e1 errors: - - code: intercom_version_invalid - message: Requested resource is not available in current API - version + - code: intercom_version_invalid + message: Requested resource is not available in current API + version schema: - '$ref': '#/components/schemas/tag' + "$ref": "#/components/schemas/tag" '404': description: Ticket not found content: @@ -9155,11 +9155,11 @@ paths: type: error.list request_id: f60fc612-3b48-42ab-ae5c-5fb336e44444 errors: - - code: intercom_version_invalid - message: Requested resource is not available in current API - version + - code: intercom_version_invalid + message: Requested resource is not available in current API + version schema: - '$ref': '#/components/schemas/error' + "$ref": "#/components/schemas/error" '401': description: Unauthorized content: @@ -9170,18 +9170,18 @@ paths: type: error.list request_id: 97e8d583-0150-43d7-bdc6-fadd51fab3ff 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 @@ -9204,31 +9204,31 @@ paths: value: id: 321923 admin_id: 991266658 - '/tickets/{ticket_id}/tags/{id}': + "/tickets/{ticket_id}/tags/{id}": delete: summary: Remove tag from a ticket parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: ticket_id - in: path - description: ticket_id - example: '64619700005694' - required: true - schema: - type: string - - name: id - in: path - description: The unique identifier for the tag which is given by Intercom - example: '7522907' - required: true - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: ticket_id + in: path + description: ticket_id + example: '64619700005694' + required: true + schema: + type: string + - name: id + in: path + description: The unique identifier for the tag which is given by Intercom + example: '7522907' + required: true + schema: + type: string tags: - - Tags - - Tickets + - Tags + - Tickets operationId: detachTagFromTicket description: You can remove tag from a specific ticket. This will return a tag object for the tag that was removed from the ticket. @@ -9243,11 +9243,11 @@ paths: type: error.list request_id: 3716e30b-a19d-4f1c-b37f-1dcdfce6df0f errors: - - code: intercom_version_invalid - message: Requested resource is not available in current API - version + - code: intercom_version_invalid + message: Requested resource is not available in current API + version schema: - '$ref': '#/components/schemas/tag' + "$ref": "#/components/schemas/tag" '404': description: Tag not found content: @@ -9258,19 +9258,19 @@ paths: type: error.list request_id: c62a80b5-c9d8-49be-b5eb-d9330e84a64d errors: - - code: intercom_version_invalid - message: Requested resource is not available in current API - version + - code: intercom_version_invalid + message: Requested resource is not available in current API + version Tag not found: value: type: error.list request_id: d9892402-301e-4406-9acb-4db2da311af3 errors: - - code: intercom_version_invalid - message: Requested resource is not available in current API - version + - code: intercom_version_invalid + message: Requested resource is not available in current API + version schema: - '$ref': '#/components/schemas/error' + "$ref": "#/components/schemas/error" '401': description: Unauthorized content: @@ -9281,17 +9281,17 @@ paths: type: error.list request_id: 8d82ea95-dd5a-4454-8357-c468da15eada 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 @@ -9311,16 +9311,16 @@ paths: summary: Tag not found value: admin_id: 991266670 - '/tickets': + "/tickets": post: summary: Create a ticket parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" tags: - - Tickets + - Tickets description: You can create a new ticket. responses: '200': @@ -9350,45 +9350,45 @@ paths: ticket_type_attributes: type: list data: - - type: ticket_type_attribute - id: '164503' - workspace_id: this_is_an_id603_that_should_be_at_least_ - name: 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: 766867 - archived: false - created_at: 1690376135 - updated_at: 1690376135 - - type: ticket_type_attribute - id: '164504' - workspace_id: this_is_an_id603_that_should_be_at_least_ - name: 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: 766867 - archived: false - created_at: 1690376135 - updated_at: 1690376135 + - type: ticket_type_attribute + id: '164503' + workspace_id: this_is_an_id603_that_should_be_at_least_ + name: 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: 766867 + archived: false + created_at: 1690376135 + updated_at: 1690376135 + - type: ticket_type_attribute + id: '164504' + workspace_id: this_is_an_id603_that_should_be_at_least_ + name: 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: 766867 + archived: false + created_at: 1690376135 + updated_at: 1690376135 contacts: type: contact.list contacts: - - id: 64c117c735824d3d6bb50710 - role: user + - id: 64c117c735824d3d6bb50710 + role: user admin_assignee_id: '0' team_assignee_id: '0' created_at: 1690376136 @@ -9396,23 +9396,23 @@ paths: ticket_parts: type: ticket_part.list ticket_parts: - - type: ticket_part - id: '711375' - part_type: ticket_state_updated_by_admin - ticket_state: submitted - previous_ticket_state: submitted - created_at: 1690376136 - updated_at: 1690376136 - author: - id: '991266682' - type: bot - name: Operator - email: operator+this_is_an_id603_that_should_be_at_least_@intercom.io - attachments: [] - redacted: false + - type: ticket_part + id: '711375' + part_type: ticket_state_updated_by_admin + ticket_state: submitted + previous_ticket_state: submitted + created_at: 1690376136 + updated_at: 1690376136 + author: + id: '991266682' + type: bot + name: Operator + email: operator+this_is_an_id603_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false total_count: 1 schema: - '$ref': '#/components/schemas/ticket' + "$ref": "#/components/schemas/ticket" '401': description: Unauthorized content: @@ -9423,41 +9423,41 @@ paths: type: error.list request_id: fec0b237-9065-4d24-913e-bcad671e5850 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_request' + "$ref": "#/components/schemas/create_ticket_request" examples: successful_response: summary: Successful response value: ticket_type_id: 766867 contacts: - - id: 64c117c735824d3d6bb50710 + - id: 64c117c735824d3d6bb50710 ticket_attributes: title: example description: there is a problem - '/tickets/{id}': + "/tickets/{id}": put: summary: Update a ticket parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The unique identifier for the ticket which is given by Intercom - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the ticket which is given by Intercom + schema: + type: string tags: - - Tickets + - Tickets description: You can update a ticket. responses: '200': @@ -9487,45 +9487,45 @@ paths: ticket_type_attributes: type: list data: - - type: ticket_type_attribute - id: '164508' - workspace_id: this_is_an_id607_that_should_be_at_least_ - name: 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: 766869 - archived: false - created_at: 1690376137 - updated_at: 1690376137 - - type: ticket_type_attribute - id: '164509' - workspace_id: this_is_an_id607_that_should_be_at_least_ - name: 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: 766869 - archived: false - created_at: 1690376137 - updated_at: 1690376137 + - type: ticket_type_attribute + id: '164508' + workspace_id: this_is_an_id607_that_should_be_at_least_ + name: 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: 766869 + archived: false + created_at: 1690376137 + updated_at: 1690376137 + - type: ticket_type_attribute + id: '164509' + workspace_id: this_is_an_id607_that_should_be_at_least_ + name: 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: 766869 + archived: false + created_at: 1690376137 + updated_at: 1690376137 contacts: type: contact.list contacts: - - id: 64c117c935824d3d6bb50711 - role: lead + - id: 64c117c935824d3d6bb50711 + role: lead admin_assignee_id: '991266696' team_assignee_id: '0' created_at: 1690376138 @@ -9533,76 +9533,76 @@ paths: ticket_parts: type: ticket_part.list ticket_parts: - - type: ticket_part - id: '711376' - part_type: ticket_state_updated_by_admin - ticket_state: submitted - previous_ticket_state: submitted - created_at: 1690376138 - updated_at: 1690376138 - author: - id: '991266694' - type: admin - name: Ciaran403 Lee - email: admin403@email.com - attachments: [] - redacted: false - - type: ticket_part - id: '711377' - part_type: ticket_attribute_updated_by_admin - created_at: 1690376139 - updated_at: 1690376139 - author: - id: '991266695' - type: bot - name: Operator - email: operator+this_is_an_id607_that_should_be_at_least_@intercom.io - attachments: [] - redacted: false - - type: ticket_part - id: '711378' - part_type: ticket_attribute_updated_by_admin - created_at: 1690376139 - updated_at: 1690376139 - author: - id: '991266695' - type: bot - name: Operator - email: operator+this_is_an_id607_that_should_be_at_least_@intercom.io - attachments: [] - redacted: false - - type: ticket_part - id: '711379' - part_type: ticket_state_updated_by_admin - ticket_state: in_progress - previous_ticket_state: submitted - created_at: 1690376139 - updated_at: 1690376139 - author: - id: '991266695' - type: bot - name: Operator - email: operator+this_is_an_id607_that_should_be_at_least_@intercom.io - attachments: [] - redacted: false - - type: ticket_part - id: '711380' - part_type: assignment - created_at: 1690376140 - updated_at: 1690376140 - assigned_to: - type: admin - id: '991266696' - author: - id: '991266694' - type: admin - name: Ciaran403 Lee - email: admin403@email.com - attachments: [] - redacted: false + - type: ticket_part + id: '711376' + part_type: ticket_state_updated_by_admin + ticket_state: submitted + previous_ticket_state: submitted + created_at: 1690376138 + updated_at: 1690376138 + author: + id: '991266694' + type: admin + name: Ciaran403 Lee + email: admin403@email.com + attachments: [] + redacted: false + - type: ticket_part + id: '711377' + part_type: ticket_attribute_updated_by_admin + created_at: 1690376139 + updated_at: 1690376139 + author: + id: '991266695' + type: bot + name: Operator + email: operator+this_is_an_id607_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false + - type: ticket_part + id: '711378' + part_type: ticket_attribute_updated_by_admin + created_at: 1690376139 + updated_at: 1690376139 + author: + id: '991266695' + type: bot + name: Operator + email: operator+this_is_an_id607_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false + - type: ticket_part + id: '711379' + part_type: ticket_state_updated_by_admin + ticket_state: in_progress + previous_ticket_state: submitted + created_at: 1690376139 + updated_at: 1690376139 + author: + id: '991266695' + type: bot + name: Operator + email: operator+this_is_an_id607_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false + - type: ticket_part + id: '711380' + part_type: assignment + created_at: 1690376140 + updated_at: 1690376140 + assigned_to: + type: admin + id: '991266696' + author: + id: '991266694' + type: admin + name: Ciaran403 Lee + email: admin403@email.com + attachments: [] + redacted: false total_count: 5 schema: - '$ref': '#/components/schemas/ticket' + "$ref": "#/components/schemas/ticket" '404': description: Assignee not found content: @@ -9613,15 +9613,15 @@ paths: type: error.list request_id: a73551de-9c47-4a9a-b549-c1cb5c950c2a 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: fd766d78-840f-4d71-8642-7d4ccd290133 errors: - - code: assignee_not_found - message: Assignee not found + - code: assignee_not_found + message: Assignee not found '401': description: Unauthorized content: @@ -9632,15 +9632,15 @@ paths: type: error.list request_id: 0e51fdb3-d8a6-4e4f-bf9a-b22010b47095 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 @@ -9677,18 +9677,18 @@ paths: get: summary: Retrieve a ticket parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: The unique identifier for the ticket which is given by Intercom. - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the ticket which is given by Intercom. + schema: + type: string tags: - - Tickets + - Tickets description: You can fetch the details of a single ticket. responses: '200': @@ -9718,45 +9718,45 @@ paths: ticket_type_attributes: type: list data: - - type: ticket_type_attribute - id: '164519' - workspace_id: this_is_an_id615_that_should_be_at_least_ - name: 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: 766873 - archived: false - created_at: 1690376145 - updated_at: 1690376145 - - type: ticket_type_attribute - id: '164520' - workspace_id: this_is_an_id615_that_should_be_at_least_ - name: 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: 766873 - archived: false - created_at: 1690376145 - updated_at: 1690376145 + - type: ticket_type_attribute + id: '164519' + workspace_id: this_is_an_id615_that_should_be_at_least_ + name: 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: 766873 + archived: false + created_at: 1690376145 + updated_at: 1690376145 + - type: ticket_type_attribute + id: '164520' + workspace_id: this_is_an_id615_that_should_be_at_least_ + name: 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: 766873 + archived: false + created_at: 1690376145 + updated_at: 1690376145 contacts: type: contact.list contacts: - - id: 64c117d135824d3d6bb50714 - role: lead + - id: 64c117d135824d3d6bb50714 + role: lead admin_assignee_id: '0' team_assignee_id: '0' created_at: 1690376145 @@ -9764,23 +9764,23 @@ paths: ticket_parts: type: ticket_part.list ticket_parts: - - type: ticket_part - id: '711383' - part_type: ticket_state_updated_by_admin - ticket_state: submitted - previous_ticket_state: submitted - created_at: 1690376146 - updated_at: 1690376146 - author: - id: '991266723' - type: admin - name: Ciaran429 Lee - email: admin429@email.com - attachments: [] - redacted: false + - type: ticket_part + id: '711383' + part_type: ticket_state_updated_by_admin + ticket_state: submitted + previous_ticket_state: submitted + created_at: 1690376146 + updated_at: 1690376146 + author: + id: '991266723' + type: admin + name: Ciaran429 Lee + email: admin429@email.com + attachments: [] + redacted: false total_count: 1 schema: - '$ref': '#/components/schemas/ticket' + "$ref": "#/components/schemas/ticket" '401': description: Unauthorized content: @@ -9791,20 +9791,20 @@ paths: type: error.list request_id: 3b97f939-077d-4c60-9b23-9169a8a7bec9 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: summary: Search tickets 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.\n\nTo search for tickets, you send a POST request to https://api.intercom.io/tickets/search. This will accept @@ -9847,16 +9847,16 @@ paths: type: error.list request_id: d60069c7-ca5c-4087-9b06-e6f977c396fd errors: - - code: intercom_version_invalid - message: Requested resource is not available in current API - version + - code: intercom_version_invalid + message: Requested resource is not available in current API + version 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 @@ -9864,27 +9864,27 @@ paths: query: operator: AND value: + - field: id + operator: "=" + value: '715541' + - operator: OR + value: + - field: id + operator: "=" + value: '715541' - field: id - operator: '=' + operator: "=" value: '715541' - - operator: OR - value: - - field: id - operator: '=' - value: '715541' - - field: id - operator: '=' - value: '715541' - '/visitors': + "/visitors": put: 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. @@ -9944,7 +9944,7 @@ paths: utm_term: do_not_track: schema: - '$ref': '#/components/schemas/visitor' + "$ref": "#/components/schemas/visitor" '404': description: visitor Not Found content: @@ -9955,10 +9955,10 @@ paths: type: error.list request_id: c23b0d2a-5a9f-4e93-aae9-bf6d6e34b9a2 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: @@ -9969,15 +9969,15 @@ paths: type: error.list request_id: 308839ca-f38a-47a9-ab8c-feafb732d6bb 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 @@ -9992,18 +9992,18 @@ paths: get: summary: Retrieve a visitor with User ID parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: user_id - in: query - description: The user_id of the Visitor you want to retrieve. - required: true - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: user_id + in: query + description: The user_id of the Visitor you want to retrieve. + required: true + schema: + type: string tags: - - Visitors + - Visitors operationId: retrieveVisitorWithUserId description: You can fetch the details of a single visitor. responses: @@ -10058,7 +10058,7 @@ paths: utm_term: do_not_track: schema: - '$ref': '#/components/schemas/visitor' + "$ref": "#/components/schemas/visitor" '404': description: Visitor not found content: @@ -10069,10 +10069,10 @@ paths: type: error.list request_id: 4eb5cc93-afe9-4f38-abce-4b4e4b428aab 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: @@ -10083,27 +10083,27 @@ paths: type: error.list request_id: 948f9dca-a392-448d-988e-c8684e64ad6f errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' - '/visitors/{id}': + "$ref": "#/components/schemas/error" + "/visitors/{id}": get: summary: Retrieve a visitor with ID parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: Id provided by Intercom. - example: 5e1c4c1c-7b1e-4b5d-8c1c-5e1c4c1c7b1e - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: Id provided by Intercom. + example: 5e1c4c1c-7b1e-4b5d-8c1c-5e1c4c1c7b1e + schema: + type: string tags: - - Visitors + - Visitors operationId: retrieveVisitor description: You can fetch the details of a single visitor. responses: @@ -10158,7 +10158,7 @@ paths: utm_term: do_not_track: schema: - '$ref': '#/components/schemas/visitor' + "$ref": "#/components/schemas/visitor" '404': description: Visitor not found content: @@ -10169,10 +10169,10 @@ paths: type: error.list request_id: 43316546-9bf1-46d7-9287-180b113e4f5f 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: @@ -10183,26 +10183,26 @@ paths: type: error.list request_id: 59e93947-89f8-4c96-98d5-b468f1bc7af0 errors: - - code: unauthorized - message: Access Token Invalid + - code: unauthorized + message: Access Token Invalid schema: - '$ref': '#/components/schemas/error' + "$ref": "#/components/schemas/error" delete: summary: Delete a visitor parameters: - - name: Intercom-Version - in: header - schema: - '$ref': '#/components/schemas/intercom_version' - - name: id - in: path - required: true - description: Id provided by Intercom. - example: 5e1c4c1c-7b1e-4b5d-8c1c-5e1c4c1c7b1e - schema: - type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: Id provided by Intercom. + example: 5e1c4c1c-7b1e-4b5d-8c1c-5e1c4c1c7b1e + schema: + type: string tags: - - Visitors + - Visitors operationId: deleteVisitor description: You can delete a single visitor. responses: @@ -10257,7 +10257,7 @@ paths: utm_term: do_not_track: schema: - '$ref': '#/components/schemas/visitor_deleted_object' + "$ref": "#/components/schemas/visitor_deleted_object" '404': description: Visitor Not Found content: @@ -10268,10 +10268,10 @@ paths: type: error.list request_id: bcf67bbb-bfaa-487f-b2f7-36e40791e862 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: @@ -10282,20 +10282,20 @@ paths: type: error.list request_id: 41c16847-8f7b-4db3-a81a-017396a63d6b 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: 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 @@ -10354,7 +10354,7 @@ paths: utm_term: do_not_track: schema: - '$ref': '#/components/schemas/contact' + "$ref": "#/components/schemas/contact" '401': description: Unauthorized content: @@ -10365,15 +10365,15 @@ paths: type: error.list request_id: 603a244a-7681-4d6a-9054-fb2453312872 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 @@ -10426,73 +10426,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 @@ -10509,12 +10509,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" addressable_list: title: Addressable List type: object @@ -10534,7 +10534,7 @@ 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 @@ -10581,7 +10581,7 @@ components: type: array description: This object represents the avatar associated with the admin. example: - - 814865 + - 814865 items: type: integer avatar: @@ -10591,7 +10591,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 @@ -10606,7 +10606,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 @@ -10618,7 +10618,7 @@ components: description: The primary admin ids for the team nullable: true example: - - 493881 + - 493881 items: type: integer secondary_admin_ids: @@ -10626,7 +10626,7 @@ components: description: The secondary admin ids for the team nullable: true example: - - 814865 + - 814865 items: type: integer admin_reply_conversation_request: @@ -10637,12 +10637,12 @@ components: message_type: type: string enum: - - comment - - note + - comment + - note type: type: string enum: - - admin + - admin example: admin body: type: string @@ -10662,9 +10662,9 @@ components: format: uri maxItems: 5 required: - - message_type - - type - - admin_id + - message_type + - type + - admin_id admin_reply_ticket_request: title: Admin Reply on ticket type: object @@ -10673,14 +10673,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 @@ -10710,8 +10710,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 @@ -10721,9 +10721,9 @@ components: format: uri maxItems: 5 required: - - message_type - - type - - admin_id + - message_type + - type + - admin_id admin_with_app: title: Admin type: object @@ -10770,7 +10770,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: @@ -10795,7 +10795,7 @@ components: nullable: true example: true app: - '$ref': '#/components/schemas/app' + "$ref": "#/components/schemas/app" nullable: true description: App that the admin belongs to. app: @@ -10845,7 +10845,7 @@ components: type: string description: The type of object - `article`. enum: - - article + - article default: article example: article id: @@ -10884,8 +10884,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: @@ -10925,10 +10925,10 @@ components: example: en translated_content: nullable: true - '$ref': '#/components/schemas/article_translated_content' + "$ref": "#/components/schemas/article_translated_content" statistics: nullable: true - '$ref': '#/components/schemas/article_statistics' + "$ref": "#/components/schemas/article_statistics" article_content: title: Article Content type: object @@ -10939,8 +10939,8 @@ components: type: string description: The type of object - `article_content` . enum: - - - - article_content + - + - article_content example: article_content title: type: string @@ -10962,8 +10962,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 @@ -10988,10 +10988,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. @@ -11000,7 +11000,7 @@ components: type: array description: An array of Article objects items: - '$ref': '#/components/schemas/article' + "$ref": "#/components/schemas/article" article_statistics: title: Article Statistics type: object @@ -11011,7 +11011,7 @@ components: type: string description: The type of object - `article_statistics`. enum: - - article_statistics + - article_statistics default: article_statistics example: article_statistics views: @@ -11052,120 +11052,120 @@ components: type: string description: The type of object - article_translated_content. enum: - - - - article_translated_content + - + - article_translated_content example: article_translated_content 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 @@ -11174,13 +11174,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 @@ -11198,10 +11198,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 @@ -11214,38 +11214,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 @@ -11254,12 +11254,12 @@ components: message_type: type: string enum: - - close + - close example: close type: type: string enum: - - admin + - admin example: admin admin_id: type: string @@ -11269,11 +11269,11 @@ 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 @@ -11338,12 +11338,12 @@ components: example: en translated_content: nullable: true - '$ref': '#/components/schemas/group_translated_content' + "$ref": "#/components/schemas/group_translated_content" type: type: string description: The type of object - `collection`. enum: - - collection + - collection default: collection example: collection collection_list: @@ -11355,10 +11355,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. @@ -11367,7 +11367,7 @@ components: type: array description: An array of collection objects items: - '$ref': '#/components/schemas/collection' + "$ref": "#/components/schemas/collection" company: title: Company type: object @@ -11380,7 +11380,7 @@ components: type: string description: Value is `company` enum: - - company + - company example: company id: type: string @@ -11471,12 +11471,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 @@ -11485,11 +11485,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 @@ -11499,19 +11499,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 @@ -11521,13 +11521,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: Companys type: object @@ -11537,10 +11537,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. @@ -11549,7 +11549,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 @@ -11562,14 +11562,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 @@ -11617,12 +11617,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 @@ -11649,52 +11649,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 @@ -11751,8 +11751,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 @@ -11783,7 +11783,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 @@ -11803,15 +11803,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 @@ -11821,7 +11821,7 @@ components: type: string description: always contact enum: - - contact + - contact example: contact id: type: string @@ -11846,19 +11846,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 @@ -11870,7 +11870,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 @@ -11890,7 +11890,7 @@ components: type: string description: always contact enum: - - contact + - contact example: contact id: type: string @@ -11915,19 +11915,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 @@ -11965,12 +11965,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 @@ -11990,7 +11990,7 @@ components: type: string description: always contact enum: - - contact + - contact example: contact id: type: string @@ -12004,202 +12004,202 @@ components: example: f3b87a2e09d514c6c2e79b9a contact_reply_conversation_request: title: Contact Reply - oneOf: - - title: Intercom User ID - type: object - description: Payload of the request to reply on behalf of a contact using - their `intercom_user_id` - properties: - message_type: - type: string - enum: - - comment - type: - type: string - enum: - - user - body: - type: string - description: The text body of the comment. - intercom_user_id: - type: string - description: The identifier for the contact as given by Intercom. - attachment_urls: - type: array - description: A list of image URLs that will be added as attachments. You - can include up to 5 URLs. - items: - type: string - format: uri - maxItems: 5 - required: - - message_type - - type - - body - - intercom_user_id - - title: User ID - type: object - description: Payload of the request to reply on behalf of a contact using - their `user_id` - properties: - message_type: - type: string - enum: - - comment - type: - type: string - enum: - - user - body: - type: string - description: The text body of the comment. - user_id: - type: string - description: The external_id you have defined for the contact. - attachment_urls: - type: array - description: A list of image URLs that will be added as attachments. You - can include up to 5 URLs. - items: - type: string - format: uri - maxItems: 5 - required: - - message_type - - type - - body - - user_id - - title: Email - type: object - description: Payload of the request to reply on behalf of a contact using - their `email` - properties: - message_type: - type: string - enum: - - comment - type: + oneOf: + - title: Intercom User ID + type: object + description: Payload of the request to reply on behalf of a contact using + their `intercom_user_id` + properties: + message_type: + type: string + enum: + - comment + type: + type: string + enum: + - user + body: + type: string + description: The text body of the comment. + intercom_user_id: + type: string + description: The identifier for the contact as given by Intercom. + attachment_urls: + type: array + description: A list of image URLs that will be added as attachments. You + can include up to 5 URLs. + items: type: string - enum: - - user - body: + format: uri + maxItems: 5 + required: + - message_type + - type + - body + - intercom_user_id + - title: User ID + type: object + description: Payload of the request to reply on behalf of a contact using + their `user_id` + properties: + message_type: + type: string + enum: + - comment + type: + type: string + enum: + - user + body: + type: string + description: The text body of the comment. + user_id: + type: string + description: The external_id you have defined for the contact. + attachment_urls: + type: array + description: A list of image URLs that will be added as attachments. You + can include up to 5 URLs. + items: type: string - description: The text body of the comment. - email: + format: uri + maxItems: 5 + required: + - message_type + - type + - body + - user_id + - title: Email + type: object + description: Payload of the request to reply on behalf of a contact using + their `email` + properties: + message_type: + type: string + enum: + - comment + type: + type: string + enum: + - user + body: + type: string + description: The text body of the comment. + email: + type: string + description: The email you have defined for the user. + attachment_urls: + type: array + description: A list of image URLs that will be added as attachments. You + can include up to 5 URLs. + items: type: string - description: The email you have defined for the user. - attachment_urls: - type: array - description: A list of image URLs that will be added as attachments. You - can include up to 5 URLs. - items: - type: string - format: uri - maxItems: 5 - required: - - message_type - - type - - body - - email + format: uri + maxItems: 5 + required: + - message_type + - type + - body + - email contact_reply_ticket_request: title: Contact Reply on ticket oneOf: - - title: Intercom User ID - type: object - description: Payload of the request to reply on behalf of a contact using - their `intercom_user_id` - properties: - message_type: - type: string - enum: - - comment - type: - type: string - enum: - - user - body: - type: string - description: The text body of the comment. - intercom_user_id: - type: string - description: The identifier for the contact as given by Intercom. - attachment_urls: - type: array - description: A list of image URLs that will be added as attachments. You - can include up to 5 URLs. - items: - type: string - format: uri - maxItems: 5 - required: - - message_type - - type - - body - - intercom_user_id - - title: User ID - type: object - description: Payload of the request to reply on behalf of a contact using - their `user_id` - properties: - message_type: - type: string - enum: - - comment - type: - type: string - enum: - - user - body: - type: string - description: The text body of the comment. - user_id: - type: string - description: The external_id you have defined for the contact. - attachment_urls: - type: array - description: A list of image URLs that will be added as attachments. You - can include up to 5 URLs. - items: - type: string - format: uri - maxItems: 5 - required: - - message_type - - type - - body - - user_id - - title: Email - type: object - description: Payload of the request to reply on behalf of a contact using - their `email` - properties: - message_type: - type: string - enum: - - comment - type: + - title: Intercom User ID + type: object + description: Payload of the request to reply on behalf of a contact using + their `intercom_user_id` + properties: + message_type: + type: string + enum: + - comment + type: + type: string + enum: + - user + body: + type: string + description: The text body of the comment. + intercom_user_id: + type: string + description: The identifier for the contact as given by Intercom. + attachment_urls: + type: array + description: A list of image URLs that will be added as attachments. You + can include up to 5 URLs. + items: type: string - enum: - - user - body: + format: uri + maxItems: 5 + required: + - message_type + - type + - body + - intercom_user_id + - title: User ID + type: object + description: Payload of the request to reply on behalf of a contact using + their `user_id` + properties: + message_type: + type: string + enum: + - comment + type: + type: string + enum: + - user + body: + type: string + description: The text body of the comment. + user_id: + type: string + description: The external_id you have defined for the contact. + attachment_urls: + type: array + description: A list of image URLs that will be added as attachments. You + can include up to 5 URLs. + items: type: string - description: The text body of the comment. - email: + format: uri + maxItems: 5 + required: + - message_type + - type + - body + - user_id + - title: Email + type: object + description: Payload of the request to reply on behalf of a contact using + their `email` + properties: + message_type: + type: string + enum: + - comment + type: + type: string + enum: + - user + body: + type: string + description: The text body of the comment. + email: + type: string + description: The email you have defined for the user. + attachment_urls: + type: array + description: A list of image URLs that will be added as attachments. You + can include up to 5 URLs. + items: type: string - description: The email you have defined for the user. - attachment_urls: - type: array - description: A list of image URLs that will be added as attachments. You - can include up to 5 URLs. - items: - type: string - format: uri - maxItems: 5 - required: - - message_type - - type - - body - - email + format: uri + maxItems: 5 + required: + - message_type + - type + - body + - email contact_segments: title: Segments type: object @@ -12209,13 +12209,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 @@ -12226,7 +12226,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 @@ -12238,12 +12238,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 @@ -12265,12 +12265,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 @@ -12290,7 +12290,7 @@ components: type: string description: always contact enum: - - contact + - contact example: contact id: type: string @@ -12360,9 +12360,9 @@ components: state: type: string enum: - - open - - closed - - snoozed + - open + - closed + - snoozed description: Can be set to "open", "closed" or "snoozed". example: open read: @@ -12372,8 +12372,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: @@ -12389,25 +12389,25 @@ 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" conversation_contacts: title: Contacts type: object @@ -12419,7 +12419,7 @@ components: type: string description: '' enum: - - contact.list + - contact.list example: contact.list contacts: type: array @@ -12427,7 +12427,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_first_contact_reply: title: First contact reply type: object @@ -12460,19 +12460,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 @@ -12495,7 +12495,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 @@ -12512,18 +12512,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 @@ -12568,7 +12568,7 @@ components: type: string description: '' enum: - - conversation_part.list + - conversation_part.list example: conversation_part.list conversation_parts: title: Conversation Parts @@ -12577,7 +12577,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: '' @@ -12605,9 +12605,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_source: title: Conversation source type: object @@ -12639,14 +12639,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 @@ -12772,7 +12772,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 @@ -12784,9 +12784,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 @@ -12816,10 +12816,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. @@ -12838,16 +12838,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 @@ -12868,7 +12868,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, @@ -12881,8 +12881,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 @@ -12894,10 +12894,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 @@ -12915,9 +12915,9 @@ components: example: English description translated_content: nullable: true - '$ref': '#/components/schemas/group_translated_content' + "$ref": "#/components/schemas/group_translated_content" required: - - name + - name create_contact_request: description: Payload to create a contact type: object @@ -12937,7 +12937,7 @@ components: type: string nullable: true description: The contacts phone - example: '+353871234567' + example: "+353871234567" name: type: string nullable: true @@ -12977,15 +12977,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_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 @@ -12999,9 +12999,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: @@ -13012,15 +13012,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 @@ -13034,20 +13034,20 @@ components: type: string description: The model that the data attribute belongs to. enum: - - contact - - company - - conversation + - contact + - company + - conversation 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 @@ -13060,12 +13060,12 @@ components: items: type: string example: - - option1 - - option2 + - option1 + - option2 required: - - name - - model - - data_type + - name + - model + - data_type create_data_event_request: description: '' type: object @@ -13104,21 +13104,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 @@ -13174,8 +13174,8 @@ components: as a unix timestamp. example: 1527811200 required: - - created_at_after - - created_at_before + - created_at_after + - created_at_before create_message_request: description: You can create a message type: object @@ -13186,8 +13186,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 @@ -13211,15 +13211,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 @@ -13229,16 +13229,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 create_conversation_without_contact_reply: type: boolean description: Whether a conversation should be opened in the inbox for the @@ -13246,20 +13246,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 @@ -13328,7 +13328,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 @@ -13339,11 +13339,11 @@ 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_section_request: description: You can create a Section type: object @@ -13360,16 +13360,16 @@ components: example: 18 translated_content: nullable: true - '$ref': '#/components/schemas/group_translated_content' + "$ref": "#/components/schemas/group_translated_content" required: - - name - - parent_id + - name + - parent_id create_ticket_reply_request: title: Create Ticket Reply Request Payload description: You can create a reply on a ticket. 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 @@ -13386,37 +13386,37 @@ 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' 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 @@ -13435,13 +13435,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 @@ -13483,9 +13483,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. @@ -13506,9 +13506,9 @@ components: type: string description: Category of the Ticket Type. enum: - - Customer - - Back-office - - Tracker + - Customer + - Back-office + - Tracker example: Customer icon: type: string @@ -13523,8 +13523,8 @@ components: example: false default: false required: - - name - - category + - name + - category cursor_pages: title: Cursor based pages type: object @@ -13538,13 +13538,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 @@ -13561,8 +13561,8 @@ 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 @@ -13591,32 +13591,32 @@ 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 @@ -13630,7 +13630,7 @@ components: type: string description: Value is `data_attribute`. enum: - - data_attribute + - data_attribute example: data_attribute id: type: integer @@ -13642,9 +13642,9 @@ components: description: Value is `contact` for user/lead attributes, `company` for company attributes and `conversation` for conversation attributes.. enum: - - contact - - company - - conversation + - contact + - company + - conversation example: contact name: type: string @@ -13668,11 +13668,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 @@ -13680,8 +13680,8 @@ components: items: type: string example: - - 'true' - - 'false' + - 'true' + - 'false' api_writable: type: boolean description: Can this attribute be updated through API @@ -13722,13 +13722,13 @@ 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 @@ -13739,7 +13739,7 @@ components: type: string description: The type of the object enum: - - event + - event example: event event_name: type: string @@ -13778,8 +13778,8 @@ components: example: invite_code: ADDAFRIEND required: - - event_name - - created_at + - event_name + - created_at data_event_list: title: Data Event List type: object @@ -13789,13 +13789,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 @@ -13815,7 +13815,7 @@ components: type: string description: The type of the object enum: - - event.summary + - event.summary example: event.summary email: type: string @@ -13833,7 +13833,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 @@ -13874,12 +13874,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: @@ -14000,7 +14000,7 @@ components: type: string description: The type of object which was deleted. - article enum: - - article + - article example: article deleted: type: boolean @@ -14020,7 +14020,7 @@ components: type: string description: The type of object which was deleted. - `collection` enum: - - collection + - collection example: collection deleted: type: boolean @@ -14039,7 +14039,7 @@ components: type: string description: The type of object which was deleted. - `company` enum: - - company + - company example: company deleted: type: boolean @@ -14059,7 +14059,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 @@ -14079,7 +14079,7 @@ components: type: string description: The type of object which was deleted. - `section` enum: - - section + - section example: section deleted: type: boolean @@ -14092,7 +14092,7 @@ components: description: The `id` of the admin who is performing the action. example: '5017690' required: - - admin_id + - admin_id error: type: object title: Error @@ -14131,10 +14131,10 @@ components: parameter that was in error. example: email required: - - code + - code required: - - type - - errors + - type + - errors file_attribute: title: File type: object @@ -14178,8 +14178,8 @@ components: type: string description: The type of object - `group_content` . enum: - - - - group_content + - + - group_content example: group_content name: type: string @@ -14188,7 +14188,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 @@ -14201,120 +14201,120 @@ 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" intercom_version: description: Intercom API version.
By default, it's equal to the version set in the app package. @@ -14322,22 +14322,22 @@ components: example: Unstable default: '2.9' 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' - - 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' + - Unstable merge_contacts_request: description: Merge contact data. type: object @@ -14385,10 +14385,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 @@ -14397,33 +14397,33 @@ 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: type: object properties: 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 @@ -14435,7 +14435,7 @@ components: type: string description: The type of object. enum: - - news-item + - news-item example: news-item id: type: string @@ -14465,14 +14465,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. @@ -14524,7 +14524,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 @@ -14535,8 +14535,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 @@ -14549,9 +14549,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, @@ -14560,16 +14560,16 @@ 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 @@ -14587,7 +14587,7 @@ components: type: string description: The type of object. enum: - - newsfeed + - newsfeed example: newsfeed name: type: string @@ -14658,12 +14658,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 @@ -14678,13 +14678,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 @@ -14693,15 +14693,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 @@ -14714,7 +14714,7 @@ components: type: string example: pages enum: - - pages + - pages page: type: integer example: 1 @@ -14739,11 +14739,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. @@ -14753,8 +14753,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 @@ -14798,60 +14798,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 @@ -14868,8 +14868,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 @@ -14877,14 +14877,14 @@ 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 section: title: Section type: object @@ -14896,7 +14896,7 @@ components: type: string description: The type of object - `section`. enum: - - section + - section default: section example: section id: @@ -14944,10 +14944,10 @@ components: example: '1' parent_id: oneOf: - - type: integer - title: Integer - - type: string - title: String + - type: integer + title: Integer + - type: string + title: String description: The id of the parent section. example: 6871119 default_locale: @@ -14957,7 +14957,7 @@ components: example: en translated_content: nullable: true - '$ref': '#/components/schemas/group_translated_content' + "$ref": "#/components/schemas/group_translated_content" section_list: title: Sections type: object @@ -14967,10 +14967,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 sections. @@ -14979,7 +14979,7 @@ components: type: array description: An array of section objects items: - '$ref': '#/components/schemas/section' + "$ref": "#/components/schemas/section" segment: title: Segment type: object @@ -14991,7 +14991,7 @@ components: type: string description: The type of object. enum: - - segment + - segment example: segment id: type: string @@ -15013,8 +15013,8 @@ components: type: string description: 'Type of the contact: contact (lead) or user.' enum: - - contact - - user + - contact + - user example: contact count: type: integer @@ -15032,13 +15032,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 @@ -15053,18 +15053,18 @@ components: operator: type: string enum: - - '=' - - '!=' - - IN - - NIN - - '<' - - '>' - - '~' - - '!~' - - '^' - - '$' + - "=" + - "!=" + - IN + - NIN + - "<" + - ">" + - "~" + - "!~" + - "^" + - "$" description: The Intercom defined id representing the company. - example: '=' + example: "=" value: type: string description: The Intercom defined id representing the company. @@ -15088,10 +15088,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. @@ -15106,7 +15106,7 @@ components: message_type: type: string enum: - - snoozed + - snoozed example: snoozed admin_id: type: string @@ -15118,9 +15118,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 @@ -15170,25 +15170,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 @@ -15197,8 +15197,8 @@ components: items: type: string enum: - - email - - sms_message + - email + - sms_message example: email subscription_type_list: title: Subscription Types @@ -15209,14 +15209,14 @@ 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 @@ -15242,7 +15242,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 @@ -15267,8 +15267,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 @@ -15278,13 +15278,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 @@ -15303,8 +15303,8 @@ components: description: The Intercom defined id representing the user. example: 5f7f0d217289f8d2f4262080 required: - - name - - users + - name + - users tags: title: Tags type: object @@ -15314,13 +15314,13 @@ 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 @@ -15343,11 +15343,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 @@ -15357,13 +15357,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 @@ -15375,7 +15375,7 @@ components: description: The primary team ids for the team nullable: true example: - - 814865 + - 814865 items: type: integer secondary_team_ids: @@ -15383,7 +15383,7 @@ components: description: The secondary team ids for the team nullable: true example: - - 493881 + - 493881 items: type: integer ticket: @@ -15397,7 +15397,7 @@ components: type: string description: Always ticket enum: - - ticket + - ticket default: ticket example: ticket id: @@ -15412,25 +15412,25 @@ 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: type: string description: The state the ticket is currenly in enum: - - submitted - - in_progress - - waiting_on_customer - - resolved + - submitted + - in_progress + - waiting_on_customer + - resolved example: submitted 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. @@ -15450,7 +15450,7 @@ components: description: The last time the ticket was updated as a UTC Unix timestamp. example: 1663597260 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. @@ -15465,13 +15465,13 @@ components: 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 @@ -15480,12 +15480,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: name: example question: Can I have some help? @@ -15511,23 +15511,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: @@ -15541,18 +15541,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 @@ -15573,10 +15573,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 @@ -15601,7 +15601,7 @@ components: type: string description: '' enum: - - ticket_part.list + - ticket_part.list example: ticket_part.list ticket_parts: title: Tickt Parts @@ -15609,7 +15609,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: '' @@ -15625,7 +15625,7 @@ components: description: Always ticket_part example: ticket_part enum: - - ticket_part + - ticket_part id: type: string description: The id representing the part. @@ -15635,14 +15635,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 @@ -15654,13 +15654,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. @@ -15678,11 +15678,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: name: example question: Can I have some help? @@ -15707,9 +15707,9 @@ components: type: string description: Category of the Ticket Type. enum: - - Customer - - Back-office - - Tracker + - Customer + - Back-office + - Tracker example: Customer name: type: string @@ -15728,7 +15728,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" archived: type: boolean description: Whether the ticket type is archived or not. @@ -15837,7 +15837,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 @@ -15851,7 +15851,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 @@ -15899,8 +15899,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 @@ -15921,7 +15921,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, @@ -15934,8 +15934,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 @@ -15947,7 +15947,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 @@ -15965,7 +15965,7 @@ components: example: English description translated_content: nullable: true - '$ref': '#/components/schemas/group_translated_content' + "$ref": "#/components/schemas/group_translated_content" update_contact_request: description: You can update a contact type: object @@ -15985,7 +15985,7 @@ components: type: string nullable: true description: The contacts phone - example: '+353871234567' + example: "+353871234567" name: type: string nullable: true @@ -16034,7 +16034,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 @@ -16055,8 +16055,8 @@ components: items: type: string example: - - option1 - - option2 + - option1 + - option2 update_section_request: description: You can update a Section type: object @@ -16073,7 +16073,7 @@ components: example: 18 translated_content: nullable: true - '$ref': '#/components/schemas/group_translated_content' + "$ref": "#/components/schemas/group_translated_content" update_ticket_request: description: You can update a Ticket type: object @@ -16088,9 +16088,9 @@ components: state: type: string enum: - - in_progress - - waiting_on_customer - - resolved + - in_progress + - waiting_on_customer + - resolved description: The state of the ticket. example: submitted is_shared: @@ -16188,9 +16188,9 @@ components: type: string description: Category of the Ticket Type. enum: - - Customer - - Back-office - - Tracker + - Customer + - Back-office + - Tracker example: Customer icon: type: string @@ -16235,10 +16235,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 @@ -16310,12 +16310,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: @@ -16383,7 +16383,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 @@ -16413,7 +16413,7 @@ components: type: string description: The type of the object enum: - - tag.list + - tag.list example: tag.list tags: type: array @@ -16423,7 +16423,7 @@ components: type: string description: The type of the object enum: - - tag + - tag example: tag id: type: string @@ -16440,7 +16440,7 @@ components: type: string description: The type of the object enum: - - segment.list + - segment.list example: segment.list segments: type: array @@ -16499,7 +16499,7 @@ components: type: string description: The type of object which was deleted enum: - - visitor + - visitor example: visitor user_id: type: string @@ -16510,63 +16510,63 @@ 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: Articles - description: Everything about your Articles - - name: Companies - description: Everything about your Companies - - name: Contacts - description: Everything about your contacts - - name: Conversations - description: Everything about your Conversations - externalDocs: - description: What is a conversation? - url: https://www.intercom.com/help/en/articles/4323904-what-is-a-conversation - - name: Data Attributes - description: Everything about your Data Attributes - - name: Data Events - description: Everything about your Data Events - - name: Data Export - description: Everything about your Data Exports - - name: Help Center - description: Everything about your Help Center - - name: Messages - description: Everything about your messages - - name: News - description: Everything about your News - externalDocs: - description: News explained - url: https://www.intercom.com/help/en/articles/6362251-news-explained - - name: Notes - description: Everything about your Notes - - name: Segments - description: Everything about your Segments - - name: Subscription Types - description: Everything about subscription types - - name: Switch - description: Everything about Switch - externalDocs: - description: 'Meet Switch: from on hold to messaging in just a few taps' - url: https://www.intercom.com/switch - - name: Tags - description: Everything about tags - - name: Teams - description: Everything about your Teams - - name: 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 +- name: Admins + description: Everything about your Admins +- name: Articles + description: Everything about your Articles +- name: Companies + description: Everything about your Companies +- name: Contacts + description: Everything about your contacts +- name: Conversations + description: Everything about your Conversations + externalDocs: + description: What is a conversation? + url: https://www.intercom.com/help/en/articles/4323904-what-is-a-conversation +- name: Data Attributes + description: Everything about your Data Attributes +- name: Data Events + description: Everything about your Data Events +- name: Data Export + description: Everything about your Data Exports +- name: Help Center + description: Everything about your Help Center +- name: Messages + description: Everything about your messages +- name: News + description: Everything about your News + externalDocs: + description: News explained + url: https://www.intercom.com/help/en/articles/6362251-news-explained +- name: Notes + description: Everything about your Notes +- name: Segments + description: Everything about your Segments +- name: Subscription Types + description: Everything about subscription types +- name: Switch + description: Everything about Switch + externalDocs: + description: 'Meet Switch: from on hold to messaging in just a few taps' + url: https://www.intercom.com/switch +- name: Tags + description: Everything about tags +- name: Teams + description: Everything about your Teams +- name: 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