From 182ac0c0cdaf8e762c9ffe98ab8a22ce354a1d86 Mon Sep 17 00:00:00 2001 From: Abhimanyu Date: Tue, 25 Jul 2023 16:23:47 +0100 Subject: [PATCH] Ticket API V3 model changes (#93) --- descriptions/0/api.intercom.io.yaml | 3617 ++++++++++++++++----------- 1 file changed, 2133 insertions(+), 1484 deletions(-) diff --git a/descriptions/0/api.intercom.io.yaml b/descriptions/0/api.intercom.io.yaml index b2d8259..572e81d 100644 --- a/descriptions/0/api.intercom.io.yaml +++ b/descriptions/0/api.intercom.io.yaml @@ -45,7 +45,7 @@ paths: type: app id_code: this_is_an_id1_that_should_be_at_least_40 name: MyApp 1 - created_at: 1688476252 + created_at: 1690292875 secure: false identity_verification: false timezone: America/Los_Angeles @@ -100,7 +100,7 @@ paths: Admin not found: value: type: error.list - request_id: 69e33939-71e3-4225-adf8-949b3ad95c58 + request_id: 399fdb81-2de0-4abf-ae78-8768174b68ed errors: - code: admin_not_found message: Admin for admin_id not found @@ -114,7 +114,7 @@ paths: Unauthorized: value: type: error.list - request_id: 3a196218-94e7-4f86-a864-2576d87b0f4c + request_id: a11c36c1-3bce-4419-a1a8-798aaafaad86 errors: - code: unauthorized message: Access Token Invalid @@ -196,12 +196,25 @@ paths: type: activity_log.list pages: type: pages - next: + next: page: 1 per_page: 20 total_pages: 1 activity_logs: - - id: f6d57cb1-52de-46ad-a83e-be4a7d34d212 + - id: 7f01b619-7fd7-4800-bb56-2e4405a041fc + performed_by: + type: admin + id: '991266219' + email: admin5@email.com + ip: 127.0.0.1 + metadata: + before: before + after: after + created_at: 1690292883 + activity_type: app_name_change + activity_description: Ciaran5 Lee changed your app name from + before to after. + - id: fa145520-ba37-4a85-bcb0-47a2605449bd performed_by: type: admin id: '991266219' @@ -213,24 +226,11 @@ paths: title: Initial message title before: Initial message title after: Eventual message title - created_at: 1687966696 + created_at: 1690292883 activity_type: message_state_change activity_description: Ciaran5 Lee changed your Initial message title message from Initial message title to Eventual message title. - - id: 69a4825e-c4c0-4f53-b1de-9abde02ab625 - performed_by: - type: admin - id: '991266219' - email: admin5@email.com - ip: 127.0.0.1 - metadata: - before: before - after: after - created_at: 1687966696 - activity_type: app_name_change - activity_description: Ciaran5 Lee changed your app name from - before to after. schema: "$ref": "#/components/schemas/activity_log_list" '401': @@ -241,7 +241,7 @@ paths: Unauthorized: value: type: error.list - request_id: 126588d6-2696-4762-b057-32574d4e96ff + request_id: b3d06002-a220-4538-b4bb-c7db691927ec errors: - code: unauthorized message: Access Token Invalid @@ -271,7 +271,7 @@ paths: admins: - type: admin email: admin7@email.com - id: '991266221' + id: '991266222' name: Ciaran7 Lee away_mode_enabled: false away_mode_reassign: false @@ -287,7 +287,7 @@ paths: Unauthorized: value: type: error.list - request_id: dfc61055-3224-4796-a255-695a5a58c683 + request_id: 1c26c81f-1d4c-482b-a840-38969802e363 errors: - code: unauthorized message: Access Token Invalid @@ -321,7 +321,7 @@ paths: Admin found: value: type: admin - id: '991266223' + id: '991266224' name: Ciaran9 Lee email: admin9@email.com away_mode_enabled: false @@ -338,7 +338,7 @@ paths: Admin not found: value: type: error.list - request_id: 514a11ca-95a0-4aae-96e8-d3f67483411d + request_id: 5d9762c2-bb67-4af5-9fcc-26f529dc9fcb errors: - code: admin_not_found message: Admin not found @@ -352,7 +352,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0bed011a-045c-45e6-b8e2-9279351806c1 + request_id: f4890332-93b6-452d-94bd-914ff36e0ee5 errors: - code: unauthorized message: Access Token Invalid @@ -398,11 +398,11 @@ paths: title: This is the article title description: '' body: '' - author_id: 991266226 + author_id: 991266227 state: published - created_at: 1687966701 - updated_at: 1687966701 - url: http://help-center.test/myapp-22/en/articles/91819-this-is-the-article-title + created_at: 1690292890 + updated_at: 1690292890 + url: http://help-center.test/myapp-22/en/articles/92828-this-is-the-article-title schema: "$ref": "#/components/schemas/article_list" '401': @@ -413,7 +413,7 @@ paths: Unauthorized: value: type: error.list - request_id: e137da90-e6f8-43e1-b405-93fe277d3f79 + request_id: f628eb9b-6488-4b4f-ab74-21bdc8b079d8 errors: - code: unauthorized message: Access Token Invalid @@ -454,11 +454,11 @@ paths: title: Thanks for everything description: Description of the Article body:

Body of the Article

- author_id: 991266234 + author_id: 991266232 state: published - created_at: 1687966703 - updated_at: 1687966703 - url: http://help-center.test/myapp-26/en/articles/91822-thanks-for-everything + created_at: 1690292893 + updated_at: 1690292893 + url: http://help-center.test/myapp-26/en/articles/92831-thanks-for-everything schema: "$ref": "#/components/schemas/article" '400': @@ -469,7 +469,7 @@ paths: Bad Request: value: type: error.list - request_id: 729dd272-1987-4e0e-80cc-4025e5ce059b + request_id: 64228c95-80ae-4445-a943-30795ce43950 errors: - code: parameter_not_found message: author_id must be in the main body or default locale @@ -484,7 +484,7 @@ paths: Unauthorized: value: type: error.list - request_id: e83030f1-262d-4a07-a0df-31c8320ca593 + request_id: 001432df-aeb1-4e27-9516-94a34d93860b errors: - code: unauthorized message: Access Token Invalid @@ -502,7 +502,7 @@ paths: title: Thanks for everything description: Description of the Article body: Body of the Article - author_id: 991266234 + author_id: 991266232 state: published parent_id: 87785 parent_type: collection @@ -511,7 +511,7 @@ paths: title: Merci pour tout description: Description de l'article body: Corps de l'article - author_id: 991266234 + author_id: 991266232 state: published bad_request: summary: Bad Request @@ -564,11 +564,11 @@ paths: title: This is the article title description: '' body: '' - author_id: 991266241 + author_id: 991266237 state: published - created_at: 1687966706 - updated_at: 1687966706 - url: http://help-center.test/myapp-32/en/articles/91825-this-is-the-article-title + created_at: 1690292898 + updated_at: 1690292898 + url: http://help-center.test/myapp-32/en/articles/92834-this-is-the-article-title schema: "$ref": "#/components/schemas/article" '404': @@ -579,7 +579,7 @@ paths: Article not found: value: type: error.list - request_id: b24c2f52-06ff-4eb0-9327-6b8706f61247 + request_id: 160b5ff6-f7ee-4174-a54f-b66bb8a08882 errors: - code: not_found message: Resource Not Found @@ -593,7 +593,7 @@ paths: Unauthorized: value: type: error.list - request_id: 3ba1f2e4-2d39-497f-a9a0-e1bdb73842af + request_id: 2fc65b87-49d5-46b5-9707-d2cc77707bcc errors: - code: unauthorized message: Access Token Invalid @@ -642,11 +642,11 @@ paths: title: Christmas is here! description: '' body:

New gifts in store for the jolly season

- author_id: 991266250 + author_id: 991266243 state: published - created_at: 1687966709 - updated_at: 1687966710 - url: http://help-center.test/myapp-38/en/articles/91828-christmas-is-here + created_at: 1690292901 + updated_at: 1690292902 + url: http://help-center.test/myapp-38/en/articles/92837-christmas-is-here schema: "$ref": "#/components/schemas/article" '404': @@ -657,7 +657,7 @@ paths: Article Not Found: value: type: error.list - request_id: a5f8490e-794e-420c-bf51-f8885ae46a51 + request_id: 58d2609a-fc65-49ef-9b29-a7383064e5c7 errors: - code: not_found message: Resource Not Found @@ -671,7 +671,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2b4fb240-1669-4adb-9f6b-10e168864b7e + request_id: 015b7b32-ef8e-4e6e-8320-30eb22bd9f98 errors: - code: unauthorized message: Access Token Invalid @@ -732,7 +732,7 @@ paths: Article Not Found: value: type: error.list - request_id: a25cb760-7405-4925-8fc3-ba6378f5a4a8 + request_id: 9c2eec9d-ca53-4f2b-9042-c4251ca28a16 errors: - code: not_found message: Resource Not Found @@ -746,7 +746,7 @@ paths: Unauthorized: value: type: error.list - request_id: d3e155b5-4768-4428-af89-699d92a06674 + request_id: 12c1b181-632c-4d40-9d48-ac989f89f1a3 errors: - code: unauthorized message: Access Token Invalid @@ -778,23 +778,13 @@ paths: Successful: value: type: list - data: - - id: '87797' - workspace_id: this_is_an_id50_that_should_be_at_least_4 - name: English collection title - url: http://help-center.test/myapp-50/collection-15 - order: 15 - created_at: 1687966715 - updated_at: 1687966715 - description: english collection description - icon: bookmark - parent_id: - total_count: 1 + data: [] + total_count: 0 pages: type: pages page: 1 per_page: 20 - total_pages: 1 + total_pages: 0 schema: "$ref": "#/components/schemas/collection_list" '401': @@ -805,7 +795,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9b112064-8c79-41e5-9f06-05365eb18633 + request_id: 89c8a853-5336-4dfd-8d90-d05e8f3cd4b9 errors: - code: unauthorized message: Access Token Invalid @@ -835,11 +825,11 @@ paths: name: Thanks for everything url: http://help-center.test/myapp-54/ order: 1 - created_at: 1687966716 - updated_at: 1687966716 + created_at: 1690292910 + updated_at: 1690292910 description: '' icon: book-bookmark - parent_id: + parent_id: schema: "$ref": "#/components/schemas/collection" '400': @@ -850,7 +840,7 @@ paths: Bad Request: value: type: error.list - request_id: 372dc4b5-f5a4-4d99-bb55-4e2e5c787c85 + request_id: 9a4dcf33-f95b-49c0-9342-924d323d0e10 errors: - code: parameter_not_found message: Name is a required parameter. @@ -864,7 +854,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9d49cfcd-6f8c-44dc-aa86-86feb89ecd2d + request_id: 1b7797e3-5ca2-4df3-a94c-9503551ad5a8 errors: - code: unauthorized message: Access Token Invalid @@ -917,11 +907,11 @@ paths: name: English collection title url: http://help-center.test/myapp-60/collection-20 order: 20 - created_at: 1687966718 - updated_at: 1687966718 + created_at: 1690292912 + updated_at: 1690292912 description: english collection description icon: bookmark - parent_id: + parent_id: schema: "$ref": "#/components/schemas/collection" '404': @@ -932,7 +922,7 @@ paths: Collection not found: value: type: error.list - request_id: f5cded43-7636-44e9-a21e-28c1d0e71102 + request_id: a1b6b12b-323d-425c-ad71-a3427a10e6da errors: - code: not_found message: Resource Not Found @@ -946,7 +936,7 @@ paths: Unauthorized: value: type: error.list - request_id: cae932e1-76f3-47e4-9a3b-ebf40c55f91d + request_id: df791308-977e-42f7-aee1-2397b0067232 errors: - code: unauthorized message: Access Token Invalid @@ -984,11 +974,11 @@ paths: name: Update collection name url: http://help-center.test/myapp-66/collection-23 order: 23 - created_at: 1687966720 - updated_at: 1687966720 + created_at: 1690292914 + updated_at: 1690292915 description: english collection description icon: folder - parent_id: + parent_id: schema: "$ref": "#/components/schemas/collection" '404': @@ -999,7 +989,7 @@ paths: Collection Not Found: value: type: error.list - request_id: 88998713-7875-48d6-b884-3593d6edc96c + request_id: e94aba09-578d-425a-a92c-b1cb064a407f errors: - code: not_found message: Resource Not Found @@ -1013,7 +1003,7 @@ paths: Unauthorized: value: type: error.list - request_id: 72e7ec92-a11c-424d-b100-ba46c6540b3e + request_id: c7df4e47-bffe-49c9-859a-53da2fff3a95 errors: - code: unauthorized message: Access Token Invalid @@ -1073,7 +1063,7 @@ paths: collection Not Found: value: type: error.list - request_id: 61807bf3-ed5a-4572-81e0-dc11be25c568 + request_id: 2e2ea6ad-e734-4fd9-811a-cb0431cc6f1c errors: - code: not_found message: Resource Not Found @@ -1087,7 +1077,7 @@ paths: Unauthorized: value: type: error.list - request_id: 22e0e426-323b-43ad-8300-f4edede8e766 + request_id: 6bd34dcd-d8c1-40dc-926f-40867fc66b93 errors: - code: unauthorized message: Access Token Invalid @@ -1119,12 +1109,12 @@ paths: value: type: company company_id: company_remote_id - id: 649c540b85b35b2332e7ef23 - app_id: this_is_an_id95_that_should_be_at_least_4 + id: 64bfd2c076af8e7a749aa7bc + app_id: this_is_an_id94_that_should_be_at_least_4 name: my company remote_created_at: 1374138000 - created_at: 1687966731 - updated_at: 1687966731 + created_at: 1690292928 + updated_at: 1690292928 monthly_spend: 0 session_count: 0 user_count: 0 @@ -1147,7 +1137,7 @@ paths: Bad Request: value: type: error.list - request_id: + request_id: errors: - code: bad_request message: bad 'test' parameter @@ -1161,7 +1151,7 @@ paths: Unauthorized: value: type: error.list - request_id: 7481051a-cd61-4a67-8acf-06d4d35cae6a + request_id: 420463c5-1c23-468c-8bbd-731fc9cd03d5 errors: - code: unauthorized message: Access Token Invalid @@ -1232,12 +1222,12 @@ paths: value: type: company company_id: '1' - id: 649c540e85b35b2332e7ef2d - app_id: this_is_an_id101_that_should_be_at_least_ + id: 64bfd2c376af8e7a749aa7c6 + app_id: this_is_an_id100_that_should_be_at_least_ name: company2 - remote_created_at: 1687966734 - created_at: 1687966734 - updated_at: 1687966734 + remote_created_at: 1690292931 + created_at: 1690292931 + updated_at: 1690292931 monthly_spend: 0 session_count: 0 user_count: 1 @@ -1259,7 +1249,7 @@ paths: Company Not Found: value: type: error.list - request_id: 2172ed7f-54e0-4b5f-a08b-6d5177bb386c + request_id: f71e7bda-c8df-4f2c-984e-b4f8f30fd0aa errors: - code: company_not_found message: Company Not Found @@ -1273,7 +1263,7 @@ paths: Unauthorized: value: type: error.list - request_id: 318ad022-f85a-49f0-b79f-2da06b29bd93 + request_id: 94c114aa-8dd1-408f-9969-d555cedfae3f errors: - code: unauthorized message: Access Token Invalid @@ -1308,12 +1298,12 @@ paths: value: type: company company_id: '1' - id: 649c541185b35b2332e7ef38 - app_id: this_is_an_id107_that_should_be_at_least_ + id: 64bfd2c776af8e7a749aa7d1 + app_id: this_is_an_id106_that_should_be_at_least_ name: company4 - remote_created_at: 1687966737 - created_at: 1687966738 - updated_at: 1687966738 + remote_created_at: 1690292935 + created_at: 1690292935 + updated_at: 1690292935 monthly_spend: 0 session_count: 0 user_count: 1 @@ -1335,7 +1325,7 @@ paths: Company Not Found: value: type: error.list - request_id: efe207cc-333f-46a9-8084-87269cba8066 + request_id: 40354376-230d-48da-901f-6134279b0251 errors: - code: company_not_found message: Company Not Found @@ -1349,7 +1339,7 @@ paths: Unauthorized: value: type: error.list - request_id: e8b20b70-9901-4908-ab3e-9b81b20809f6 + request_id: 072d6fe9-fec1-4ab0-8470-162a8971e9f8 errors: - code: unauthorized message: Access Token Invalid @@ -1383,12 +1373,12 @@ paths: value: type: company company_id: '1' - id: 649c541585b35b2332e7ef42 - app_id: this_is_an_id113_that_should_be_at_least_ + id: 64bfd2cb76af8e7a749aa7db + app_id: this_is_an_id112_that_should_be_at_least_ name: company5 - remote_created_at: 1687966741 - created_at: 1687966741 - updated_at: 1687966741 + remote_created_at: 1690292939 + created_at: 1690292939 + updated_at: 1690292939 monthly_spend: 0 session_count: 0 user_count: 1 @@ -1410,7 +1400,7 @@ paths: Company Not Found: value: type: error.list - request_id: 5e6d9ab1-e938-4554-98a2-bc81588d5b74 + request_id: a11a8a21-3a8f-47e3-94ba-6681b247da44 errors: - code: company_not_found message: Company Not Found @@ -1424,7 +1414,7 @@ paths: Unauthorized: value: type: error.list - request_id: 51e22ef8-0155-4858-80b8-0346fa69a77d + request_id: 4dedd1fc-4c00-4136-9e38-e12f72f7de8f errors: - code: unauthorized message: Access Token Invalid @@ -1456,7 +1446,7 @@ paths: examples: Successful: value: - id: 649c541885b35b2332e7ef4c + id: 64bfd2cf76af8e7a749aa7e5 object: company deleted: true schema: @@ -1469,7 +1459,7 @@ paths: Company Not Found: value: type: error.list - request_id: 1e2e9dcf-0c09-4146-b4cd-f9303139d7cc + request_id: 8bd99e4c-b8fc-49d3-898e-961f6b353af6 errors: - code: company_not_found message: Company Not Found @@ -1483,7 +1473,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2c6f16f1-317b-4d5c-81da-baae03a0a222 + request_id: a0d7140e-5862-4046-a811-7751ed1a7076 errors: - code: unauthorized message: Access Token Invalid @@ -1535,7 +1525,7 @@ paths: Company Not Found: value: type: error.list - request_id: aea47031-7d96-4013-981f-4871a4e4c57d + request_id: 1a45b856-8b2c-4d1f-bc32-f8d58e248c5c errors: - code: company_not_found message: Company Not Found @@ -1549,7 +1539,7 @@ paths: Unauthorized: value: type: error.list - request_id: ef45ba1a-1986-4c82-bee2-816169af0e9c + request_id: e84d54fc-7861-464c-a215-daa17d55f579 errors: - code: unauthorized message: Access Token Invalid @@ -1594,7 +1584,7 @@ paths: Company Not Found: value: type: error.list - request_id: b94fafe5-5e7b-45f2-98bc-7e8df8944b7b + request_id: 9a01e5fd-2a5a-485f-8cd2-2a0ef4f0be4a errors: - code: company_not_found message: Company Not Found @@ -1608,7 +1598,7 @@ paths: Unauthorized: value: type: error.list - request_id: 5bd2c388-8f58-4d03-b6e8-30f6b1fd71af + request_id: 7de0e195-6add-47f1-bdb7-11f74de48294 errors: - code: unauthorized message: Access Token Invalid @@ -1689,12 +1679,12 @@ paths: data: - type: company company_id: remote_companies_scroll_2 - id: 649c542385b35b2332e7ef68 - app_id: this_is_an_id137_that_should_be_at_least_ + id: 64bfd2da76af8e7a749aa801 + app_id: this_is_an_id136_that_should_be_at_least_ name: IntercomQATest1 - remote_created_at: 1687966755 - created_at: 1687966755 - updated_at: 1687966755 + remote_created_at: 1690292953 + created_at: 1690292954 + updated_at: 1690292954 monthly_spend: 0 session_count: 0 user_count: 4 @@ -1708,7 +1698,7 @@ paths: custom_attributes: {} pages: type: pages - next: + next: page: 1 per_page: 15 total_pages: 1 @@ -1723,7 +1713,7 @@ paths: Unauthorized: value: type: error.list - request_id: a97fa6b2-fedc-4488-909a-42939a8edd6b + request_id: 071dbabb-82e4-4c88-963d-80bcd0139858 errors: - code: unauthorized message: Access Token Invalid @@ -1775,12 +1765,12 @@ paths: data: - type: company company_id: remote_companies_scroll_2 - id: 649c542585b35b2332e7ef70 - app_id: this_is_an_id141_that_should_be_at_least_ + id: 64bfd2dc76af8e7a749aa809 + app_id: this_is_an_id140_that_should_be_at_least_ name: IntercomQATest1 - remote_created_at: 1687966757 - created_at: 1687966757 - updated_at: 1687966757 + remote_created_at: 1690292956 + created_at: 1690292956 + updated_at: 1690292956 monthly_spend: 0 session_count: 0 user_count: 4 @@ -1792,9 +1782,9 @@ paths: segments: [] plan: {} custom_attributes: {} - pages: - total_count: - scroll_param: 9ecbc878-5d48-499a-8499-de82bc1bffb6 + pages: + total_count: + scroll_param: 77527454-abb3-4373-aad8-9dff02f833b2 schema: "$ref": "#/components/schemas/company_scroll" '401': @@ -1805,7 +1795,7 @@ paths: Unauthorized: value: type: error.list - request_id: f2caebd7-b764-4d92-b872-85831c2b2fa7 + request_id: a7b2f365-05b2-495f-af8e-f6af664d9f81 errors: - code: unauthorized message: Access Token Invalid @@ -1840,12 +1830,12 @@ paths: value: type: company company_id: '1' - id: 649c542885b35b2332e7ef79 - app_id: this_is_an_id145_that_should_be_at_least_ + id: 64bfd2df76af8e7a749aa812 + app_id: this_is_an_id144_that_should_be_at_least_ name: company9 - remote_created_at: 1687966760 - created_at: 1687966760 - updated_at: 1687966760 + remote_created_at: 1690292959 + created_at: 1690292959 + updated_at: 1690292959 monthly_spend: 0 session_count: 0 user_count: 1 @@ -1867,7 +1857,7 @@ paths: Company Not Found: value: type: error.list - request_id: 6a2cff36-0567-4a2e-964b-8c246248a2d1 + request_id: 5124ddbd-3da7-47e7-b59d-317b779053ab errors: - code: not_found message: User Not Found @@ -1881,7 +1871,7 @@ paths: Unauthorized: value: type: error.list - request_id: 95be315c-fdbe-42d2-8c8c-6ff8d5973d89 + request_id: ac592024-7695-453a-abdb-82c1ca377c05 errors: - code: unauthorized message: Access Token Invalid @@ -1904,11 +1894,11 @@ paths: successful: summary: Successful value: - id: 649c542885b35b2332e7ef79 + id: 64bfd2df76af8e7a749aa812 company_not_found: summary: Company Not Found value: - id: 649c542a85b35b2332e7ef7d + id: 64bfd2e176af8e7a749aa816 "/contacts/{contact_id}/companies/{id}": delete: summary: Detach a contact from a company @@ -1946,12 +1936,12 @@ paths: value: type: company company_id: '1' - id: 649c542c85b35b2332e7ef85 - app_id: this_is_an_id151_that_should_be_at_least_ + id: 64bfd2e376af8e7a749aa81e + app_id: this_is_an_id150_that_should_be_at_least_ name: company12 - remote_created_at: 1687966764 - created_at: 1687966764 - updated_at: 1687966765 + remote_created_at: 1690292963 + created_at: 1690292963 + updated_at: 1690292964 monthly_spend: 0 session_count: 0 user_count: 0 @@ -1973,14 +1963,14 @@ paths: Company Not Found: value: type: error.list - request_id: e61c205f-83c0-4293-902c-6bf7587f70d9 + request_id: 6ddde220-2c23-4f54-aae7-c4bff2f44101 errors: - code: company_not_found message: Company Not Found Contact Not Found: value: type: error.list - request_id: abfd36f1-3445-4b6a-bad0-f3f17514090b + request_id: a04dafa1-a635-45b0-959b-00083ba59c1b errors: - code: not_found message: User Not Found @@ -1994,7 +1984,7 @@ paths: Unauthorized: value: type: error.list - request_id: 85a103b3-ed9c-4607-ba86-ab6f7827d02c + request_id: 063c32ce-1886-4a39-9a82-f416e32e7718 errors: - code: unauthorized message: Access Token Invalid @@ -2032,13 +2022,13 @@ paths: data: - type: company company_id: '1' - id: 649c543e85b35b2332e7efab - app_id: this_is_an_id159_that_should_be_at_least_ + id: 64bfd2f776af8e7a749aa844 + app_id: this_is_an_id158_that_should_be_at_least_ name: company25 - remote_created_at: 1687966782 - created_at: 1687966782 - updated_at: 1687966782 - last_request_at: 1687793982 + remote_created_at: 1690292983 + created_at: 1690292983 + updated_at: 1690292983 + last_request_at: 1690120183 monthly_spend: 0 session_count: 0 user_count: 1 @@ -2052,7 +2042,7 @@ paths: custom_attributes: {} pages: type: pages - next: + next: page: 1 per_page: 50 total_pages: 1 @@ -2067,7 +2057,7 @@ paths: Contact not found: value: type: error.list - request_id: 7bef1afe-6473-4217-9da5-7639d8a28f0f + request_id: 882e1dfd-81f3-4be2-8d80-3314f81cef69 errors: - code: not_found message: User Not Found @@ -2081,7 +2071,7 @@ paths: Unauthorized: value: type: error.list - request_id: 4bd7a1d8-926e-4257-ac33-99c30f182a6d + request_id: b38c4cab-1cd9-4036-b6f3-69e897aecb57 errors: - code: unauthorized message: Access Token Invalid @@ -2117,51 +2107,51 @@ paths: type: list data: - type: note - id: '401584' - created_at: 1687361986 + id: '404611' + created_at: 1689688187 contact: type: contact - id: 649c544285b35b2332e7efb6 + id: 64bfd2fb76af8e7a749aa84f author: type: admin - id: '991266317' - name: Ciaran103 Lee - email: admin103@email.com + 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: '401583' - created_at: 1687275586 + id: '404610' + created_at: 1689601787 contact: type: contact - id: 649c544285b35b2332e7efb6 + id: 64bfd2fb76af8e7a749aa84f author: type: admin - id: '991266317' - name: Ciaran103 Lee - email: admin103@email.com + 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: '401582' - created_at: 1687275586 + id: '404609' + created_at: 1689601787 contact: type: contact - id: 649c544285b35b2332e7efb6 + id: 64bfd2fb76af8e7a749aa84f author: type: admin - id: '991266317' - name: Ciaran103 Lee - email: admin103@email.com + 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 - next: + next: page: 1 per_page: 50 total_pages: 1 @@ -2175,7 +2165,7 @@ paths: Contact not found: value: type: error.list - request_id: 159271b1-15f6-4a45-80c2-823c6b92e61e + request_id: b843e20e-3971-4eea-942d-de87e0a52868 errors: - code: not_found message: User Not Found @@ -2209,16 +2199,16 @@ paths: Successful response: value: type: note - id: '401589' - created_at: 1687966788 + id: '404616' + created_at: 1690292989 contact: type: contact - id: 649c544485b35b2332e7efb8 + id: 64bfd2fd76af8e7a749aa851 author: type: admin - id: '991266319' - name: Ciaran105 Lee - email: admin105@email.com + id: '991266306' + name: Ciaran91 Lee + email: admin91@email.com away_mode_enabled: false away_mode_reassign: false body: "

Hello

" @@ -2232,14 +2222,14 @@ paths: Admin not found: value: type: error.list - request_id: '038e378b-1e05-46c8-b872-e051e3f4bd44' + request_id: 888d2306-b943-422c-8b0d-cc07faf6be8d errors: - code: not_found message: Resource Not Found Contact not found: value: type: error.list - request_id: a7f21ef8-33fc-4756-8539-66ba01252663 + request_id: 0e6725a0-a886-42b1-92f5-bccececdee3b errors: - code: not_found message: User Not Found @@ -2269,20 +2259,20 @@ paths: successful_response: summary: Successful response value: - contact_id: 649c544485b35b2332e7efb8 - admin_id: 991266319 + contact_id: 64bfd2fd76af8e7a749aa851 + admin_id: 991266306 body: Hello admin_not_found: summary: Admin not found value: - contact_id: 649c544485b35b2332e7efb9 + contact_id: 64bfd2fd76af8e7a749aa852 admin_id: 123 body: Hello contact_not_found: summary: Contact not found value: contact_id: 123 - admin_id: 991266321 + admin_id: 991266308 body: Hello "/contacts/{contact_id}/segments": get: @@ -2315,10 +2305,10 @@ paths: type: list data: - type: segment - id: 649c544685b35b2332e7efbb + id: 64bfd2ff76af8e7a749aa854 name: segment - created_at: 1687966790 - updated_at: 1687966790 + created_at: 1690292991 + updated_at: 1690292991 person_type: user schema: "$ref": "#/components/schemas/contact_segments" @@ -2330,7 +2320,7 @@ paths: Contact not found: value: type: error.list - request_id: a8c57010-331d-4c1f-8054-e82a0159bbed + request_id: a3ecd655-cade-4806-8e79-34322e7842d2 errors: - code: not_found message: User Not Found @@ -2344,7 +2334,7 @@ paths: Unauthorized: value: type: error.list - request_id: eb6b8805-8d93-4dbb-a16b-506baf0d931c + request_id: 652371f6-55c8-45f4-be9e-7bc0ef8319d5 errors: - code: unauthorized message: Access Token Invalid @@ -2388,7 +2378,7 @@ paths: type: list data: - type: subscription - id: '437906' + id: '439924' state: live consent_type: opt_out default_translation: @@ -2402,7 +2392,7 @@ paths: content_types: - email - type: subscription - id: '437908' + id: '439926' state: live consent_type: opt_in default_translation: @@ -2425,7 +2415,7 @@ paths: Contact not found: value: type: error.list - request_id: be296f9f-aaae-4682-9899-15543b8ed24e + request_id: 4e25a441-c28f-455c-8da1-011204928666 errors: - code: not_found message: User Not Found @@ -2439,7 +2429,7 @@ paths: Unauthorized: value: type: error.list - request_id: cb15ed8a-ec21-4a91-8e1e-a565ae5555e8 + request_id: ac8badd8-adbf-44f7-ad0a-603cad0dbb1a errors: - code: unauthorized message: Access Token Invalid @@ -2480,7 +2470,7 @@ paths: Successful: value: type: subscription - id: '437921' + id: '439939' state: live consent_type: opt_in default_translation: @@ -2503,14 +2493,14 @@ paths: Contact not found: value: type: error.list - request_id: 464c02ee-64c8-4e1a-ac96-2db785b498cc + request_id: 69f2557c-3c23-4587-b52b-c92f6d1bf421 errors: - code: not_found message: User Not Found Resource not found: value: type: error.list - request_id: 162151de-b841-40df-9c52-d88254ba1c96 + request_id: 715cdf72-5598-4cd8-9a46-8f01cd1328ed errors: - code: not_found message: Resource Not Found @@ -2524,7 +2514,7 @@ paths: Unauthorized: value: type: error.list - request_id: 41ee9de2-5fc4-4715-8873-820bc21778f5 + request_id: '01966569-148d-4cad-af24-2002e1f38864' errors: - code: unauthorized message: Access Token Invalid @@ -2552,12 +2542,12 @@ paths: successful: summary: Successful value: - id: 437921 + id: 439939 consent_type: opt_in contact_not_found: summary: Contact not found value: - id: 437925 + id: 439943 consent_type: opt_in resource_not_found: summary: Resource not found @@ -2603,7 +2593,7 @@ paths: Successful: value: type: subscription - id: '437937' + id: '439955' state: live consent_type: opt_in default_translation: @@ -2626,14 +2616,14 @@ paths: Contact not found: value: type: error.list - request_id: bc43ebc9-7c12-414d-8bab-8e3d17f367d7 + request_id: 4d884a69-0110-46b8-b7d3-d329862321bb errors: - code: not_found message: User Not Found Resource not found: value: type: error.list - request_id: 7a44f599-41f6-4a1c-9644-29f60c98f291 + request_id: 75050ea5-ba95-4b53-98ff-47da3c30aa42 errors: - code: not_found message: Resource Not Found @@ -2647,7 +2637,7 @@ paths: Unauthorized: value: type: error.list - request_id: c7711cb0-af89-4d13-92c8-8b6e8c7ed407 + request_id: b25bff94-3aa8-4c5c-bf84-7a3acf89bd2e errors: - code: unauthorized message: Access Token Invalid @@ -2685,7 +2675,7 @@ paths: type: list data: - type: tag - id: '318846' + id: '320864' name: Manual tag schema: "$ref": "#/components/schemas/tag_list" @@ -2697,7 +2687,7 @@ paths: Contact not found: value: type: error.list - request_id: e1255249-e8d0-4949-88ac-4e75086cf317 + request_id: 9c810697-13a8-434e-a2aa-569e3b0cdd06 errors: - code: not_found message: User Not Found @@ -2711,7 +2701,7 @@ paths: Unauthorized: value: type: error.list - request_id: 00baa6f6-17c9-45d9-b500-4dea5bc24828 + request_id: 7c9708ad-1597-4e3c-b833-24ea7bfe81f6 errors: - code: unauthorized message: Access Token Invalid @@ -2746,7 +2736,7 @@ paths: successful: value: type: tag - id: '318847' + id: '320865' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -2758,14 +2748,14 @@ paths: Contact not found: value: type: error.list - request_id: 23339994-c2bf-42ea-8684-304b0dec3cf2 + request_id: 44630054-c21d-47a4-9672-30e4a22736bc errors: - code: not_found message: User Not Found Tag not found: value: type: error.list - request_id: e1c60292-672a-47f6-9289-e488f132f565 + request_id: 6b06d4b6-99e1-44f5-9d87-ef4cf6ba4636 errors: - code: not_found message: Resource Not Found @@ -2779,7 +2769,7 @@ paths: Unauthorized: value: type: error.list - request_id: fe2e480c-7c86-4ee1-9011-c04863581bd8 + request_id: 9c782aa6-25b5-4068-afec-38924c92e3dd errors: - code: unauthorized message: Access Token Invalid @@ -2802,11 +2792,11 @@ paths: successful: summary: successful value: - id: 318847 + id: 320865 contact_not_found: summary: Contact not found value: - id: 318848 + id: 320866 tag_not_found: summary: Tag not found value: @@ -2848,7 +2838,7 @@ paths: successful: value: type: tag - id: '318850' + id: '320868' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -2860,14 +2850,14 @@ paths: Contact not found: value: type: error.list - request_id: bac56153-7f77-472f-bbe9-cfb18d824fe5 + request_id: de6dbfb4-0f18-4157-82ff-e6bd5b983ae7 errors: - code: not_found message: User Not Found Tag not found: value: type: error.list - request_id: 4f691c9e-7337-447e-89e6-222ed90919b0 + request_id: 74292bad-6ca6-4ab4-8708-76824920b31f errors: - code: not_found message: Resource Not Found @@ -2881,7 +2871,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9b7bda60-f41a-4832-9825-7aee3652691c + request_id: 38681b93-1725-4644-ad57-c642d961d285 errors: - code: unauthorized message: Access Token Invalid @@ -2915,91 +2905,91 @@ paths: successful: value: type: contact - id: 649c545885b35b2332e7efd2 - workspace_id: this_is_an_id225_that_should_be_at_least_ + id: 64bfd31576af8e7a749aa86b + workspace_id: this_is_an_id224_that_should_be_at_least_ external_id: '70' role: user email: joebloggs@intercom.io - phone: - formatted_phone: + phone: + formatted_phone: name: joe bloggs - avatar: - owner_id: + avatar: + owner_id: social_profiles: type: list data: [] has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1687966808 - updated_at: 1687966808 - signed_up_at: 1687966808 - last_seen_at: - last_replied_at: - last_contacted_at: - last_email_opened_at: - last_email_clicked_at: - language_override: - browser: - browser_version: - browser_language: - os: + created_at: 1690293013 + updated_at: 1690293014 + signed_up_at: 1690293013 + last_seen_at: + last_replied_at: + last_contacted_at: + last_email_opened_at: + last_email_clicked_at: + language_override: + browser: + browser_version: + browser_language: + os: location: type: location - country: - region: - city: - country_code: - continent_code: - android_app_name: - android_app_version: - android_device: - android_os_version: - android_sdk_version: - android_last_seen_at: - ios_app_name: - ios_app_version: - ios_device: - ios_os_version: - ios_sdk_version: - ios_last_seen_at: + country: + region: + city: + country_code: + continent_code: + android_app_name: + android_app_version: + android_device: + android_os_version: + android_sdk_version: + android_last_seen_at: + ios_app_name: + ios_app_version: + ios_device: + ios_os_version: + ios_sdk_version: + ios_last_seen_at: custom_attributes: {} tags: type: list data: [] - url: "/contacts/649c545885b35b2332e7efd2/tags" + url: "/contacts/64bfd31576af8e7a749aa86b/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/649c545885b35b2332e7efd2/notes" + url: "/contacts/64bfd31576af8e7a749aa86b/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/649c545885b35b2332e7efd2/companies" + url: "/contacts/64bfd31576af8e7a749aa86b/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/649c545885b35b2332e7efd2/subscriptions" + url: "/contacts/64bfd31576af8e7a749aa86b/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/649c545885b35b2332e7efd2/subscriptions" + url: "/contacts/64bfd31576af8e7a749aa86b/subscriptions" total_count: 0 has_more: false - utm_campaign: - utm_content: - utm_medium: - utm_source: - utm_term: - referrer: + utm_campaign: + utm_content: + utm_medium: + utm_source: + utm_term: + referrer: schema: "$ref": "#/components/schemas/contact" '401': @@ -3010,7 +3000,7 @@ paths: Unauthorized: value: type: error.list - request_id: 3d4f051b-eeb2-4605-91ff-cc3fa6122c41 + request_id: 70d7c2a0-3d68-47b5-9474-fb1bc9783eeb errors: - code: unauthorized message: Access Token Invalid @@ -3055,91 +3045,91 @@ paths: successful: value: type: contact - id: 649c545a85b35b2332e7efd3 - workspace_id: this_is_an_id229_that_should_be_at_least_ + id: 64bfd31876af8e7a749aa86c + workspace_id: this_is_an_id228_that_should_be_at_least_ external_id: '70' role: user email: joe@bloggs.com - phone: - formatted_phone: + phone: + formatted_phone: name: Joe Bloggs - avatar: - owner_id: + avatar: + owner_id: social_profiles: type: list data: [] has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1687966810 - updated_at: 1687966810 - signed_up_at: 1687966810 - last_seen_at: - last_replied_at: - last_contacted_at: - last_email_opened_at: - last_email_clicked_at: - language_override: - browser: - browser_version: - browser_language: - os: + created_at: 1690293016 + updated_at: 1690293016 + signed_up_at: 1690293016 + last_seen_at: + last_replied_at: + last_contacted_at: + last_email_opened_at: + last_email_clicked_at: + language_override: + browser: + browser_version: + browser_language: + os: location: type: location - country: - region: - city: - country_code: - continent_code: - android_app_name: - android_app_version: - android_device: - android_os_version: - android_sdk_version: - android_last_seen_at: - ios_app_name: - ios_app_version: - ios_device: - ios_os_version: - ios_sdk_version: - ios_last_seen_at: + country: + region: + city: + country_code: + continent_code: + android_app_name: + android_app_version: + android_device: + android_os_version: + android_sdk_version: + android_last_seen_at: + ios_app_name: + ios_app_version: + ios_device: + ios_os_version: + ios_sdk_version: + ios_last_seen_at: custom_attributes: {} tags: type: list data: [] - url: "/contacts/649c545a85b35b2332e7efd3/tags" + url: "/contacts/64bfd31876af8e7a749aa86c/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/649c545a85b35b2332e7efd3/notes" + url: "/contacts/64bfd31876af8e7a749aa86c/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/649c545a85b35b2332e7efd3/companies" + url: "/contacts/64bfd31876af8e7a749aa86c/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/649c545a85b35b2332e7efd3/subscriptions" + url: "/contacts/64bfd31876af8e7a749aa86c/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/649c545a85b35b2332e7efd3/subscriptions" + url: "/contacts/64bfd31876af8e7a749aa86c/subscriptions" total_count: 0 has_more: false - utm_campaign: - utm_content: - utm_medium: - utm_source: - utm_term: - referrer: + utm_campaign: + utm_content: + utm_medium: + utm_source: + utm_term: + referrer: schema: "$ref": "#/components/schemas/contact" '401': @@ -3150,7 +3140,7 @@ paths: Unauthorized: value: type: error.list - request_id: ae7c7e33-c10c-4851-8c41-d13d6fb07dc1 + request_id: ff80f019-db45-40ab-a2dd-ec10e98ad2a4 errors: - code: unauthorized message: Access Token Invalid @@ -3181,8 +3171,9 @@ paths: examples: successful: value: - id: 649c545c85b35b2332e7efd4 - object: contact + id: 64bfd31a76af8e7a749aa86d + external_id: '70' + type: contact deleted: true schema: "$ref": "#/components/schemas/contact_deleted" @@ -3194,7 +3185,7 @@ paths: Unauthorized: value: type: error.list - request_id: 195a5c6e-e178-4dce-ba98-30782a244a0f + request_id: 14286969-7b9c-44ac-95b1-ae773f06952a errors: - code: unauthorized message: Access Token Invalid @@ -3222,91 +3213,91 @@ paths: successful: value: type: contact - id: 649c545e85b35b2332e7efd6 - workspace_id: this_is_an_id237_that_should_be_at_least_ + id: 64bfd31c76af8e7a749aa86f + workspace_id: this_is_an_id236_that_should_be_at_least_ external_id: '70' role: user email: joe@bloggs.com - phone: - formatted_phone: + phone: + formatted_phone: name: Joe Bloggs - avatar: - owner_id: + avatar: + owner_id: social_profiles: type: list data: [] has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1687966814 - updated_at: 1687966815 - signed_up_at: 1687966814 - last_seen_at: - last_replied_at: - last_contacted_at: - last_email_opened_at: - last_email_clicked_at: - language_override: - browser: - browser_version: - browser_language: - os: + created_at: 1690293020 + updated_at: 1690293021 + signed_up_at: 1690293020 + last_seen_at: + last_replied_at: + last_contacted_at: + last_email_opened_at: + last_email_clicked_at: + language_override: + browser: + browser_version: + browser_language: + os: location: type: location - country: - region: - city: - country_code: - continent_code: - android_app_name: - android_app_version: - android_device: - android_os_version: - android_sdk_version: - android_last_seen_at: - ios_app_name: - ios_app_version: - ios_device: - ios_os_version: - ios_sdk_version: - ios_last_seen_at: + country: + region: + city: + country_code: + continent_code: + android_app_name: + android_app_version: + android_device: + android_os_version: + android_sdk_version: + android_last_seen_at: + ios_app_name: + ios_app_version: + ios_device: + ios_os_version: + ios_sdk_version: + ios_last_seen_at: custom_attributes: {} tags: type: list data: [] - url: "/contacts/649c545e85b35b2332e7efd6/tags" + url: "/contacts/64bfd31c76af8e7a749aa86f/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/649c545e85b35b2332e7efd6/notes" + url: "/contacts/64bfd31c76af8e7a749aa86f/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/649c545e85b35b2332e7efd6/companies" + url: "/contacts/64bfd31c76af8e7a749aa86f/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/649c545e85b35b2332e7efd6/subscriptions" + url: "/contacts/64bfd31c76af8e7a749aa86f/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/649c545e85b35b2332e7efd6/subscriptions" + url: "/contacts/64bfd31c76af8e7a749aa86f/subscriptions" total_count: 0 has_more: false - utm_campaign: - utm_content: - utm_medium: - utm_source: - utm_term: - referrer: + utm_campaign: + utm_content: + utm_medium: + utm_source: + utm_term: + referrer: schema: "$ref": "#/components/schemas/contact" '401': @@ -3317,7 +3308,7 @@ paths: Unauthorized: value: type: error.list - request_id: c6c24aba-4b27-49e8-b41a-70ca3ad5ebe4 + request_id: 17f4df4d-9672-4b6b-a6fb-f0e906f6c96c errors: - code: unauthorized message: Access Token Invalid @@ -3332,8 +3323,8 @@ paths: successful: summary: successful value: - from: 649c545e85b35b2332e7efd5 - into: 649c545e85b35b2332e7efd6 + from: 64bfd31c76af8e7a749aa86e + into: 64bfd31c76af8e7a749aa86f "/contacts/search": post: summary: Search contacts @@ -3442,7 +3433,7 @@ paths: Unauthorized: value: type: error.list - request_id: 3259829b-e411-49d3-8722-bb673bff3f85 + request_id: c1fafb9e-d67c-4b62-8635-253eb4b7d8a7 errors: - code: unauthorized message: Access Token Invalid @@ -3462,15 +3453,15 @@ paths: value: - field: id operator: "=" - value: 649c546185b35b2332e7efd9 + value: 64bfd31f76af8e7a749aa872 - operator: OR value: - field: id operator: "=" - value: 649c546185b35b2332e7efd9 + value: 64bfd31f76af8e7a749aa872 - field: id operator: "=" - value: 649c546185b35b2332e7efd9 + value: 64bfd31f76af8e7a749aa872 "/contacts": get: summary: List all contacts @@ -3509,7 +3500,7 @@ paths: Unauthorized: value: type: error.list - request_id: 17c37777-1be5-40d3-8c48-e4343352a90d + request_id: 240dc870-c905-4fa8-ba25-dcfe2f22f564 errors: - code: unauthorized message: Access Token Invalid @@ -3535,91 +3526,91 @@ paths: successful: value: type: contact - id: 649c546585b35b2332e7efdb - workspace_id: this_is_an_id249_that_should_be_at_least_ - external_id: + id: 64bfd32676af8e7a749aa874 + workspace_id: this_is_an_id248_that_should_be_at_least_ + external_id: role: user email: joebloggs@intercom.io - phone: - formatted_phone: - name: - avatar: - owner_id: + phone: + formatted_phone: + name: + avatar: + owner_id: social_profiles: type: list data: [] has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1687966821 - updated_at: 1687966821 - signed_up_at: - last_seen_at: - last_replied_at: - last_contacted_at: - last_email_opened_at: - last_email_clicked_at: - language_override: - browser: - browser_version: - browser_language: - os: + created_at: 1690293030 + updated_at: 1690293030 + signed_up_at: + last_seen_at: + last_replied_at: + last_contacted_at: + last_email_opened_at: + last_email_clicked_at: + language_override: + browser: + browser_version: + browser_language: + os: location: type: location - country: - region: - city: - country_code: - continent_code: - android_app_name: - android_app_version: - android_device: - android_os_version: - android_sdk_version: - android_last_seen_at: - ios_app_name: - ios_app_version: - ios_device: - ios_os_version: - ios_sdk_version: - ios_last_seen_at: + country: + region: + city: + country_code: + continent_code: + android_app_name: + android_app_version: + android_device: + android_os_version: + android_sdk_version: + android_last_seen_at: + ios_app_name: + ios_app_version: + ios_device: + ios_os_version: + ios_sdk_version: + ios_last_seen_at: custom_attributes: {} tags: type: list data: [] - url: "/contacts/649c546585b35b2332e7efdb/tags" + url: "/contacts/64bfd32676af8e7a749aa874/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/649c546585b35b2332e7efdb/notes" + url: "/contacts/64bfd32676af8e7a749aa874/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/649c546585b35b2332e7efdb/companies" + url: "/contacts/64bfd32676af8e7a749aa874/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/649c546585b35b2332e7efdb/subscriptions" + url: "/contacts/64bfd32676af8e7a749aa874/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/649c546585b35b2332e7efdb/subscriptions" + url: "/contacts/64bfd32676af8e7a749aa874/subscriptions" total_count: 0 has_more: false - utm_campaign: - utm_content: - utm_medium: - utm_source: - utm_term: - referrer: + utm_campaign: + utm_content: + utm_medium: + utm_source: + utm_term: + referrer: schema: "$ref": "#/components/schemas/contact" '401': @@ -3630,7 +3621,7 @@ paths: Unauthorized: value: type: error.list - request_id: 56063235-8f36-40d3-ad4b-b59368f3be78 + request_id: 30cd928d-4288-4f11-95bc-bd45b99c041c errors: - code: unauthorized message: Access Token Invalid @@ -3674,8 +3665,9 @@ paths: examples: successful: value: - id: 649c546785b35b2332e7efdc - object: contact + id: 64bfd32876af8e7a749aa875 + external_id: '70' + type: contact archived: true schema: "$ref": "#/components/schemas/contact_archived" @@ -3706,8 +3698,9 @@ paths: examples: successful: value: - id: 649c546885b35b2332e7efdd - object: contact + id: 64bfd32976af8e7a749aa876 + external_id: '70' + type: contact archived: false schema: "$ref": "#/components/schemas/contact_unarchived" @@ -3741,7 +3734,7 @@ paths: successful: value: type: tag - id: '318852' + id: '320870' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -3753,7 +3746,7 @@ paths: Conversation not found: value: type: error.list - request_id: 94e93a8f-1543-43e7-b12e-8d7541c9473d + request_id: 9f0a9303-3d68-449e-867e-5428eaff4919 errors: - code: not_found message: Conversation not found @@ -3767,7 +3760,7 @@ paths: Unauthorized: value: type: error.list - request_id: 83302d03-c5fe-4a6c-82b6-8a7afb482c68 + request_id: b3acdbac-d437-42fc-850e-343da39ffb53 errors: - code: unauthorized message: Access Token Invalid @@ -3796,13 +3789,13 @@ paths: successful: summary: successful value: - id: 318852 - admin_id: 991266352 + id: 320870 + admin_id: 991266339 conversation_not_found: summary: Conversation not found value: - id: 318853 - admin_id: 991266354 + id: 320871 + admin_id: 991266341 "/conversations/{conversation_id}/tags/{id}": delete: summary: Remove tag from a conversation @@ -3840,7 +3833,7 @@ paths: successful: value: type: tag - id: '318855' + id: '320873' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -3852,14 +3845,14 @@ paths: Conversation not found: value: type: error.list - request_id: b7194981-e6c4-4bae-bdab-95c8b7b488bd + request_id: 723fde8f-a79d-4881-9206-57943b05048a errors: - code: not_found message: Conversation not found Tag not found: value: type: error.list - request_id: 69e811d3-47ad-489a-99b2-a51df6f5db9a + request_id: daab1b1d-8c97-4a65-a1ae-6e651acc62be errors: - code: tag_not_found message: Tag not found @@ -3873,7 +3866,7 @@ paths: Unauthorized: value: type: error.list - request_id: 6a396fe9-ccb8-44ee-9eb7-f2ab11698b24 + request_id: 7468e31d-8fc4-4826-872f-85421663d22d errors: - code: unauthorized message: Access Token Invalid @@ -3896,15 +3889,15 @@ paths: successful: summary: successful value: - admin_id: 991266356 + admin_id: 991266343 conversation_not_found: summary: Conversation not found value: - admin_id: 991266358 + admin_id: 991266345 tag_not_found: summary: Tag not found value: - admin_id: 991266359 + admin_id: 991266346 "/conversations": get: summary: List all conversations @@ -3951,11 +3944,11 @@ paths: total_count: 1 conversations: - type: conversation - id: '710340' - created_at: 1687966834 - updated_at: 1687966834 - waiting_since: - snoozed_until: + id: '714376' + created_at: 1690293043 + updated_at: 1690293043 + waiting_since: + snoozed_until: source: type: conversation id: '403918065' @@ -3964,20 +3957,21 @@ paths: body: "

this is the message body

" author: type: admin - id: '991266362' - name: Ciaran145 Lee - email: admin145@email.com + id: '991266349' + name: Ciaran131 Lee + email: admin131@email.com attachments: [] - url: + url: redacted: false contacts: type: contact.list contacts: - type: contact - id: 649c547185b35b2332e7efe1 - first_contact_reply: - admin_assignee_id: - team_assignee_id: + id: 64bfd33276af8e7a749aa87a + external_id: '70' + first_contact_reply: + admin_assignee_id: + team_assignee_id: open: false state: closed read: false @@ -3985,14 +3979,14 @@ paths: type: tag.list tags: [] priority: not_priority - sla_applied: - statistics: - conversation_rating: - teammates: - title: + sla_applied: + statistics: + conversation_rating: + teammates: + title: custom_attributes: {} topics: {} - ticket: + ticket: linked_objects: type: list data: [] @@ -4008,7 +4002,7 @@ paths: Unauthorized: value: type: error.list - request_id: ea12b20d-d749-41be-a991-fabf799389c5 + request_id: c0dd8bd4-5fcd-477f-8647-03641325e700 errors: - code: unauthorized message: Access Token Invalid @@ -4022,7 +4016,7 @@ paths: API plan restricted: value: type: error.list - request_id: 07e2bc1e-c313-434c-81c0-05464a5dc410 + request_id: 4698c691-9910-4e57-925f-16963455e107 errors: - code: api_plan_restricted message: Active subscription needed. @@ -4055,10 +4049,10 @@ paths: value: type: user_message id: '403918075' - created_at: 1687966862 + created_at: 1690293072 body: Hello there message_type: inapp - conversation_id: '712383' + conversation_id: '714401' schema: "$ref": "#/components/schemas/message" '404': @@ -4069,7 +4063,7 @@ paths: Contact Not Found: value: type: error.list - request_id: 961b113f-72a0-45e2-8f89-0100d21897b0 + request_id: ffb316aa-49d2-4f98-bafb-57052246dd51 errors: - code: not_found message: User Not Found @@ -4083,7 +4077,7 @@ paths: Unauthorized: value: type: error.list - request_id: 02dd49f8-b651-48b1-8377-6ea186996cf6 + request_id: 98f9532c-3154-4571-bc02-8cf5cb9e6f9f errors: - code: unauthorized message: Access Token Invalid @@ -4097,7 +4091,7 @@ paths: API plan restricted: value: type: error.list - request_id: 3c19fe6d-abf2-45c1-8243-89313460b502 + request_id: b329ad39-8356-48d9-b395-adc259dc3e4d errors: - code: api_plan_restricted message: Active subscription needed. @@ -4114,7 +4108,7 @@ paths: value: from: type: user - id: 649c548d85b35b2332e7eff6 + id: 64bfd34f76af8e7a749aa88f body: Hello there contact_not_found: summary: Contact Not Found @@ -4166,11 +4160,11 @@ paths: conversation found: value: type: conversation - id: '710369' - created_at: 1687966871 - updated_at: 1687966871 - waiting_since: - snoozed_until: + id: '714405' + created_at: 1690293082 + updated_at: 1690293082 + waiting_since: + snoozed_until: source: type: conversation id: '403918079' @@ -4179,20 +4173,21 @@ paths: body: "

this is the message body

" author: type: admin - id: '991266376' - name: Ciaran152 Lee - email: admin152@email.com + id: '991266363' + name: Ciaran138 Lee + email: admin138@email.com attachments: [] - url: + url: redacted: false contacts: type: contact.list contacts: - type: contact - id: 649c549785b35b2332e7effa - first_contact_reply: - admin_assignee_id: - team_assignee_id: + id: 64bfd35a76af8e7a749aa893 + external_id: '70' + first_contact_reply: + admin_assignee_id: + team_assignee_id: open: false state: closed read: false @@ -4200,14 +4195,14 @@ paths: type: tag.list tags: [] priority: not_priority - sla_applied: - statistics: - conversation_rating: - teammates: - title: + sla_applied: + statistics: + conversation_rating: + teammates: + title: custom_attributes: {} topics: {} - ticket: + ticket: linked_objects: type: list data: [] @@ -4227,7 +4222,7 @@ paths: Not found: value: type: error.list - request_id: d4c24633-990e-4022-9216-e6b6cb32942c + request_id: 1b0c1801-6916-48c5-9c38-196d1a06d9ab errors: - code: not_found message: Resource Not Found @@ -4241,7 +4236,7 @@ paths: Unauthorized: value: type: error.list - request_id: 1c31bd4a-4bca-4dd9-b826-283098cd1e80 + request_id: f7f3a7e9-dd60-4bec-9502-e70829a572d9 errors: - code: unauthorized message: Access Token Invalid @@ -4255,7 +4250,7 @@ paths: API plan restricted: value: type: error.list - request_id: de47c812-0b72-4259-86b5-ec6f6cb7fea1 + request_id: df3a6476-6413-49b1-94e5-b9d517323560 errors: - code: api_plan_restricted message: Active subscription needed. @@ -4298,11 +4293,11 @@ paths: conversation found: value: type: conversation - id: '710373' - created_at: 1687966881 - updated_at: 1687966883 - waiting_since: - snoozed_until: + id: '714409' + created_at: 1690293093 + updated_at: 1690293096 + waiting_since: + snoozed_until: source: type: conversation id: '403918083' @@ -4311,20 +4306,21 @@ paths: body: "

this is the message body

" author: type: admin - id: '991266384' - name: Ciaran156 Lee - email: admin156@email.com + id: '991266371' + name: Ciaran142 Lee + email: admin142@email.com attachments: [] - url: + url: redacted: false contacts: type: contact.list contacts: - type: contact - id: 649c54a185b35b2332e7effe - first_contact_reply: - admin_assignee_id: - team_assignee_id: + id: 64bfd36576af8e7a749aa897 + external_id: '70' + first_contact_reply: + admin_assignee_id: + team_assignee_id: open: false state: closed read: true @@ -4332,16 +4328,16 @@ paths: type: tag.list tags: [] priority: not_priority - sla_applied: - statistics: - conversation_rating: - teammates: - title: + sla_applied: + statistics: + conversation_rating: + teammates: + title: custom_attributes: issue_type: Billing priority: High topics: {} - ticket: + ticket: linked_objects: type: list data: [] @@ -4351,37 +4347,37 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '708321' + id: '710339' part_type: conversation_attribute_updated_by_admin - body: - created_at: 1687966883 - updated_at: 1687966883 - notified_at: 1687966883 - assigned_to: + body: + created_at: 1690293095 + updated_at: 1690293095 + notified_at: 1690293095 + assigned_to: author: - id: '991266385' + id: '991266372' type: bot name: Operator email: operator+this_is_an_id292_that_should_be_at_least_@intercom.io attachments: [] - external_id: + external_id: redacted: false metadata: {} - type: conversation_part - id: '708322' + id: '710340' part_type: conversation_attribute_updated_by_admin - body: - created_at: 1687966883 - updated_at: 1687966883 - notified_at: 1687966883 - assigned_to: + body: + created_at: 1690293096 + updated_at: 1690293096 + notified_at: 1690293096 + assigned_to: author: - id: '991266385' + id: '991266372' type: bot name: Operator email: operator+this_is_an_id292_that_should_be_at_least_@intercom.io attachments: [] - external_id: + external_id: redacted: false metadata: {} total_count: 2 @@ -4395,7 +4391,7 @@ paths: Not found: value: type: error.list - request_id: d0533b84-ad22-4c4c-9b3a-f058000bd87d + request_id: a9303195-6100-41f6-b383-b6f8719c6185 errors: - code: not_found message: Resource Not Found @@ -4409,7 +4405,7 @@ paths: Unauthorized: value: type: error.list - request_id: abf8443c-4f4f-4db0-b550-9e35b79c9ade + request_id: b5625b54-fb4e-438c-a573-7e57c120297b errors: - code: unauthorized message: Access Token Invalid @@ -4423,7 +4419,7 @@ paths: API plan restricted: value: type: error.list - request_id: 83b95bd4-243c-462a-a824-3dcf98730745 + request_id: d56475da-306e-494e-b06f-317790de28e6 errors: - code: api_plan_restricted message: Active subscription needed. @@ -4542,11 +4538,11 @@ paths: total_count: 1 conversations: - type: conversation - id: '710377' - created_at: 1687966893 - updated_at: 1687966893 - waiting_since: - snoozed_until: + id: '714413' + created_at: 1690293107 + updated_at: 1690293107 + waiting_since: + snoozed_until: source: type: conversation id: '403918087' @@ -4555,20 +4551,21 @@ paths: body: "

this is the message body

" author: type: admin - id: '991266408' - name: Ciaran176 Lee - email: admin176@email.com + id: '991266395' + name: Ciaran162 Lee + email: admin162@email.com attachments: [] - url: + url: redacted: false contacts: type: contact.list contacts: - type: contact - id: 649c54ad85b35b2332e7f002 - first_contact_reply: - admin_assignee_id: - team_assignee_id: + id: 64bfd37276af8e7a749aa89b + external_id: '70' + first_contact_reply: + admin_assignee_id: + team_assignee_id: open: false state: closed read: false @@ -4576,14 +4573,14 @@ paths: type: tag.list tags: [] priority: not_priority - sla_applied: - statistics: - conversation_rating: - teammates: - title: + sla_applied: + statistics: + conversation_rating: + teammates: + title: custom_attributes: {} topics: {} - ticket: + ticket: linked_objects: type: list data: [] @@ -4605,15 +4602,15 @@ paths: value: - field: id operator: "=" - value: '712395' + value: '714413' - operator: OR value: - field: id operator: "=" - value: '712395' + value: '714413' - field: id operator: "=" - value: '712395' + value: '714413' "/conversations/{id}/reply": post: summary: Reply to a conversation @@ -4652,11 +4649,11 @@ paths: User reply: value: type: conversation - id: '710385' - created_at: 1687966902 - updated_at: 1687966903 - waiting_since: 1687966903 - snoozed_until: + id: '714421' + created_at: 1690293116 + updated_at: 1690293117 + waiting_since: 1690293117 + snoozed_until: source: type: conversation id: '403918090' @@ -4665,23 +4662,24 @@ paths: body: "

this is the message body

" author: type: admin - id: '991266410' - name: Ciaran177 Lee - email: admin177@email.com + id: '991266397' + name: Ciaran163 Lee + email: admin163@email.com attachments: [] - url: + url: redacted: false contacts: type: contact.list contacts: - type: contact - id: 649c54b585b35b2332e7f009 + id: 64bfd37c76af8e7a749aa8a2 + external_id: '70' first_contact_reply: - created_at: 1687966903 + created_at: 1690293117 type: conversation - url: - admin_assignee_id: - team_assignee_id: + url: + admin_assignee_id: + team_assignee_id: open: true state: open read: false @@ -4689,14 +4687,14 @@ paths: type: tag.list tags: [] priority: not_priority - sla_applied: - statistics: - conversation_rating: - teammates: - title: + sla_applied: + statistics: + conversation_rating: + teammates: + title: custom_attributes: {} topics: {} - ticket: + ticket: linked_objects: type: list data: [] @@ -4706,31 +4704,31 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '708324' + id: '710342' part_type: comment body: "

Thanks again :)

" - created_at: 1687966903 - updated_at: 1687966903 - notified_at: 1687966903 - assigned_to: + created_at: 1690293117 + updated_at: 1690293117 + notified_at: 1690293117 + assigned_to: author: - id: 649c54b585b35b2332e7f009 + id: 64bfd37c76af8e7a749aa8a2 type: user name: Joe Bloggs email: joe@bloggs.com attachments: [] - external_id: + external_id: redacted: false metadata: {} total_count: 1 Admin note reply: value: type: conversation - id: '710386' - created_at: 1687966906 - updated_at: 1687966907 - waiting_since: - snoozed_until: + id: '714422' + created_at: 1690293119 + updated_at: 1690293120 + waiting_since: + snoozed_until: source: type: conversation id: '403918091' @@ -4739,20 +4737,21 @@ paths: body: "

this is the message body

" author: type: admin - id: '991266412' - name: Ciaran178 Lee - email: admin178@email.com + id: '991266399' + name: Ciaran164 Lee + email: admin164@email.com attachments: [] - url: + url: redacted: false contacts: type: contact.list contacts: - type: contact - id: 649c54b985b35b2332e7f00a - first_contact_reply: - admin_assignee_id: - team_assignee_id: + id: 64bfd37f76af8e7a749aa8a3 + external_id: '70' + first_contact_reply: + admin_assignee_id: + team_assignee_id: open: false state: closed read: false @@ -4760,14 +4759,14 @@ paths: type: tag.list tags: [] priority: not_priority - sla_applied: - statistics: - conversation_rating: - teammates: - title: + sla_applied: + statistics: + conversation_rating: + teammates: + title: custom_attributes: {} topics: {} - ticket: + ticket: linked_objects: type: list data: [] @@ -4777,7 +4776,7 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '708325' + id: '710343' part_type: note body: |-

An Unordered HTML List

@@ -4792,28 +4791,28 @@ paths:
  • Tea
  • Milk
    • - created_at: 1687966907 - updated_at: 1687966907 - notified_at: 1687966907 - assigned_to: + created_at: 1690293120 + updated_at: 1690293120 + notified_at: 1690293120 + assigned_to: author: - id: '991266412' + id: '991266399' type: admin - name: Ciaran178 Lee - email: admin178@email.com + name: Ciaran164 Lee + email: admin164@email.com attachments: [] - external_id: + external_id: redacted: false metadata: {} total_count: 1 Admin quick_reply reply: value: type: conversation - id: '710387' - created_at: 1687966909 - updated_at: 1687966910 - waiting_since: - snoozed_until: + id: '714423' + created_at: 1690293122 + updated_at: 1690293123 + waiting_since: + snoozed_until: source: type: conversation id: '403918092' @@ -4822,20 +4821,21 @@ paths: body: "

    this is the message body

    " author: type: admin - id: '991266414' - name: Ciaran179 Lee - email: admin179@email.com + id: '991266401' + name: Ciaran165 Lee + email: admin165@email.com attachments: [] - url: + url: redacted: false contacts: type: contact.list contacts: - type: contact - id: 649c54bd85b35b2332e7f00b - first_contact_reply: - admin_assignee_id: - team_assignee_id: + id: 64bfd38176af8e7a749aa8a4 + external_id: '70' + first_contact_reply: + admin_assignee_id: + team_assignee_id: open: false state: closed read: false @@ -4843,14 +4843,14 @@ paths: type: tag.list tags: [] priority: not_priority - sla_applied: - statistics: - conversation_rating: - teammates: - title: + sla_applied: + statistics: + conversation_rating: + teammates: + title: custom_attributes: {} topics: {} - ticket: + ticket: linked_objects: type: list data: [] @@ -4860,31 +4860,31 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '708326' + id: '710344' part_type: quick_reply - body: - created_at: 1687966910 - updated_at: 1687966910 - notified_at: 1687966910 - assigned_to: + body: + created_at: 1690293123 + updated_at: 1690293123 + notified_at: 1690293123 + assigned_to: author: - id: '991266414' + id: '991266401' type: admin - name: Ciaran179 Lee - email: admin179@email.com + name: Ciaran165 Lee + email: admin165@email.com attachments: [] - external_id: + external_id: redacted: false metadata: {} total_count: 1 User last conversation reply: value: type: conversation - id: '710388' - created_at: 1687966912 - updated_at: 1687966913 - waiting_since: 1687966913 - snoozed_until: + id: '714424' + created_at: 1690293125 + updated_at: 1690293126 + waiting_since: 1690293126 + snoozed_until: source: type: conversation id: '403918093' @@ -4893,23 +4893,24 @@ paths: body: "

    this is the message body

    " author: type: admin - id: '991266416' - name: Ciaran180 Lee - email: admin180@email.com + id: '991266403' + name: Ciaran166 Lee + email: admin166@email.com attachments: [] - url: + url: redacted: false contacts: type: contact.list contacts: - type: contact - id: 649c54c085b35b2332e7f00c + id: 64bfd38476af8e7a749aa8a5 + external_id: '70' first_contact_reply: - created_at: 1687966913 + created_at: 1690293126 type: conversation - url: - admin_assignee_id: - team_assignee_id: + url: + admin_assignee_id: + team_assignee_id: open: true state: open read: false @@ -4917,14 +4918,14 @@ paths: type: tag.list tags: [] priority: not_priority - sla_applied: - statistics: - conversation_rating: - teammates: - title: + sla_applied: + statistics: + conversation_rating: + teammates: + title: custom_attributes: {} topics: {} - ticket: + ticket: linked_objects: type: list data: [] @@ -4934,20 +4935,20 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '708327' + id: '710345' part_type: comment body: "

    Thanks again :)

    " - created_at: 1687966913 - updated_at: 1687966913 - notified_at: 1687966913 - assigned_to: + created_at: 1690293126 + updated_at: 1690293126 + notified_at: 1690293126 + assigned_to: author: - id: 649c54c085b35b2332e7f00c + id: 64bfd38476af8e7a749aa8a5 type: user name: Joe Bloggs email: joe@bloggs.com attachments: [] - external_id: + external_id: redacted: false metadata: {} total_count: 1 @@ -4961,7 +4962,7 @@ paths: Not found: value: type: error.list - request_id: c5ff0b03-9b8c-4802-9e9f-580af6a36e65 + request_id: e683141d-b21d-4c43-86b0-d813372a6f73 errors: - code: not_found message: Resource Not Found @@ -4975,7 +4976,7 @@ paths: Unauthorized: value: type: error.list - request_id: aa37b4bb-407d-4375-9e76-34388b1bcff7 + request_id: 0b5c9041-5a51-4ca3-b021-2280021f75d8 errors: - code: unauthorized message: Access Token Invalid @@ -4989,7 +4990,7 @@ paths: API plan restricted: value: type: error.list - request_id: 21397db5-4ab4-42ad-adac-c021e4a2ba91 + request_id: 412a9a45-c0b2-48eb-93b2-bf860288bbe4 errors: - code: api_plan_restricted message: Active subscription needed. @@ -5006,14 +5007,14 @@ paths: value: message_type: comment type: user - intercom_user_id: 649c54b585b35b2332e7f009 + intercom_user_id: 64bfd37c76af8e7a749aa8a2 body: Thanks again :) admin_note_reply: summary: Admin note reply value: message_type: note type: admin - admin_id: 991266412 + admin_id: 991266399 body: "

    An Unordered HTML List

    An Ordered HTML List

    \
    1. Coffee
    2. Tea
    3. Milk
    @@ -5023,25 +5024,25 @@ paths: value: message_type: quick_reply type: admin - admin_id: 991266414 + admin_id: 991266401 reply_options: - text: 'Yes' - uuid: 9e1263d9-78b8-4b89-9509-72ddbfdcf3ba + uuid: 248f061f-89bd-4284-888b-e41c58e2ba0d - text: 'No' - uuid: cfcbe915-13c2-4b19-9aa3-868d51833c34 + uuid: 8eefaab0-d63d-42cc-9b4c-897f4c2703d3 user_last_conversation_reply: summary: User last conversation reply value: message_type: comment type: user - intercom_user_id: 649c54c085b35b2332e7f00c + intercom_user_id: 64bfd38476af8e7a749aa8a5 body: Thanks again :) not_found: summary: Not found value: message_type: comment type: user - intercom_user_id: 649c54c385b35b2332e7f00d + intercom_user_id: 64bfd38776af8e7a749aa8a6 body: Thanks again :) "/conversations/{id}/parts": post: @@ -5075,11 +5076,11 @@ paths: Close a conversation: value: type: conversation - id: '710392' - created_at: 1687966922 - updated_at: 1687966923 - waiting_since: - snoozed_until: + id: '714428' + created_at: 1690293136 + updated_at: 1690293137 + waiting_since: + snoozed_until: source: type: conversation id: '403918097' @@ -5088,20 +5089,21 @@ paths: body: "

    this is the message body

    " author: type: admin - id: '991266424' - name: Ciaran184 Lee - email: admin184@email.com + id: '991266411' + name: Ciaran170 Lee + email: admin170@email.com attachments: [] - url: + url: redacted: false contacts: type: contact.list contacts: - type: contact - id: 649c54ca85b35b2332e7f010 - first_contact_reply: - admin_assignee_id: - team_assignee_id: + id: 64bfd38f76af8e7a749aa8a9 + external_id: '70' + first_contact_reply: + admin_assignee_id: + team_assignee_id: open: false state: closed read: false @@ -5109,14 +5111,14 @@ paths: type: tag.list tags: [] priority: not_priority - sla_applied: - statistics: - conversation_rating: - teammates: - title: + sla_applied: + statistics: + conversation_rating: + teammates: + title: custom_attributes: {} topics: {} - ticket: + ticket: linked_objects: type: list data: [] @@ -5126,31 +5128,31 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '708328' + id: '710346' part_type: close body: "

    Goodbye :)

    " - created_at: 1687966923 - updated_at: 1687966923 - notified_at: 1687966923 - assigned_to: + created_at: 1690293137 + updated_at: 1690293137 + notified_at: 1690293137 + assigned_to: author: - id: '991266424' + id: '991266411' type: admin - name: Ciaran184 Lee - email: admin184@email.com + name: Ciaran170 Lee + email: admin170@email.com attachments: [] - external_id: + external_id: redacted: false metadata: {} total_count: 1 Snooze a conversation: value: type: conversation - id: '710393' - created_at: 1687966926 - updated_at: 1687966927 - waiting_since: - snoozed_until: 1687970527 + id: '714429' + created_at: 1690293139 + updated_at: 1690293140 + waiting_since: + snoozed_until: 1690296740 source: type: conversation id: '403918098' @@ -5159,20 +5161,21 @@ paths: body: "

    this is the message body

    " author: type: admin - id: '991266426' - name: Ciaran185 Lee - email: admin185@email.com + id: '991266413' + name: Ciaran171 Lee + email: admin171@email.com attachments: [] - url: + url: redacted: false contacts: type: contact.list contacts: - type: contact - id: 649c54cd85b35b2332e7f011 - first_contact_reply: - admin_assignee_id: - team_assignee_id: + id: 64bfd39376af8e7a749aa8aa + external_id: '70' + first_contact_reply: + admin_assignee_id: + team_assignee_id: open: true state: snoozed read: false @@ -5180,14 +5183,14 @@ paths: type: tag.list tags: [] priority: not_priority - sla_applied: - statistics: - conversation_rating: - teammates: - title: + sla_applied: + statistics: + conversation_rating: + teammates: + title: custom_attributes: {} topics: {} - ticket: + ticket: linked_objects: type: list data: [] @@ -5197,31 +5200,31 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '708329' + id: '710347' part_type: snoozed - body: - created_at: 1687966927 - updated_at: 1687966927 - notified_at: 1687966927 - assigned_to: + body: + created_at: 1690293140 + updated_at: 1690293140 + notified_at: 1690293140 + assigned_to: author: - id: '991266426' + id: '991266413' type: admin - name: Ciaran185 Lee - email: admin185@email.com + name: Ciaran171 Lee + email: admin171@email.com attachments: [] - external_id: + external_id: redacted: false metadata: {} total_count: 1 Open a conversation: value: type: conversation - id: '710398' - created_at: 1687966927 - updated_at: 1687966937 - waiting_since: - snoozed_until: + id: '714434' + created_at: 1690293140 + updated_at: 1690293149 + waiting_since: + snoozed_until: source: type: conversation id: '403918099' @@ -5230,20 +5233,21 @@ paths: body: "

    this is the message body

    " author: type: admin - id: '991266428' - name: Ciaran186 Lee - email: admin186@email.com + id: '991266415' + name: Ciaran172 Lee + email: admin172@email.com attachments: [] - url: + url: redacted: false contacts: type: contact.list contacts: - type: contact - id: 649c54d485b35b2332e7f016 - first_contact_reply: - admin_assignee_id: - team_assignee_id: + id: 64bfd39976af8e7a749aa8af + external_id: '74' + first_contact_reply: + admin_assignee_id: + team_assignee_id: open: true state: open read: true @@ -5251,14 +5255,14 @@ paths: type: tag.list tags: [] priority: not_priority - sla_applied: - statistics: - conversation_rating: - teammates: + sla_applied: + statistics: + conversation_rating: + teammates: title: '' custom_attributes: {} topics: {} - ticket: + ticket: linked_objects: type: list data: [] @@ -5268,31 +5272,31 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '708331' + id: '710349' part_type: open - body: - created_at: 1687966937 - updated_at: 1687966937 - notified_at: 1687966937 - assigned_to: + body: + created_at: 1690293149 + updated_at: 1690293149 + notified_at: 1690293149 + assigned_to: author: - id: '991266428' + id: '991266415' type: admin - name: Ciaran186 Lee - email: admin186@email.com + name: Ciaran172 Lee + email: admin172@email.com attachments: [] - external_id: + external_id: redacted: false metadata: {} total_count: 1 Assign a conversation: value: type: conversation - id: '710402' - created_at: 1687966939 - updated_at: 1687966940 - waiting_since: - snoozed_until: + id: '714438' + created_at: 1690293151 + updated_at: 1690293153 + waiting_since: + snoozed_until: source: type: conversation id: '403918102' @@ -5301,20 +5305,21 @@ paths: body: "

    this is the message body

    " author: type: admin - id: '991266430' - name: Ciaran187 Lee - email: admin187@email.com + id: '991266417' + name: Ciaran173 Lee + email: admin173@email.com attachments: [] - url: + url: redacted: false contacts: type: contact.list contacts: - type: contact - id: 649c54da85b35b2332e7f019 - first_contact_reply: - admin_assignee_id: 991266430 - team_assignee_id: + id: 64bfd39e76af8e7a749aa8b2 + external_id: '70' + first_contact_reply: + admin_assignee_id: 991266417 + team_assignee_id: open: true state: open read: false @@ -5322,14 +5327,14 @@ paths: type: tag.list tags: [] priority: not_priority - sla_applied: - statistics: - conversation_rating: - teammates: - title: + sla_applied: + statistics: + conversation_rating: + teammates: + title: custom_attributes: {} topics: {} - ticket: + ticket: linked_objects: type: list data: [] @@ -5339,22 +5344,22 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '708332' + id: '710350' part_type: assign_and_reopen - body: - created_at: 1687966940 - updated_at: 1687966940 - notified_at: 1687966940 + body: + created_at: 1690293153 + updated_at: 1690293153 + notified_at: 1690293153 assigned_to: type: admin - id: '991266430' + id: '991266417' author: - id: '991266430' + id: '991266417' type: admin - name: Ciaran187 Lee - email: admin187@email.com + name: Ciaran173 Lee + email: admin173@email.com attachments: [] - external_id: + external_id: redacted: false metadata: {} total_count: 1 @@ -5368,7 +5373,7 @@ paths: Not found: value: type: error.list - request_id: 5b3f04de-52fa-4b49-bab7-29df3d9c31e6 + request_id: 93578852-47c5-47e1-ab31-3383fdf95c51 errors: - code: not_found message: Resource Not Found @@ -5382,7 +5387,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0a6b22a9-6c40-441e-8046-5171944aa81b + request_id: 48944132-418c-4cb9-b228-55f14c97a980 errors: - code: unauthorized message: Access Token Invalid @@ -5396,7 +5401,7 @@ paths: API plan restricted: value: type: error.list - request_id: 49c94dce-bc16-4d63-ae5b-676f9376888d + request_id: fb088ade-77e8-45ee-9188-7cd783af8a67 errors: - code: api_plan_restricted message: Active subscription needed. @@ -5417,32 +5422,32 @@ paths: value: message_type: close type: admin - admin_id: 991266424 + admin_id: 991266411 body: Goodbye :) snooze_a_conversation: summary: Snooze a conversation value: message_type: snoozed - admin_id: 991266426 - snoozed_until: 1687970527 + admin_id: 991266413 + snoozed_until: 1690296740 open_a_conversation: summary: Open a conversation value: message_type: open - admin_id: 991266428 + admin_id: 991266415 assign_a_conversation: summary: Assign a conversation value: message_type: assignment type: admin - admin_id: 991266430 - assignee_id: 991266430 + admin_id: 991266417 + assignee_id: 991266417 not_found: summary: Not found value: message_type: close type: admin - admin_id: 991266432 + admin_id: 991266419 body: Goodbye :) "/conversations/{id}/run_assignment_rules": post: @@ -5473,11 +5478,11 @@ paths: Assign a conversation using assignment rules: value: type: conversation - id: '710406' - created_at: 1687966949 - updated_at: 1687966950 - waiting_since: - snoozed_until: + id: '714442' + created_at: 1690293163 + updated_at: 1690293165 + waiting_since: + snoozed_until: source: type: conversation id: '403918106' @@ -5486,20 +5491,21 @@ paths: body: "

    this is the message body

    " author: type: admin - id: '991266438' - name: Ciaran191 Lee - email: admin191@email.com + id: '991266425' + name: Ciaran177 Lee + email: admin177@email.com attachments: [] - url: + url: redacted: false contacts: type: contact.list contacts: - type: contact - id: 649c54e585b35b2332e7f01d - first_contact_reply: - admin_assignee_id: - team_assignee_id: + id: 64bfd3ab76af8e7a749aa8b6 + external_id: '70' + first_contact_reply: + admin_assignee_id: + team_assignee_id: open: false state: closed read: false @@ -5507,14 +5513,14 @@ paths: type: tag.list tags: [] priority: not_priority - sla_applied: - statistics: - conversation_rating: - teammates: - title: + sla_applied: + statistics: + conversation_rating: + teammates: + title: custom_attributes: {} topics: {} - ticket: + ticket: linked_objects: type: list data: [] @@ -5524,22 +5530,22 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '708333' + id: '710351' part_type: default_assignment - body: - created_at: 1687966950 - updated_at: 1687966950 - notified_at: 1687966950 + body: + created_at: 1690293165 + updated_at: 1690293165 + notified_at: 1690293165 assigned_to: type: nobody_admin - id: + id: author: - id: '991266439' + id: '991266426' type: bot name: Operator email: operator+this_is_an_id330_that_should_be_at_least_@intercom.io attachments: [] - external_id: + external_id: redacted: false metadata: {} total_count: 1 @@ -5553,7 +5559,7 @@ paths: Not found: value: type: error.list - request_id: 92bd02a3-ad5e-4012-aef9-92be9115fb13 + request_id: f5e5cecf-bea1-4304-8641-8ec3af0c1038 errors: - code: not_found message: Resource Not Found @@ -5567,7 +5573,7 @@ paths: Unauthorized: value: type: error.list - request_id: aa51462c-7edb-4fc3-90b3-215171b1d770 + request_id: eb894aec-c68c-4c51-b185-f1203eee476f errors: - code: unauthorized message: Access Token Invalid @@ -5581,7 +5587,7 @@ paths: API plan restricted: value: type: error.list - request_id: 0beb4ae9-b398-48a1-9615-a8544b5c018e + request_id: 31a966fb-ba29-4522-a2d5-349121b0ebd6 errors: - code: api_plan_restricted message: Active subscription needed. @@ -5620,7 +5626,7 @@ paths: value: customers: - type: user - id: 649c54ef85b35b2332e7f021 + id: 64bfd3b676af8e7a749aa8ba schema: "$ref": "#/components/schemas/conversation" '404': @@ -5631,7 +5637,7 @@ paths: Not found: value: type: error.list - request_id: 3cec102f-0fff-47bd-9d88-b273b3fc2275 + request_id: bbebe2cb-a34e-4e03-82d0-086d875d6043 errors: - code: not_found message: Resource Not Found @@ -5645,7 +5651,7 @@ paths: Unauthorized: value: type: error.list - request_id: 95e6bed9-8f93-40aa-8371-584a7cb5df14 + request_id: e6a20965-2533-40cd-990e-352dea33ea86 errors: - code: unauthorized message: Access Token Invalid @@ -5659,7 +5665,7 @@ paths: API plan restricted: value: type: error.list - request_id: a741f1ca-d98c-4091-b5c5-7316114e0e52 + request_id: 57a378e4-aa2f-4363-8618-12f162173e63 errors: - code: api_plan_restricted message: Active subscription needed. @@ -5674,15 +5680,15 @@ paths: attach_a_contact_to_a_conversation: summary: Attach a contact to a conversation value: - admin_id: 991266446 + admin_id: 991266433 customer: - intercom_user_id: 649c54ef85b35b2332e7f021 + intercom_user_id: 64bfd3b676af8e7a749aa8ba not_found: summary: Not found value: - admin_id: 991266448 + admin_id: 991266435 customer: - intercom_user_id: 649c54f285b35b2332e7f022 + intercom_user_id: 64bfd3b876af8e7a749aa8bb "/conversations/{conversation_id}/customers/{contact_id}": delete: summary: Detach a contact from a group conversation @@ -5723,7 +5729,7 @@ paths: value: customers: - type: user - id: 649c550185b35b2332e7f02c + id: 64bfd3c876af8e7a749aa8c5 schema: "$ref": "#/components/schemas/conversation" '404': @@ -5734,14 +5740,14 @@ paths: Conversation not found: value: type: error.list - request_id: 0f469ee0-11cd-49b5-83aa-6568790657f9 + request_id: ccd5bbc6-b64e-48c4-a924-0577a1604877 errors: - code: not_found message: Resource Not Found Contact not found: value: type: error.list - request_id: f1b72868-02e4-47c4-814d-acaaf7a9da57 + request_id: f0f62f71-92c3-435a-9165-bc0ad72fed67 errors: - code: not_found message: User Not Found @@ -5755,7 +5761,7 @@ paths: Last customer: value: type: error.list - request_id: dd8c3962-9526-4615-a1ab-8952cea44a78 + request_id: 6e24829e-9333-4536-adb7-f3444b59f9f6 errors: - code: parameter_invalid message: Removing the last customer is not allowed @@ -5769,7 +5775,7 @@ paths: Unauthorized: value: type: error.list - request_id: 798b53e3-f1db-4f5f-b29a-10b0941a1ed7 + request_id: 0bcf36f2-2891-407a-9354-44f26596fdcb errors: - code: unauthorized message: Access Token Invalid @@ -5783,7 +5789,7 @@ paths: API plan restricted: value: type: error.list - request_id: a89c84b5-3ec5-435a-b272-0063c5e93377 + request_id: c731fe33-7048-4b27-ba7c-6acf69b532c9 errors: - code: api_plan_restricted message: Active subscription needed. @@ -5798,27 +5804,27 @@ paths: detach_a_contact_from_a_group_conversation: summary: Detach a contact from a group conversation value: - admin_id: 991266454 + admin_id: 991266441 customer: - intercom_user_id: 649c54f985b35b2332e7f025 + intercom_user_id: 64bfd3bf76af8e7a749aa8be conversation_not_found: summary: Conversation not found value: - admin_id: 991266456 + admin_id: 991266443 customer: - intercom_user_id: 649c550385b35b2332e7f02d + intercom_user_id: 64bfd3ca76af8e7a749aa8c6 contact_not_found: summary: Contact not found value: - admin_id: 991266458 + admin_id: 991266445 customer: - intercom_user_id: 649c550c85b35b2332e7f034 + intercom_user_id: 64bfd3d376af8e7a749aa8cd last_customer: summary: Last customer value: - admin_id: 991266460 + admin_id: 991266447 customer: - intercom_user_id: 649c551585b35b2332e7f03b + intercom_user_id: 64bfd3dc76af8e7a749aa8d4 "/conversations/redact": post: summary: Redact a conversation part @@ -5845,11 +5851,11 @@ paths: Redact a conversation part: value: type: conversation - id: '710462' - created_at: 1687967025 - updated_at: 1687967028 - waiting_since: 1687967027 - snoozed_until: + id: '714498' + created_at: 1690293240 + updated_at: 1690293242 + waiting_since: 1690293241 + snoozed_until: source: type: conversation id: '403918132' @@ -5858,23 +5864,24 @@ paths: body: "

    this is the message body

    " author: type: admin - id: '991266466' - name: Ciaran205 Lee - email: admin205@email.com + id: '991266453' + name: Ciaran191 Lee + email: admin191@email.com attachments: [] - url: + url: redacted: false contacts: type: contact.list contacts: - type: contact - id: 649c553185b35b2332e7f050 + id: 64bfd3f776af8e7a749aa8e9 + external_id: '70' first_contact_reply: - created_at: 1687967027 + created_at: 1690293241 type: conversation - url: - admin_assignee_id: - team_assignee_id: + url: + admin_assignee_id: + team_assignee_id: open: true state: open read: true @@ -5882,14 +5889,14 @@ paths: type: tag.list tags: [] priority: not_priority - sla_applied: - statistics: - conversation_rating: - teammates: - title: + sla_applied: + statistics: + conversation_rating: + teammates: + title: custom_attributes: {} topics: {} - ticket: + ticket: linked_objects: type: list data: [] @@ -5899,20 +5906,20 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '708341' + id: '710359' part_type: comment body: "

    This message was deleted

    " - created_at: 1687967027 - updated_at: 1687967028 - notified_at: 1687967027 - assigned_to: + created_at: 1690293241 + updated_at: 1690293242 + notified_at: 1690293241 + assigned_to: author: - id: 649c553185b35b2332e7f050 + id: 64bfd3f776af8e7a749aa8e9 type: user name: Joe Bloggs email: joe@bloggs.com attachments: [] - external_id: + external_id: redacted: true metadata: {} total_count: 1 @@ -5926,7 +5933,7 @@ paths: Not found: value: type: error.list - request_id: 984790b2-6abc-4090-baad-a4ac22b138aa + request_id: d18c1a8e-ddb7-4dd7-9ae7-b5ba97693a8f errors: - code: conversation_part_or_message_not_found message: Conversation part or message not found @@ -5940,7 +5947,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0ab8a27d-1ffd-45c5-92ae-6596de833642 + request_id: 7805f57d-bd1a-41bd-a427-6f69a4b92162 errors: - code: unauthorized message: Access Token Invalid @@ -5956,14 +5963,121 @@ paths: summary: Redact a conversation part value: type: conversation_part - conversation_id: 712480 - conversation_part_id: 708341 + conversation_id: 714498 + conversation_part_id: 710359 not_found: summary: Not found value: type: conversation_part conversation_id: really_123_doesnt_exist conversation_part_id: really_123_doesnt_exist + "/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 + tags: + - Conversations + description: You can convert a conversation to a ticket. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: ticket + id: '714501' + friendly_id: '712354' + ticket_attributes: {} + ticket_state: submitted + ticket_type: + type: ticket_type + id: '765831' + name: my-ticket-type-1 + description: my ticket type description is awesome. + icon: "\U0001F981" + workspace_id: this_is_an_id364_that_should_be_at_least_ + archived: false + created_at: 1690293251 + updated_at: 1690293251 + is_internal: false + ticket_type_attributes: + type: list + data: [] + category: Back-office + contacts: + type: contact.list + contacts: + - type: contact + id: 64bfd40076af8e7a749aa8ec + external_id: '70' + admin_assignee_id: '0' + team_assignee_id: '0' + created_at: 1690293252 + updated_at: 1690293251 + ticket_parts: + type: ticket_part.list + ticket_parts: + - type: ticket_part + id: '710361' + part_type: comment + body: "

    Comment for message

    " + created_at: 1690293248 + updated_at: 1690293248 + author: + id: 64bfd40076af8e7a749aa8ec + type: user + name: Joe Bloggs + email: joe@bloggs.com + attachments: [] + redacted: false + - type: ticket_part + id: '710362' + part_type: ticket_state_updated_by_admin + ticket_state: submitted + previous_ticket_state: submitted + created_at: 1690293252 + updated_at: 1690293252 + 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: + type: list + data: [] + total_count: 0 + has_more: false + category: Customer + is_shared: true + schema: + "$ref": "#/components/schemas/ticket" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/convert_conversation_to_ticket_request" + examples: + successful: + summary: successful + value: + ticket_type_id: '765831' "/data_attributes": get: summary: List all data attributes @@ -6133,7 +6247,7 @@ paths: custom: false archived: false model: company - - id: 187681 + - id: 188690 type: data_attribute name: The One Ring full_name: custom_attributes.The One Ring @@ -6145,9 +6259,9 @@ paths: ui_writable: false custom: true archived: false - admin_id: '991266472' - created_at: 1687967034 - updated_at: 1687967034 + admin_id: '991266465' + created_at: 1690293253 + updated_at: 1690293253 model: company - type: data_attribute name: id @@ -6214,7 +6328,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0a30410e-023a-47af-bd20-cb94143ca957 + request_id: e9a12c68-e63b-4948-ba24-202565725326 errors: - code: unauthorized message: Access Token Invalid @@ -6239,7 +6353,7 @@ paths: examples: Successful: value: - id: 187684 + id: 188693 type: data_attribute name: Mithril Shirt full_name: custom_attributes.Mithril Shirt @@ -6249,9 +6363,9 @@ paths: ui_writable: false custom: true archived: false - admin_id: '991266474' - created_at: 1687967036 - updated_at: 1687967036 + admin_id: '991266467' + created_at: 1690293255 + updated_at: 1690293255 model: company schema: "$ref": "#/components/schemas/data_attribute" @@ -6263,7 +6377,7 @@ paths: Same name already exists: value: type: error.list - request_id: da2796e3-65ff-4d44-9104-0594e969e0bc + request_id: 85ebcf73-cec3-4e7e-8813-8544f36fc0f3 errors: - code: parameter_invalid message: You already have 'The One Ring' in your company data. @@ -6271,7 +6385,7 @@ paths: Invalid name: value: type: error.list - request_id: 4a449715-22b8-4f9a-95de-d7a5c2ca6367 + request_id: 380b8b04-9a67-4a08-92b6-74136445ad52 errors: - code: parameter_invalid message: Your name for this attribute must only contain alphanumeric @@ -6279,7 +6393,7 @@ paths: Attribute already exists: value: type: error.list - request_id: 4641d099-110e-4a66-b390-6b9e635cabff + request_id: 1080cc59-c423-46cc-8c3d-a2ba18d39acc errors: - code: parameter_invalid message: You already have 'The One Ring' in your company data. @@ -6287,14 +6401,14 @@ paths: Invalid Data Type: value: type: error.list - request_id: 8ec0f234-296f-4df6-ba21-08caa995bde4 + request_id: 03ad57ba-eab1-422d-87f8-c8e13cc9978c errors: - code: parameter_invalid message: Data Type isn't an option Too few options for list: value: type: error.list - request_id: 8458fe2a-42a3-4c0f-aa30-2175e4d570e1 + request_id: dd5c58a8-4702-4741-87f9-5bc6834c867a errors: - code: parameter_invalid message: The Data Attribute model field must be either contact @@ -6309,7 +6423,7 @@ paths: Unauthorized: value: type: error.list - request_id: 7affcbf1-7270-42fa-8b5a-a60581c50869 + request_id: 5504d2f9-eb28-4356-a1c8-1f3491397edb errors: - code: unauthorized message: Access Token Invalid @@ -6388,7 +6502,7 @@ paths: examples: Successful: value: - id: 187691 + id: 188700 type: data_attribute name: The One Ring full_name: custom_attributes.The One Ring @@ -6402,9 +6516,9 @@ paths: ui_writable: false custom: true archived: false - admin_id: '991266481' - created_at: 1687967040 - updated_at: 1687967040 + admin_id: '991266474' + created_at: 1690293259 + updated_at: 1690293260 model: company schema: "$ref": "#/components/schemas/data_attribute" @@ -6416,7 +6530,7 @@ paths: Too few options in list: value: type: error.list - request_id: 127a14d0-346f-43d3-993e-36ac17842df9 + request_id: 5bbb09e7-e279-4225-b6ba-e28427c9cdbc errors: - code: parameter_invalid message: Options isn't an array @@ -6430,7 +6544,7 @@ paths: Attribute Not Found: value: type: error.list - request_id: e1837b29-5153-4282-ba07-8ae2d3e4dff7 + request_id: 7e1851a9-69ba-4461-a209-1f404201e1fe errors: - code: field_not_found message: We couldn't find that data attribute to update @@ -6444,7 +6558,7 @@ paths: Has Dependant Object: value: type: error.list - request_id: 93645a6b-967a-4c79-ae4c-46edf8356eeb + request_id: cbcc3b6f-967a-415d-9f38-b0efcffa9d99 errors: - code: data_invalid message: The Data Attribute you are trying to archive has a @@ -6459,7 +6573,7 @@ paths: Unauthorized: value: type: error.list - request_id: ecdd5d05-79e7-4c37-80c8-50181fd85f70 + request_id: 6d3119b5-1699-487f-a94e-ccc44029a59b errors: - code: unauthorized message: Access Token Invalid @@ -6578,7 +6692,7 @@ paths: Unauthorized: value: type: error.list - request_id: fa7dbc97-3ff0-4ee7-92a2-c9b74bda8923 + request_id: a5940a9b-b52b-476f-b7ac-089656d46fef errors: - code: unauthorized message: Access Token Invalid @@ -6665,7 +6779,7 @@ paths: pages: next: http://api.intercom.test/events?next page email: user24@email.com - intercom_user_id: 649c554c85b35b2332e7f067 + intercom_user_id: 64bfd41976af8e7a749aa901 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 schema: "$ref": "#/components/schemas/data_event_summary" @@ -6677,7 +6791,7 @@ paths: Unauthorized: value: type: error.list - request_id: b7bdf228-ab5e-47c3-ab29-388cc04352d5 + request_id: 923ee45d-d28c-48b2-b28f-63c888065185 errors: - code: unauthorized message: Access Token Invalid @@ -6708,7 +6822,7 @@ paths: Unauthorized: value: type: error.list - request_id: b21e8e94-ddfb-4442-926b-24f8f853fa35 + request_id: aad433b9-ff4c-4440-9def-f739040e81b4 errors: - code: unauthorized message: Access Token Invalid @@ -6752,7 +6866,7 @@ paths: examples: successful: value: - job_identifier: 9pgbxtov1omupfpz + job_identifier: xf6du94qdv4074kd status: pending download_url: '' download_expires_at: '' @@ -6767,8 +6881,8 @@ paths: successful: summary: successful value: - created_at_after: 1687949056 - created_at_before: 1687967056 + created_at_after: 1690275277 + created_at_before: 1690293277 "/export/content/data/{job_identifier}": get: summary: Show content data export @@ -6802,7 +6916,7 @@ paths: examples: successful: value: - job_identifier: 3jnqlbmn0719x601 + job_identifier: lm0e17jqeeefbjuu status: pending download_url: '' download_expires_at: '' @@ -6834,7 +6948,7 @@ paths: examples: successful: value: - job_identifier: f283xlz3wvmdh9cd + job_identifier: o7rpfd0sa9xohhng status: canceled download_url: '' download_expires_at: '' @@ -6895,32 +7009,32 @@ paths: user message created: value: type: user_message - id: '403918141' - created_at: 1687967103 + id: '403918142' + created_at: 1690293322 body: heyy message_type: inapp - conversation_id: '712494' + conversation_id: '714513' lead message created: value: type: user_message - id: '403918142' - created_at: 1687967104 + id: '403918143' + created_at: 1690293323 body: heyy message_type: inapp - conversation_id: '712495' + conversation_id: '714514' admin message created: value: type: admin_message - id: '466161' - created_at: 1687967106 + id: '469190' + created_at: 1690293325 subject: heyy body: heyy message_type: inapp owner: type: admin - id: '991266510' - name: Ciaran238 Lee - email: admin238@email.com + id: '991266503' + name: Ciaran229 Lee + email: admin229@email.com away_mode_enabled: false away_mode_reassign: false schema: @@ -6933,14 +7047,14 @@ paths: No body supplied for message: value: type: error.list - request_id: 1c718141-c4c1-4339-af0f-c3e96a7a7dcd + request_id: 72570b88-5146-420a-b5e5-c2dbe57c625f errors: - code: parameter_invalid message: Body is required No body supplied for email message: value: type: error.list - request_id: d9cd9d7a-30b2-472a-bbfc-9b9928c6fefe + request_id: d62a285f-1a3d-47ac-ae48-0c41c95dcfaa errors: - code: parameter_invalid message: Body is required @@ -6954,7 +7068,7 @@ paths: No subject supplied for email message: value: type: error.list - request_id: 8821d66f-2ec4-4d90-986a-d61f327473fa + request_id: a3322ae2-fd7b-4085-b3ee-da0d4225def4 errors: - code: parameter_not_found message: No subject supplied for email message @@ -6968,7 +7082,7 @@ paths: Unauthorized: value: type: error.list - request_id: ea3a5462-0907-4e54-82f8-6032a7f99a20 + request_id: 80562f70-a220-40fd-9130-e51b37dbb5c0 errors: - code: unauthorized message: Access Token Invalid @@ -6982,7 +7096,7 @@ paths: API plan restricted: value: type: error.list - request_id: 65ff9029-b3cf-48ef-a0ef-475163d54770 + request_id: d7706cbe-9160-4265-9d7d-d2c09f5ceea8 errors: - code: api_plan_restricted message: Active subscription needed. @@ -6999,7 +7113,7 @@ paths: value: from: type: user - id: 649c557f85b35b2332e7f0bc + id: 64bfd44976af8e7a749aa956 body: heyy referer: https://twitter.com/bob lead_message_created: @@ -7007,7 +7121,7 @@ paths: value: from: type: lead - id: 649c558085b35b2332e7f0bd + id: 64bfd44a76af8e7a749aa957 body: heyy referer: https://twitter.com/bob admin_message_created: @@ -7015,10 +7129,10 @@ paths: value: from: type: admin - id: '991266510' + id: '991266503' to: type: user - id: 649c558285b35b2332e7f0be + id: 64bfd44c76af8e7a749aa958 message_type: conversation body: heyy no_body_supplied_for_message: @@ -7026,19 +7140,19 @@ paths: value: from: type: admin - id: '991266511' + id: '991266504' to: type: user - id: 649c558385b35b2332e7f0bf + id: 64bfd44d76af8e7a749aa959 message_type: inapp - body: + body: subject: heyy no_subject_supplied_for_email_message: summary: No subject supplied for email message value: from: type: admin - id: '991266512' + id: '991266505' to: type: user user_id: '70' @@ -7049,12 +7163,12 @@ paths: value: from: type: admin - id: '991266513' + id: '991266506' to: type: user - id: 649c558485b35b2332e7f0c1 + id: 64bfd44e76af8e7a749aa95b message_type: email - body: + body: subject: heyy "/news/news_items": get: @@ -7083,41 +7197,41 @@ paths: total_pages: 1 type: pages data: - - id: '394519' + - id: '397546' type: news-item - workspace_id: this_is_an_id430_that_should_be_at_least_ + workspace_id: this_is_an_id433_that_should_be_at_least_ title: We have news body: "

    Hello there,

    " - sender_id: 991266520 + sender_id: 991266511 state: draft labels: [] - cover_image_url: + cover_image_url: reactions: - - - - - - - - + - + - + - + - deliver_silently: false - created_at: 1687967110 - updated_at: 1687967110 + created_at: 1690293329 + updated_at: 1690293329 newsfeed_assignments: [] - - id: '394520' + - id: '397547' type: news-item - workspace_id: this_is_an_id430_that_should_be_at_least_ + workspace_id: this_is_an_id433_that_should_be_at_least_ title: We have news body: "

    Hello there,

    " - sender_id: 991266518 + sender_id: 991266513 state: draft labels: [] - cover_image_url: + cover_image_url: reactions: - - - - - - - - + - + - + - + - deliver_silently: false - created_at: 1687967110 - updated_at: 1687967110 + created_at: 1690293329 + updated_at: 1690293329 newsfeed_assignments: [] total_count: 2 schema: @@ -7130,7 +7244,7 @@ paths: Unauthorized: value: type: error.list - request_id: c0eb3905-7841-435d-8054-9b2d8b67598f + request_id: 7f5bc77c-1ce3-4be2-80ab-0bbdc4e5c82f errors: - code: unauthorized message: Access Token Invalid @@ -7155,26 +7269,26 @@ paths: examples: successful: value: - id: '395532' + id: '397550' type: news-item - workspace_id: this_is_an_id434_that_should_be_at_least_ + workspace_id: this_is_an_id437_that_should_be_at_least_ title: Halloween is here! body: "

    New costumes in store for this spooky season

    " - sender_id: 991266527 + sender_id: 991266520 state: live labels: - New - Product - Update - cover_image_url: + cover_image_url: reactions: - "\U0001F606" - "\U0001F605" deliver_silently: true - created_at: 1687967113 - updated_at: 1687967113 + created_at: 1690293332 + updated_at: 1690293332 newsfeed_assignments: - - newsfeed_id: 400575 + - newsfeed_id: 402593 published_at: 1664638214 schema: "$ref": "#/components/schemas/news_item" @@ -7186,7 +7300,7 @@ paths: Unauthorized: value: type: error.list - request_id: 86d6ec6f-ea76-4d03-a6fc-608cb9ce0fcb + request_id: d75b7248-7dab-4365-af88-385305c4cfb5 errors: - code: unauthorized message: Access Token Invalid @@ -7207,14 +7321,14 @@ paths: - Product - Update - New - sender_id: 991266527 + sender_id: 991266520 deliver_silently: true reactions: - "\U0001F606" - "\U0001F605" state: live newsfeed_assignments: - - newsfeed_id: 400575 + - newsfeed_id: 402593 published_at: 1664638214 "/news/news_items/{id}": get: @@ -7243,26 +7357,26 @@ paths: examples: successful: value: - id: '395533' + id: '397551' type: news-item - workspace_id: this_is_an_id438_that_should_be_at_least_ + workspace_id: this_is_an_id441_that_should_be_at_least_ title: We have news body: "

    Hello there,

    " - sender_id: 991266530 + sender_id: 991266523 state: live labels: [] - cover_image_url: + cover_image_url: reactions: - - - - - - - - + - + - + - + - deliver_silently: false - created_at: 1687967115 - updated_at: 1687967115 + created_at: 1690293333 + updated_at: 1690293333 newsfeed_assignments: - - newsfeed_id: 399568 - published_at: 1687967115 + - newsfeed_id: 402595 + published_at: 1690293334 schema: "$ref": "#/components/schemas/news_item" '404': @@ -7273,7 +7387,7 @@ paths: News Item Not Found: value: type: error.list - request_id: 3bb5c3de-2966-4f27-b306-5cddfde114f5 + request_id: 52fc5474-35a3-49a0-b197-76e9cfce340a errors: - code: not_found message: Resource Not Found @@ -7287,7 +7401,7 @@ paths: Unauthorized: value: type: error.list - request_id: 37cc0052-3ab0-46c4-a6dc-81fad70fc043 + request_id: 62fe8245-2074-4212-bdd9-c99cfd525a65 errors: - code: unauthorized message: Access Token Invalid @@ -7318,21 +7432,21 @@ paths: examples: successful: value: - id: '395536' + id: '397554' type: news-item - workspace_id: this_is_an_id444_that_should_be_at_least_ + workspace_id: this_is_an_id447_that_should_be_at_least_ title: Christmas is here! body: "

    New gifts in store for the jolly season

    " - sender_id: 991266538 + sender_id: 991266531 state: live labels: [] - cover_image_url: + cover_image_url: reactions: - "\U0001F61D" - "\U0001F602" deliver_silently: false - created_at: 1687967117 - updated_at: 1687967117 + created_at: 1690293339 + updated_at: 1690293341 newsfeed_assignments: [] schema: "$ref": "#/components/schemas/news_item" @@ -7344,7 +7458,7 @@ paths: News Item Not Found: value: type: error.list - request_id: 9b32336c-5a1e-47d9-9821-767bdadea4d8 + request_id: 5f5ca227-4987-4478-87ee-e427aa778a35 errors: - code: not_found message: Resource Not Found @@ -7358,7 +7472,7 @@ paths: Unauthorized: value: type: error.list - request_id: a4e493bc-e5a0-4c3f-9674-888d30421428 + request_id: 17ce04bd-88cb-449d-a60f-394729a0ae74 errors: - code: unauthorized message: Access Token Invalid @@ -7375,7 +7489,7 @@ paths: value: title: Christmas is here! body: "

    New gifts in store for the jolly season

    " - sender_id: 991266538 + sender_id: 991266531 reactions: - "\U0001F61D" - "\U0001F602" @@ -7384,7 +7498,7 @@ paths: value: title: Christmas is here! body: "

    New gifts in store for the jolly season

    " - sender_id: 991266541 + sender_id: 991266534 reactions: - "\U0001F61D" - "\U0001F602" @@ -7414,7 +7528,7 @@ paths: examples: successful: value: - id: '395539' + id: '397557' object: news-item deleted: true schema: @@ -7427,7 +7541,7 @@ paths: News Item Not Found: value: type: error.list - request_id: 8ab9b84a-4372-4f01-88a9-6e7174cdcb36 + request_id: 3cadb7aa-32dd-4a2a-ab88-a9d3f4e2e3c3 errors: - code: not_found message: Resource Not Found @@ -7441,7 +7555,7 @@ paths: Unauthorized: value: type: error.list - request_id: a1458538-82a9-4e3d-9f80-4900b280e397 + request_id: 485b4bc2-34c8-47d4-86b9-f6c1d56a947c errors: - code: unauthorized message: Access Token Invalid @@ -7494,7 +7608,7 @@ paths: Unauthorized: value: type: error.list - request_id: 60a0849d-c84a-4b34-9db8-aa639b2cd440 + request_id: 0d54de45-aad2-4f9a-bc8e-46b9935d24e9 errors: - code: unauthorized message: Access Token Invalid @@ -7527,16 +7641,16 @@ paths: total_pages: 1 type: pages data: - - id: '400590' + - id: '402608' type: newsfeed name: Visitor Feed - created_at: 1687967125 - updated_at: 1687967125 - - id: '399582' + created_at: 1690293348 + updated_at: 1690293348 + - id: '402609' type: newsfeed name: Visitor Feed - created_at: 1687967125 - updated_at: 1687967125 + created_at: 1690293348 + updated_at: 1690293348 total_count: 2 schema: "$ref": "#/components/schemas/paginated_response" @@ -7548,7 +7662,7 @@ paths: Unauthorized: value: type: error.list - request_id: bf50a0d1-6576-46c7-a07c-3d35a9ad8553 + request_id: 451b90dd-c0de-4b9b-90d2-ceeedd72f75d errors: - code: unauthorized message: Access Token Invalid @@ -7582,11 +7696,11 @@ paths: examples: successful: value: - id: '400594' + id: '402612' type: newsfeed name: Visitor Feed - created_at: 1687967126 - updated_at: 1687967126 + created_at: 1690293350 + updated_at: 1690293350 schema: "$ref": "#/components/schemas/newsfeed" '401': @@ -7597,7 +7711,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9b550bb9-85ce-47de-bb45-c4bb671ac23e + request_id: 695974d4-d224-4d04-8764-288147382e39 errors: - code: unauthorized message: Access Token Invalid @@ -7631,16 +7745,16 @@ paths: Note found: value: type: note - id: '401602' - created_at: 1687275931 + id: '404629' + created_at: 1689602157 contact: type: contact - id: 649c559b85b35b2332e7f0cc + id: 64bfd46d76af8e7a749aa966 author: type: admin - id: '991266557' - name: Ciaran285 Lee - email: admin285@email.com + id: '991266550' + name: Ciaran276 Lee + email: admin276@email.com away_mode_enabled: false away_mode_reassign: false body: "

    This is a note.

    " @@ -7654,7 +7768,7 @@ paths: Note not found: value: type: error.list - request_id: f2208aec-0a54-400b-b8b1-0cc2b350388c + request_id: 7672180a-6c6e-4a75-9123-7513b0018666 errors: - code: not_found message: Resource Not Found @@ -7668,7 +7782,7 @@ paths: Unauthorized: value: type: error.list - request_id: 1e9242c4-736b-4581-96ee-648376042295 + request_id: 92005cb4-d883-4bbf-bcfb-3923882398e7 errors: - code: unauthorized message: Access Token Invalid @@ -7704,16 +7818,16 @@ paths: type: segment.list segments: - type: segment - id: 649c55a185b35b2332e7f0d4 - name: Jane segment - created_at: 1687967137 - updated_at: 1687967137 + id: 64bfd47376af8e7a749aa96d + name: John segment + created_at: 1690293363 + updated_at: 1690293363 person_type: user - type: segment - id: 649c55a185b35b2332e7f0d3 - name: John segment - created_at: 1687967137 - updated_at: 1687967137 + id: 64bfd47376af8e7a749aa96e + name: Jane segment + created_at: 1690293363 + updated_at: 1690293363 person_type: user schema: "$ref": "#/components/schemas/segment_list" @@ -7725,7 +7839,7 @@ paths: Unauthorized: value: type: error.list - request_id: 6284b9c1-1a67-460b-9499-209ded59e8ac + request_id: fb4f052f-b745-4450-afa1-f1964d93fff9 errors: - code: unauthorized message: Access Token Invalid @@ -7759,10 +7873,10 @@ paths: Successful response: value: type: segment - id: 649c55a285b35b2332e7f0d7 + id: 64bfd47576af8e7a749aa971 name: John segment - created_at: 1687967138 - updated_at: 1687967138 + created_at: 1690293365 + updated_at: 1690293365 person_type: user schema: "$ref": "#/components/schemas/segment" @@ -7774,7 +7888,7 @@ paths: Segment not found: value: type: error.list - request_id: c9bfdc95-504f-4024-9b79-02f575bfd7e3 + request_id: b681117b-68ce-46c0-b291-d8dd38713dcc errors: - code: not_found message: Resource Not Found @@ -7788,7 +7902,7 @@ paths: Unauthorized: value: type: error.list - request_id: 88084650-c677-47ff-bc32-13c498147114 + request_id: 98acbae5-0dad-4530-9843-6e2ffe5230d1 errors: - code: unauthorized message: Access Token Invalid @@ -7818,7 +7932,7 @@ paths: type: list data: - type: subscription - id: '437950' + id: '439968' state: live consent_type: opt_out default_translation: @@ -7841,7 +7955,7 @@ paths: Unauthorized: value: type: error.list - request_id: 95ebcb6f-3b1c-4e74-ba5f-2a82c6f523f5 + request_id: 03dda41c-1546-45f9-b7d1-45a696953c6d errors: - code: unauthorized message: Access Token Invalid @@ -7871,7 +7985,7 @@ paths: examples: successful: value: - url: http://via.intercom.io/msgr/ea4e2d8a-e1c2-4d20-a701-5ffcf077ad82 + url: http://via.intercom.io/msgr/d29e1243-87d5-4b85-8ef4-881509efa310 type: phone_call_redirect schema: "$ref": "#/components/schemas/phone_switch" @@ -7904,7 +8018,7 @@ paths: Unauthorized: value: type: error.list - request_id: a041ad85-8f1f-43d0-939e-f9c8369437c0 + request_id: 2d3a428c-9ac8-40cf-8d76-574f02cd7887 errors: - code: unauthorized message: Access Token Invalid @@ -7967,7 +8081,7 @@ paths: type: list data: - type: tag - id: '318876' + id: '320894' name: Manual tag 1 schema: "$ref": "#/components/schemas/tag_list" @@ -7979,7 +8093,7 @@ paths: Unauthorized: value: type: error.list - request_id: cf7ea691-f365-4fe2-ac86-414b97989e1f + request_id: 14ce65b9-1565-421d-a99a-6f6d5a34f343 errors: - code: unauthorized message: Access Token Invalid @@ -8018,7 +8132,7 @@ paths: Action successful: value: type: tag - id: '318879' + id: '320897' name: test schema: "$ref": "#/components/schemas/tag" @@ -8030,7 +8144,7 @@ paths: Invalid parameters: value: type: error.list - request_id: ae4ab2d5-e1ad-441b-b0c3-85216625cb93 + request_id: ab9f0026-54a2-439d-8217-79d5ce460d2d errors: - code: parameter_invalid message: invalid tag parameters @@ -8044,14 +8158,14 @@ paths: Company not found: value: type: error.list - request_id: fb333542-e005-4f6f-b0d8-9f65866dab2a + request_id: fe3d6657-1b30-4219-b798-007dcc71bdf4 errors: - code: company_not_found message: Company Not Found User not found: value: type: error.list - request_id: 3ca9a828-1a77-4eef-94d1-2c0d35190d3a + request_id: 97e8b34f-92c3-45bd-9379-9fc4178c3810 errors: - code: not_found message: User Not Found @@ -8065,7 +8179,7 @@ paths: Unauthorized: value: type: error.list - request_id: c45b432d-3ab0-42a7-b7eb-bc5275944582 + request_id: b9a9a295-29b6-401a-b584-cccc5547528d errors: - code: unauthorized message: Access Token Invalid @@ -8131,7 +8245,7 @@ paths: Tag found: value: type: tag - id: '318887' + id: '320905' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -8143,7 +8257,7 @@ paths: Tag not found: value: type: error.list - request_id: 0fba7229-6c33-454d-bcaa-7e6584093a28 + request_id: be0df518-e2cc-41b6-a49b-e7a879c81ddf errors: - code: not_found message: Resource Not Found @@ -8157,7 +8271,7 @@ paths: Unauthorized: value: type: error.list - request_id: dc95358c-f98a-4e34-96c0-91ce8987c02a + request_id: 19057eed-28ae-420f-8f9f-814846c3d1fa errors: - code: unauthorized message: Access Token Invalid @@ -8193,7 +8307,7 @@ paths: Resource not found: value: type: error.list - request_id: 544febe9-1f08-46ef-a81b-087aa0e553a4 + request_id: 958e8d0e-0137-47f9-ac27-167e9279d860 errors: - code: not_found message: Resource Not Found @@ -8207,7 +8321,7 @@ paths: Tag has dependent objects: value: type: error.list - request_id: 7d22234d-0401-4730-9bc8-5aded7194084 + request_id: 91684658-94b1-44f8-9888-cef049b17423 errors: - code: tag_has_dependent_objects message: 'Unable to delete Tag with dependent objects. Segments: @@ -8222,7 +8336,7 @@ paths: Unauthorized: value: type: error.list - request_id: 232bc7f8-fab2-41fd-92fb-246fe9228e2d + request_id: fd86947f-6895-43f6-acfc-6ae0be5eb16f errors: - code: unauthorized message: Access Token Invalid @@ -8260,7 +8374,7 @@ paths: Unauthorized: value: type: error.list - request_id: ff7abb53-b453-4ccb-ba0e-b232abb7539e + request_id: 8ef0b1cd-dc60-449b-a69a-12b645490731 errors: - code: unauthorized message: Access Token Invalid @@ -8295,7 +8409,7 @@ paths: successful: value: type: team - id: '991266601' + id: '991266594' name: team 1 admin_ids: [] schema: @@ -8308,7 +8422,7 @@ paths: Team not found: value: type: error.list - request_id: f9c41c29-ccfd-4c8f-b158-6bc8539a2633 + request_id: bff117cb-9404-4fec-86b0-ab8831ae2ecd errors: - code: team_not_found message: Team not found @@ -8322,7 +8436,7 @@ paths: Unauthorized: value: type: error.list - request_id: 76a5d0e8-6a88-4bfb-adf4-e6b749709745 + request_id: 4afe5a4b-aa86-4250-b4fd-4420e91e8908 errors: - code: unauthorized message: Access Token Invalid @@ -8355,8 +8469,8 @@ paths: Ticket Type Attribute created: value: type: ticket_type_attribute - id: '163476' - workspace_id: this_is_an_id536_that_should_be_at_least_ + id: '164486' + workspace_id: this_is_an_id539_that_should_be_at_least_ name: Attribute Title description: Attribute Description data_type: string @@ -8368,10 +8482,10 @@ paths: visible_on_create: true visible_to_contacts: true default: false - ticket_type_id: 763813 + ticket_type_id: 765832 archived: false - created_at: 1687967172 - updated_at: 1687967172 + created_at: 1690293397 + updated_at: 1690293397 schema: "$ref": "#/components/schemas/ticket_type_attribute" '401': @@ -8382,7 +8496,7 @@ paths: Unauthorized: value: type: error.list - request_id: f99554ee-6599-411c-aaa2-2f6e898f13bf + request_id: a636eb92-3e95-4dc5-8b3b-110c22cbf1b9 errors: - code: unauthorized message: Access Token Invalid @@ -8435,8 +8549,8 @@ paths: Ticket Type Attribute updated: value: type: ticket_type_attribute - id: '163477' - workspace_id: this_is_an_id540_that_should_be_at_least_ + id: '164487' + workspace_id: this_is_an_id543_that_should_be_at_least_ name: name description: New Attribute Description data_type: string @@ -8446,10 +8560,10 @@ paths: visible_on_create: false visible_to_contacts: false default: false - ticket_type_id: 763815 + ticket_type_id: 765834 archived: false - created_at: 1687967173 - updated_at: 1687967173 + created_at: 1690293398 + updated_at: 1690293399 schema: "$ref": "#/components/schemas/ticket_type_attribute" '401': @@ -8460,7 +8574,7 @@ paths: Unauthorized: value: type: error.list - request_id: 48a16966-b189-49c6-b499-abac47ffc8a3 + request_id: 32915537-18fc-4d28-aaee-caf61528d9de errors: - code: unauthorized message: Access Token Invalid @@ -8498,35 +8612,36 @@ paths: type: list data: - type: ticket_type - id: '763817' + id: '765836' name: Bug Report description: Bug Report Template icon: "\U0001F39F️" - workspace_id: this_is_an_id544_that_should_be_at_least_ + workspace_id: this_is_an_id547_that_should_be_at_least_ archived: false - created_at: 1687967174 - updated_at: 1687967174 + created_at: 1690293400 + updated_at: 1690293400 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '163478' - workspace_id: this_is_an_id544_that_should_be_at_least_ + id: '164488' + workspace_id: this_is_an_id547_that_should_be_at_least_ name: name description: description data_type: string - input_options: + 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: 763817 + ticket_type_id: 765836 archived: false - created_at: 1687967174 - updated_at: 1687967174 + created_at: 1690293400 + updated_at: 1690293400 + category: Customer schema: "$ref": "#/components/schemas/ticket_type_list" '401': @@ -8537,7 +8652,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2d1bec39-3f2c-48ea-899c-54b5be91b36c + request_id: d5a01c18-ea6f-4248-861b-b11003553e57 errors: - code: unauthorized message: Access Token Invalid @@ -8565,18 +8680,19 @@ paths: Ticket type created: value: type: ticket_type - id: '763820' + id: '765839' name: Customer Issue description: Customer Report Template icon: "\U0001F39F️" - workspace_id: this_is_an_id548_that_should_be_at_least_ + workspace_id: this_is_an_id551_that_should_be_at_least_ archived: false - created_at: 1687967176 - updated_at: 1687967176 + created_at: 1690293402 + updated_at: 1690293402 is_internal: false ticket_type_attributes: type: list data: [] + category: Customer schema: "$ref": "#/components/schemas/ticket_type" '401': @@ -8587,7 +8703,7 @@ paths: Unauthorized: value: type: error.list - request_id: 23eea240-6e65-47c7-8312-6f65cef13b37 + request_id: 592aa35e-56a3-4ecf-b924-ba6e173389a4 errors: - code: unauthorized message: Access Token Invalid @@ -8605,6 +8721,7 @@ paths: name: Customer Issue description: Customer Report Template icon: "\U0001F39F️" + category: Customer "/ticket_types/{id}": get: summary: Retrieve a ticket type @@ -8617,6 +8734,7 @@ paths: in: path required: true description: The unique identifier for the ticket type which is given by Intercom. + category: Category of the Ticket Type. schema: type: string tags: @@ -8631,35 +8749,36 @@ paths: Ticket type found: value: type: ticket_type - id: '763822' + id: '765841' name: Bug Report description: Bug Report Template icon: "\U0001F39F️" - workspace_id: this_is_an_id552_that_should_be_at_least_ + workspace_id: this_is_an_id555_that_should_be_at_least_ archived: false - created_at: 1687967177 - updated_at: 1687967177 + created_at: 1690293403 + updated_at: 1690293403 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '163482' - workspace_id: this_is_an_id552_that_should_be_at_least_ + id: '164492' + workspace_id: this_is_an_id555_that_should_be_at_least_ name: name description: description data_type: string - input_options: + 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: 763822 + ticket_type_id: 765841 archived: false - created_at: 1687967177 - updated_at: 1687967177 + created_at: 1690293403 + updated_at: 1690293403 + category: Customer schema: "$ref": "#/components/schemas/ticket_type" '401': @@ -8670,7 +8789,7 @@ paths: Unauthorized: value: type: error.list - request_id: c4be6d89-7d86-4b6b-a1c7-c8cb5cdc30a3 + request_id: dfc2c052-885d-45f3-89e4-2cbcc56befaf errors: - code: unauthorized message: Access Token Invalid @@ -8687,6 +8806,7 @@ paths: in: path required: true description: The unique identifier for the ticket type which is given by Intercom. + category: Category of the Ticket Type. schema: type: string tags: @@ -8702,35 +8822,36 @@ paths: Ticket type updated: value: type: ticket_type - id: '763824' + id: '765843' name: Bug Report 2 description: Bug Report Template icon: "\U0001F39F️" - workspace_id: this_is_an_id556_that_should_be_at_least_ + workspace_id: this_is_an_id559_that_should_be_at_least_ archived: false - created_at: 1687967178 - updated_at: 1687967179 + created_at: 1690293404 + updated_at: 1690293405 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '163484' - workspace_id: this_is_an_id556_that_should_be_at_least_ + id: '164494' + workspace_id: this_is_an_id559_that_should_be_at_least_ name: name description: description data_type: string - input_options: + 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: 763824 + ticket_type_id: 765843 archived: false - created_at: 1687967178 - updated_at: 1687967178 + created_at: 1690293404 + updated_at: 1690293404 + category: Customer schema: "$ref": "#/components/schemas/ticket_type" '401': @@ -8741,7 +8862,7 @@ paths: Unauthorized: value: type: error.list - request_id: f49ee358-8860-4331-9571-a43cf16c45e8 + request_id: 919128b3-e7cb-416c-b807-ff16b93be4a8 errors: - code: unauthorized message: Access Token Invalid @@ -8757,56 +8878,105 @@ paths: summary: Ticket type updated value: name: Bug Report 2 - "/tickets/{ticket_id}/reply": - parameters: - - name: ticket_id - in: path - description: ticket_id - required: true - schema: - type: string + "/tickets/{id}/reply": post: - summary: Create a ticket reply + summary: Reply to a ticket + operationId: replyTicket + description: You can reply to a ticket with a message from an admin or on behalf + of a contact, or with a note for admins. parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: ticket_id + - name: id in: path required: true - description: The unique identifier for the ticket which is given by Intercom schema: + title: Ticket ID type: string + description: The id of the ticket to target. + example: '123' tags: - Tickets - description: "You can create a new ticket reply. Only note is supported as a - ticket reply type at the moment.\n> \U0001F4D8 Creating ticket notes.\n>\n> - All tickets have the same internal notes functionality as conversations so - teammates can discuss and resolve the customer request internally.\n" responses: '200': - description: Successful response + description: Admin quick_reply reply content: application/json: examples: - Successful response: + User reply: + value: + type: ticket_part + id: '710364' + part_type: comment + body: "

    Thanks again :)

    " + created_at: 1690293408 + updated_at: 1690293408 + author: + id: 64bfd4a076af8e7a749aa9a0 + type: user + name: + email: user28@email.com + attachments: [] + redacted: false + Admin note reply: value: type: ticket_part - id: '708344' + id: '710366' part_type: note - body: "

    This is a body

    " - created_at: 1687967182 - updated_at: 1687967182 + body: |- +

    An Unordered HTML List

    + +

    An Ordered HTML List

    +
      +
    1. Coffee
      2. +
    2. Tea
      3. +
    3. Milk
      4. +
    + created_at: 1690293411 + updated_at: 1690293411 + author: + id: '991266621' + type: admin + name: Ciaran341 Lee + email: admin341@email.com + attachments: [] + redacted: false + Admin quick_reply reply: + value: + type: ticket_part + id: '710368' + part_type: quick_reply + created_at: 1690293414 + updated_at: 1690293414 author: - id: '991266623' + id: '991266626' type: admin - name: Ciaran346 Lee - email: admin346@email.com + name: Ciaran345 Lee + email: admin345@email.com attachments: [] redacted: false schema: - "$ref": "#/components/schemas/ticket_note" + "$ref": "#/components/schemas/ticket_reply" + '404': + description: Not found + content: + application/json: + examples: + Not found: + value: + type: error.list + request_id: d403bb05-1451-4f46-9c01-e38928364cfd + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" '401': description: Unauthorized content: @@ -8815,7 +8985,7 @@ paths: Unauthorized: value: type: error.list - request_id: 306d610c-210a-47d7-8622-1439a37ed682 + request_id: a321980a-2d11-43a7-88e9-ae0644296974 errors: - code: unauthorized message: Access Token Invalid @@ -8827,109 +8997,335 @@ paths: schema: "$ref": "#/components/schemas/create_ticket_reply_request" examples: - successful_response: - summary: Successful response + user_reply: + summary: User reply + value: + message_type: comment + type: user + intercom_user_id: 64bfd4a076af8e7a749aa9a0 + body: Thanks again :) + admin_note_reply: + summary: Admin note reply value: - body: This is a body - admin_id: 991266623 message_type: note - "/tickets": + type: admin + admin_id: 991266621 + body: "

    An Unordered HTML List

    An Ordered HTML List

    + \
    1. Coffee
    2. Tea
    3. Milk
    + \ " + admin_quick_reply_reply: + summary: Admin quick_reply reply + value: + message_type: quick_reply + type: admin + admin_id: 991266626 + reply_options: + - text: 'Yes' + uuid: 34829d34-5a40-4587-806b-1d7672e98d4f + - text: 'No' + uuid: c2c0428c-0b80-4397-af0e-b25f5f5997ca + not_found: + summary: Not found + value: + message_type: comment + type: user + intercom_user_id: 64bfd4a776af8e7a749aa9a3 + body: Thanks again :) + "/tickets/{ticket_id}/tags": post: - summary: Create a ticket + 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 tags: + - Tags - Tickets - description: You can create a new ticket. + operationId: attachTagToTicket + description: You can tag a specific ticket. This will return a tag object for + the tag that was added to the ticket. responses: '200': - description: Successful response + description: successful content: application/json: examples: - Successful response: + successful: value: - type: ticket - id: '712499' - ticket_attributes: - title: example - description: there is a problem - ticket_state: submitted - ticket_type: - type: ticket_type - id: '763828' - name: my-ticket-type-3 - description: my ticket type description is awesome. - icon: "\U0001F981" - workspace_id: this_is_an_id564_that_should_be_at_least_ - archived: false - created_at: 1687967185 - updated_at: 1687967185 - is_internal: false - ticket_type_attributes: - type: list - data: - - type: ticket_type_attribute - id: '163490' - workspace_id: this_is_an_id564_that_should_be_at_least_ + type: tag + id: '320913' + name: Manual tag + schema: + "$ref": "#/components/schemas/tag" + '404': + description: Ticket not found + content: + application/json: + examples: + Ticket not found: + value: + type: error.list + request_id: a04408e6-c836-4cde-b53a-fc744f9ff432 + errors: + - code: ticket_not_found + message: Ticket not found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 65fefd99-ad75-4bb8-9d2e-3c2f5ee9fc34 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + type: object + required: + - id + - admin_id + properties: + id: + type: string + description: The unique identifier for the tag which is given by + Intercom + example: '7522907' + admin_id: + type: string + description: The unique identifier for the admin which is given + by Intercom. + example: '780' + examples: + successful: + summary: successful + value: + id: 320913 + admin_id: 991266636 + ticket_not_found: + summary: Ticket not found + value: + id: 320914 + admin_id: 991266639 + "/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 + tags: + - 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. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: tag + id: '320916' + name: Manual tag + schema: + "$ref": "#/components/schemas/tag" + '404': + description: Tag not found + content: + application/json: + examples: + Ticket not found: + value: + type: error.list + request_id: 8eefb9b0-65f5-4cd9-be99-432b8c086126 + errors: + - code: ticket_not_found + message: Ticket not found + Tag not found: + value: + type: error.list + request_id: 746ef2fc-44ff-4e6e-9cb1-756df5411197 + errors: + - code: tag_not_found + message: Tag not found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: e2202857-b15d-4add-855b-cb0c357a1ade + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + type: object + required: + - admin_id + properties: + admin_id: + type: string + description: The unique identifier for the admin which is given + by Intercom. + example: '123' + examples: + successful: + summary: successful + value: + admin_id: 991266645 + ticket_not_found: + summary: Ticket not found + value: + admin_id: 991266648 + tag_not_found: + summary: Tag not found + value: + admin_id: 991266651 + "/tickets": + post: + summary: Create a ticket + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Tickets + description: You can create a new ticket. + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: ticket + id: '714526' + friendly_id: '712365' + ticket_attributes: + title: example + description: there is a problem + ticket_state: submitted + ticket_type: + type: ticket_type + id: '765857' + name: my-ticket-type-14 + description: my ticket type description is awesome. + icon: "\U0001F981" + workspace_id: this_is_an_id587_that_should_be_at_least_ + archived: false + created_at: 1690293430 + updated_at: 1690293430 + is_internal: false + ticket_type_attributes: + type: list + data: + - type: ticket_type_attribute + id: '164504' + workspace_id: this_is_an_id587_that_should_be_at_least_ name: title description: ola data_type: string - input_options: + 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: 763828 + ticket_type_id: 765857 archived: false - created_at: 1687967185 - updated_at: 1687967185 + created_at: 1690293430 + updated_at: 1690293430 - type: ticket_type_attribute - id: '163491' - workspace_id: this_is_an_id564_that_should_be_at_least_ + id: '164505' + workspace_id: this_is_an_id587_that_should_be_at_least_ name: description description: ola data_type: string - input_options: + 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: 763828 + ticket_type_id: 765857 archived: false - created_at: 1687967185 - updated_at: 1687967185 + created_at: 1690293431 + updated_at: 1690293431 + category: Back-office contacts: type: contact.list contacts: - - id: 649c55d285b35b2332e7f107 - role: user + - type: contact + id: 64bfd4b776af8e7a749aa9ac + external_id: '70' admin_assignee_id: '0' team_assignee_id: '0' - created_at: 1687967186 - updated_at: 1687967185 + created_at: 1690293431 + updated_at: 1690293430 ticket_parts: type: ticket_part.list ticket_parts: - type: ticket_part - id: '708346' + id: '710369' part_type: ticket_state_updated_by_admin ticket_state: submitted previous_ticket_state: submitted - created_at: 1687967187 - updated_at: 1687967187 + created_at: 1690293432 + updated_at: 1690293432 author: - id: '991266636' + id: '991266663' type: bot name: Operator - email: operator+this_is_an_id564_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id587_that_should_be_at_least_@intercom.io attachments: [] redacted: false total_count: 1 @@ -8939,6 +9335,8 @@ paths: data: [] total_count: 0 has_more: false + category: Back-office + is_shared: false schema: "$ref": "#/components/schemas/ticket" '401': @@ -8949,7 +9347,7 @@ paths: Unauthorized: value: type: error.list - request_id: d2682e87-6446-4e0b-894a-796367752f28 + request_id: a4ad1adc-675b-41b6-aa5b-7314c8b61c54 errors: - code: unauthorized message: Access Token Invalid @@ -8964,9 +9362,9 @@ paths: successful_response: summary: Successful response value: - ticket_type_id: 763828 + ticket_type_id: 765857 contacts: - - id: 649c55d285b35b2332e7f107 + - id: 64bfd4b776af8e7a749aa9ac ticket_attributes: title: example description: there is a problem @@ -8996,145 +9394,163 @@ paths: Successful response: value: type: ticket - id: '712500' + id: '714527' + friendly_id: '712366' ticket_attributes: title: example description: there is a problem ticket_state: in_progress ticket_type: type: ticket_type - id: '763830' - name: my-ticket-type-5 + id: '765859' + name: my-ticket-type-16 description: my ticket type description is awesome. icon: "\U0001F981" - workspace_id: this_is_an_id568_that_should_be_at_least_ + workspace_id: this_is_an_id591_that_should_be_at_least_ archived: false - created_at: 1687967190 - updated_at: 1687967190 + created_at: 1690293434 + updated_at: 1690293434 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '163495' - workspace_id: this_is_an_id568_that_should_be_at_least_ + id: '164509' + workspace_id: this_is_an_id591_that_should_be_at_least_ name: title description: ola data_type: string - input_options: + 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: 763830 + ticket_type_id: 765859 archived: false - created_at: 1687967190 - updated_at: 1687967190 + created_at: 1690293434 + updated_at: 1690293434 - type: ticket_type_attribute - id: '163496' - workspace_id: this_is_an_id568_that_should_be_at_least_ + id: '164510' + workspace_id: this_is_an_id591_that_should_be_at_least_ name: description description: ola data_type: string - input_options: + 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: 763830 + ticket_type_id: 765859 archived: false - created_at: 1687967190 - updated_at: 1687967190 + created_at: 1690293434 + updated_at: 1690293434 + category: Back-office contacts: type: contact.list contacts: - - id: 649c55d685b35b2332e7f108 - role: lead - admin_assignee_id: '991266650' + - type: contact + id: 64bfd4ba76af8e7a749aa9ad + external_id: b9145cbb-3802-408c-b3bf-62961b06b385 + admin_assignee_id: '991266677' team_assignee_id: '0' - created_at: 1687967191 - updated_at: 1687967190 + created_at: 1690293434 + updated_at: 1690293434 ticket_parts: type: ticket_part.list ticket_parts: - type: ticket_part - id: '708347' + id: '710370' part_type: ticket_state_updated_by_admin ticket_state: submitted previous_ticket_state: submitted - created_at: 1687967191 - updated_at: 1687967191 + created_at: 1690293435 + updated_at: 1690293435 author: - id: '991266648' + id: '991266675' type: admin - name: Ciaran368 Lee - email: admin368@email.com + name: Ciaran385 Lee + email: admin385@email.com attachments: [] redacted: false - type: ticket_part - id: '708348' + id: '710371' part_type: ticket_attribute_updated_by_admin - created_at: 1687967192 - updated_at: 1687967192 + created_at: 1690293436 + updated_at: 1690293436 author: - id: '991266649' + id: '991266676' type: bot name: Operator - email: operator+this_is_an_id568_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id591_that_should_be_at_least_@intercom.io attachments: [] redacted: false - type: ticket_part - id: '708349' + id: '710372' part_type: ticket_attribute_updated_by_admin - created_at: 1687967193 - updated_at: 1687967193 + created_at: 1690293436 + updated_at: 1690293436 author: - id: '991266649' + id: '991266676' type: bot name: Operator - email: operator+this_is_an_id568_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id591_that_should_be_at_least_@intercom.io attachments: [] redacted: false - type: ticket_part - id: '708350' + id: '710373' part_type: ticket_state_updated_by_admin ticket_state: in_progress previous_ticket_state: submitted - created_at: 1687967193 - updated_at: 1687967193 + created_at: 1690293436 + updated_at: 1690293436 author: - id: '991266649' + id: '991266676' type: bot name: Operator - email: operator+this_is_an_id568_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id591_that_should_be_at_least_@intercom.io attachments: [] redacted: false - type: ticket_part - id: '708351' + id: '710374' part_type: assignment - created_at: 1687967193 - updated_at: 1687967193 + created_at: 1690293437 + updated_at: 1690293437 assigned_to: type: admin - id: '991266650' + id: '991266677' author: - id: '991266648' + id: '991266675' type: admin - name: Ciaran368 Lee - email: admin368@email.com + name: Ciaran385 Lee + email: admin385@email.com attachments: [] redacted: false - total_count: 5 + - type: ticket_part + id: '710375' + part_type: snoozed + created_at: 1690293438 + updated_at: 1690293438 + author: + id: '991266676' + type: bot + name: Operator + email: operator+this_is_an_id591_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false + total_count: 6 open: true + snoozed_until: 1690387200 linked_objects: type: list data: [] total_count: 0 has_more: false + category: Back-office + is_shared: false schema: "$ref": "#/components/schemas/ticket" '404': @@ -9145,14 +9561,14 @@ paths: Admin not found: value: type: error.list - request_id: 3fe0dbf3-0613-4037-9b22-62ce6e68c170 + request_id: 9f17bf54-5199-4b8a-b38e-2034858733c0 errors: - code: assignee_not_found message: Assignee not found Assignee not found: value: type: error.list - request_id: 0b2cf7cb-0fd4-445c-9538-79ec6a5b8661 + request_id: 0771fa71-be0b-4a7d-8637-dbeeea71ab34 errors: - code: assignee_not_found message: Assignee not found @@ -9164,7 +9580,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9ec26490-7646-4c34-a5c4-065948af68cc + request_id: fd63fcfd-d91b-444d-a03b-07ce0af78794 errors: - code: unauthorized message: Access Token Invalid @@ -9184,9 +9600,10 @@ paths: description: there is a problem state: in_progress assignment: - admin_id: '991266648' - assignee_id: '991266650' + admin_id: '991266675' + assignee_id: '991266677' open: true + snoozed_until: 1673609604 admin_not_found: summary: Admin not found value: @@ -9196,7 +9613,7 @@ paths: state: in_progress assignment: admin_id: '123' - assignee_id: '991266658' + assignee_id: '991266685' assignee_not_found: summary: Assignee not found value: @@ -9205,7 +9622,7 @@ paths: description: there is a problem state: in_progress assignment: - admin_id: '991266664' + admin_id: '991266691' assignee_id: '456' get: summary: Retrieve a ticket @@ -9232,83 +9649,86 @@ paths: Ticket found: value: type: ticket - id: '712503' + id: '714530' + friendly_id: '712369' ticket_attributes: title: attribute_value - description: + description: ticket_state: submitted ticket_type: type: ticket_type - id: '763834' - name: my-ticket-type-9 + id: '765863' + name: my-ticket-type-20 description: my ticket type description is awesome. icon: "\U0001F981" - workspace_id: this_is_an_id576_that_should_be_at_least_ + workspace_id: this_is_an_id599_that_should_be_at_least_ archived: false - created_at: 1687967201 - updated_at: 1687967201 + created_at: 1690293444 + updated_at: 1690293444 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '163506' - workspace_id: this_is_an_id576_that_should_be_at_least_ + id: '164520' + workspace_id: this_is_an_id599_that_should_be_at_least_ name: title description: ola data_type: string - input_options: + 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: 763834 + ticket_type_id: 765863 archived: false - created_at: 1687967201 - updated_at: 1687967201 + created_at: 1690293444 + updated_at: 1690293444 - type: ticket_type_attribute - id: '163507' - workspace_id: this_is_an_id576_that_should_be_at_least_ + id: '164521' + workspace_id: this_is_an_id599_that_should_be_at_least_ name: description description: ola data_type: string - input_options: + 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: 763834 + ticket_type_id: 765863 archived: false - created_at: 1687967202 - updated_at: 1687967202 + created_at: 1690293444 + updated_at: 1690293444 + category: Back-office contacts: type: contact.list contacts: - - id: 649c55e285b35b2332e7f10b - role: lead + - type: contact + id: 64bfd4c476af8e7a749aa9b0 + external_id: b2c95509-73b4-49c7-82e7-f01328818e83 admin_assignee_id: '0' team_assignee_id: '0' - created_at: 1687967202 - updated_at: 1687967201 + created_at: 1690293445 + updated_at: 1690293444 ticket_parts: type: ticket_part.list ticket_parts: - type: ticket_part - id: '708354' + id: '710378' part_type: ticket_state_updated_by_admin ticket_state: submitted previous_ticket_state: submitted - created_at: 1687967203 - updated_at: 1687967203 + created_at: 1690293445 + updated_at: 1690293445 author: - id: '991266677' + id: '991266704' type: admin - name: Ciaran394 Lee - email: admin394@email.com + name: Ciaran411 Lee + email: admin411@email.com attachments: [] redacted: false total_count: 1 @@ -9318,6 +9738,8 @@ paths: data: [] total_count: 0 has_more: false + category: Back-office + is_shared: false schema: "$ref": "#/components/schemas/ticket" '401': @@ -9328,7 +9750,7 @@ paths: Unauthorized: value: type: error.list - request_id: e97e42b0-1790-4110-90a6-a1459e1e1fb5 + request_id: 9d803d71-acfb-4446-8ed9-2d795e3c2580 errors: - code: unauthorized message: Access Token Invalid @@ -9391,83 +9813,86 @@ paths: total_count: 1 tickets: - type: ticket - id: '712504' + id: '714531' + friendly_id: '712370' ticket_attributes: title: attribute_value - description: + description: ticket_state: submitted ticket_type: type: ticket_type - id: '763836' - name: my-ticket-type-11 + id: '765865' + name: my-ticket-type-22 description: my ticket type description is awesome. icon: "\U0001F981" - workspace_id: this_is_an_id580_that_should_be_at_least_ + workspace_id: this_is_an_id603_that_should_be_at_least_ archived: false - created_at: 1687967206 - updated_at: 1687967206 + created_at: 1690293447 + updated_at: 1690293447 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '163511' - workspace_id: this_is_an_id580_that_should_be_at_least_ + id: '164525' + workspace_id: this_is_an_id603_that_should_be_at_least_ name: title description: ola data_type: string - input_options: + 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: 763836 + ticket_type_id: 765865 archived: false - created_at: 1687967206 - updated_at: 1687967206 + created_at: 1690293448 + updated_at: 1690293448 - type: ticket_type_attribute - id: '163512' - workspace_id: this_is_an_id580_that_should_be_at_least_ + id: '164526' + workspace_id: this_is_an_id603_that_should_be_at_least_ name: description description: ola data_type: string - input_options: + 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: 763836 + ticket_type_id: 765865 archived: false - created_at: 1687967206 - updated_at: 1687967206 + created_at: 1690293448 + updated_at: 1690293448 + category: Back-office contacts: type: contact.list contacts: - - id: 649c55e785b35b2332e7f10c - role: lead + - type: contact + id: 64bfd4c876af8e7a749aa9b1 + external_id: d3e6eb50-1b56-4f26-a6ea-19a486099e1d admin_assignee_id: '0' team_assignee_id: '0' - created_at: 1687967207 - updated_at: 1687967206 + created_at: 1690293449 + updated_at: 1690293447 ticket_parts: type: ticket_part.list ticket_parts: - type: ticket_part - id: '708355' + id: '710379' part_type: ticket_state_updated_by_admin ticket_state: submitted previous_ticket_state: submitted - created_at: 1687967208 - updated_at: 1687967208 + created_at: 1690293449 + updated_at: 1690293449 author: - id: '991266690' + id: '991266717' type: admin - name: Ciaran406 Lee - email: admin406@email.com + name: Ciaran423 Lee + email: admin423@email.com attachments: [] redacted: false total_count: 1 @@ -9477,6 +9902,8 @@ paths: data: [] total_count: 0 has_more: false + category: Back-office + is_shared: false schema: "$ref": "#/components/schemas/ticket_list" requestBody: @@ -9493,15 +9920,15 @@ paths: value: - field: id operator: "=" - value: '712504' + value: '714531' - operator: OR value: - field: id operator: "=" - value: '712504' + value: '714531' - field: id operator: "=" - value: '712504' + value: '714531' "/visitors": put: summary: Update a visitor @@ -9528,31 +9955,31 @@ paths: successful: value: type: visitor - id: 649c563485b35b2332e7f1f8 + id: 64bfd51c76af8e7a749aaa9d user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' - phone: + phone: name: Gareth Bale - pseudonym: Orange Fish + pseudonym: Silver Birdhouse avatar: type: avatar - image_url: https://static.intercomassets.com/app/pseudonym_avatars_2019/orange-fish.png - app_id: this_is_an_id585_that_should_be_at_least_ + image_url: https://static.intercomassets.com/app/pseudonym_avatars_2019/silver-birdhouse.png + app_id: this_is_an_id607_that_should_be_at_least_ companies: type: company.list companies: [] location_data: {} - last_request_at: - created_at: 1687967284 - remote_created_at: 1687967284 - signed_up_at: 1687967284 - updated_at: 1687967284 + last_request_at: + created_at: 1690293532 + remote_created_at: 1690293532 + signed_up_at: 1690293532 + updated_at: 1690293533 session_count: 0 social_profiles: type: social_profile.list social_profiles: [] - owner_id: + owner_id: unsubscribed_from_emails: false marked_email_as_spam: false has_hard_bounced: false @@ -9563,13 +9990,13 @@ paths: type: segment.list segments: [] custom_attributes: {} - referrer: - utm_campaign: - utm_content: - utm_medium: - utm_source: - utm_term: - do_not_track: + referrer: + utm_campaign: + utm_content: + utm_medium: + utm_source: + utm_term: + do_not_track: schema: "$ref": "#/components/schemas/visitor" '404': @@ -9580,7 +10007,7 @@ paths: visitor Not Found: value: type: error.list - request_id: 7f25c0f1-c8cf-4196-b27a-e042b102f9ca + request_id: f1db4464-39b5-4efe-85be-903fe7a56208 errors: - code: not_found message: Visitor Not Found @@ -9594,7 +10021,7 @@ paths: Unauthorized: value: type: error.list - request_id: 554865a5-3569-4247-b0d0-2a941c1bcebd + request_id: 41731821-63e7-472f-a42a-84a27aca58d6 errors: - code: unauthorized message: Access Token Invalid @@ -9609,7 +10036,7 @@ paths: successful: summary: successful value: - id: 649c563485b35b2332e7f1f8 + id: 64bfd51c76af8e7a749aaa9d name: Gareth Bale visitor_not_found: summary: visitor Not Found @@ -9642,31 +10069,31 @@ paths: successful: value: type: visitor - id: 649c563685b35b2332e7f1fb + id: 64bfd51f76af8e7a749aaaa0 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' - phone: - name: - pseudonym: + phone: + name: + pseudonym: avatar: type: avatar - image_url: - app_id: this_is_an_id590_that_should_be_at_least_ + image_url: + app_id: this_is_an_id613_that_should_be_at_least_ companies: type: company.list companies: [] location_data: {} - last_request_at: - created_at: 1687967286 - remote_created_at: 1687967286 - signed_up_at: 1687967286 - updated_at: 1687967286 + last_request_at: + created_at: 1690293535 + remote_created_at: 1690293535 + signed_up_at: 1690293535 + updated_at: 1690293535 session_count: 0 social_profiles: type: social_profile.list social_profiles: [] - owner_id: + owner_id: unsubscribed_from_emails: false marked_email_as_spam: false has_hard_bounced: false @@ -9677,13 +10104,13 @@ paths: type: segment.list segments: [] custom_attributes: {} - referrer: - utm_campaign: - utm_content: - utm_medium: - utm_source: - utm_term: - do_not_track: + referrer: + utm_campaign: + utm_content: + utm_medium: + utm_source: + utm_term: + do_not_track: schema: "$ref": "#/components/schemas/visitor" '404': @@ -9694,7 +10121,7 @@ paths: Visitor not found: value: type: error.list - request_id: 766ec1e1-b352-42fd-bb3e-5bd458f623de + request_id: 8dcc8693-f96a-46b4-a4db-0f71db1fdcbe errors: - code: not_found message: Visitor Not Found @@ -9708,7 +10135,7 @@ paths: Unauthorized: value: type: error.list - request_id: 3b9d2376-896b-4808-a0d2-246ee3f77b58 + request_id: 893efe11-590f-4b1d-a97b-c73afd315b37 errors: - code: unauthorized message: Access Token Invalid @@ -9742,31 +10169,31 @@ paths: successful: value: type: visitor - id: 649c563785b35b2332e7f1fe + id: 64bfd52176af8e7a749aaaa3 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' - phone: - name: - pseudonym: + phone: + name: + pseudonym: avatar: type: avatar - image_url: - app_id: this_is_an_id596_that_should_be_at_least_ + image_url: + app_id: this_is_an_id619_that_should_be_at_least_ companies: type: company.list companies: [] location_data: {} - last_request_at: - created_at: 1687967288 - remote_created_at: 1687967287 - signed_up_at: 1687967287 - updated_at: 1687967288 + last_request_at: + created_at: 1690293537 + remote_created_at: 1690293537 + signed_up_at: 1690293537 + updated_at: 1690293537 session_count: 0 social_profiles: type: social_profile.list social_profiles: [] - owner_id: + owner_id: unsubscribed_from_emails: false marked_email_as_spam: false has_hard_bounced: false @@ -9777,13 +10204,13 @@ paths: type: segment.list segments: [] custom_attributes: {} - referrer: - utm_campaign: - utm_content: - utm_medium: - utm_source: - utm_term: - do_not_track: + referrer: + utm_campaign: + utm_content: + utm_medium: + utm_source: + utm_term: + do_not_track: schema: "$ref": "#/components/schemas/visitor" '404': @@ -9794,7 +10221,7 @@ paths: Visitor not found: value: type: error.list - request_id: c0a5416a-a3d8-4e76-812e-6d71c44f4aaf + request_id: 567abcaa-deaa-42b4-b6ad-dca0927fb8fa errors: - code: not_found message: Visitor Not Found @@ -9808,7 +10235,7 @@ paths: Unauthorized: value: type: error.list - request_id: cbfa7019-d6c0-4aa0-a206-ec6c926ec247 + request_id: c2094e28-b574-46ce-9eed-a336e668dbde errors: - code: unauthorized message: Access Token Invalid @@ -9841,31 +10268,31 @@ paths: successful: value: type: visitor - id: 649c563a85b35b2332e7f201 + id: 64bfd52376af8e7a749aaaa6 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' - phone: - name: - pseudonym: + phone: + name: + pseudonym: avatar: type: avatar - image_url: - app_id: this_is_an_id602_that_should_be_at_least_ + image_url: + app_id: this_is_an_id625_that_should_be_at_least_ companies: type: company.list companies: [] location_data: {} - last_request_at: - created_at: 1687967290 - remote_created_at: 1687967290 - signed_up_at: 1687967290 - updated_at: 1687967290 + last_request_at: + created_at: 1690293539 + remote_created_at: 1690293539 + signed_up_at: 1690293539 + updated_at: 1690293540 session_count: 0 social_profiles: type: social_profile.list social_profiles: [] - owner_id: + owner_id: unsubscribed_from_emails: false marked_email_as_spam: false has_hard_bounced: false @@ -9876,13 +10303,13 @@ paths: type: segment.list segments: [] custom_attributes: {} - referrer: - utm_campaign: - utm_content: - utm_medium: - utm_source: - utm_term: - do_not_track: + referrer: + utm_campaign: + utm_content: + utm_medium: + utm_source: + utm_term: + do_not_track: schema: "$ref": "#/components/schemas/visitor_deleted_object" '404': @@ -9893,7 +10320,7 @@ paths: Visitor Not Found: value: type: error.list - request_id: d8093125-c04c-49db-a1e6-7681c9128cc9 + request_id: b31c5b0d-2d4e-4c5d-b210-eb5b34c142b0 errors: - code: not_found message: User Not Found @@ -9907,7 +10334,7 @@ paths: Unauthorized: value: type: error.list - request_id: 26a38bc1-3200-45bd-a943-28c8902d1703 + request_id: 65cf489e-7c30-4177-bad2-8f91dcaac26d errors: - code: unauthorized message: Access Token Invalid @@ -9938,31 +10365,31 @@ paths: successful: value: type: visitor - id: 649c563c85b35b2332e7f204 + id: 64bfd52576af8e7a749aaaa9 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' - phone: - name: - pseudonym: Orange Bear + phone: + name: + pseudonym: Orange Shark avatar: type: avatar - image_url: https://static.intercomassets.com/app/pseudonym_avatars_2019/orange-bear.png - app_id: this_is_an_id609_that_should_be_at_least_ + image_url: https://static.intercomassets.com/app/pseudonym_avatars_2019/orange-shark.png + app_id: this_is_an_id631_that_should_be_at_least_ companies: type: company.list companies: [] location_data: {} - last_request_at: - created_at: 1687967292 - remote_created_at: 1687967292 - signed_up_at: 1687967292 - updated_at: 1687967292 + last_request_at: + created_at: 1690293541 + remote_created_at: 1690293542 + signed_up_at: 1690293542 + updated_at: 1690293542 session_count: 0 social_profiles: type: social_profile.list social_profiles: [] - owner_id: + owner_id: unsubscribed_from_emails: false marked_email_as_spam: false has_hard_bounced: false @@ -9973,13 +10400,13 @@ paths: type: segment.list segments: [] custom_attributes: {} - referrer: - utm_campaign: - utm_content: - utm_medium: - utm_source: - utm_term: - do_not_track: + referrer: + utm_campaign: + utm_content: + utm_medium: + utm_source: + utm_term: + do_not_track: schema: "$ref": "#/components/schemas/contact" '401': @@ -9990,7 +10417,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0ad20baa-a85e-4bd8-af82-f5e732757d1f + request_id: 764b96e9-0843-4aa6-8a90-bd28d6297f33 errors: - code: unauthorized message: Access Token Invalid @@ -10314,6 +10741,65 @@ components: - message_type - type - admin_id + admin_reply_ticket_request: + title: Admin Reply on ticket + type: object + description: Payload of the request to reply on behalf of an admin + properties: + message_type: + type: string + enum: + - comment + - note + - quick_reply + example: comment + type: + type: string + enum: + - admin + example: admin + body: + type: string + description: The text body of the reply.\nNotes accept some HTML formatting. + Must be present for comment and note message types. + example: Hello there! + admin_id: + type: string + description: The id of the admin who is authoring the comment. + example: '3156780' + reply_options: + title: Quick Reply Options + type: array + description: The quick reply options to display. Must be present for quick_reply + message types. + items: + title: Quick Reply Option + type: object + properties: + text: + type: string + description: The text to display in this quick reply option. + uuid: + type: string + format: uuid + description: A unique identifier for this quick reply option. This + 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 + 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 + - admin_id admin_with_app: title: Admin type: object @@ -10528,7 +11014,7 @@ components: type: string description: The type of object - `article_content` . enum: - - + - - article_content example: article_content title: @@ -10641,7 +11127,7 @@ components: type: string description: The type of object - article_translated_content. enum: - - + - - article_translated_content example: article_translated_content ar: @@ -11686,6 +12172,105 @@ components: - 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: + 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 + format: uri + maxItems: 5 + required: + - message_type + - type + - body + - email contact_segments: title: Segments type: object @@ -12139,7 +12724,7 @@ components: nullable: true description: The URL where the conversation was started. For Twitter, Email, and Bots, this will be blank. - example: + example: redacted: type: boolean description: Whether or not the source message has been redacted. Only applicable @@ -12260,6 +12845,20 @@ components: (wrote at least one conversation part). items: "$ref": "#/components/schemas/reference" + convert_conversation_to_ticket_request: + description: You can convert a Conversation to a Ticket + type: object + title: Convert Ticket Request Payload + properties: + ticket_type_id: + type: string + description: The ID of the type of ticket you want to convert the conversation + to + example: '1234' + attributes: + "$ref": "#/components/schemas/ticket_request_custom_attributes" + required: + - ticket_type_id convert_visitor_request: description: You can merge a Visitor to a Contact of role type lead or user. type: object @@ -12845,25 +13444,10 @@ components: - parent_id create_ticket_reply_request: title: Create Ticket Reply Request Payload - type: object description: You can create a reply on a ticket. - properties: - body: - type: string - description: The message body of the note, which may contain HTML. - example: "

    Okay!

    " - message_type: - type: string - description: The type of the reply. Only `note` is supported at the moment. - example: note - default: note - admin_id: - type: string - description: The id of the admin who is making the note. - example: '1234' - required: - - body - - admin_id + oneOf: + - "$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 @@ -12996,6 +13580,14 @@ components: type: string description: The description of the ticket type. example: Used for tracking bugs + category: + type: string + description: Category of the Ticket Type. + enum: + - Customer + - Back-office + - Tracker + example: Customer icon: type: string description: The icon of the ticket type. @@ -13010,6 +13602,7 @@ components: default: false required: - name + - category cursor_pages: title: Cursor based pages type: object @@ -13660,7 +14253,7 @@ components: type: string description: The type of object - `group_content` . enum: - - + - - group_content example: group_content name: @@ -13683,7 +14276,7 @@ components: description: The type of object - group_translated_content. nullable: true enum: - - + - - group_translated_content example: group_translated_content ar: @@ -13831,11 +14424,20 @@ components: enum: - ticket - conversation - example: conversation + example: ticket id: type: string description: The ID of the linked object example: '7583' + category: + type: string + description: Category of the Linked Ticket Object. + enum: + - Customer + - Back-office + - Tracker + - + example: Customer linked_object_list: title: Linked Objects type: object @@ -14916,6 +15518,18 @@ components: type: string description: The id representing the ticket. example: '1295' + friendly_id: + type: string + description: The friendly id representing the ticket. + example: '1390' + category: + type: string + description: Category of the Ticket. + enum: + - Customer + - Back-office + - Tracker + example: Customer ticket_attributes: "$ref": "#/components/schemas/ticket_custom_attributes" ticket_state: @@ -14964,6 +15578,10 @@ components: "$ref": "#/components/schemas/linked_object_list" ticket_parts: "$ref": "#/components/schemas/ticket_parts" + is_shared: + type: boolean + description: Whether or not the ticket is shared with the customer. + example: true ticket_contacts: title: Contacts type: object @@ -15019,54 +15637,6 @@ components: example: 12345 pages: "$ref": "#/components/schemas/cursor_pages" - ticket_note: - title: A Ticket Part representing a note - type: object - description: A Ticket Part representing a note on a ticket - properties: - type: - type: string - description: Always ticket_part - example: ticket_part - enum: - - ticket_part - id: - type: string - description: The id representing the note. - example: '3' - part_type: - type: string - description: Always note - example: note - enum: - - note - body: - type: string - nullable: true - description: The message body, which may contain HTML. - example: "

    Okay!

    " - created_at: - type: integer - format: date-time - description: The time the note was created. - example: 1663597223 - updated_at: - type: integer - format: date-time - description: The last time the note was updated. - example: 1663597260 - 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" - redacted: - type: boolean - description: Whether or not the ticket part has been redacted. - example: false ticket_part: title: Ticket Part type: object @@ -15142,8 +15712,8 @@ components: ticket_part_author: title: Ticket part author type: object - description: The author that wrote or triggered the part. Can be a bot or an - admin. + description: The author that wrote or triggered the part. Can be a bot, admin, + team or user. properties: type: type: string @@ -15153,12 +15723,15 @@ components: - admin - bot - team + - user id: type: string description: The id of the author example: '274' name: - type: string + type: + - 'null' + - string description: The name of the author example: Operator email: @@ -15189,6 +15762,57 @@ components: type: integer description: '' example: 2 + ticket_reply: + title: A Ticket Part representing a note, comment, or quick_reply on a ticket + type: object + description: A Ticket Part representing a note, comment, or quick_reply on a + ticket + properties: + type: + type: string + description: Always ticket_part + example: ticket_part + enum: + - ticket_part + id: + type: string + description: The id representing the part. + example: '3' + part_type: + type: string + description: Type of the part + example: note + enum: + - note + - comment + - quick_reply + body: + type: string + nullable: true + description: The message body, which may contain HTML. + example: "

    Okay!

    " + created_at: + type: integer + format: date-time + description: The time the note was created. + example: 1663597223 + updated_at: + type: integer + format: date-time + description: The last time the note was updated. + example: 1663597260 + 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" + redacted: + type: boolean + description: Whether or not the ticket part has been redacted. + example: false ticket_request_custom_attributes: title: Ticket Attributes type: object @@ -15226,6 +15850,14 @@ components: type: string description: The id representing the ticket type. example: '1295' + category: + type: string + description: Category of the Ticket Type. + enum: + - Customer + - Back-office + - Tracker + example: Customer name: type: string description: The name of the ticket type @@ -15619,6 +16251,15 @@ components: description: Specify if a ticket is open. Set to false to close a ticket. Closing a ticket will also unsnooze it. example: true + is_shared: + type: boolean + description: Specify whether the ticket is visible to users. + example: true + snoozed_until: + type: integer + format: timestamp + description: The time you want the ticket to reopen. + example: 1673609604 assignment: type: object properties: @@ -15706,6 +16347,14 @@ components: type: string description: The description of the ticket type. example: A bug has been occured + category: + type: string + description: Category of the Ticket Type. + enum: + - Customer + - Back-office + - Tracker + example: Customer icon: type: string description: The icon of the ticket type.