diff --git a/descriptions/0/api.intercom.io.yaml b/descriptions/0/api.intercom.io.yaml index afded43..cff53f5 100644 --- a/descriptions/0/api.intercom.io.yaml +++ b/descriptions/0/api.intercom.io.yaml @@ -37,7 +37,7 @@ paths: Successful response: value: type: admin - id: '991268888' + id: '991268825' email: admin1@email.com name: Ciaran1 Lee email_verified: true @@ -45,7 +45,7 @@ paths: type: app id_code: this_is_an_id1_that_should_be_at_least_40 name: MyApp 1 - created_at: 1704903635 + created_at: 1707477577 secure: false identity_verification: false timezone: America/Los_Angeles @@ -83,7 +83,7 @@ paths: Successful response: value: type: admin - id: '991268889' + id: '991268826' name: Ciaran2 Lee email: admin2@email.com away_mode_enabled: true @@ -100,7 +100,7 @@ paths: Admin not found: value: type: error.list - request_id: 1332be41-e8ca-4d01-8db8-d66435747992 + request_id: 68329322-f208-485e-80dc-14dded555842 errors: - code: admin_not_found message: Admin for admin_id not found @@ -114,7 +114,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9abff7fa-90f8-4e19-824a-b4e2925cbc8c + request_id: 60bed783-170a-419d-bc6e-524f2b687d16 errors: - code: unauthorized message: Access Token Invalid @@ -201,23 +201,10 @@ paths: per_page: 20 total_pages: 1 activity_logs: - - id: 39cfa672-b5d6-4fc3-aaf5-058f070f25c7 + - id: 17f8a4e9-8ce9-454c-8a9e-06ef0726cf05 performed_by: type: admin - id: '991268893' - email: admin5@email.com - ip: 127.0.0.1 - metadata: - before: before - after: after - created_at: 1704903639 - activity_type: app_name_change - activity_description: Ciaran5 Lee changed your app name from - before to after. - - id: f2383f45-3d84-4744-8d32-947e987e7196 - performed_by: - type: admin - id: '991268893' + id: '991268830' email: admin5@email.com ip: 127.0.0.1 metadata: @@ -226,11 +213,24 @@ paths: title: Initial message title before: Initial message title after: Eventual message title - created_at: 1704903639 + created_at: 1707477583 activity_type: message_state_change activity_description: Ciaran5 Lee changed your Initial message title message from Initial message title to Eventual message title. + - id: db9f77ff-f6fe-4e52-84ff-046bc26f9c81 + performed_by: + type: admin + id: '991268830' + email: admin5@email.com + ip: 127.0.0.1 + metadata: + before: before + after: after + created_at: 1707477583 + 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: dc0ce667-50ea-41d8-a305-7efc5fea8712 + request_id: f42be56a-4355-4f73-8fe1-8bcfea252546 errors: - code: unauthorized message: Access Token Invalid @@ -271,7 +271,7 @@ paths: admins: - type: admin email: admin7@email.com - id: '991268896' + id: '991268832' name: Ciaran7 Lee away_mode_enabled: false away_mode_reassign: false @@ -287,7 +287,7 @@ paths: Unauthorized: value: type: error.list - request_id: 6eef037c-9cf5-4bba-a2d5-00edacbefdeb + request_id: 9f69f7c4-00c2-4cf5-bc85-6a2df136fa45 errors: - code: unauthorized message: Access Token Invalid @@ -321,7 +321,7 @@ paths: Admin found: value: type: admin - id: '991268898' + id: '991268834' 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: e48612e5-93fe-4864-8ff8-728e160ed37e + request_id: 43717a74-800d-459a-aa91-5b5a21bbd277 errors: - code: admin_not_found message: Admin not found @@ -352,7 +352,7 @@ paths: Unauthorized: value: type: error.list - request_id: 46db883b-14cb-4a8f-b12f-c20970f4e227 + request_id: 56207970-00e2-4a96-92da-a4f7d58baea6 errors: - code: unauthorized message: Access Token Invalid @@ -381,28 +381,28 @@ paths: data: - id: 1 type: content_import_source - last_synced_at: 1704903641 + last_synced_at: 1707477586 status: active url: https://support.example.com/us/1 sync_behavior: automatic - created_at: 1704903641 - updated_at: 1704903641 + created_at: 1707477586 + updated_at: 1707477586 - id: 2 type: content_import_source - last_synced_at: 1704903641 + last_synced_at: 1707477586 status: active url: https://support.example.com/us/2 sync_behavior: automatic - created_at: 1704903641 - updated_at: 1704903641 + created_at: 1707477586 + updated_at: 1707477586 - id: 3 type: content_import_source - last_synced_at: 1704903641 + last_synced_at: 1707477586 status: active url: https://support.example.com/us/3 sync_behavior: automatic - created_at: 1704903641 - updated_at: 1704903641 + created_at: 1707477586 + updated_at: 1707477586 pages: type: pages page: 1 @@ -420,7 +420,7 @@ paths: Unauthorized: value: type: error.list - request_id: f6f82c24-7e01-4137-ab42-9de9e8fa4f4c + request_id: 669b24cc-1379-40e7-83d4-07bcee105c89 errors: - code: unauthorized message: Access Token Invalid @@ -448,12 +448,12 @@ paths: value: id: 4 type: content_import_source - last_synced_at: 1704903642 + last_synced_at: 1707477587 status: active url: https://www.example.com sync_behavior: api - created_at: 1704903642 - updated_at: 1704903642 + created_at: 1707477587 + updated_at: 1707477587 schema: "$ref": "#/components/schemas/content_import_source" '401': @@ -464,7 +464,7 @@ paths: Unauthorized: value: type: error.list - request_id: 69d852ea-2747-45ff-976b-486841c520b0 + request_id: e05b8881-e6dc-4bcb-b68a-dcf6f6affaf6 errors: - code: unauthorized message: Access Token Invalid @@ -514,7 +514,7 @@ paths: Unauthorized: value: type: error.list - request_id: 327461a7-738c-4145-858a-6774518bb554 + request_id: 907a5b59-cbcc-477e-a623-c7fddf63b75b errors: - code: unauthorized message: Access Token Invalid @@ -540,12 +540,12 @@ paths: value: id: 6 type: content_import_source - last_synced_at: 1704903644 + last_synced_at: 1707477589 status: active url: https://support.example.com/us/5 sync_behavior: api - created_at: 1704903644 - updated_at: 1704903644 + created_at: 1707477589 + updated_at: 1707477589 schema: "$ref": "#/components/schemas/content_import_source" '401': @@ -556,7 +556,7 @@ paths: Unauthorized: value: type: error.list - request_id: 5f47e25e-eb1b-4ab1-8b55-a8501c4f694b + request_id: e79fb58b-3a29-45d4-a941-fbde6199baf5 errors: - code: unauthorized message: Access Token Invalid @@ -583,12 +583,12 @@ paths: value: id: 7 type: content_import_source - last_synced_at: 1704903645 + last_synced_at: 1707477590 status: active url: https://www.example.com sync_behavior: api - created_at: 1704903645 - updated_at: 1704903645 + created_at: 1707477590 + updated_at: 1707477590 schema: "$ref": "#/components/schemas/content_import_source" '401': @@ -599,7 +599,7 @@ paths: Unauthorized: value: type: error.list - request_id: adfdaae0-0e8c-4234-8a40-dbe12b71d15d + request_id: 02ca379f-64c5-455a-92a8-7698dadecff6 errors: - code: unauthorized message: Access Token Invalid @@ -646,9 +646,9 @@ paths: locale: en source_id: 10 external_id: '3' - created_at: 1704903646 - updated_at: 1704903646 - last_ingested_at: 1704903646 + created_at: 1707477591 + updated_at: 1707477591 + last_ingested_at: 1707477591 - id: '2' type: external_page title: My External Content @@ -658,9 +658,9 @@ paths: locale: en source_id: 9 external_id: '2' - created_at: 1704903646 - updated_at: 1704903646 - last_ingested_at: 1704903646 + created_at: 1707477591 + updated_at: 1707477591 + last_ingested_at: 1707477591 - id: '1' type: external_page title: My External Content @@ -670,9 +670,9 @@ paths: locale: en source_id: 8 external_id: '1' - created_at: 1704903646 - updated_at: 1704903646 - last_ingested_at: 1704903646 + created_at: 1707477591 + updated_at: 1707477591 + last_ingested_at: 1707477591 pages: type: pages page: 1 @@ -690,7 +690,7 @@ paths: Unauthorized: value: type: error.list - request_id: 4dd5a6a5-4385-4005-abaa-c1f38d882f54 + request_id: 105957ed-4682-4073-97e8-676fd1553f2c errors: - code: unauthorized message: Access Token Invalid @@ -726,9 +726,9 @@ paths: locale: en source_id: 12 external_id: abc1234 - created_at: 1704903647 - updated_at: 1704903647 - last_ingested_at: 1704903647 + created_at: 1707477593 + updated_at: 1707477593 + last_ingested_at: 1707477593 schema: "$ref": "#/components/schemas/external_page" '401': @@ -739,7 +739,7 @@ paths: Unauthorized: value: type: error.list - request_id: 7adc9043-6d6c-4d91-9b3e-f3d43b52b9db + request_id: 4e8ddc99-e3f3-4705-b579-e8942a827d34 errors: - code: unauthorized message: Access Token Invalid @@ -797,9 +797,9 @@ paths: locale: en source_id: 13 external_id: '4' - created_at: 1704903648 - updated_at: 1704903648 - last_ingested_at: 1704903648 + created_at: 1707477594 + updated_at: 1707477594 + last_ingested_at: 1707477594 schema: "$ref": "#/components/schemas/external_page" '401': @@ -810,7 +810,7 @@ paths: Unauthorized: value: type: error.list - request_id: d3aa8bce-bb2b-4459-a224-f59915d6128c + request_id: 34317a92-cc72-489c-89d4-9bfecf4d6ff3 errors: - code: unauthorized message: Access Token Invalid @@ -844,9 +844,9 @@ paths: locale: en source_id: 14 external_id: '5' - created_at: 1704903648 - updated_at: 1704903648 - last_ingested_at: 1704903648 + created_at: 1707477595 + updated_at: 1707477595 + last_ingested_at: 1707477595 schema: "$ref": "#/components/schemas/external_page" '401': @@ -857,7 +857,7 @@ paths: Unauthorized: value: type: error.list - request_id: eeccd81c-53a5-403f-bb42-df9edb9c3f00 + request_id: 284842d3-67f6-43a2-aed3-6410baff958e errors: - code: unauthorized message: Access Token Invalid @@ -892,9 +892,9 @@ paths: locale: en source_id: 15 external_id: '5678' - created_at: 1704903649 - updated_at: 1704903649 - last_ingested_at: 1704903649 + created_at: 1707477596 + updated_at: 1707477596 + last_ingested_at: 1707477596 schema: "$ref": "#/components/schemas/external_page" '401': @@ -905,7 +905,7 @@ paths: Unauthorized: value: type: error.list - request_id: '049a769a-f598-49ab-825a-559d69ec0c6f' + request_id: ba792660-482e-43e7-b0b9-f74693f76156 errors: - code: unauthorized message: Access Token Invalid @@ -958,20 +958,20 @@ paths: total_pages: 1 total_count: 1 data: - - id: '105' + - id: '129' type: article workspace_id: this_is_an_id64_that_should_be_at_least_4 - parent_id: 432 + parent_id: 421 parent_type: collection parent_ids: [] title: This is the article title description: '' body: '' - author_id: 991268922 + author_id: 991268858 state: published - created_at: 1704903651 - updated_at: 1704903651 - url: http://help-center.test/myapp-64/en/articles/105-this-is-the-article-title + created_at: 1707477597 + updated_at: 1707477597 + url: http://help-center.test/myapp-64/en/articles/129-this-is-the-article-title schema: "$ref": "#/components/schemas/article_list" '401': @@ -982,7 +982,7 @@ paths: Unauthorized: value: type: error.list - request_id: 3df4a247-ada9-421f-9834-dd3acb3e28c3 + request_id: 13826f97-7db9-4caf-851c-9211be79512f errors: - code: unauthorized message: Access Token Invalid @@ -1007,10 +1007,10 @@ paths: examples: article created: value: - id: '108' + id: '132' type: article workspace_id: this_is_an_id68_that_should_be_at_least_4 - parent_id: 434 + parent_id: 423 parent_type: collection parent_ids: [] statistics: @@ -1024,11 +1024,11 @@ paths: title: Thanks for everything description: Description of the Article body:
Body of the Article
- author_id: 991268927 + author_id: 991268863 state: published - created_at: 1704903653 - updated_at: 1704903653 - url: http://help-center.test/myapp-68/en/articles/108-thanks-for-everything + created_at: 1707477598 + updated_at: 1707477598 + url: http://help-center.test/myapp-68/en/articles/132-thanks-for-everything schema: "$ref": "#/components/schemas/article" '400': @@ -1039,7 +1039,7 @@ paths: Bad Request: value: type: error.list - request_id: 036acaa5-7c5f-4042-8815-08c070dd66e8 + request_id: 5969e5e1-94a3-41a8-95fc-8199e5016dc3 errors: - code: parameter_not_found message: author_id must be in the main body or default locale @@ -1054,7 +1054,7 @@ paths: Unauthorized: value: type: error.list - request_id: a759579e-da92-48b4-aa06-3a40e7bc1c97 + request_id: 7fac7eae-0b9c-4ff9-ae36-2fbd8482ab49 errors: - code: unauthorized message: Access Token Invalid @@ -1072,16 +1072,16 @@ paths: title: Thanks for everything description: Description of the Article body: Body of the Article - author_id: 991268927 + author_id: 991268863 state: published - parent_id: 434 + parent_id: 423 parent_type: collection translated_content: fr: title: Merci pour tout description: Description de l'article body: Corps de l'article - author_id: 991268927 + author_id: 991268863 state: published bad_request: summary: Bad Request @@ -1118,10 +1118,10 @@ paths: examples: Article found: value: - id: '111' + id: '135' type: article workspace_id: this_is_an_id74_that_should_be_at_least_4 - parent_id: 437 + parent_id: 426 parent_type: collection parent_ids: [] statistics: @@ -1135,11 +1135,11 @@ paths: title: This is the article title description: '' body: '' - author_id: 991268932 + author_id: 991268868 state: published - created_at: 1704903654 - updated_at: 1704903654 - url: http://help-center.test/myapp-74/en/articles/111-this-is-the-article-title + created_at: 1707477600 + updated_at: 1707477600 + url: http://help-center.test/myapp-74/en/articles/135-this-is-the-article-title schema: "$ref": "#/components/schemas/article" '404': @@ -1150,7 +1150,7 @@ paths: Article not found: value: type: error.list - request_id: fdcde47c-c572-498e-b0aa-79c7fa386496 + request_id: 2570e07c-ec36-44db-a67a-d53b9eeb7044 errors: - code: not_found message: Resource Not Found @@ -1164,7 +1164,7 @@ paths: Unauthorized: value: type: error.list - request_id: 4375a7e2-cc8f-4da2-a335-2d6dadf87e91 + request_id: c9a9b6c6-47b6-47d8-8204-5cfbd9e1f02c errors: - code: unauthorized message: Access Token Invalid @@ -1197,10 +1197,10 @@ paths: examples: successful: value: - id: '114' + id: '138' type: article workspace_id: this_is_an_id80_that_should_be_at_least_4 - parent_id: 440 + parent_id: 429 parent_type: collection parent_ids: [] statistics: @@ -1214,11 +1214,11 @@ paths: title: Christmas is here! description: '' body:New gifts in store for the jolly season
- author_id: 991268938 + author_id: 991268874 state: published - created_at: 1704903656 - updated_at: 1704903657 - url: http://help-center.test/myapp-80/en/articles/114-christmas-is-here + created_at: 1707477602 + updated_at: 1707477603 + url: http://help-center.test/myapp-80/en/articles/138-christmas-is-here schema: "$ref": "#/components/schemas/article" '404': @@ -1229,7 +1229,7 @@ paths: Article Not Found: value: type: error.list - request_id: 7ac09d01-753b-44a6-ba4e-0f37495b3c14 + request_id: bb80b8bd-c5e0-4b5c-afea-4dd2a2e53aa1 errors: - code: not_found message: Resource Not Found @@ -1243,7 +1243,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2e17bd20-98d7-4e5b-abf8-c18e4cc98d19 + request_id: d528acd8-3864-4bda-9243-8a7b928a9cf3 errors: - code: unauthorized message: Access Token Invalid @@ -1291,7 +1291,7 @@ paths: examples: successful: value: - id: '117' + id: '141' object: article deleted: true schema: @@ -1304,7 +1304,7 @@ paths: Article Not Found: value: type: error.list - request_id: 97c15472-ade6-4cf8-b16b-15116a5771df + request_id: 6a96eec8-5280-41c8-aac9-52547dacd737 errors: - code: not_found message: Resource Not Found @@ -1318,7 +1318,7 @@ paths: Unauthorized: value: type: error.list - request_id: d80dc162-a5ed-49ed-8540-9164955f5ab0 + request_id: a3f4b805-639a-44bf-8432-ca9e0ef55d0b errors: - code: unauthorized message: Access Token Invalid @@ -1378,7 +1378,7 @@ paths: total_count: 1 data: articles: - - id: '121' + - id: '145' type: article workspace_id: this_is_an_id92_that_should_be_at_least_4 parent_id: @@ -1387,10 +1387,10 @@ paths: title: Title 1 description: '' body: '' - author_id: 991268951 + author_id: 991268887 state: draft - created_at: 1704903660 - updated_at: 1704903660 + created_at: 1707477607 + updated_at: 1707477607 url: highlights: [] pages: @@ -1408,7 +1408,7 @@ paths: Unauthorized: value: type: error.list - request_id: e66eef28-becd-4bac-af2e-bca433e90fd2 + request_id: 4937e6e1-dc5a-442b-aa50-b2cc4e1b19dd errors: - code: unauthorized message: Access Token Invalid @@ -1441,27 +1441,27 @@ paths: value: type: list data: - - id: '448' + - id: '437' workspace_id: this_is_an_id96_that_should_be_at_least_4 name: English collection title url: http://help-center.test/myapp-96/collection-17 order: 17 - created_at: 1704903662 - updated_at: 1704903662 + created_at: 1707477608 + updated_at: 1707477608 description: english collection description icon: bookmark parent_id: - help_center_id: 228 - - id: '449' + help_center_id: 240 + - id: '438' workspace_id: this_is_an_id96_that_should_be_at_least_4 name: English section title url: http://help-center.test/myapp-96/section-1 order: 1 - created_at: 1704903662 - updated_at: 1704903662 + created_at: 1707477608 + updated_at: 1707477608 description: icon: bookmark - parent_id: '448' + parent_id: '437' help_center_id: total_count: 2 pages: @@ -1479,7 +1479,7 @@ paths: Unauthorized: value: type: error.list - request_id: '098c2d8f-1c20-48df-9725-652cfa09e382' + request_id: 16ad3683-b7a2-4c84-814a-53872447b5f6 errors: - code: unauthorized message: Access Token Invalid @@ -1504,17 +1504,17 @@ paths: examples: collection created: value: - id: '454' + id: '443' workspace_id: this_is_an_id100_that_should_be_at_least_ name: Thanks for everything url: http://help-center.test/myapp-100/ order: 1 - created_at: 1704903663 - updated_at: 1704903663 + created_at: 1707477609 + updated_at: 1707477609 description: '' icon: book-bookmark parent_id: - help_center_id: 230 + help_center_id: 242 schema: "$ref": "#/components/schemas/collection" '400': @@ -1525,7 +1525,7 @@ paths: Bad Request: value: type: error.list - request_id: 460a1ee0-294a-47f8-bb0c-5fb6748a1934 + request_id: 226b286b-2242-442e-ab3b-19d7544ba5f2 errors: - code: parameter_not_found message: Name is a required parameter. @@ -1539,7 +1539,7 @@ paths: Unauthorized: value: type: error.list - request_id: 708ead40-48f4-46d6-a891-6e9816685e34 + request_id: 9a802cb0-51ec-4f02-bc14-b78563d04c93 errors: - code: unauthorized message: Access Token Invalid @@ -1587,17 +1587,17 @@ paths: examples: Collection found: value: - id: '459' + id: '448' workspace_id: this_is_an_id106_that_should_be_at_least_ name: English collection title url: http://help-center.test/myapp-106/collection-22 order: 22 - created_at: 1704903664 - updated_at: 1704903664 + created_at: 1707477610 + updated_at: 1707477610 description: english collection description icon: bookmark parent_id: - help_center_id: 233 + help_center_id: 245 schema: "$ref": "#/components/schemas/collection" '404': @@ -1608,7 +1608,7 @@ paths: Collection not found: value: type: error.list - request_id: 1a69ed78-bb1d-4b43-a46b-de34bbadb729 + request_id: 222a3a2e-dc3e-434b-bbf9-34dce4ab8e30 errors: - code: not_found message: Resource Not Found @@ -1622,7 +1622,7 @@ paths: Unauthorized: value: type: error.list - request_id: 5322973b-2866-42aa-8018-c7ddc4a4b885 + request_id: d85f6cef-f962-4d74-9176-1d11a809639c errors: - code: unauthorized message: Access Token Invalid @@ -1655,17 +1655,17 @@ paths: examples: successful: value: - id: '465' + id: '454' workspace_id: this_is_an_id112_that_should_be_at_least_ name: Update collection name url: http://help-center.test/myapp-112/collection-25 order: 25 - created_at: 1704903665 - updated_at: 1704903665 + created_at: 1707477612 + updated_at: 1707477612 description: english collection description icon: folder parent_id: - help_center_id: 236 + help_center_id: 248 schema: "$ref": "#/components/schemas/collection" '404': @@ -1676,7 +1676,7 @@ paths: Collection Not Found: value: type: error.list - request_id: 5b0890a4-b421-47a9-ac56-ea210e6cdf93 + request_id: f195c213-4284-47ee-a44e-d38c7f9b501a errors: - code: not_found message: Resource Not Found @@ -1690,7 +1690,7 @@ paths: Unauthorized: value: type: error.list - request_id: d25bb08c-8b41-43e7-ad97-12f7472e803e + request_id: 9373092a-b180-44fd-a2c6-741e25143e45 errors: - code: unauthorized message: Access Token Invalid @@ -1737,7 +1737,7 @@ paths: examples: successful: value: - id: '471' + id: '460' object: collection deleted: true schema: @@ -1750,7 +1750,7 @@ paths: collection Not Found: value: type: error.list - request_id: 3a14434d-128c-41ba-b25a-fd3592d20e55 + request_id: 1894b1c3-85b1-4d8e-b7c4-95a3daa57bcc errors: - code: not_found message: Resource Not Found @@ -1764,7 +1764,7 @@ paths: Unauthorized: value: type: error.list - request_id: b8d2b528-a98e-448d-a4e4-7ecfca3cfd1d + request_id: 4d079066-3bbd-42c0-9538-b3f98165b0d9 errors: - code: unauthorized message: Access Token Invalid @@ -1798,10 +1798,10 @@ paths: examples: Collection found: value: - id: '242' + id: '254' workspace_id: this_is_an_id124_that_should_be_at_least_ - created_at: 1704903668 - updated_at: 1704903668 + created_at: 1707477616 + updated_at: 1707477616 identifier: help-center-1 website_turned_on: false display_name: Intercom Help Center @@ -1815,7 +1815,7 @@ paths: Collection not found: value: type: error.list - request_id: 45379c71-719b-4a67-bb79-55d395a216cd + request_id: 56809c9d-14b2-4841-a2b5-fa8a629accbb errors: - code: not_found message: Resource Not Found @@ -1829,7 +1829,7 @@ paths: Unauthorized: value: type: error.list - request_id: d652bb77-d93b-4b95-b725-9ead2caa673e + request_id: e1df67d8-ec5f-4bcc-9728-b0b83dd3aa8f errors: - code: unauthorized message: Access Token Invalid @@ -1867,7 +1867,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0bdf09b9-50ea-4123-82e8-faf64726faed + request_id: bc5e7069-334c-45df-a94e-1cffc2c3f0ea errors: - code: unauthorized message: Access Token Invalid @@ -1900,12 +1900,12 @@ paths: value: type: company company_id: company_remote_id - id: 659ec3fb6abd0164c0288596 - app_id: this_is_an_id150_that_should_be_at_least_ + id: 65c60a7586ce64d2dcea3b91 + app_id: this_is_an_id147_that_should_be_at_least_ name: my company remote_created_at: 1374138000 - created_at: 1704903675 - updated_at: 1704903675 + created_at: 1707477621 + updated_at: 1707477621 monthly_spend: 0 session_count: 0 user_count: 0 @@ -1942,7 +1942,7 @@ paths: Unauthorized: value: type: error.list - request_id: e1eaf92e-119b-4af0-923b-0249e1aefb9b + request_id: c3a24e2d-55fe-44dd-af50-7a3fc14f1c22 errors: - code: unauthorized message: Access Token Invalid @@ -2016,11 +2016,18 @@ paths: tags: - Companies operationId: retrieveCompany - description: "You can fetch a single company by passing in `company_id` or `name`.\n\n - \ `https://api.intercom.io/companies?name={name}`\n\n `https://api.intercom.io/companies?company_id={company_id}`\n\nYou - can fetch all companies and filter by `segment_id` or `tag_id` as a query - parameter.\n \n `https://api.intercom.io/companies?tag_id={tag_id}`\n\n - \ `https://api.intercom.io/companies?segment_id={segment_id}`\n" + description: | + You can fetch a single company by passing in `company_id` or `name`. + + `https://api.intercom.io/companies?name={name}` + + `https://api.intercom.io/companies?company_id={company_id}` + + You can fetch all companies and filter by `segment_id` or `tag_id` as a query parameter. + + `https://api.intercom.io/companies?tag_id={tag_id}` + + `https://api.intercom.io/companies?segment_id={segment_id}` responses: '200': description: Successful @@ -2033,12 +2040,12 @@ paths: data: - type: company company_id: remote_companies_scroll_2 - id: 659ec3fd6abd0164c028859e - app_id: this_is_an_id156_that_should_be_at_least_ + id: 65c60a7686ce64d2dcea3b99 + app_id: this_is_an_id153_that_should_be_at_least_ name: IntercomQATest1 - remote_created_at: 1704903677 - created_at: 1704903677 - updated_at: 1704903677 + remote_created_at: 1707477622 + created_at: 1707477622 + updated_at: 1707477622 monthly_spend: 0 session_count: 0 user_count: 4 @@ -2067,7 +2074,7 @@ paths: Company Not Found: value: type: error.list - request_id: 77fbf5d1-a878-4d84-8364-a6ed743d34c6 + request_id: bfb24104-b9be-44e0-afbd-db95243731c6 errors: - code: company_not_found message: Company Not Found @@ -2081,7 +2088,7 @@ paths: Unauthorized: value: type: error.list - request_id: 4e489a52-e9da-4a0d-bf9a-201444e4f4ff + request_id: 62bc9c6a-502f-4e36-aa3b-54ca3d4a3e0e errors: - code: unauthorized message: Access Token Invalid @@ -2116,12 +2123,12 @@ paths: value: type: company company_id: '1' - id: 659ec3ff6abd0164c02885a9 - app_id: this_is_an_id162_that_should_be_at_least_ - name: company2 - remote_created_at: 1704903679 - created_at: 1704903679 - updated_at: 1704903679 + id: 65c60a7986ce64d2dcea3ba4 + app_id: this_is_an_id159_that_should_be_at_least_ + name: company1 + remote_created_at: 1707477625 + created_at: 1707477625 + updated_at: 1707477625 monthly_spend: 0 session_count: 0 user_count: 1 @@ -2143,7 +2150,7 @@ paths: Company Not Found: value: type: error.list - request_id: d6024d8b-76d2-4112-ba9d-1252082d6698 + request_id: 8f028d26-df20-438f-90ee-ef553865c432 errors: - code: company_not_found message: Company Not Found @@ -2157,7 +2164,7 @@ paths: Unauthorized: value: type: error.list - request_id: 37496e75-3e3e-414a-b149-b043c8772f1d + request_id: 16b91449-9752-4ed2-8757-bcace6f3d38b errors: - code: unauthorized message: Access Token Invalid @@ -2191,12 +2198,12 @@ paths: value: type: company company_id: '1' - id: 659ec4006abd0164c02885b3 - app_id: this_is_an_id168_that_should_be_at_least_ - name: company3 - remote_created_at: 1704903680 - created_at: 1704903680 - updated_at: 1704903680 + id: 65c60a7b86ce64d2dcea3bae + app_id: this_is_an_id165_that_should_be_at_least_ + name: company2 + remote_created_at: 1707477627 + created_at: 1707477627 + updated_at: 1707477627 monthly_spend: 0 session_count: 0 user_count: 1 @@ -2218,7 +2225,7 @@ paths: Company Not Found: value: type: error.list - request_id: c3403cfb-ae3c-45dc-8b19-351586d7958d + request_id: 479d682e-29dd-4d2c-8138-993c9010cd98 errors: - code: company_not_found message: Company Not Found @@ -2232,7 +2239,7 @@ paths: Unauthorized: value: type: error.list - request_id: d8425b98-40bf-4f24-9875-84e82848eb9e + request_id: 3e29f69a-306d-4ca1-848c-83102fd337f3 errors: - code: unauthorized message: Access Token Invalid @@ -2264,7 +2271,7 @@ paths: examples: Successful: value: - id: 659ec4026abd0164c02885bd + id: 65c60a7e86ce64d2dcea3bb8 object: company deleted: true schema: @@ -2277,7 +2284,7 @@ paths: Company Not Found: value: type: error.list - request_id: 76645705-a892-41ce-adc4-7a727bd277f3 + request_id: ef710e81-dd86-48ef-8d94-73c100181070 errors: - code: company_not_found message: Company Not Found @@ -2291,7 +2298,7 @@ paths: Unauthorized: value: type: error.list - request_id: 76645cd7-db79-4ff4-a750-b8c71f43a600 + request_id: b1d6b6ca-231a-4ae8-9745-ad8e67e1d9a7 errors: - code: unauthorized message: Access Token Invalid @@ -2343,7 +2350,7 @@ paths: Company Not Found: value: type: error.list - request_id: 90f4401e-685d-44c8-9948-2a264f132d9f + request_id: 8cdafe7b-ddbf-44c2-a1fb-9e6e24edf0ed errors: - code: company_not_found message: Company Not Found @@ -2357,7 +2364,7 @@ paths: Unauthorized: value: type: error.list - request_id: 3e7574b6-7275-43ae-beba-91e344449b2b + request_id: d050530c-75e2-4f8b-8c0e-4ace19297519 errors: - code: unauthorized message: Access Token Invalid @@ -2402,7 +2409,7 @@ paths: Company Not Found: value: type: error.list - request_id: df848494-e9ef-4337-ad41-080dcf3113c5 + request_id: 3a4649ad-8bdd-4d3c-ac59-61b1449e764a errors: - code: company_not_found message: Company Not Found @@ -2416,7 +2423,7 @@ paths: Unauthorized: value: type: error.list - request_id: ddf110d8-cf0e-479a-aef7-72b7a2545ec1 + request_id: 16af8340-1765-4c85-99e2-44339fc887b5 errors: - code: unauthorized message: Access Token Invalid @@ -2473,12 +2480,12 @@ paths: data: - type: company company_id: remote_companies_scroll_2 - id: 659ec4076abd0164c02885d9 - app_id: this_is_an_id192_that_should_be_at_least_ + id: 65c60a8486ce64d2dcea3bd4 + app_id: this_is_an_id189_that_should_be_at_least_ name: IntercomQATest1 - remote_created_at: 1704903687 - created_at: 1704903687 - updated_at: 1704903687 + remote_created_at: 1707477636 + created_at: 1707477636 + updated_at: 1707477636 monthly_spend: 0 session_count: 0 user_count: 4 @@ -2507,7 +2514,7 @@ paths: Unauthorized: value: type: error.list - request_id: a7286931-1315-461f-a101-52551962b513 + request_id: 60e75181-fcf0-49f3-929d-6901affec9f4 errors: - code: unauthorized message: Access Token Invalid @@ -2559,12 +2566,12 @@ paths: data: - type: company company_id: remote_companies_scroll_2 - id: 659ec4086abd0164c02885df - app_id: this_is_an_id196_that_should_be_at_least_ + id: 65c60a8686ce64d2dcea3bda + app_id: this_is_an_id193_that_should_be_at_least_ name: IntercomQATest1 - remote_created_at: 1704903688 - created_at: 1704903688 - updated_at: 1704903688 + remote_created_at: 1707477638 + created_at: 1707477638 + updated_at: 1707477638 monthly_spend: 0 session_count: 0 user_count: 4 @@ -2578,7 +2585,7 @@ paths: custom_attributes: {} pages: total_count: - scroll_param: '0290fb7b-fcd3-44c4-aeb6-d019c51f6700' + scroll_param: c5aeb4be-7a9e-4b90-98af-6357e6206779 schema: "$ref": "#/components/schemas/company_scroll" '401': @@ -2589,7 +2596,7 @@ paths: Unauthorized: value: type: error.list - request_id: f09f1742-4355-4983-95f5-4628e48fb6b1 + request_id: '08a37192-eade-4fe3-b4ec-cd8ac216a5f6' errors: - code: unauthorized message: Access Token Invalid @@ -2624,12 +2631,12 @@ paths: value: type: company company_id: '1' - id: 659ec40a6abd0164c02885e8 - app_id: this_is_an_id200_that_should_be_at_least_ - name: company7 - remote_created_at: 1704903690 - created_at: 1704903690 - updated_at: 1704903690 + id: 65c60a8886ce64d2dcea3be3 + app_id: this_is_an_id197_that_should_be_at_least_ + name: company6 + remote_created_at: 1707477640 + created_at: 1707477640 + updated_at: 1707477640 monthly_spend: 0 session_count: 0 user_count: 1 @@ -2643,6 +2650,20 @@ paths: custom_attributes: {} schema: "$ref": "#/components/schemas/company" + '400': + description: Bad Request + content: + application/json: + examples: + Bad Request: + value: + type: error.list + request_id: dc27d92d-eb6a-476f-adeb-dff7e11c33cf + errors: + - code: parameter_not_found + message: company not specified + schema: + "$ref": "#/components/schemas/error" '404': description: Company Not Found content: @@ -2651,10 +2672,10 @@ paths: Company Not Found: value: type: error.list - request_id: 5767e335-1c31-4be2-978a-e39bfc472a33 + request_id: 546c5e08-4bbd-4657-9a3f-362dcfa8fa3d errors: - - code: not_found - message: User Not Found + - code: company_not_found + message: Company Not Found schema: "$ref": "#/components/schemas/error" '401': @@ -2665,7 +2686,7 @@ paths: Unauthorized: value: type: error.list - request_id: 5a821e47-f5e2-40a0-9bd1-a50297bfbe80 + request_id: 54673aa1-f12e-4cff-9e5e-2f6e189883f8 errors: - code: unauthorized message: Access Token Invalid @@ -2688,11 +2709,14 @@ paths: successful: summary: Successful value: - id: 659ec40a6abd0164c02885e8 + id: 65c60a8886ce64d2dcea3be3 + bad_request: + summary: Bad Request + value: company_not_found: summary: Company Not Found value: - id: 659ec40b6abd0164c02885ec + id: '123' get: summary: List attached companies for contact parameters: @@ -2724,13 +2748,13 @@ paths: data: - type: company company_id: '1' - id: 659ec4156abd0164c028861a - app_id: this_is_an_id214_that_should_be_at_least_ - name: company23 - remote_created_at: 1704903701 - created_at: 1704903701 - updated_at: 1704903701 - last_request_at: 1704730901 + id: 65c60a8e86ce64d2dcea3c04 + app_id: this_is_an_id213_that_should_be_at_least_ + name: company12 + remote_created_at: 1707477646 + created_at: 1707477646 + updated_at: 1707477646 + last_request_at: 1707304846 monthly_spend: 0 session_count: 0 user_count: 1 @@ -2759,7 +2783,7 @@ paths: Contact not found: value: type: error.list - request_id: 3e3ea353-34ce-4073-9fc3-0ae24bfee036 + request_id: 4ff41dc5-b780-4b7a-824a-a29719e296fa errors: - code: not_found message: User Not Found @@ -2773,7 +2797,7 @@ paths: Unauthorized: value: type: error.list - request_id: 223bc611-2bd6-4e5e-a15f-35195cfd9877 + request_id: 9c1d68fc-6726-4149-b91c-208e6f49a264 errors: - code: unauthorized message: Access Token Invalid @@ -2816,12 +2840,12 @@ paths: value: type: company company_id: '1' - id: 659ec40c6abd0164c02885f4 - app_id: this_is_an_id206_that_should_be_at_least_ - name: company10 - remote_created_at: 1704903692 - created_at: 1704903692 - updated_at: 1704903692 + id: 65c60a8b86ce64d2dcea3bf3 + app_id: this_is_an_id205_that_should_be_at_least_ + name: company8 + remote_created_at: 1707477643 + created_at: 1707477643 + updated_at: 1707477643 monthly_spend: 0 session_count: 0 user_count: 0 @@ -2843,14 +2867,14 @@ paths: Company Not Found: value: type: error.list - request_id: c1247435-3113-4b93-b03f-9a4821bb9b02 + request_id: 0131b0ae-689c-4c29-82a0-3bfa1ade8d53 errors: - code: company_not_found message: Company Not Found Contact Not Found: value: type: error.list - request_id: 8fda4373-1c70-4aa6-adbd-f96a0740a76b + request_id: 5001fbba-b38a-4c8e-a535-5e3a9f973783 errors: - code: not_found message: User Not Found @@ -2864,7 +2888,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8a0faa5f-28d3-4741-ad00-77a1fe6f82eb + request_id: cc096f03-f727-48ad-a8a5-67ef3cba2731 errors: - code: unauthorized message: Access Token Invalid @@ -2900,44 +2924,44 @@ paths: type: list data: - type: note - id: '128' - created_at: 1704298904 + id: '68' + created_at: 1706872848 contact: type: contact - id: 659ec4186abd0164c0288625 + id: 65c60a9086ce64d2dcea3c0f author: type: admin - id: '991269010' - name: Ciaran121 Lee - email: admin121@email.com + id: '991268947' + name: Ciaran122 Lee + email: admin122@email.com away_mode_enabled: false away_mode_reassign: false body: "This is a note.
" - type: note - id: '127' - created_at: 1704212504 + id: '67' + created_at: 1706786448 contact: type: contact - id: 659ec4186abd0164c0288625 + id: 65c60a9086ce64d2dcea3c0f author: type: admin - id: '991269010' - name: Ciaran121 Lee - email: admin121@email.com + id: '991268947' + name: Ciaran122 Lee + email: admin122@email.com away_mode_enabled: false away_mode_reassign: false body: "This is a note.
" - type: note - id: '126' - created_at: 1704212504 + id: '66' + created_at: 1706786448 contact: type: contact - id: 659ec4186abd0164c0288625 + id: 65c60a9086ce64d2dcea3c0f author: type: admin - id: '991269010' - name: Ciaran121 Lee - email: admin121@email.com + id: '991268947' + name: Ciaran122 Lee + email: admin122@email.com away_mode_enabled: false away_mode_reassign: false body: "This is a note.
" @@ -2958,7 +2982,7 @@ paths: Contact not found: value: type: error.list - request_id: c2b9002b-49c2-449d-8a71-06cf32ff7f92 + request_id: 9c821274-f65a-46f8-bdc0-bbe7d98a6477 errors: - code: not_found message: User Not Found @@ -2992,16 +3016,16 @@ paths: Successful response: value: type: note - id: '133' - created_at: 1704903705 + id: '73' + created_at: 1707477650 contact: type: contact - id: 659ec4196abd0164c0288627 + id: 65c60a9186ce64d2dcea3c11 author: type: admin - id: '991269012' - name: Ciaran123 Lee - email: admin123@email.com + id: '991268949' + name: Ciaran124 Lee + email: admin124@email.com away_mode_enabled: false away_mode_reassign: false body: "Hello
" @@ -3015,14 +3039,14 @@ paths: Admin not found: value: type: error.list - request_id: 718fd925-2e30-4c18-8bb2-7a7c39f4c2c3 + request_id: 76c92e66-02cb-4df1-a53e-f75fe695bee4 errors: - code: not_found message: Resource Not Found Contact not found: value: type: error.list - request_id: 5b53c4f6-2470-400d-b18d-6bc8228ba769 + request_id: f52dcfb7-a247-44df-866d-5e2b0f33e87c errors: - code: not_found message: User Not Found @@ -3052,20 +3076,20 @@ paths: successful_response: summary: Successful response value: - contact_id: 659ec4196abd0164c0288627 - admin_id: 991269012 + contact_id: 65c60a9186ce64d2dcea3c11 + admin_id: 991268949 body: Hello admin_not_found: summary: Admin not found value: - contact_id: 659ec4196abd0164c0288628 + contact_id: 65c60a9286ce64d2dcea3c12 admin_id: 123 body: Hello contact_not_found: summary: Contact not found value: contact_id: 123 - admin_id: 991269014 + admin_id: 991268951 body: Hello "/contacts/{contact_id}/segments": get: @@ -3098,10 +3122,10 @@ paths: type: list data: - type: segment - id: 659ec41a6abd0164c028862a + id: 65c60a9386ce64d2dcea3c14 name: segment - created_at: 1704903706 - updated_at: 1704903706 + created_at: 1707477651 + updated_at: 1707477651 person_type: user schema: "$ref": "#/components/schemas/contact_segments" @@ -3113,7 +3137,7 @@ paths: Contact not found: value: type: error.list - request_id: 7d295373-c721-4c92-95d1-97ddf8d683ba + request_id: 691719f6-2066-4807-9f48-c2cff6126092 errors: - code: not_found message: User Not Found @@ -3127,7 +3151,7 @@ paths: Unauthorized: value: type: error.list - request_id: 3243c595-1714-4ea5-9658-ce5f1b07e2a9 + request_id: 54a9e785-cae3-4792-850e-c4f974eed7d3 errors: - code: unauthorized message: Access Token Invalid @@ -3171,7 +3195,7 @@ paths: type: list data: - type: subscription - id: '274' + id: '231' state: live consent_type: opt_out default_translation: @@ -3185,7 +3209,7 @@ paths: content_types: - email - type: subscription - id: '276' + id: '233' state: live consent_type: opt_in default_translation: @@ -3208,7 +3232,7 @@ paths: Contact not found: value: type: error.list - request_id: 69db39b4-49c7-4803-9407-3a8e2617bccd + request_id: 33f87f09-472d-44d9-acea-8a6433a9ef92 errors: - code: not_found message: User Not Found @@ -3222,7 +3246,7 @@ paths: Unauthorized: value: type: error.list - request_id: eedf11ca-ada5-448b-82d7-9871a48e0cf9 + request_id: 96756579-dadb-477c-b3bc-1ecfe6fd2d72 errors: - code: unauthorized message: Access Token Invalid @@ -3263,7 +3287,7 @@ paths: Successful: value: type: subscription - id: '289' + id: '246' state: live consent_type: opt_in default_translation: @@ -3286,14 +3310,14 @@ paths: Contact not found: value: type: error.list - request_id: 8e7f65b7-d1b0-4ee5-bfa1-932c1cb33113 + request_id: f9673daa-0039-4c1c-9271-1a5bea89243b errors: - code: not_found message: User Not Found Resource not found: value: type: error.list - request_id: c8d0d520-0e15-474a-96b9-dd95245d0b5e + request_id: 8833c0f4-8cf2-4e26-9eca-d0ecb1413d31 errors: - code: not_found message: Resource Not Found @@ -3307,7 +3331,7 @@ paths: Unauthorized: value: type: error.list - request_id: 691de864-171c-448f-bfc4-890e10a6609e + request_id: 42b6aa9f-ac39-4e06-b3cb-dea4f7bd6b0a errors: - code: unauthorized message: Access Token Invalid @@ -3335,12 +3359,12 @@ paths: successful: summary: Successful value: - id: 289 + id: 246 consent_type: opt_in contact_not_found: summary: Contact not found value: - id: 293 + id: 250 consent_type: opt_in resource_not_found: summary: Resource not found @@ -3386,7 +3410,7 @@ paths: Successful: value: type: subscription - id: '305' + id: '262' state: live consent_type: opt_in default_translation: @@ -3409,14 +3433,14 @@ paths: Contact not found: value: type: error.list - request_id: a168d4ce-af1a-4ff1-9ff0-71f90ea9beb0 + request_id: 3f6c61dc-77c0-4768-9a0f-d657ce0627da errors: - code: not_found message: User Not Found Resource not found: value: type: error.list - request_id: 4a246cee-ba85-46b3-8642-51d16247eee6 + request_id: 9fbc7eb9-34b0-48c7-9f56-e23980bcff2e errors: - code: not_found message: Resource Not Found @@ -3430,7 +3454,7 @@ paths: Unauthorized: value: type: error.list - request_id: 36d76381-dfe7-477e-9a37-1da24017bb2a + request_id: ec199ed9-3e76-42d3-b9f8-e2332bae0774 errors: - code: unauthorized message: Access Token Invalid @@ -3468,7 +3492,7 @@ paths: type: list data: - type: tag - id: '261' + id: '202' name: Manual tag schema: "$ref": "#/components/schemas/tag_list" @@ -3480,7 +3504,7 @@ paths: Contact not found: value: type: error.list - request_id: 55b894cb-42c0-4ab6-8b3e-d8129b10732c + request_id: '008ae849-7843-4f97-a710-ad950fb73307' errors: - code: not_found message: User Not Found @@ -3494,7 +3518,7 @@ paths: Unauthorized: value: type: error.list - request_id: 6ae698a9-6bd4-4210-8d81-25cb10f0deb7 + request_id: c766dd1d-eccd-4957-b3be-ece5e88806b9 errors: - code: unauthorized message: Access Token Invalid @@ -3529,7 +3553,7 @@ paths: successful: value: type: tag - id: '262' + id: '203' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -3541,14 +3565,14 @@ paths: Contact not found: value: type: error.list - request_id: 9f46d030-d574-4e2a-838c-1aa7c74b02ab + request_id: bc6e9910-7eb9-47d9-8c8d-86b4c33e03c5 errors: - code: not_found message: User Not Found Tag not found: value: type: error.list - request_id: 0ae9b7c9-56ee-4db1-a1a3-1a9ee17f00a8 + request_id: 48614762-0c1d-43ae-9977-9d93dc3b6ca0 errors: - code: not_found message: Resource Not Found @@ -3562,7 +3586,7 @@ paths: Unauthorized: value: type: error.list - request_id: ea7e1fdb-8049-429d-bfce-e8a6a60822c3 + request_id: cd47cfbf-9421-43ec-bdc7-5413637549e5 errors: - code: unauthorized message: Access Token Invalid @@ -3585,11 +3609,11 @@ paths: successful: summary: successful value: - id: 262 + id: 203 contact_not_found: summary: Contact not found value: - id: 263 + id: 204 tag_not_found: summary: Tag not found value: @@ -3631,7 +3655,7 @@ paths: successful: value: type: tag - id: '265' + id: '206' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -3643,14 +3667,14 @@ paths: Contact not found: value: type: error.list - request_id: ba8ef0e1-3ec3-42ce-8d14-04ea7f8ca718 + request_id: 8d230402-1db8-4752-b6ff-5066f39ace70 errors: - code: not_found message: User Not Found Tag not found: value: type: error.list - request_id: c2d252bc-acfe-41fd-8dac-7b87e51d6fe2 + request_id: 518a5b68-7827-4022-bacb-599457976569 errors: - code: not_found message: Resource Not Found @@ -3664,7 +3688,7 @@ paths: Unauthorized: value: type: error.list - request_id: 00441540-6a74-4a5b-b028-ac7f20976b5f + request_id: 1eb95050-8881-4d1b-9b29-5432c65ec90e errors: - code: unauthorized message: Access Token Invalid @@ -3698,8 +3722,8 @@ paths: successful: value: type: contact - id: 659ec4266abd0164c0288641 - workspace_id: this_is_an_id280_that_should_be_at_least_ + id: 65c60aa086ce64d2dcea3c2b + workspace_id: this_is_an_id279_that_should_be_at_least_ external_id: '70' role: user email: joebloggs@intercom.io @@ -3714,9 +3738,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1704903718 - updated_at: 1704903718 - signed_up_at: 1704903718 + created_at: 1707477664 + updated_at: 1707477665 + signed_up_at: 1707477664 last_seen_at: last_replied_at: last_contacted_at: @@ -3750,31 +3774,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ec4266abd0164c0288641/tags" + url: "/contacts/65c60aa086ce64d2dcea3c2b/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ec4266abd0164c0288641/notes" + url: "/contacts/65c60aa086ce64d2dcea3c2b/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ec4266abd0164c0288641/companies" + url: "/contacts/65c60aa086ce64d2dcea3c2b/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ec4266abd0164c0288641/subscriptions" + url: "/contacts/65c60aa086ce64d2dcea3c2b/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ec4266abd0164c0288641/subscriptions" + url: "/contacts/65c60aa086ce64d2dcea3c2b/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3793,7 +3817,7 @@ paths: Unauthorized: value: type: error.list - request_id: '09a0b914-92b8-4208-b935-47498c466437' + request_id: 5a9e68f6-e7a4-49b9-a737-a6040dab0484 errors: - code: unauthorized message: Access Token Invalid @@ -3838,8 +3862,8 @@ paths: successful: value: type: contact - id: 659ec4276abd0164c0288642 - workspace_id: this_is_an_id284_that_should_be_at_least_ + id: 65c60aa186ce64d2dcea3c2c + workspace_id: this_is_an_id283_that_should_be_at_least_ external_id: '70' role: user email: joe@bloggs.com @@ -3854,9 +3878,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1704903719 - updated_at: 1704903719 - signed_up_at: 1704903719 + created_at: 1707477665 + updated_at: 1707477665 + signed_up_at: 1707477665 last_seen_at: last_replied_at: last_contacted_at: @@ -3890,31 +3914,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ec4276abd0164c0288642/tags" + url: "/contacts/65c60aa186ce64d2dcea3c2c/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ec4276abd0164c0288642/notes" + url: "/contacts/65c60aa186ce64d2dcea3c2c/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ec4276abd0164c0288642/companies" + url: "/contacts/65c60aa186ce64d2dcea3c2c/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ec4276abd0164c0288642/subscriptions" + url: "/contacts/65c60aa186ce64d2dcea3c2c/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ec4276abd0164c0288642/subscriptions" + url: "/contacts/65c60aa186ce64d2dcea3c2c/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3933,7 +3957,7 @@ paths: Unauthorized: value: type: error.list - request_id: afb4352a-c774-4690-81ac-cf48b48a17dc + request_id: dafe5635-9e77-4183-b275-8f305d7e0c00 errors: - code: unauthorized message: Access Token Invalid @@ -3964,7 +3988,7 @@ paths: examples: successful: value: - id: 659ec4286abd0164c0288643 + id: 65c60aa386ce64d2dcea3c2d external_id: '70' type: contact deleted: true @@ -3978,7 +4002,7 @@ paths: Unauthorized: value: type: error.list - request_id: 66d8dd5c-00a8-43c3-ab3f-9e69650bc2e3 + request_id: 4bd957fe-c943-4e6e-afdd-bc259ceb8748 errors: - code: unauthorized message: Access Token Invalid @@ -4006,8 +4030,8 @@ paths: successful: value: type: contact - id: 659ec4296abd0164c0288645 - workspace_id: this_is_an_id292_that_should_be_at_least_ + id: 65c60aa486ce64d2dcea3c2f + workspace_id: this_is_an_id291_that_should_be_at_least_ external_id: '70' role: user email: joe@bloggs.com @@ -4022,9 +4046,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1704903721 - updated_at: 1704903721 - signed_up_at: 1704903721 + created_at: 1707477668 + updated_at: 1707477668 + signed_up_at: 1707477668 last_seen_at: last_replied_at: last_contacted_at: @@ -4058,31 +4082,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ec4296abd0164c0288645/tags" + url: "/contacts/65c60aa486ce64d2dcea3c2f/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ec4296abd0164c0288645/notes" + url: "/contacts/65c60aa486ce64d2dcea3c2f/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ec4296abd0164c0288645/companies" + url: "/contacts/65c60aa486ce64d2dcea3c2f/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ec4296abd0164c0288645/subscriptions" + url: "/contacts/65c60aa486ce64d2dcea3c2f/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ec4296abd0164c0288645/subscriptions" + url: "/contacts/65c60aa486ce64d2dcea3c2f/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -4101,7 +4125,7 @@ paths: Unauthorized: value: type: error.list - request_id: 3b59cd0f-68f6-4f7a-8b36-038f68090b39 + request_id: 7db71eb6-cde8-41a4-ab84-20a1e6ed71bf errors: - code: unauthorized message: Access Token Invalid @@ -4116,8 +4140,8 @@ paths: successful: summary: successful value: - from: 659ec4296abd0164c0288644 - into: 659ec4296abd0164c0288645 + from: 65c60aa486ce64d2dcea3c2e + into: 65c60aa486ce64d2dcea3c2f "/contacts/search": post: summary: Search contacts @@ -4226,7 +4250,7 @@ paths: Unauthorized: value: type: error.list - request_id: 60e9f120-512d-46f4-956c-b87c4a9360e7 + request_id: 1ade6914-0241-4e44-a92f-740fb25ffb37 errors: - code: unauthorized message: Access Token Invalid @@ -4246,15 +4270,15 @@ paths: value: - field: id operator: "=" - value: 659ec42b6abd0164c0288648 + value: 65c60aa586ce64d2dcea3c32 - operator: OR value: - field: id operator: "=" - value: 659ec42b6abd0164c0288648 + value: 65c60aa586ce64d2dcea3c32 - field: id operator: "=" - value: 659ec42b6abd0164c0288648 + value: 65c60aa586ce64d2dcea3c32 "/contacts": get: summary: List all contacts @@ -4293,7 +4317,7 @@ paths: Unauthorized: value: type: error.list - request_id: 70e85a70-bb70-4782-9854-ffb2327da540 + request_id: b5d96e11-62d3-46d2-9551-40ca19002015 errors: - code: unauthorized message: Access Token Invalid @@ -4319,8 +4343,8 @@ paths: successful: value: type: contact - id: 659ec42d6abd0164c028864a - workspace_id: this_is_an_id304_that_should_be_at_least_ + id: 65c60aa886ce64d2dcea3c34 + workspace_id: this_is_an_id303_that_should_be_at_least_ external_id: role: user email: joebloggs@intercom.io @@ -4335,8 +4359,8 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1704903725 - updated_at: 1704903725 + created_at: 1707477672 + updated_at: 1707477672 signed_up_at: last_seen_at: last_replied_at: @@ -4371,31 +4395,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ec42d6abd0164c028864a/tags" + url: "/contacts/65c60aa886ce64d2dcea3c34/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ec42d6abd0164c028864a/notes" + url: "/contacts/65c60aa886ce64d2dcea3c34/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ec42d6abd0164c028864a/companies" + url: "/contacts/65c60aa886ce64d2dcea3c34/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ec42d6abd0164c028864a/subscriptions" + url: "/contacts/65c60aa886ce64d2dcea3c34/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ec42d6abd0164c028864a/subscriptions" + url: "/contacts/65c60aa886ce64d2dcea3c34/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -4414,7 +4438,7 @@ paths: Unauthorized: value: type: error.list - request_id: 92be95cb-2d74-4b6e-87a2-f7d7f7d1019a + request_id: 4544ab5d-f445-4329-ace3-24c890b0448d errors: - code: unauthorized message: Access Token Invalid @@ -4458,7 +4482,7 @@ paths: examples: successful: value: - id: 659ec42e6abd0164c028864b + id: 65c60aa986ce64d2dcea3c35 external_id: '70' type: contact archived: true @@ -4491,7 +4515,7 @@ paths: examples: successful: value: - id: 659ec42e6abd0164c028864c + id: 65c60aaa86ce64d2dcea3c36 external_id: '70' type: contact archived: false @@ -4527,7 +4551,7 @@ paths: successful: value: type: tag - id: '267' + id: '208' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -4539,7 +4563,7 @@ paths: Conversation not found: value: type: error.list - request_id: 0717d089-9f40-4fe8-a1f6-8c0e2c662d0d + request_id: 4d420a40-49af-422b-98c5-530e9cb4656c errors: - code: not_found message: Conversation not found @@ -4553,7 +4577,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8b9fedc3-96f7-4b3e-91de-85cd53ef5189 + request_id: 01d70e3c-6229-47e2-a87f-2076a2774b0c errors: - code: unauthorized message: Access Token Invalid @@ -4582,13 +4606,13 @@ paths: successful: summary: successful value: - id: 267 - admin_id: 991269045 + id: 208 + admin_id: 991268982 conversation_not_found: summary: Conversation not found value: - id: 268 - admin_id: 991269047 + id: 209 + admin_id: 991268984 "/conversations/{conversation_id}/tags/{id}": delete: summary: Remove tag from a conversation @@ -4626,7 +4650,7 @@ paths: successful: value: type: tag - id: '270' + id: '211' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -4638,14 +4662,14 @@ paths: Conversation not found: value: type: error.list - request_id: a0e2d7ec-0830-4704-b5c4-a1cfe3f6341a + request_id: 2389d151-f860-4968-ba72-ffa84dd5c54e errors: - code: not_found message: Conversation not found Tag not found: value: type: error.list - request_id: b5928124-e0a6-4647-87a4-d02e016cd8ff + request_id: ca305fbc-b876-495e-93bd-59c2bce41059 errors: - code: tag_not_found message: Tag not found @@ -4659,7 +4683,7 @@ paths: Unauthorized: value: type: error.list - request_id: 85564021-0b57-4ef7-9f26-b1c39c16de8a + request_id: 74d59fc8-616b-4d39-bccf-e444fbef285e errors: - code: unauthorized message: Access Token Invalid @@ -4682,15 +4706,15 @@ paths: successful: summary: successful value: - admin_id: 991269049 + admin_id: 991268986 conversation_not_found: summary: Conversation not found value: - admin_id: 991269051 + admin_id: 991268988 tag_not_found: summary: Tag not found value: - admin_id: 991269052 + admin_id: 991268989 "/conversations": get: summary: List all conversations @@ -4737,22 +4761,22 @@ paths: total_count: 1 conversations: - type: conversation - id: '819' - created_at: 1704903734 - updated_at: 1704903734 + id: '715' + created_at: 1707477681 + updated_at: 1707477681 waiting_since: snoozed_until: source: type: conversation - id: '403918547' + id: '403918480' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991269055' - name: Ciaran163 Lee - email: admin163@email.com + id: '991268992' + name: Ciaran164 Lee + email: admin164@email.com attachments: [] url: redacted: false @@ -4760,7 +4784,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ec4366abd0164c0288650 + id: 65c60ab186ce64d2dcea3c3a external_id: '70' first_contact_reply: admin_assignee_id: @@ -4795,7 +4819,7 @@ paths: Unauthorized: value: type: error.list - request_id: e1074a8b-c7ba-46fc-8d1a-b93207c18d80 + request_id: 1aae66ea-b28f-4e36-8b64-454388f33b67 errors: - code: unauthorized message: Access Token Invalid @@ -4809,7 +4833,7 @@ paths: API plan restricted: value: type: error.list - request_id: 933bd826-3a0f-4631-872b-6ae12ca04922 + request_id: 18df922b-6026-496e-8abd-4e34f5191e58 errors: - code: api_plan_restricted message: Active subscription needed. @@ -4841,11 +4865,11 @@ paths: conversation created: value: type: user_message - id: '403918557' - created_at: 1704903757 + id: '403918490' + created_at: 1707477701 body: Hello there message_type: inapp - conversation_id: '844' + conversation_id: '740' schema: "$ref": "#/components/schemas/message" '404': @@ -4856,7 +4880,7 @@ paths: Contact Not Found: value: type: error.list - request_id: 65545ed7-eb0e-4230-ac46-31d6372ab4d7 + request_id: 82a754c2-64e8-49a1-925f-d7512e408bfc errors: - code: not_found message: User Not Found @@ -4870,7 +4894,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0fa91acb-e260-408f-9c21-da48ca1a0c76 + request_id: 53899138-2829-4874-a549-8a6df1748fe0 errors: - code: unauthorized message: Access Token Invalid @@ -4884,7 +4908,7 @@ paths: API plan restricted: value: type: error.list - request_id: 690d8d74-73ab-41c7-b42a-b8366f709a05 + request_id: 899a390d-082a-44b7-a7ab-94c76250a4ef errors: - code: api_plan_restricted message: Active subscription needed. @@ -4901,7 +4925,7 @@ paths: value: from: type: user - id: 659ec44c6abd0164c0288665 + id: 65c60ac486ce64d2dcea3c4f body: Hello there contact_not_found: summary: Contact Not Found @@ -4953,22 +4977,22 @@ paths: conversation found: value: type: conversation - id: '848' - created_at: 1704903763 - updated_at: 1704903763 + id: '744' + created_at: 1707477707 + updated_at: 1707477707 waiting_since: snoozed_until: source: type: conversation - id: '403918561' + id: '403918494' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991269069' - name: Ciaran170 Lee - email: admin170@email.com + id: '991269006' + name: Ciaran171 Lee + email: admin171@email.com attachments: [] url: redacted: false @@ -4976,7 +5000,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ec4536abd0164c0288669 + id: 65c60aca86ce64d2dcea3c53 external_id: '70' first_contact_reply: admin_assignee_id: @@ -5015,7 +5039,7 @@ paths: Not found: value: type: error.list - request_id: ec54b5af-5f5b-4013-815f-f48b04b13728 + request_id: 14a2b206-48fe-492b-bed2-5c9a3f8c6454 errors: - code: not_found message: Resource Not Found @@ -5029,7 +5053,7 @@ paths: Unauthorized: value: type: error.list - request_id: 473a88ca-18e3-42e7-bcc7-e9c4de5c772a + request_id: e07f570d-3e6e-40a1-9aba-6eac0d115b7f errors: - code: unauthorized message: Access Token Invalid @@ -5043,7 +5067,7 @@ paths: API plan restricted: value: type: error.list - request_id: 72874dc4-714e-4f7d-b23f-3c3e4d6d0848 + request_id: 8eb47c12-8e27-47be-bdf9-106e70b524f6 errors: - code: api_plan_restricted message: Active subscription needed. @@ -5086,22 +5110,22 @@ paths: conversation found: value: type: conversation - id: '852' - created_at: 1704903768 - updated_at: 1704903769 + id: '748' + created_at: 1707477712 + updated_at: 1707477714 waiting_since: snoozed_until: source: type: conversation - id: '403918565' + id: '403918498' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991269077' - name: Ciaran174 Lee - email: admin174@email.com + id: '991269014' + name: Ciaran175 Lee + email: admin175@email.com attachments: [] url: redacted: false @@ -5109,7 +5133,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ec4586abd0164c028866d + id: 65c60ad086ce64d2dcea3c57 external_id: '70' first_contact_reply: admin_assignee_id: @@ -5140,35 +5164,35 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '169' + id: '163' part_type: conversation_attribute_updated_by_admin body: - created_at: 1704903769 - updated_at: 1704903769 - notified_at: 1704903769 + created_at: 1707477714 + updated_at: 1707477714 + notified_at: 1707477714 assigned_to: author: - id: '991269078' + id: '991269015' type: bot name: Operator - email: operator+this_is_an_id348_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id347_that_should_be_at_least_@intercom.io attachments: [] external_id: redacted: false metadata: {} - type: conversation_part - id: '170' + id: '164' part_type: conversation_attribute_updated_by_admin body: - created_at: 1704903769 - updated_at: 1704903769 - notified_at: 1704903769 + created_at: 1707477714 + updated_at: 1707477714 + notified_at: 1707477714 assigned_to: author: - id: '991269078' + id: '991269015' type: bot name: Operator - email: operator+this_is_an_id348_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id347_that_should_be_at_least_@intercom.io attachments: [] external_id: redacted: false @@ -5184,7 +5208,7 @@ paths: Not found: value: type: error.list - request_id: 821f265e-4176-4b58-8c62-dbd2ea82cf83 + request_id: 0c45f449-6d38-45f0-b645-5c1e79cacf2f errors: - code: not_found message: Resource Not Found @@ -5198,7 +5222,7 @@ paths: Unauthorized: value: type: error.list - request_id: 389af948-253b-4145-8b53-78ea83db7b18 + request_id: f6ab0e57-63ed-43cb-b96c-3d427a679eca errors: - code: unauthorized message: Access Token Invalid @@ -5212,7 +5236,7 @@ paths: API plan restricted: value: type: error.list - request_id: 89d9ab19-995b-472f-9b7d-c29c18be6bc8 + request_id: 96ec8ed8-4262-427a-9cf1-4f2097274dd1 errors: - code: api_plan_restricted message: Active subscription needed. @@ -5263,7 +5287,7 @@ paths: examples: successful: value: - id: '856' + id: '752' object: conversation deleted: true schema: @@ -5276,7 +5300,7 @@ paths: Unauthorized: value: type: error.list - request_id: ff3712e2-b00c-486c-8099-53f54f281c0a + request_id: 22f42e31-38f4-4182-a5d6-1b00acff41cb errors: - code: unauthorized message: Access Token Invalid @@ -5290,7 +5314,7 @@ paths: API plan restricted: value: type: error.list - request_id: 4369fbbb-b8eb-43ff-bb73-cdf1881b886d + request_id: 101922cb-36f8-4bc0-804d-298bb05ca017 errors: - code: api_plan_restricted message: Active subscription needed. @@ -5389,22 +5413,22 @@ paths: total_count: 1 conversations: - type: conversation - id: '859' - created_at: 1704903778 - updated_at: 1704903778 + id: '755' + created_at: 1707477724 + updated_at: 1707477724 waiting_since: snoozed_until: source: type: conversation - id: '403918572' + id: '403918505' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991269107' - name: Ciaran197 Lee - email: admin197@email.com + id: '991269044' + name: Ciaran198 Lee + email: admin198@email.com attachments: [] url: redacted: false @@ -5412,7 +5436,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ec4626abd0164c0288674 + id: 65c60adb86ce64d2dcea3c5e external_id: '70' first_contact_reply: admin_assignee_id: @@ -5453,15 +5477,15 @@ paths: value: - field: id operator: "=" - value: '859' + value: '755' - operator: OR value: - field: id operator: "=" - value: '859' + value: '755' - field: id operator: "=" - value: '859' + value: '755' "/conversations/{id}/reply": post: summary: Reply to a conversation @@ -5500,22 +5524,22 @@ paths: User reply: value: type: conversation - id: '867' - created_at: 1704903785 - updated_at: 1704903786 - waiting_since: 1704903786 + id: '763' + created_at: 1707477730 + updated_at: 1707477730 + waiting_since: 1707477730 snoozed_until: source: type: conversation - id: '403918575' + id: '403918508' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991269109' - name: Ciaran198 Lee - email: admin198@email.com + id: '991269046' + name: Ciaran199 Lee + email: admin199@email.com attachments: [] url: redacted: false @@ -5523,10 +5547,10 @@ paths: type: contact.list contacts: - type: contact - id: 659ec4696abd0164c028867b + id: 65c60ae286ce64d2dcea3c65 external_id: '70' first_contact_reply: - created_at: 1704903786 + created_at: 1707477730 type: conversation url: admin_assignee_id: @@ -5555,15 +5579,15 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '172' + id: '166' part_type: open body: "Thanks again :)
" - created_at: 1704903786 - updated_at: 1704903786 - notified_at: 1704903786 + created_at: 1707477730 + updated_at: 1707477730 + notified_at: 1707477730 assigned_to: author: - id: 659ec4696abd0164c028867b + id: 65c60ae286ce64d2dcea3c65 type: user name: Joe Bloggs email: joe@bloggs.com @@ -5575,22 +5599,22 @@ paths: Admin note reply: value: type: conversation - id: '868' - created_at: 1704903787 - updated_at: 1704903788 + id: '764' + created_at: 1707477732 + updated_at: 1707477732 waiting_since: snoozed_until: source: type: conversation - id: '403918576' + id: '403918509' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991269111' - name: Ciaran199 Lee - email: admin199@email.com + id: '991269048' + name: Ciaran200 Lee + email: admin200@email.com attachments: [] url: redacted: false @@ -5598,7 +5622,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ec46b6abd0164c028867c + id: 65c60ae386ce64d2dcea3c66 external_id: '70' first_contact_reply: admin_assignee_id: @@ -5627,7 +5651,7 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '173' + id: '167' part_type: note body: |-this is the message body
" author: type: admin - id: '991269113' - name: Ciaran200 Lee - email: admin200@email.com + id: '991269050' + name: Ciaran201 Lee + email: admin201@email.com attachments: [] url: redacted: false @@ -5682,7 +5706,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ec46d6abd0164c028867d + id: 65c60ae586ce64d2dcea3c67 external_id: '70' first_contact_reply: admin_assignee_id: @@ -5711,18 +5735,18 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '174' + id: '168' part_type: quick_reply body: - created_at: 1704903790 - updated_at: 1704903790 - notified_at: 1704903790 + created_at: 1707477734 + updated_at: 1707477734 + notified_at: 1707477734 assigned_to: author: - id: '991269113' + id: '991269050' type: admin - name: Ciaran200 Lee - email: admin200@email.com + name: Ciaran201 Lee + email: admin201@email.com attachments: [] external_id: redacted: false @@ -5731,22 +5755,22 @@ paths: User last conversation reply: value: type: conversation - id: '870' - created_at: 1704903791 - updated_at: 1704903792 - waiting_since: 1704903792 + id: '766' + created_at: 1707477735 + updated_at: 1707477736 + waiting_since: 1707477736 snoozed_until: source: type: conversation - id: '403918578' + id: '403918511' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991269115' - name: Ciaran201 Lee - email: admin201@email.com + id: '991269052' + name: Ciaran202 Lee + email: admin202@email.com attachments: [] url: redacted: false @@ -5754,10 +5778,10 @@ paths: type: contact.list contacts: - type: contact - id: 659ec46e6abd0164c028867e + id: 65c60ae786ce64d2dcea3c68 external_id: '70' first_contact_reply: - created_at: 1704903792 + created_at: 1707477736 type: conversation url: admin_assignee_id: @@ -5786,15 +5810,15 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '175' + id: '169' part_type: open body: "Thanks again :)
" - created_at: 1704903792 - updated_at: 1704903792 - notified_at: 1704903792 + created_at: 1707477736 + updated_at: 1707477736 + notified_at: 1707477736 assigned_to: author: - id: 659ec46e6abd0164c028867e + id: 65c60ae786ce64d2dcea3c68 type: user name: Joe Bloggs email: joe@bloggs.com @@ -5813,7 +5837,7 @@ paths: Not found: value: type: error.list - request_id: ddb8686d-ff9f-4ffb-80e5-e16fe733b8b6 + request_id: d9df585a-8ab9-4dc2-81fb-e764154342b2 errors: - code: not_found message: Resource Not Found @@ -5827,7 +5851,7 @@ paths: Unauthorized: value: type: error.list - request_id: 10bc34f2-3b5e-4cc9-b93c-479b8c97f370 + request_id: c01d54ec-98c8-45fb-8d71-8e02735bbb09 errors: - code: unauthorized message: Access Token Invalid @@ -5841,7 +5865,7 @@ paths: API plan restricted: value: type: error.list - request_id: 045dc491-f25d-4d97-94bc-cb6ea9f49659 + request_id: bc287030-2792-4db2-8936-712b113a2bd6 errors: - code: api_plan_restricted message: Active subscription needed. @@ -5858,14 +5882,14 @@ paths: value: message_type: comment type: user - intercom_user_id: 659ec4696abd0164c028867b + intercom_user_id: 65c60ae286ce64d2dcea3c65 body: Thanks again :) admin_note_reply: summary: Admin note reply value: message_type: note type: admin - admin_id: 991269111 + admin_id: 991269048 body: "this is the message body
" author: type: admin - id: '991269123' - name: Ciaran205 Lee - email: admin205@email.com + id: '991269060' + name: Ciaran206 Lee + email: admin206@email.com attachments: [] url: redacted: false @@ -5950,7 +5974,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ec4746abd0164c0288682 + id: 65c60aed86ce64d2dcea3c6c external_id: '70' first_contact_reply: admin_assignee_id: @@ -5979,18 +6003,18 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '176' + id: '170' part_type: close body: "Goodbye :)
" - created_at: 1704903797 - updated_at: 1704903797 - notified_at: 1704903797 + created_at: 1707477743 + updated_at: 1707477743 + notified_at: 1707477743 assigned_to: author: - id: '991269123' + id: '991269060' type: admin - name: Ciaran205 Lee - email: admin205@email.com + name: Ciaran206 Lee + email: admin206@email.com attachments: [] external_id: redacted: false @@ -5999,22 +6023,22 @@ paths: Snooze a conversation: value: type: conversation - id: '875' - created_at: 1704903799 - updated_at: 1704903800 + id: '771' + created_at: 1707477744 + updated_at: 1707477745 waiting_since: - snoozed_until: 1704907400 + snoozed_until: 1707481345 source: type: conversation - id: '403918583' + id: '403918516' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991269125' - name: Ciaran206 Lee - email: admin206@email.com + id: '991269062' + name: Ciaran207 Lee + email: admin207@email.com attachments: [] url: redacted: false @@ -6022,7 +6046,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ec4766abd0164c0288683 + id: 65c60af086ce64d2dcea3c6d external_id: '70' first_contact_reply: admin_assignee_id: @@ -6051,18 +6075,18 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '177' + id: '171' part_type: snoozed body: - created_at: 1704903800 - updated_at: 1704903800 - notified_at: 1704903800 + created_at: 1707477745 + updated_at: 1707477745 + notified_at: 1707477745 assigned_to: author: - id: '991269125' + id: '991269062' type: admin - name: Ciaran206 Lee - email: admin206@email.com + name: Ciaran207 Lee + email: admin207@email.com attachments: [] external_id: redacted: false @@ -6071,22 +6095,22 @@ paths: Open a conversation: value: type: conversation - id: '880' - created_at: 1704903799 - updated_at: 1704903807 + id: '776' + created_at: 1707477744 + updated_at: 1707477753 waiting_since: snoozed_until: source: type: conversation - id: '403918584' + id: '403918517' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991269127' - name: Ciaran207 Lee - email: admin207@email.com + id: '991269064' + name: Ciaran208 Lee + email: admin208@email.com attachments: [] url: redacted: false @@ -6094,7 +6118,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ec47c6abd0164c0288688 + id: 65c60af586ce64d2dcea3c72 external_id: '74' first_contact_reply: admin_assignee_id: @@ -6123,18 +6147,18 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '179' + id: '173' part_type: open body: - created_at: 1704903807 - updated_at: 1704903807 - notified_at: 1704903807 + created_at: 1707477753 + updated_at: 1707477753 + notified_at: 1707477753 assigned_to: author: - id: '991269127' + id: '991269064' type: admin - name: Ciaran207 Lee - email: admin207@email.com + name: Ciaran208 Lee + email: admin208@email.com attachments: [] external_id: redacted: false @@ -6143,22 +6167,22 @@ paths: Assign a conversation: value: type: conversation - id: '884' - created_at: 1704903808 - updated_at: 1704903809 + id: '780' + created_at: 1707477754 + updated_at: 1707477756 waiting_since: snoozed_until: source: type: conversation - id: '403918587' + id: '403918520' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991269129' - name: Ciaran208 Lee - email: admin208@email.com + id: '991269066' + name: Ciaran209 Lee + email: admin209@email.com attachments: [] url: redacted: false @@ -6166,10 +6190,10 @@ paths: type: contact.list contacts: - type: contact - id: 659ec4806abd0164c028868b + id: 65c60afa86ce64d2dcea3c75 external_id: '70' first_contact_reply: - admin_assignee_id: 991269129 + admin_assignee_id: 991269066 team_assignee_id: open: true state: open @@ -6195,20 +6219,20 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '180' + id: '174' part_type: assign_and_reopen body: - created_at: 1704903809 - updated_at: 1704903809 - notified_at: 1704903809 + created_at: 1707477756 + updated_at: 1707477756 + notified_at: 1707477756 assigned_to: type: admin - id: '991269129' + id: '991269066' author: - id: '991269129' + id: '991269066' type: admin - name: Ciaran208 Lee - email: admin208@email.com + name: Ciaran209 Lee + email: admin209@email.com attachments: [] external_id: redacted: false @@ -6224,7 +6248,7 @@ paths: Not found: value: type: error.list - request_id: 917eb5e0-461d-46a8-9f50-656e7ce4a3a6 + request_id: 11d6a4b7-7e7b-47dd-be62-208270a7dac7 errors: - code: not_found message: Resource Not Found @@ -6238,7 +6262,7 @@ paths: Unauthorized: value: type: error.list - request_id: 1bf38a19-e450-4c6d-9654-98d2e4877849 + request_id: d51cac40-4ce3-4826-af8f-6199def04e8b errors: - code: unauthorized message: Access Token Invalid @@ -6252,7 +6276,7 @@ paths: API plan restricted: value: type: error.list - request_id: abb6792c-f636-4e04-b045-35e783b6bfad + request_id: 0a4661ed-4231-4864-b8f2-085b7c7f0f36 errors: - code: api_plan_restricted message: Active subscription needed. @@ -6273,32 +6297,32 @@ paths: value: message_type: close type: admin - admin_id: 991269123 + admin_id: 991269060 body: Goodbye :) snooze_a_conversation: summary: Snooze a conversation value: message_type: snoozed - admin_id: 991269125 - snoozed_until: 1704907400 + admin_id: 991269062 + snoozed_until: 1707481345 open_a_conversation: summary: Open a conversation value: message_type: open - admin_id: 991269127 + admin_id: 991269064 assign_a_conversation: summary: Assign a conversation value: message_type: assignment type: admin - admin_id: 991269129 - assignee_id: 991269129 + admin_id: 991269066 + assignee_id: 991269066 not_found: summary: Not found value: message_type: close type: admin - admin_id: 991269131 + admin_id: 991269068 body: Goodbye :) "/conversations/{id}/run_assignment_rules": post: @@ -6329,22 +6353,22 @@ paths: Assign a conversation using assignment rules: value: type: conversation - id: '888' - created_at: 1704903815 - updated_at: 1704903816 + id: '784' + created_at: 1707477762 + updated_at: 1707477763 waiting_since: snoozed_until: source: type: conversation - id: '403918591' + id: '403918524' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991269137' - name: Ciaran212 Lee - email: admin212@email.com + id: '991269074' + name: Ciaran213 Lee + email: admin213@email.com attachments: [] url: redacted: false @@ -6352,7 +6376,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ec4876abd0164c028868f + id: 65c60b0286ce64d2dcea3c79 external_id: '70' first_contact_reply: admin_assignee_id: @@ -6381,20 +6405,20 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '181' + id: '175' part_type: default_assignment body: - created_at: 1704903816 - updated_at: 1704903816 - notified_at: 1704903816 + created_at: 1707477763 + updated_at: 1707477763 + notified_at: 1707477763 assigned_to: type: nobody_admin id: author: - id: '991269138' + id: '991269075' type: bot name: Operator - email: operator+this_is_an_id392_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id391_that_should_be_at_least_@intercom.io attachments: [] external_id: redacted: false @@ -6410,7 +6434,7 @@ paths: Not found: value: type: error.list - request_id: c1a35bf7-bc78-4ae8-95d8-81370a2c9d86 + request_id: 7bd0a011-a57d-4704-8266-1fb3ce469449 errors: - code: not_found message: Resource Not Found @@ -6424,7 +6448,7 @@ paths: Unauthorized: value: type: error.list - request_id: 87a11dd6-6207-45f3-a352-25788e84835e + request_id: f73abb83-a3ff-4c06-b31b-3d06a2aaf80b errors: - code: unauthorized message: Access Token Invalid @@ -6438,7 +6462,7 @@ paths: API plan restricted: value: type: error.list - request_id: 6a6649c6-cc1e-4514-8b1b-4ed69a2b82a6 + request_id: 88b24010-779b-445b-bd00-222b6fc8cd62 errors: - code: api_plan_restricted message: Active subscription needed. @@ -6477,7 +6501,7 @@ paths: value: customers: - type: user - id: 659ec48d6abd0164c0288693 + id: 65c60b0886ce64d2dcea3c7d schema: "$ref": "#/components/schemas/conversation" '404': @@ -6488,7 +6512,7 @@ paths: Not found: value: type: error.list - request_id: 189b020e-33dd-4337-8251-0b00ec7f53d1 + request_id: 37df33f7-5874-467b-9fe4-3893891f06f4 errors: - code: not_found message: Resource Not Found @@ -6502,7 +6526,7 @@ paths: Unauthorized: value: type: error.list - request_id: 1e8d039d-ecfd-4754-9de8-00387f3d2f91 + request_id: 682e2a0b-6350-4aae-ab42-1107aba99a5b errors: - code: unauthorized message: Access Token Invalid @@ -6516,7 +6540,7 @@ paths: API plan restricted: value: type: error.list - request_id: '029f8340-b4c5-4e27-a208-e795e8d6c426' + request_id: 56647881-3255-4322-9294-45150d16c6c5 errors: - code: api_plan_restricted message: Active subscription needed. @@ -6531,15 +6555,15 @@ paths: attach_a_contact_to_a_conversation: summary: Attach a contact to a conversation value: - admin_id: 991269145 + admin_id: 991269082 customer: - intercom_user_id: 659ec48d6abd0164c0288693 + intercom_user_id: 65c60b0886ce64d2dcea3c7d not_found: summary: Not found value: - admin_id: 991269147 + admin_id: 991269084 customer: - intercom_user_id: 659ec48f6abd0164c0288694 + intercom_user_id: 65c60b0986ce64d2dcea3c7e "/conversations/{conversation_id}/customers/{contact_id}": delete: summary: Detach a contact from a group conversation @@ -6580,7 +6604,7 @@ paths: value: customers: - type: user - id: 659ec49a6abd0164c028869e + id: 65c60b1386ce64d2dcea3c88 schema: "$ref": "#/components/schemas/conversation" '404': @@ -6591,14 +6615,14 @@ paths: Conversation not found: value: type: error.list - request_id: 61a312a0-69f6-4b68-8735-549b6c7b5236 + request_id: 86ef6e5c-ee60-4134-b46c-b022fea956cf errors: - code: not_found message: Resource Not Found Contact not found: value: type: error.list - request_id: 58970872-e6a2-4f14-bb7a-db32676c007c + request_id: 23a34bd7-025a-4880-93c0-e64b2bbce1fe errors: - code: not_found message: User Not Found @@ -6612,7 +6636,7 @@ paths: Last customer: value: type: error.list - request_id: 4dabf0b3-3495-4d32-b065-28c1b2e9acad + request_id: 70089ea5-4108-497c-8c87-8e220732136e errors: - code: parameter_invalid message: Removing the last customer is not allowed @@ -6626,7 +6650,7 @@ paths: Unauthorized: value: type: error.list - request_id: 5c48f485-e778-41f9-a2c0-461796b4662f + request_id: 4a97a122-1b02-4b4e-a217-34f90ea70a7d errors: - code: unauthorized message: Access Token Invalid @@ -6640,7 +6664,7 @@ paths: API plan restricted: value: type: error.list - request_id: 56693267-cfb5-4d0d-8851-435c568680f3 + request_id: d13b1d57-b591-454a-9243-15c7cb5edd6b errors: - code: api_plan_restricted message: Active subscription needed. @@ -6655,27 +6679,27 @@ paths: detach_a_contact_from_a_group_conversation: summary: Detach a contact from a group conversation value: - admin_id: 991269153 + admin_id: 991269090 customer: - intercom_user_id: 659ec4926abd0164c0288697 + intercom_user_id: 65c60b0e86ce64d2dcea3c81 conversation_not_found: summary: Conversation not found value: - admin_id: 991269155 + admin_id: 991269092 customer: - intercom_user_id: 659ec49b6abd0164c028869f + intercom_user_id: 65c60b1486ce64d2dcea3c89 contact_not_found: summary: Contact not found value: - admin_id: 991269157 + admin_id: 991269094 customer: - intercom_user_id: 659ec4a36abd0164c02886a6 + intercom_user_id: 65c60b1b86ce64d2dcea3c90 last_customer: summary: Last customer value: - admin_id: 991269159 + admin_id: 991269096 customer: - intercom_user_id: 659ec4a96abd0164c02886ad + intercom_user_id: 65c60b2186ce64d2dcea3c97 "/conversations/redact": post: summary: Redact a conversation part @@ -6702,22 +6726,22 @@ paths: Redact a conversation part: value: type: conversation - id: '944' - created_at: 1704903869 - updated_at: 1704903871 - waiting_since: 1704903869 + id: '840' + created_at: 1707477811 + updated_at: 1707477812 + waiting_since: 1707477812 snoozed_until: source: type: conversation - id: '403918617' + id: '403918550' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991269165' - name: Ciaran226 Lee - email: admin226@email.com + id: '991269102' + name: Ciaran227 Lee + email: admin227@email.com attachments: [] url: redacted: false @@ -6725,10 +6749,10 @@ paths: type: contact.list contacts: - type: contact - id: 659ec4bc6abd0164c02886c2 + id: 65c60b3386ce64d2dcea3cac external_id: '70' first_contact_reply: - created_at: 1704903869 + created_at: 1707477812 type: conversation url: admin_assignee_id: @@ -6757,15 +6781,15 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '189' + id: '183' part_type: open body: "This message was deleted
" - created_at: 1704903869 - updated_at: 1704903871 - notified_at: 1704903869 + created_at: 1707477812 + updated_at: 1707477812 + notified_at: 1707477812 assigned_to: author: - id: 659ec4bc6abd0164c02886c2 + id: 65c60b3386ce64d2dcea3cac type: user name: Joe Bloggs email: joe@bloggs.com @@ -6784,7 +6808,7 @@ paths: Not found: value: type: error.list - request_id: 23c8e2eb-c9ad-4d5f-af09-bb87ac5138f9 + request_id: 947ead2c-4d62-41f1-ba7e-f5657fb95b99 errors: - code: conversation_part_or_message_not_found message: Conversation part or message not found @@ -6798,7 +6822,7 @@ paths: Unauthorized: value: type: error.list - request_id: 36146671-8234-43bf-b8f1-6579a89fbb6e + request_id: 0f42defd-3e84-4153-8edf-822fab467cd0 errors: - code: unauthorized message: Access Token Invalid @@ -6814,8 +6838,8 @@ paths: summary: Redact a conversation part value: type: conversation_part - conversation_id: 944 - conversation_part_id: 189 + conversation_id: 840 + conversation_part_id: 183 not_found: summary: Not found value: @@ -6850,7 +6874,7 @@ paths: successful: value: type: ticket - id: '947' + id: '843' ticket_id: '24' ticket_attributes: {} ticket_state: submitted @@ -6860,10 +6884,10 @@ paths: name: my-ticket-type-1 description: my ticket type description is awesome. icon: "\U0001F981" - workspace_id: this_is_an_id426_that_should_be_at_least_ + workspace_id: this_is_an_id425_that_should_be_at_least_ archived: false - created_at: 1704903876 - updated_at: 1704903876 + created_at: 1707477818 + updated_at: 1707477818 is_internal: false ticket_type_attributes: type: list @@ -6873,40 +6897,40 @@ paths: type: contact.list contacts: - type: contact - id: 659ec4c26abd0164c02886c5 + id: 65c60b3986ce64d2dcea3caf external_id: '70' admin_assignee_id: '0' team_assignee_id: '0' - created_at: 1704903874 - updated_at: 1704903876 + created_at: 1707477817 + updated_at: 1707477819 ticket_parts: type: ticket_part.list ticket_parts: - type: ticket_part - id: '191' + id: '185' part_type: comment body: "Comment for message
" - created_at: 1704903874 - updated_at: 1704903874 + created_at: 1707477817 + updated_at: 1707477817 author: - id: 659ec4c26abd0164c02886c5 + id: 65c60b3986ce64d2dcea3caf type: user name: Joe Bloggs email: joe@bloggs.com attachments: [] redacted: false - type: ticket_part - id: '192' + id: '186' part_type: ticket_state_updated_by_admin ticket_state: submitted previous_ticket_state: submitted - created_at: 1704903876 - updated_at: 1704903876 + created_at: 1707477819 + updated_at: 1707477819 author: - id: '991269175' + id: '991269112' type: bot name: Operator - email: operator+this_is_an_id426_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id425_that_should_be_at_least_@intercom.io attachments: [] redacted: false total_count: 2 @@ -6928,7 +6952,7 @@ paths: Bad request: value: type: error.list - request_id: ff47d2c7-957a-4765-a373-c6b2faa4cad1 + request_id: a4a613fb-5fa8-416e-b246-291b8bfeef11 errors: - code: parameter_invalid message: Ticket type is not a customer ticket type @@ -6948,6 +6972,237 @@ paths: summary: Bad request value: ticket_type_id: '109' + "/custom_object_instances/{custom_object_type_identifier}": + parameters: + - name: custom_object_type_identifier + in: path + description: The unique identifier of the custom object type that defines the + structure of the custom object instance. + example: Order + required: true + schema: + type: string + post: + summary: create_or_update object_instance + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Custom Object Instances + description: Create or update a custom object instance + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: '1' + type: object_type_identifier_1 + custom_attributes: {} + external_id: '123' + external_created_at: 1392036272 + external_updated_at: 1392036272 + created_at: 1707477823 + updated_at: 1707477823 + schema: + "$ref": "#/components/schemas/custom_object_instance" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: fe45d2e5-82b4-48e3-a09b-ba537951dbbd + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_or_update_custom_object_instance_request" + examples: + successful: + summary: successful + value: + external_id: '123' + external_created_at: 1392036272 + external_updated_at: 1392036272 + get: + summary: show object_instance + parameters: + - name: fetch_custom_object_instance_request + in: query + style: form + required: true + schema: + type: object + oneOf: + - description: The Intercom defined id representing the custom object instance. + title: Find by id + properties: + external_id: + type: string + required: + - external_id + additionalProperties: false + - description: The unique identifier for the instance in the external system + it originated from. + title: Find by external_id + properties: + external_id: + type: string + required: + - external_id + additionalProperties: false + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Custom Object Instances + description: Fetch a Custom Object Instance by external_id + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: '3' + type: object_type_identifier_4 + custom_attributes: {} + external_id: '123' + external_created_at: + external_updated_at: + created_at: 1707477824 + updated_at: 1707477824 + schema: + "$ref": "#/components/schemas/custom_object_instance" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 50411270-54b3-410d-afdb-da9ef8149241 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/custom_object_instances/{custom_object_type_identifier}/{id}": + parameters: + - name: custom_object_type_identifier + in: path + description: The unique identifier of the custom object type that defines the + structure of the custom object instance. + example: Order + required: true + schema: + type: string + get: + summary: show object_instance + parameters: + - name: id + in: path + description: The id or external_id of the custom object instance + required: true + schema: + type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Custom Object Instances + description: Fetch a Custom Object Instance by id + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: '4' + type: object_type_identifier_6 + custom_attributes: {} + external_id: '123' + external_created_at: + external_updated_at: + created_at: 1707477825 + updated_at: 1707477825 + schema: + "$ref": "#/components/schemas/custom_object_instance" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: f131b944-9a3f-405b-b790-44e547f5ee4e + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + delete: + summary: delete object_instance + parameters: + - name: id + in: path + description: The Intercom id of the custom object instance + required: true + schema: + type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Custom Object Instances + description: Deleting a single Custom Object instance. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: '5' + object: object_type_identifier_8 + deleted: true + schema: + "$ref": "#/components/schemas/custom_object_instance_deleted" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 848f1ac2-81b0-4ac5-b11f-1ddf1b885c99 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" "/data_attributes": get: summary: List all data attributes @@ -6998,6 +7253,7 @@ paths: data_type: string api_writable: true ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -7009,6 +7265,7 @@ paths: data_type: string api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -7021,6 +7278,7 @@ paths: data_type: date api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -7032,6 +7290,7 @@ paths: data_type: date api_writable: true ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -7043,6 +7302,7 @@ paths: data_type: integer api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -7055,6 +7315,7 @@ paths: data_type: integer api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -7067,6 +7328,7 @@ paths: data_type: string api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -7078,6 +7340,7 @@ paths: data_type: float api_writable: true ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -7090,6 +7353,7 @@ paths: data_type: integer api_writable: true ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -7102,6 +7366,7 @@ paths: data_type: string api_writable: true ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -7114,10 +7379,11 @@ paths: data_type: string api_writable: true ui_writable: false + messenger_writable: true custom: false archived: false model: company - - id: 138 + - id: 82 type: data_attribute name: The One Ring full_name: custom_attributes.The One Ring @@ -7127,11 +7393,12 @@ paths: data_type: string api_writable: true ui_writable: false + messenger_writable: true custom: true archived: false - admin_id: '991269183' - created_at: 1704903879 - updated_at: 1704903879 + admin_id: '991269129' + created_at: 1707477827 + updated_at: 1707477827 model: company - type: data_attribute name: id @@ -7141,6 +7408,7 @@ paths: data_type: string api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -7152,6 +7420,7 @@ paths: data_type: date api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -7163,6 +7432,7 @@ paths: data_type: date api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -7174,6 +7444,7 @@ paths: data_type: string api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -7185,6 +7456,7 @@ paths: data_type: string api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -7198,7 +7470,7 @@ paths: Unauthorized: value: type: error.list - request_id: 23758fbb-8387-42d5-bd33-e57ffd8f8b10 + request_id: a4f6d7b6-cd72-4993-817d-f482f83437a5 errors: - code: unauthorized message: Access Token Invalid @@ -7223,7 +7495,7 @@ paths: examples: Successful: value: - id: 141 + id: 85 type: data_attribute name: Mithril Shirt full_name: custom_attributes.Mithril Shirt @@ -7231,11 +7503,12 @@ paths: data_type: string api_writable: true ui_writable: false + messenger_writable: false custom: true archived: false - admin_id: '991269185' - created_at: 1704903880 - updated_at: 1704903880 + admin_id: '991269131' + created_at: 1707477828 + updated_at: 1707477828 model: company schema: "$ref": "#/components/schemas/data_attribute" @@ -7247,7 +7520,7 @@ paths: Same name already exists: value: type: error.list - request_id: c0ba02a0-8bf0-4f17-ae44-0cc30b3c0255 + request_id: 10ad148b-6e0d-4002-b000-6b934985f891 errors: - code: parameter_invalid message: You already have 'The One Ring' in your company data. @@ -7255,7 +7528,7 @@ paths: Invalid name: value: type: error.list - request_id: b6f86b8e-175d-4f02-9d9a-51f5d84600e0 + request_id: affd8241-3872-48d8-aae0-8d44dda9b746 errors: - code: parameter_invalid message: Your name for this attribute must only contain alphanumeric @@ -7263,7 +7536,7 @@ paths: Attribute already exists: value: type: error.list - request_id: b6b61265-a059-467d-930c-9f267d8740ae + request_id: 8d293d1b-cac2-4f34-9ba1-86e3d227ad81 errors: - code: parameter_invalid message: You already have 'The One Ring' in your company data. @@ -7271,14 +7544,14 @@ paths: Invalid Data Type: value: type: error.list - request_id: f414dd43-7238-4113-aec1-a9698b085b04 + request_id: 1e7e0692-1aa6-47cc-b49d-bcb2d810651f errors: - code: parameter_invalid message: Data Type isn't an option Too few options for list: value: type: error.list - request_id: 4d6e67a5-47bc-43eb-9222-ac453e3cc657 + request_id: c4be59fb-0c1e-4e79-9aa1-b12feb96305f errors: - code: parameter_invalid message: The Data Attribute model field must be either contact @@ -7293,7 +7566,7 @@ paths: Unauthorized: value: type: error.list - request_id: 76ca950e-d96b-4fb4-83c3-012cb7840a1c + request_id: d56bfef6-1f89-45ed-af88-211385f15ecd errors: - code: unauthorized message: Access Token Invalid @@ -7372,7 +7645,7 @@ paths: examples: Successful: value: - id: 148 + id: 92 type: data_attribute name: The One Ring full_name: custom_attributes.The One Ring @@ -7384,11 +7657,12 @@ paths: - 11-20 api_writable: true ui_writable: false + messenger_writable: true custom: true archived: false - admin_id: '991269192' - created_at: 1704903883 - updated_at: 1704903883 + admin_id: '991269138' + created_at: 1707477831 + updated_at: 1707477831 model: company schema: "$ref": "#/components/schemas/data_attribute" @@ -7400,7 +7674,7 @@ paths: Too few options in list: value: type: error.list - request_id: fb2e4e2e-523b-4ef3-a602-cff95e0814b3 + request_id: 47d7fbac-6ed1-4370-8462-08940fc32b43 errors: - code: parameter_invalid message: Options isn't an array @@ -7414,7 +7688,7 @@ paths: Attribute Not Found: value: type: error.list - request_id: b04d200a-7580-4865-a9b9-55443d06d9fc + request_id: 56261d68-6d46-48dc-854b-7f089bc717a3 errors: - code: field_not_found message: We couldn't find that data attribute to update @@ -7428,7 +7702,7 @@ paths: Has Dependant Object: value: type: error.list - request_id: 3976d450-6ee4-4bff-b82c-737bda9a43e7 + request_id: 19cebcfa-b78e-44a7-bd00-07cbe9ef2064 errors: - code: data_invalid message: The Data Attribute you are trying to archive has a @@ -7443,7 +7717,7 @@ paths: Unauthorized: value: type: error.list - request_id: be041231-fdff-4b28-bdad-32d8a80946cc + request_id: 02324d38-7589-41cc-9699-bfef2229e9e4 errors: - code: unauthorized message: Access Token Invalid @@ -7494,63 +7768,49 @@ paths: tags: - Data Events operationId: createDataEvent - description: "\nYou will need an Access Token that has write permissions to - send Events. Once you have a key you can submit events via POST to the Events - resource, which is located at https://api.intercom.io/events, or you can send - events using one of the client libraries. When working with the HTTP API directly - a client should send the event with a `Content-Type` of `application/json`.\n\nWhen - using the JavaScript API, [adding the code to your app](http://docs.intercom.io/configuring-Intercom/tracking-user-events-in-your-app) - makes the Events API available. Once added, you can submit an event using - the `trackEvent` method. This will associate the event with the Lead or currently - logged-in user or logged-out visitor/lead and send it to Intercom. The final - parameter is a map that can be used to send optional metadata about the event.\n\nWith - the Ruby client you pass a hash describing the event to `Intercom::Event.create`, - or call the `track_user` method directly on the current user object (e.g. - `user.track_event`).\n\n| Type | Description | - Example |\n| - :-------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- - | :-------------------------------------------------------------------------------- - |\n| String | The value is a JSON String | - `\"source\":\"desktop\"` |\n| - Number | The value is a JSON Number | - `\"load\": 3.67` |\n| - Date | The key ends with the String `_date` and the value is a - [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time), assumed to be in - the [UTC](http://en.wikipedia.org/wiki/Coordinated_Universal_Time) timezone. - | `\"contact_date\": 1392036272` |\n| - Link | The value is a HTTP or HTTPS URI. | - `\"article\": \"https://example.org/ab1de.html\"` |\n| - Rich Link | The value is a JSON object that contains `url` and `value` - keys. | - `\"article\": {\"url\": \"https://example.org/ab1de.html\", \"value\":\"the - dude abides\"}` |\n| Monetary Amount | The value is a JSON object that contains - `amount` and `currency` keys. The `amount` key is a positive integer representing - the amount in cents. The price in the example to the right denotes €349.99. - \ | `\"price\": {\"amount\": 34999, \"currency\": \"eur\"}` |\n\n**NB: - For the JSON object types, please note that we do not currently support nested - JSON structure.**\n\n> \U0001F6A7 Lead Events\n>\n> When submitting events - for Leads, you will need to specify the Lead's `id`.\n\n> \U0001F4D8 Metadata - behaviour\n>\n> - We currently limit the number of tracked metadata keys to - 10 per event. Once the quota is reached, we ignore any further keys we receive. - The first 10 metadata keys are determined by the order in which they are sent - in with the event.\n> - It is not possible to change the metadata keys once - the event has been sent. A new event will need to be created with the new - keys and you can archive the old one.\n> - There might be up to 24 hrs delay - when you send a new metadata for an existing event.\n\n> \U0001F4D8 Event - de-duplication\n>\n> The API may detect and ignore duplicate events. Each - event is uniquely identified as a combination of the following data - the - Workspace identifier, the Contact external identifier, the Data Event name - and the Data Event created time. As a result, it is **strongly recommended** - to send a second granularity Unix timestamp in the `created_at` field.\n>\n> - Duplicated events are responded to using the normal `202 Accepted` code - - an error is not thrown, however repeat requests will be counted against any - rate limit that is in place.\n\n### HTTP API Responses\n\n- Successful responses - to submitted events return `202 Accepted` with an empty body.\n- Unauthorised - access will be rejected with a `401 Unauthorized` or `403 Forbidden` response - code.\n- Events sent about users that cannot be found will return a `404 Not - Found`.\n- Event lists containing duplicate events will have those duplicates - ignored.\n- Server errors will return a `500` response code and may contain - an error message in the body.\n\n" + description: |2+ + + You will need an Access Token that has write permissions to send Events. Once you have a key you can submit events via POST to the Events resource, which is located at https://api.intercom.io/events, or you can send events using one of the client libraries. When working with the HTTP API directly a client should send the event with a `Content-Type` of `application/json`. + + When using the JavaScript API, [adding the code to your app](http://docs.intercom.io/configuring-Intercom/tracking-user-events-in-your-app) makes the Events API available. Once added, you can submit an event using the `trackEvent` method. This will associate the event with the Lead or currently logged-in user or logged-out visitor/lead and send it to Intercom. The final parameter is a map that can be used to send optional metadata about the event. + + With the Ruby client you pass a hash describing the event to `Intercom::Event.create`, or call the `track_user` method directly on the current user object (e.g. `user.track_event`). + + **NB: For the JSON object types, please note that we do not currently support nested JSON structure.** + + | Type | Description | Example | + | :-------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------- | + | String | The value is a JSON String | `"source":"desktop"` | + | Number | The value is a JSON Number | `"load": 3.67` | + | Date | The key ends with the String `_date` and the value is a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time), assumed to be in the [UTC](http://en.wikipedia.org/wiki/Coordinated_Universal_Time) timezone. | `"contact_date": 1392036272` | + | Link | The value is a HTTP or HTTPS URI. | `"article": "https://example.org/ab1de.html"` | + | Rich Link | The value is a JSON object that contains `url` and `value` keys. | `"article": {"url": "https://example.org/ab1de.html", "value":"the dude abides"}` | + | Monetary Amount | The value is a JSON object that contains `amount` and `currency` keys. The `amount` key is a positive integer representing the amount in cents. The price in the example to the right denotes €349.99. | `"price": {"amount": 34999, "currency": "eur"}` | + + **Lead Events** + + When submitting events for Leads, you will need to specify the Lead's `id`. + + **Metadata behaviour** + + - We currently limit the number of tracked metadata keys to 10 per event. Once the quota is reached, we ignore any further keys we receive. The first 10 metadata keys are determined by the order in which they are sent in with the event. + - It is not possible to change the metadata keys once the event has been sent. A new event will need to be created with the new keys and you can archive the old one. + - There might be up to 24 hrs delay when you send a new metadata for an existing event. + + **Event de-duplication** + + The API may detect and ignore duplicate events. Each event is uniquely identified as a combination of the following data - the Workspace identifier, the Contact external identifier, the Data Event name and the Data Event created time. As a result, it is **strongly recommended** to send a second granularity Unix timestamp in the `created_at` field. + + Duplicated events are responded to using the normal `202 Accepted` code - an error is not thrown, however repeat requests will be counted against any rate limit that is in place. + + ### HTTP API Responses + + - Successful responses to submitted events return `202 Accepted` with an empty body. + - Unauthorised access will be rejected with a `401 Unauthorized` or `403 Forbidden` response code. + - Events sent about users that cannot be found will return a `404 Not Found`. + - Event lists containing duplicate events will have those duplicates ignored. + - Server errors will return a `500` response code and may contain an error message in the body. + responses: '202': description: successful @@ -7562,7 +7822,7 @@ paths: Unauthorized: value: type: error.list - request_id: e8f477b3-28ed-47d9-8538-a38e03e4f999 + request_id: a8772112-6296-44e0-8ba4-e752c63551b6 errors: - code: unauthorized message: Access Token Invalid @@ -7648,8 +7908,8 @@ paths: events: [] pages: next: http://api.intercom.test/events?next page - email: user24@email.com - intercom_user_id: 659ec4d36abd0164c02886db + email: user26@email.com + intercom_user_id: 65c60b4b86ce64d2dcea3cb5 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 schema: "$ref": "#/components/schemas/data_event_summary" @@ -7661,7 +7921,7 @@ paths: Unauthorized: value: type: error.list - request_id: d23d8a4a-b289-47ac-ad17-868a9bb6a9e6 + request_id: 7829f8c9-3016-48a0-935e-026106396449 errors: - code: unauthorized message: Access Token Invalid @@ -7692,7 +7952,7 @@ paths: Unauthorized: value: type: error.list - request_id: b7c55438-98b5-4cff-acf2-acfe67997ad0 + request_id: e68e2ac0-89ce-466c-b2b8-f3e210b88552 errors: - code: unauthorized message: Access Token Invalid @@ -7736,7 +7996,7 @@ paths: examples: successful: value: - job_identifier: lv4ulh4c6ywmpdor + job_identifier: krvzigvnei5rs9fj status: pending download_url: '' download_expires_at: '' @@ -7751,8 +8011,8 @@ paths: successful: summary: successful value: - created_at_after: 1704885893 - created_at_before: 1704903893 + created_at_after: 1707459838 + created_at_before: 1707477838 "/export/content/data/{job_identifier}": get: summary: Show content data export @@ -7786,7 +8046,7 @@ paths: examples: successful: value: - job_identifier: rgbw5mzyj4g4oh53 + job_identifier: 7c85dohhe66wczrv status: pending download_url: '' download_expires_at: '' @@ -7818,7 +8078,7 @@ paths: examples: successful: value: - job_identifier: 38tdk26dluyuwzgj + job_identifier: uhx7u4iwpg26u5p1 status: canceled download_url: '' download_expires_at: '' @@ -7879,32 +8139,32 @@ paths: user message created: value: type: user_message - id: '403918628' - created_at: 1704903920 + id: '403918555' + created_at: 1707477840 body: heyy message_type: inapp - conversation_id: '960' + conversation_id: '845' lead message created: value: type: user_message - id: '403918629' - created_at: 1704903921 + id: '403918556' + created_at: 1707477841 body: heyy message_type: inapp - conversation_id: '961' + conversation_id: '846' admin message created: value: type: admin_message - id: '48' - created_at: 1704903922 + id: '30' + created_at: 1707477842 subject: heyy body: heyy message_type: inapp owner: type: admin - id: '991269226' - name: Ciaran269 Lee - email: admin269@email.com + id: '991269161' + name: Ciaran279 Lee + email: admin279@email.com away_mode_enabled: false away_mode_reassign: false schema: @@ -7917,14 +8177,14 @@ paths: No body supplied for message: value: type: error.list - request_id: fa33246e-3f1d-400b-8b95-afd826704f6e + request_id: 1bd4c2c2-bf42-4f3d-ab9a-53b0c8742fbd errors: - code: parameter_invalid message: Body is required No body supplied for email message: value: type: error.list - request_id: 15627032-d1aa-4596-8d57-068e53b33bc1 + request_id: 8e4f00b8-3c92-496a-9f68-c02aa0d4f77f errors: - code: parameter_invalid message: Body is required @@ -7938,7 +8198,7 @@ paths: No subject supplied for email message: value: type: error.list - request_id: 59bd3793-9819-42cb-948b-f0523ed5277a + request_id: 921cdd3d-e590-40a8-9692-51426ddffa81 errors: - code: parameter_not_found message: No subject supplied for email message @@ -7952,7 +8212,7 @@ paths: Unauthorized: value: type: error.list - request_id: b4a94fe9-bf7e-46bd-b641-6556ad8230f0 + request_id: aae2f07a-dd3e-43ea-9cc1-3a101297b97a errors: - code: unauthorized message: Access Token Invalid @@ -7966,7 +8226,7 @@ paths: API plan restricted: value: type: error.list - request_id: a10db167-db31-4a76-a3d2-dd2c09782860 + request_id: 65f47524-b678-46b0-aef8-86578f1b836c errors: - code: api_plan_restricted message: Active subscription needed. @@ -7983,7 +8243,7 @@ paths: value: from: type: user - id: 659ec4f06abd0164c0288730 + id: 65c60b5086ce64d2dcea3cba body: heyy referer: https://twitter.com/bob lead_message_created: @@ -7991,7 +8251,7 @@ paths: value: from: type: lead - id: 659ec4f16abd0164c0288731 + id: 65c60b5186ce64d2dcea3cbb body: heyy referer: https://twitter.com/bob admin_message_created: @@ -7999,10 +8259,10 @@ paths: value: from: type: admin - id: '991269226' + id: '991269161' to: type: user - id: 659ec4f26abd0164c0288732 + id: 65c60b5286ce64d2dcea3cbc message_type: conversation body: heyy no_body_supplied_for_message: @@ -8010,10 +8270,10 @@ paths: value: from: type: admin - id: '991269228' + id: '991269163' to: type: user - id: 659ec4f36abd0164c0288733 + id: 65c60b5386ce64d2dcea3cbd message_type: inapp body: subject: heyy @@ -8022,7 +8282,7 @@ paths: value: from: type: admin - id: '991269229' + id: '991269164' to: type: user user_id: '70' @@ -8033,10 +8293,10 @@ paths: value: from: type: admin - id: '991269230' + id: '991269165' to: type: user - id: 659ec4f46abd0164c0288735 + id: 65c60b5486ce64d2dcea3cbf message_type: email body: subject: heyy @@ -8067,12 +8327,12 @@ paths: total_pages: 1 type: pages data: - - id: '72' + - id: '71' type: news-item - workspace_id: this_is_an_id498_that_should_be_at_least_ + workspace_id: this_is_an_id515_that_should_be_at_least_ title: We have news body: "Hello there,
" - sender_id: 991269237 + sender_id: 991269170 state: draft labels: [] cover_image_url: @@ -8082,15 +8342,15 @@ paths: - - deliver_silently: false - created_at: 1704903926 - updated_at: 1704903926 + created_at: 1707477846 + updated_at: 1707477846 newsfeed_assignments: [] - - id: '71' + - id: '72' type: news-item - workspace_id: this_is_an_id498_that_should_be_at_least_ + workspace_id: this_is_an_id515_that_should_be_at_least_ title: We have news body: "Hello there,
" - sender_id: 991269235 + sender_id: 991269172 state: draft labels: [] cover_image_url: @@ -8100,8 +8360,8 @@ paths: - - deliver_silently: false - created_at: 1704903925 - updated_at: 1704903925 + created_at: 1707477846 + updated_at: 1707477846 newsfeed_assignments: [] total_count: 2 schema: @@ -8114,7 +8374,7 @@ paths: Unauthorized: value: type: error.list - request_id: 396f2b22-52ef-4eec-bdf4-f6b72dd1de2d + request_id: 50d53fea-83df-4555-a32a-74595c517b08 errors: - code: unauthorized message: Access Token Invalid @@ -8141,10 +8401,10 @@ paths: value: id: '75' type: news-item - workspace_id: this_is_an_id502_that_should_be_at_least_ + workspace_id: this_is_an_id519_that_should_be_at_least_ title: Halloween is here! body: "New costumes in store for this spooky season
" - sender_id: 991269244 + sender_id: 991269179 state: live labels: - New @@ -8155,8 +8415,8 @@ paths: - "\U0001F606" - "\U0001F605" deliver_silently: true - created_at: 1704903927 - updated_at: 1704903927 + created_at: 1707477848 + updated_at: 1707477848 newsfeed_assignments: - newsfeed_id: 128 published_at: 1664638214 @@ -8170,7 +8430,7 @@ paths: Unauthorized: value: type: error.list - request_id: 5f9be90a-5885-43ca-bace-1db32e7e95f7 + request_id: d67a3d99-d66e-42e9-a757-c0ad0d172e29 errors: - code: unauthorized message: Access Token Invalid @@ -8191,7 +8451,7 @@ paths: - Product - Update - New - sender_id: 991269244 + sender_id: 991269179 deliver_silently: true reactions: - "\U0001F606" @@ -8229,10 +8489,10 @@ paths: value: id: '76' type: news-item - workspace_id: this_is_an_id506_that_should_be_at_least_ + workspace_id: this_is_an_id523_that_should_be_at_least_ title: We have news body: "Hello there,
" - sender_id: 991269247 + sender_id: 991269182 state: live labels: [] cover_image_url: @@ -8242,11 +8502,11 @@ paths: - - deliver_silently: false - created_at: 1704903928 - updated_at: 1704903928 + created_at: 1707477849 + updated_at: 1707477849 newsfeed_assignments: - newsfeed_id: 130 - published_at: 1704903928 + published_at: 1707477849 schema: "$ref": "#/components/schemas/news_item" '404': @@ -8257,7 +8517,7 @@ paths: News Item Not Found: value: type: error.list - request_id: f5bd1826-17f3-4c80-9ce1-c606504f6c9e + request_id: 044e64c8-7208-4c9b-8ffb-a4a24cb80887 errors: - code: not_found message: Resource Not Found @@ -8271,7 +8531,7 @@ paths: Unauthorized: value: type: error.list - request_id: a9194a49-4864-47d2-bfbc-35e6e76fa06e + request_id: 6e18353b-102e-4611-b5c4-5abe61cd8083 errors: - code: unauthorized message: Access Token Invalid @@ -8304,10 +8564,10 @@ paths: value: id: '79' type: news-item - workspace_id: this_is_an_id512_that_should_be_at_least_ + workspace_id: this_is_an_id529_that_should_be_at_least_ title: Christmas is here! body: "New gifts in store for the jolly season
" - sender_id: 991269255 + sender_id: 991269190 state: live labels: [] cover_image_url: @@ -8315,8 +8575,8 @@ paths: - "\U0001F61D" - "\U0001F602" deliver_silently: false - created_at: 1704903930 - updated_at: 1704903930 + created_at: 1707477851 + updated_at: 1707477851 newsfeed_assignments: [] schema: "$ref": "#/components/schemas/news_item" @@ -8328,7 +8588,7 @@ paths: News Item Not Found: value: type: error.list - request_id: d87e34b9-23c9-4ad0-8193-05943f854b4e + request_id: ab939077-21ef-4e4f-95a1-1e6f73fe3df4 errors: - code: not_found message: Resource Not Found @@ -8342,7 +8602,7 @@ paths: Unauthorized: value: type: error.list - request_id: 12f547e0-6bff-44ca-8a3c-961157010a3d + request_id: ca827289-ebe8-4b3b-b3fc-003297caf7e4 errors: - code: unauthorized message: Access Token Invalid @@ -8359,7 +8619,7 @@ paths: value: title: Christmas is here! body: "New gifts in store for the jolly season
" - sender_id: 991269255 + sender_id: 991269190 reactions: - "\U0001F61D" - "\U0001F602" @@ -8368,7 +8628,7 @@ paths: value: title: Christmas is here! body: "New gifts in store for the jolly season
" - sender_id: 991269258 + sender_id: 991269193 reactions: - "\U0001F61D" - "\U0001F602" @@ -8411,7 +8671,7 @@ paths: News Item Not Found: value: type: error.list - request_id: a94679ef-21c5-4509-93f4-5be7a6c00705 + request_id: daa4aa42-c514-448a-8e8f-ee8978c4d72a errors: - code: not_found message: Resource Not Found @@ -8425,7 +8685,7 @@ paths: Unauthorized: value: type: error.list - request_id: b61d2629-5642-4788-8e17-9f65060ad479 + request_id: b143b48f-88d3-4e14-83fc-830bb2bd149f errors: - code: unauthorized message: Access Token Invalid @@ -8478,7 +8738,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8dbdb1dc-3b8b-4763-a914-87f7cb315064 + request_id: 128ead3b-0f67-4f25-bd52-1f2bd10b32da errors: - code: unauthorized message: Access Token Invalid @@ -8514,13 +8774,13 @@ paths: - id: '143' type: newsfeed name: Visitor Feed - created_at: 1704903934 - updated_at: 1704903934 + created_at: 1707477856 + updated_at: 1707477856 - id: '144' type: newsfeed name: Visitor Feed - created_at: 1704903934 - updated_at: 1704903934 + created_at: 1707477856 + updated_at: 1707477856 total_count: 2 schema: "$ref": "#/components/schemas/paginated_response" @@ -8532,7 +8792,7 @@ paths: Unauthorized: value: type: error.list - request_id: bbfe34dd-fedf-4adb-b100-4416c28c887c + request_id: 12eb4439-10e6-4427-92ca-877e23d47fc9 errors: - code: unauthorized message: Access Token Invalid @@ -8569,8 +8829,8 @@ paths: id: '147' type: newsfeed name: Visitor Feed - created_at: 1704903935 - updated_at: 1704903935 + created_at: 1707477857 + updated_at: 1707477857 schema: "$ref": "#/components/schemas/newsfeed" '401': @@ -8581,7 +8841,7 @@ paths: Unauthorized: value: type: error.list - request_id: 673b7b15-a16c-49ea-b852-4e4d34e34d6e + request_id: 25d17763-1966-45fb-9d7e-5b7a96cf4b37 errors: - code: unauthorized message: Access Token Invalid @@ -8615,16 +8875,16 @@ paths: Note found: value: type: note - id: '146' - created_at: 1704212738 + id: '76' + created_at: 1706786658 contact: type: contact - id: 659ec5026abd0164c0288740 + id: 65c60b6286ce64d2dcea3cc2 author: type: admin - id: '991269274' - name: Ciaran316 Lee - email: admin316@email.com + id: '991269209' + name: Ciaran326 Lee + email: admin326@email.com away_mode_enabled: false away_mode_reassign: false body: "This is a note.
" @@ -8638,7 +8898,7 @@ paths: Note not found: value: type: error.list - request_id: 477bcd84-40b8-4d18-9c48-c281d75f7b6b + request_id: 0005ee0f-a101-4146-ba46-7c13a1b2362f errors: - code: not_found message: Resource Not Found @@ -8652,7 +8912,7 @@ paths: Unauthorized: value: type: error.list - request_id: a6c05584-a665-4881-8c57-e2fc59dc903d + request_id: 1f23b1ba-5d8f-489a-940f-03d21dce27ef errors: - code: unauthorized message: Access Token Invalid @@ -8688,16 +8948,16 @@ paths: type: segment.list segments: - type: segment - id: 659ec5056abd0164c0288747 + id: 65c60b6386ce64d2dcea3cc5 name: John segment - created_at: 1704903941 - updated_at: 1704903941 + created_at: 1707477859 + updated_at: 1707477859 person_type: user - type: segment - id: 659ec5056abd0164c0288748 + id: 65c60b6386ce64d2dcea3cc6 name: Jane segment - created_at: 1704903941 - updated_at: 1704903941 + created_at: 1707477859 + updated_at: 1707477859 person_type: user schema: "$ref": "#/components/schemas/segment_list" @@ -8709,7 +8969,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9b496fe6-c69c-489a-af6d-838c89a8dd85 + request_id: 5e03fa3a-3f7e-4142-9cbb-f48e2a2ffa43 errors: - code: unauthorized message: Access Token Invalid @@ -8743,10 +9003,10 @@ paths: Successful response: value: type: segment - id: 659ec5066abd0164c028874b + id: 65c60b6486ce64d2dcea3cc9 name: John segment - created_at: 1704903942 - updated_at: 1704903942 + created_at: 1707477860 + updated_at: 1707477860 person_type: user schema: "$ref": "#/components/schemas/segment" @@ -8758,7 +9018,7 @@ paths: Segment not found: value: type: error.list - request_id: 2e3a1f51-be84-41ed-a388-8b2d6557354c + request_id: e7ecaa55-2684-48bf-a2f2-73827a3d1bd5 errors: - code: not_found message: Resource Not Found @@ -8772,7 +9032,7 @@ paths: Unauthorized: value: type: error.list - request_id: 668198cd-1528-412f-b81b-8f215df72bb6 + request_id: fc12b054-f212-4725-aaac-96bcf9d2fb06 errors: - code: unauthorized message: Access Token Invalid @@ -8802,7 +9062,7 @@ paths: type: list data: - type: subscription - id: '318' + id: '275' state: live consent_type: opt_out default_translation: @@ -8825,7 +9085,7 @@ paths: Unauthorized: value: type: error.list - request_id: 21357080-d104-4a11-8edf-64346f8d4a31 + request_id: b6ed7c08-5749-4c81-bc1a-b59531d8d113 errors: - code: unauthorized message: Access Token Invalid @@ -8855,7 +9115,7 @@ paths: examples: successful: value: - url: http://via.intercom.io/msgr/80584690-365f-43d8-8c53-d27404b60148 + url: http://via.intercom.io/msgr/38f13661-b69e-4b54-9083-e2bdcdf31def type: phone_call_redirect schema: "$ref": "#/components/schemas/phone_switch" @@ -8888,7 +9148,7 @@ paths: Unauthorized: value: type: error.list - request_id: 365cf128-a63c-436d-b848-11e8cbe546b8 + request_id: dc19bcd6-4302-4f03-9ebd-a3a8c532c954 errors: - code: unauthorized message: Access Token Invalid @@ -8951,7 +9211,7 @@ paths: type: list data: - type: tag - id: '291' + id: '224' name: Manual tag 1 schema: "$ref": "#/components/schemas/tag_list" @@ -8963,7 +9223,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9998e174-5bf3-476d-ae10-8a9cc6f223fb + request_id: 7ba8f42a-3098-4b32-914a-34e813c93c6a errors: - code: unauthorized message: Access Token Invalid @@ -9002,7 +9262,7 @@ paths: Action successful: value: type: tag - id: '294' + id: '227' name: test schema: "$ref": "#/components/schemas/tag" @@ -9014,7 +9274,7 @@ paths: Invalid parameters: value: type: error.list - request_id: d34d9f8a-1f85-4f56-90f6-1a3dc59925a6 + request_id: 1feb41f5-5713-4e7b-bf56-b8a860d80b6f errors: - code: parameter_invalid message: invalid tag parameters @@ -9028,14 +9288,14 @@ paths: Company not found: value: type: error.list - request_id: 1c6548e5-afd6-47c8-bea1-e916b7595fd1 + request_id: 2c84f59c-02ea-4649-b930-44235b0cfa06 errors: - code: company_not_found message: Company Not Found User not found: value: type: error.list - request_id: f838fd69-3e96-4317-af9d-47b8ac6f9547 + request_id: 56c7f0d2-b829-42ec-827f-0130c913f52b errors: - code: not_found message: User Not Found @@ -9049,7 +9309,7 @@ paths: Unauthorized: value: type: error.list - request_id: 58788ccd-1207-450c-a013-1a858d06fe2c + request_id: a91aaa89-8a1d-42f7-b77f-96d9f269a4a9 errors: - code: unauthorized message: Access Token Invalid @@ -9115,7 +9375,7 @@ paths: Tag found: value: type: tag - id: '302' + id: '235' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -9127,7 +9387,7 @@ paths: Tag not found: value: type: error.list - request_id: ed151a71-b388-4fee-9b14-1e3375b1e0ba + request_id: 9db06583-6984-4c1c-b02e-933a26a57ce0 errors: - code: not_found message: Resource Not Found @@ -9141,7 +9401,7 @@ paths: Unauthorized: value: type: error.list - request_id: 87544aa3-71b4-4d41-a5aa-a25d07ff477d + request_id: 27c0d4c6-0b59-4d6c-b24a-548436cf213b errors: - code: unauthorized message: Access Token Invalid @@ -9177,7 +9437,7 @@ paths: Resource not found: value: type: error.list - request_id: a5e003d1-0a0a-4339-939a-9a255b032364 + request_id: e3c0e34d-2cec-45fe-97e7-d4a8dce1f471 errors: - code: not_found message: Resource Not Found @@ -9191,7 +9451,7 @@ paths: Tag has dependent objects: value: type: error.list - request_id: edd61656-e294-4dcf-9115-d9a6c0900c97 + request_id: bc8e933d-d5b3-49a1-9c69-04ae488fe737 errors: - code: tag_has_dependent_objects message: 'Unable to delete Tag with dependent objects. Segments: @@ -9206,7 +9466,7 @@ paths: Unauthorized: value: type: error.list - request_id: 1fdc4ebb-5107-486d-b8c0-d8f8a4ba0605 + request_id: 74a1d09e-93d8-4d5c-be01-15a8ca48e69d errors: - code: unauthorized message: Access Token Invalid @@ -9244,7 +9504,7 @@ paths: Unauthorized: value: type: error.list - request_id: cc7ba0a6-9d3a-4df5-a2c1-481d466034e5 + request_id: 0c64d886-9c13-4a7a-989d-f9033dcc57fb errors: - code: unauthorized message: Access Token Invalid @@ -9279,7 +9539,7 @@ paths: successful: value: type: team - id: '991269318' + id: '991269247' name: team 1 admin_ids: [] schema: @@ -9292,7 +9552,7 @@ paths: Team not found: value: type: error.list - request_id: fd588da6-8b21-4fe4-80d7-6c2b1b843ec4 + request_id: 9927b07d-5c47-48d2-9895-64e6144f6421 errors: - code: team_not_found message: Team not found @@ -9306,7 +9566,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0bfa928b-bf5d-4728-aaa9-f18647e22235 + request_id: 4cf425a5-51c9-477a-8989-f2741958062e errors: - code: unauthorized message: Access Token Invalid @@ -9339,14 +9599,14 @@ paths: Ticket Type Attribute created: value: type: ticket_type_attribute - id: '252' - workspace_id: this_is_an_id604_that_should_be_at_least_ + id: '340' + workspace_id: this_is_an_id621_that_should_be_at_least_ name: Attribute Title description: Attribute Description data_type: string input_options: multiline: false - order: 0 + order: 2 required_to_create: false required_to_create_for_contacts: false visible_on_create: true @@ -9354,8 +9614,8 @@ paths: default: false ticket_type_id: 110 archived: false - created_at: 1704903962 - updated_at: 1704903962 + created_at: 1707477878 + updated_at: 1707477878 schema: "$ref": "#/components/schemas/ticket_type_attribute" '401': @@ -9366,7 +9626,7 @@ paths: Unauthorized: value: type: error.list - request_id: fecfe8d4-6d8f-41ee-b68a-c7611980c08f + request_id: 47598faa-e53a-4361-a7c2-f5a03c1f87b3 errors: - code: unauthorized message: Access Token Invalid @@ -9419,8 +9679,8 @@ paths: Ticket Type Attribute updated: value: type: ticket_type_attribute - id: '253' - workspace_id: this_is_an_id608_that_should_be_at_least_ + id: '345' + workspace_id: this_is_an_id625_that_should_be_at_least_ name: name description: New Attribute Description data_type: string @@ -9432,8 +9692,8 @@ paths: default: false ticket_type_id: 112 archived: false - created_at: 1704903963 - updated_at: 1704903963 + created_at: 1707477879 + updated_at: 1707477879 schema: "$ref": "#/components/schemas/ticket_type_attribute" '401': @@ -9444,7 +9704,7 @@ paths: Unauthorized: value: type: error.list - request_id: e5ea76f4-8454-4728-8fa6-ae9adc926406 + request_id: 55841fdd-6fdb-49bd-ba14-9d21376228f4 errors: - code: unauthorized message: Access Token Invalid @@ -9487,17 +9747,35 @@ paths: name: Bug Report description: Bug Report Template icon: "\U0001F39F️" - workspace_id: this_is_an_id612_that_should_be_at_least_ + workspace_id: this_is_an_id629_that_should_be_at_least_ archived: false - created_at: 1704903964 - updated_at: 1704903964 + created_at: 1707477880 + updated_at: 1707477880 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '254' - workspace_id: this_is_an_id612_that_should_be_at_least_ + id: '348' + workspace_id: this_is_an_id629_that_should_be_at_least_ + name: _default_title_ + description: '' + data_type: string + input_options: + multiline: false + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 114 + archived: false + created_at: 1707477880 + updated_at: 1707477880 + - type: ticket_type_attribute + id: '350' + workspace_id: this_is_an_id629_that_should_be_at_least_ name: name description: description data_type: string @@ -9510,8 +9788,26 @@ paths: default: false ticket_type_id: 114 archived: false - created_at: 1704903964 - updated_at: 1704903964 + created_at: 1707477880 + updated_at: 1707477880 + - type: ticket_type_attribute + id: '349' + workspace_id: this_is_an_id629_that_should_be_at_least_ + name: _default_description_ + description: '' + data_type: string + input_options: + multiline: true + order: 1 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 114 + archived: false + created_at: 1707477880 + updated_at: 1707477880 category: Customer schema: "$ref": "#/components/schemas/ticket_type_list" @@ -9523,7 +9819,7 @@ paths: Unauthorized: value: type: error.list - request_id: 73312699-450e-4cd2-958b-21cae0e07b22 + request_id: 6f23579c-5429-49f7-8693-0dc37142c745 errors: - code: unauthorized message: Access Token Invalid @@ -9556,14 +9852,50 @@ paths: name: Customer Issue description: Customer Report Template icon: "\U0001F39F️" - workspace_id: this_is_an_id616_that_should_be_at_least_ + workspace_id: this_is_an_id633_that_should_be_at_least_ archived: false - created_at: 1704903965 - updated_at: 1704903965 + created_at: 1707477882 + updated_at: 1707477882 is_internal: false ticket_type_attributes: type: list - data: [] + data: + - type: ticket_type_attribute + id: '357' + workspace_id: this_is_an_id633_that_should_be_at_least_ + name: _default_title_ + description: '' + data_type: string + input_options: + multiline: false + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 117 + archived: false + created_at: 1707477882 + updated_at: 1707477882 + - type: ticket_type_attribute + id: '358' + workspace_id: this_is_an_id633_that_should_be_at_least_ + name: _default_description_ + description: '' + data_type: string + input_options: + multiline: true + order: 1 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 117 + archived: false + created_at: 1707477882 + updated_at: 1707477882 category: Customer schema: "$ref": "#/components/schemas/ticket_type" @@ -9575,7 +9907,7 @@ paths: Unauthorized: value: type: error.list - request_id: 646105ff-f9ec-4a00-b252-6d15b8c117d8 + request_id: 3316e6ec-1fbb-491f-ac6f-3976d95186ad errors: - code: unauthorized message: Access Token Invalid @@ -9625,17 +9957,35 @@ paths: name: Bug Report description: Bug Report Template icon: "\U0001F39F️" - workspace_id: this_is_an_id620_that_should_be_at_least_ + workspace_id: this_is_an_id637_that_should_be_at_least_ archived: false - created_at: 1704903966 - updated_at: 1704903966 + created_at: 1707477883 + updated_at: 1707477883 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '258' - workspace_id: this_is_an_id620_that_should_be_at_least_ + id: '362' + workspace_id: this_is_an_id637_that_should_be_at_least_ + name: _default_title_ + description: '' + data_type: string + input_options: + multiline: false + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 119 + archived: false + created_at: 1707477883 + updated_at: 1707477883 + - type: ticket_type_attribute + id: '364' + workspace_id: this_is_an_id637_that_should_be_at_least_ name: name description: description data_type: string @@ -9648,8 +9998,26 @@ paths: default: false ticket_type_id: 119 archived: false - created_at: 1704903966 - updated_at: 1704903966 + created_at: 1707477883 + updated_at: 1707477883 + - type: ticket_type_attribute + id: '363' + workspace_id: this_is_an_id637_that_should_be_at_least_ + name: _default_description_ + description: '' + data_type: string + input_options: + multiline: true + order: 1 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 119 + archived: false + created_at: 1707477883 + updated_at: 1707477883 category: Customer schema: "$ref": "#/components/schemas/ticket_type" @@ -9661,7 +10029,7 @@ paths: Unauthorized: value: type: error.list - request_id: d6cc875b-9b5d-4843-a439-33ff0d065e38 + request_id: 629a8b60-7ab8-49d9-bf27-e359de0764ab errors: - code: unauthorized message: Access Token Invalid @@ -9698,17 +10066,35 @@ paths: name: Bug Report 2 description: Bug Report Template icon: "\U0001F39F️" - workspace_id: this_is_an_id624_that_should_be_at_least_ + workspace_id: this_is_an_id641_that_should_be_at_least_ archived: false - created_at: 1704903966 - updated_at: 1704903967 + created_at: 1707477884 + updated_at: 1707477884 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '260' - workspace_id: this_is_an_id624_that_should_be_at_least_ + id: '368' + workspace_id: this_is_an_id641_that_should_be_at_least_ + name: _default_title_ + description: '' + data_type: string + input_options: + multiline: false + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 121 + archived: false + created_at: 1707477884 + updated_at: 1707477884 + - type: ticket_type_attribute + id: '370' + workspace_id: this_is_an_id641_that_should_be_at_least_ name: name description: description data_type: string @@ -9721,8 +10107,26 @@ paths: default: false ticket_type_id: 121 archived: false - created_at: 1704903966 - updated_at: 1704903966 + created_at: 1707477884 + updated_at: 1707477884 + - type: ticket_type_attribute + id: '369' + workspace_id: this_is_an_id641_that_should_be_at_least_ + name: _default_description_ + description: '' + data_type: string + input_options: + multiline: true + order: 1 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 121 + archived: false + created_at: 1707477884 + updated_at: 1707477884 category: Customer schema: "$ref": "#/components/schemas/ticket_type" @@ -9734,7 +10138,7 @@ paths: Unauthorized: value: type: error.list - request_id: 39c4e515-cca1-4bd2-9f08-087b6cd06d91 + request_id: 89c80674-49f3-4292-9346-33c69aa65ce8 errors: - code: unauthorized message: Access Token Invalid @@ -9780,22 +10184,22 @@ paths: User reply: value: type: ticket_part - id: '195' + id: '189' part_type: comment body: "Thanks again :)
" - created_at: 1704903969 - updated_at: 1704903969 + created_at: 1707477887 + updated_at: 1707477887 author: - id: 659ec5216abd0164c028877a + id: 65c60b7f86ce64d2dcea3cec type: user name: - email: user28@email.com + email: user30@email.com attachments: [] redacted: false Admin note reply: value: type: ticket_part - id: '197' + id: '191' part_type: note body: |-Body of the Article
- author_id: 991268357 + author_id: 991268293 state: published - created_at: 1704903244 - updated_at: 1704903244 - url: http://help-center.test/myapp-26/en/articles/89-thanks-for-everything + created_at: 1707477202 + updated_at: 1707477202 + url: http://help-center.test/myapp-26/en/articles/113-thanks-for-everything schema: "$ref": "#/components/schemas/article" '400': @@ -471,7 +471,7 @@ paths: Bad Request: value: type: error.list - request_id: 414f3abc-1919-4c74-b517-1b2e9de5900f + request_id: 479cc045-194f-4110-995e-04b6d860379d errors: - code: parameter_not_found message: author_id must be in the main body or default locale @@ -486,7 +486,7 @@ paths: Unauthorized: value: type: error.list - request_id: fc1b06f2-3fc4-48ad-89f5-28c10ba05173 + request_id: bc742c64-3fe2-44c6-a036-19d1845b914c errors: - code: unauthorized message: Access Token Invalid @@ -504,16 +504,16 @@ paths: title: Thanks for everything description: Description of the Article body: Body of the Article - author_id: 991268357 + author_id: 991268293 state: published - parent_id: 363 + parent_id: 352 parent_type: collection translated_content: fr: title: Merci pour tout description: Description de l'article body: Corps de l'article - author_id: 991268357 + author_id: 991268293 state: published bad_request: summary: Bad Request @@ -550,10 +550,10 @@ paths: examples: Article found: value: - id: '92' + id: '116' type: article workspace_id: this_is_an_id32_that_should_be_at_least_4 - parent_id: 366 + parent_id: 355 parent_type: collection parent_ids: [] statistics: @@ -567,11 +567,11 @@ paths: title: This is the article title description: '' body: '' - author_id: 991268362 + author_id: 991268298 state: published - created_at: 1704903245 - updated_at: 1704903245 - url: http://help-center.test/myapp-32/en/articles/92-this-is-the-article-title + created_at: 1707477204 + updated_at: 1707477204 + url: http://help-center.test/myapp-32/en/articles/116-this-is-the-article-title schema: "$ref": "#/components/schemas/article" '404': @@ -582,7 +582,7 @@ paths: Article not found: value: type: error.list - request_id: d9179c3a-92c6-4e7b-a3ae-4d5e845bdecf + request_id: 857ebcf2-e670-4d1b-ab3f-f3d94dbee28b errors: - code: not_found message: Resource Not Found @@ -596,7 +596,7 @@ paths: Unauthorized: value: type: error.list - request_id: c4532afb-1fb9-41ab-8b36-57b060643f1e + request_id: 52c8ce70-2416-4e53-a9c0-0ebc1ef20a7a errors: - code: unauthorized message: Access Token Invalid @@ -629,10 +629,10 @@ paths: examples: successful: value: - id: '95' + id: '119' type: article workspace_id: this_is_an_id38_that_should_be_at_least_4 - parent_id: 369 + parent_id: 358 parent_type: collection parent_ids: [] statistics: @@ -646,11 +646,11 @@ paths: title: Christmas is here! description: '' body:New gifts in store for the jolly season
- author_id: 991268368 + author_id: 991268304 state: published - created_at: 1704903247 - updated_at: 1704903248 - url: http://help-center.test/myapp-38/en/articles/95-christmas-is-here + created_at: 1707477206 + updated_at: 1707477207 + url: http://help-center.test/myapp-38/en/articles/119-christmas-is-here schema: "$ref": "#/components/schemas/article" '404': @@ -661,7 +661,7 @@ paths: Article Not Found: value: type: error.list - request_id: 9a6d247d-dcf1-458f-a8aa-adb320aba3ad + request_id: 44707a46-6c84-48be-bf2a-35bfe56bb317 errors: - code: not_found message: Resource Not Found @@ -675,7 +675,7 @@ paths: Unauthorized: value: type: error.list - request_id: abf63428-088e-4886-b40b-f0f166456092 + request_id: 82ccd870-2ca8-4586-90f3-31b11dd08afe errors: - code: unauthorized message: Access Token Invalid @@ -723,7 +723,7 @@ paths: examples: successful: value: - id: '98' + id: '122' object: article deleted: true schema: @@ -735,11 +735,9 @@ paths: examples: Article Not Found: value: - type: error.list - request_id: 27c6a6c0-c465-4192-b4a9-19d0755ab935 - errors: - - code: not_found - message: Resource Not Found + id: '123' + object: article + deleted: true schema: "$ref": "#/components/schemas/error" '401': @@ -750,7 +748,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8ad0c08a-9266-4258-9030-662fc6b73a94 + request_id: ce96e375-8919-4a6a-9dee-920079f8c0d0 errors: - code: unauthorized message: Access Token Invalid @@ -810,7 +808,7 @@ paths: total_count: 1 data: articles: - - id: '102' + - id: '126' type: article workspace_id: this_is_an_id50_that_should_be_at_least_4 parent_id: @@ -819,10 +817,10 @@ paths: title: Title 1 description: '' body: '' - author_id: 991268381 + author_id: 991268317 state: draft - created_at: 1704903252 - updated_at: 1704903252 + created_at: 1707477211 + updated_at: 1707477211 url: highlights: [] pages: @@ -840,7 +838,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0303ba58-8efd-4b20-8a13-8e13327b567d + request_id: 607aa251-c7f7-4d84-b79f-d4a6522e9d4e errors: - code: unauthorized message: Access Token Invalid @@ -873,27 +871,27 @@ paths: value: type: list data: - - id: '377' + - id: '366' workspace_id: this_is_an_id54_that_should_be_at_least_4 name: English collection title url: http://help-center.test/myapp-54/collection-17 order: 17 - created_at: 1704903253 - updated_at: 1704903253 + created_at: 1707477212 + updated_at: 1707477212 description: english collection description icon: bookmark parent_id: - help_center_id: 197 - - id: '378' + help_center_id: 209 + - id: '367' workspace_id: this_is_an_id54_that_should_be_at_least_4 name: English section title url: http://help-center.test/myapp-54/section-1 order: 1 - created_at: 1704903253 - updated_at: 1704903253 + created_at: 1707477212 + updated_at: 1707477212 description: icon: bookmark - parent_id: '377' + parent_id: '366' help_center_id: total_count: 2 pages: @@ -911,7 +909,7 @@ paths: Unauthorized: value: type: error.list - request_id: abae41c0-058f-4fef-a23f-fee2071f83da + request_id: 8936c1bd-fbdf-4114-a389-b5f5418c5cc7 errors: - code: unauthorized message: Access Token Invalid @@ -936,17 +934,17 @@ paths: examples: collection created: value: - id: '383' + id: '372' workspace_id: this_is_an_id58_that_should_be_at_least_4 name: Thanks for everything url: http://help-center.test/myapp-58/ order: 1 - created_at: 1704903254 - updated_at: 1704903254 + created_at: 1707477214 + updated_at: 1707477214 description: '' icon: book-bookmark parent_id: - help_center_id: 199 + help_center_id: 211 schema: "$ref": "#/components/schemas/collection" '400': @@ -957,7 +955,7 @@ paths: Bad Request: value: type: error.list - request_id: eb5a4902-d00c-4e18-8b96-171aaf42ce42 + request_id: 0b9d3d40-c3ad-465e-9115-de7e7f6f1056 errors: - code: parameter_not_found message: Name is a required parameter. @@ -971,7 +969,7 @@ paths: Unauthorized: value: type: error.list - request_id: 3835be26-a15c-4e2e-937c-8808c5c675c4 + request_id: 58001de9-a257-4b3d-b773-6dc6bb33f123 errors: - code: unauthorized message: Access Token Invalid @@ -1019,17 +1017,17 @@ paths: examples: Collection found: value: - id: '388' + id: '377' workspace_id: this_is_an_id64_that_should_be_at_least_4 name: English collection title url: http://help-center.test/myapp-64/collection-22 order: 22 - created_at: 1704903255 - updated_at: 1704903255 + created_at: 1707477215 + updated_at: 1707477215 description: english collection description icon: bookmark parent_id: - help_center_id: 202 + help_center_id: 214 schema: "$ref": "#/components/schemas/collection" '404': @@ -1040,7 +1038,7 @@ paths: Collection not found: value: type: error.list - request_id: d8a24da6-931f-49b4-849f-7c27d9548b3a + request_id: 8f4c4988-7fef-472e-b29c-8cdc14e29c7c errors: - code: not_found message: Resource Not Found @@ -1054,7 +1052,7 @@ paths: Unauthorized: value: type: error.list - request_id: bc4222fe-422e-43a1-bcd4-880916f39c04 + request_id: ee9dcc53-5706-4736-a8ef-15a06aa8bce7 errors: - code: unauthorized message: Access Token Invalid @@ -1087,17 +1085,17 @@ paths: examples: successful: value: - id: '394' + id: '383' workspace_id: this_is_an_id70_that_should_be_at_least_4 name: Update collection name url: http://help-center.test/myapp-70/collection-25 order: 25 - created_at: 1704903256 - updated_at: 1704903257 + created_at: 1707477216 + updated_at: 1707477217 description: english collection description icon: folder parent_id: - help_center_id: 205 + help_center_id: 217 schema: "$ref": "#/components/schemas/collection" '404': @@ -1108,7 +1106,7 @@ paths: Collection Not Found: value: type: error.list - request_id: cdd6744a-dea1-4748-9887-b187d7c9a122 + request_id: 9aefce5c-02b8-4b3e-9632-7468327a28c3 errors: - code: not_found message: Resource Not Found @@ -1122,7 +1120,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2a97e317-df3a-4084-a071-a6f5b886f6c9 + request_id: '052183cd-9af9-458c-aef0-cfeb6dd6741c' errors: - code: unauthorized message: Access Token Invalid @@ -1169,7 +1167,7 @@ paths: examples: successful: value: - id: '400' + id: '389' object: collection deleted: true schema: @@ -1182,7 +1180,7 @@ paths: collection Not Found: value: type: error.list - request_id: 0fc946dd-765d-4031-96d3-0a6cc5c0dfbd + request_id: a2edff0e-56db-46d6-813e-b32f79a558fb errors: - code: not_found message: Resource Not Found @@ -1196,7 +1194,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0b8bf7e3-c13e-4c02-8229-b1b2a32674f9 + request_id: 61f46138-3ab5-4e20-8d3a-c9f8cd3f47d8 errors: - code: unauthorized message: Access Token Invalid @@ -1230,10 +1228,10 @@ paths: examples: Collection found: value: - id: '211' + id: '223' workspace_id: this_is_an_id82_that_should_be_at_least_4 - created_at: 1704903259 - updated_at: 1704903259 + created_at: 1707477220 + updated_at: 1707477220 identifier: help-center-1 website_turned_on: false display_name: Intercom Help Center @@ -1247,7 +1245,7 @@ paths: Collection not found: value: type: error.list - request_id: ff346d6f-dd0c-4487-af63-f23d8162fe8d + request_id: 342132dd-b5cf-443b-9a9b-e5914ab94e19 errors: - code: not_found message: Resource Not Found @@ -1261,7 +1259,7 @@ paths: Unauthorized: value: type: error.list - request_id: e12272c6-f4ca-44a7-a384-72120d58a7c8 + request_id: 59acdf93-1523-4f53-881f-81273ae64126 errors: - code: unauthorized message: Access Token Invalid @@ -1299,7 +1297,7 @@ paths: Unauthorized: value: type: error.list - request_id: bb022ad5-cc3c-4017-9a3d-140250067e2e + request_id: 1dc77818-47c9-4a24-8e19-68dd149cf9b2 errors: - code: unauthorized message: Access Token Invalid @@ -1332,12 +1330,12 @@ paths: value: type: company company_id: company_remote_id - id: 659ec2626abd01535c223397 - app_id: this_is_an_id108_that_should_be_at_least_ + id: 65c608e986ce64d19db0c3ed + app_id: this_is_an_id105_that_should_be_at_least_ name: my company remote_created_at: 1374138000 - created_at: 1704903266 - updated_at: 1704903266 + created_at: 1707477225 + updated_at: 1707477225 monthly_spend: 0 session_count: 0 user_count: 0 @@ -1374,7 +1372,7 @@ paths: Unauthorized: value: type: error.list - request_id: bbac2bcf-ae91-4c6e-b422-ca60764aa997 + request_id: 46b6105f-2e26-4bf2-a3d0-433869016c05 errors: - code: unauthorized message: Access Token Invalid @@ -1448,11 +1446,18 @@ paths: tags: - Companies operationId: retrieveCompany - description: "You can fetch a single company by passing in `company_id` or `name`.\n\n - \ `https://api.intercom.io/companies?name={name}`\n\n `https://api.intercom.io/companies?company_id={company_id}`\n\nYou - can fetch all companies and filter by `segment_id` or `tag_id` as a query - parameter.\n \n `https://api.intercom.io/companies?tag_id={tag_id}`\n\n - \ `https://api.intercom.io/companies?segment_id={segment_id}`\n" + description: | + You can fetch a single company by passing in `company_id` or `name`. + + `https://api.intercom.io/companies?name={name}` + + `https://api.intercom.io/companies?company_id={company_id}` + + You can fetch all companies and filter by `segment_id` or `tag_id` as a query parameter. + + `https://api.intercom.io/companies?tag_id={tag_id}` + + `https://api.intercom.io/companies?segment_id={segment_id}` responses: '200': description: Successful @@ -1465,12 +1470,12 @@ paths: data: - type: company company_id: remote_companies_scroll_2 - id: 659ec2636abd01535c22339f - app_id: this_is_an_id114_that_should_be_at_least_ + id: 65c608eb86ce64d19db0c3f5 + app_id: this_is_an_id111_that_should_be_at_least_ name: IntercomQATest1 - remote_created_at: 1704903267 - created_at: 1704903267 - updated_at: 1704903267 + remote_created_at: 1707477227 + created_at: 1707477227 + updated_at: 1707477227 monthly_spend: 0 session_count: 0 user_count: 4 @@ -1499,7 +1504,7 @@ paths: Company Not Found: value: type: error.list - request_id: bcb25d3f-6d23-4f1c-bca3-8ec54cbcfb44 + request_id: '04903002-a8dd-4760-a430-fe8101bb16ed' errors: - code: company_not_found message: Company Not Found @@ -1513,7 +1518,7 @@ paths: Unauthorized: value: type: error.list - request_id: 48bc459e-b604-44f7-a1eb-5782f39af72a + request_id: 255b8419-10ba-4185-958b-abe4452ecd89 errors: - code: unauthorized message: Access Token Invalid @@ -1548,12 +1553,12 @@ paths: value: type: company company_id: '1' - id: 659ec2656abd01535c2233aa - app_id: this_is_an_id120_that_should_be_at_least_ - name: company2 - remote_created_at: 1704903269 - created_at: 1704903269 - updated_at: 1704903269 + id: 65c608ed86ce64d19db0c400 + app_id: this_is_an_id117_that_should_be_at_least_ + name: company1 + remote_created_at: 1707477229 + created_at: 1707477229 + updated_at: 1707477229 monthly_spend: 0 session_count: 0 user_count: 1 @@ -1575,7 +1580,7 @@ paths: Company Not Found: value: type: error.list - request_id: 781d833a-dc97-4383-9fad-b9a1f401a2dd + request_id: 254f6993-e24c-4514-b149-34b74a3d979b errors: - code: company_not_found message: Company Not Found @@ -1589,7 +1594,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0fd82661-dbb1-4355-8df2-4e8a21d4a5c4 + request_id: e1ccad9e-f1d3-4ef5-a771-b916c2a3336e errors: - code: unauthorized message: Access Token Invalid @@ -1623,12 +1628,12 @@ paths: value: type: company company_id: '1' - id: 659ec2676abd01535c2233b4 - app_id: this_is_an_id126_that_should_be_at_least_ - name: company3 - remote_created_at: 1704903271 - created_at: 1704903271 - updated_at: 1704903271 + id: 65c608f086ce64d19db0c40a + app_id: this_is_an_id123_that_should_be_at_least_ + name: company2 + remote_created_at: 1707477232 + created_at: 1707477232 + updated_at: 1707477232 monthly_spend: 0 session_count: 0 user_count: 1 @@ -1650,7 +1655,7 @@ paths: Company Not Found: value: type: error.list - request_id: 2cc82fa2-e8e8-41d3-a95e-3dd83ae50a96 + request_id: 9ed8bd82-a2c6-4ae0-9dce-26b200c48844 errors: - code: company_not_found message: Company Not Found @@ -1664,7 +1669,7 @@ paths: Unauthorized: value: type: error.list - request_id: c9d241f5-e7e6-494b-ad3f-ad8cc98f6ced + request_id: 79df95f8-5088-466e-9db4-6bf76b84f745 errors: - code: unauthorized message: Access Token Invalid @@ -1696,7 +1701,7 @@ paths: examples: Successful: value: - id: 659ec2696abd01535c2233be + id: 65c608f286ce64d19db0c414 object: company deleted: true schema: @@ -1709,7 +1714,7 @@ paths: Company Not Found: value: type: error.list - request_id: 403d0fc0-b4d6-4d6c-a3a3-9ae0092a299c + request_id: cc459655-3e6a-43eb-845b-addda0ae31d1 errors: - code: company_not_found message: Company Not Found @@ -1723,7 +1728,7 @@ paths: Unauthorized: value: type: error.list - request_id: '081daf1e-35c8-48e1-a115-39c41a5b2f60' + request_id: f3d14bf9-d60e-49f5-92f4-c9985be3e078 errors: - code: unauthorized message: Access Token Invalid @@ -1775,7 +1780,7 @@ paths: Company Not Found: value: type: error.list - request_id: a2181e32-c23c-4bc1-802e-1aa11c3029c1 + request_id: 5841e5bc-de63-4f06-aa92-91019eab250d errors: - code: company_not_found message: Company Not Found @@ -1789,7 +1794,7 @@ paths: Unauthorized: value: type: error.list - request_id: a80ee688-d6c6-4a75-a54e-c649362c7b2e + request_id: 5e5da140-f2f3-4cc6-a3d8-a95f12877e0f errors: - code: unauthorized message: Access Token Invalid @@ -1834,7 +1839,7 @@ paths: Company Not Found: value: type: error.list - request_id: 4b5f141e-611f-4692-a894-d98e471e7e14 + request_id: 7db8853a-be1f-45bb-9794-aebb8e00644a errors: - code: company_not_found message: Company Not Found @@ -1848,7 +1853,7 @@ paths: Unauthorized: value: type: error.list - request_id: ff221dd8-260e-4fdc-a591-7cb18e962d0f + request_id: 3554f2bf-4117-4144-8f6d-334239b2356e errors: - code: unauthorized message: Access Token Invalid @@ -1905,12 +1910,12 @@ paths: data: - type: company company_id: remote_companies_scroll_2 - id: 659ec26e6abd01535c2233da - app_id: this_is_an_id150_that_should_be_at_least_ + id: 65c608f986ce64d19db0c430 + app_id: this_is_an_id147_that_should_be_at_least_ name: IntercomQATest1 - remote_created_at: 1704903278 - created_at: 1704903278 - updated_at: 1704903278 + remote_created_at: 1707477241 + created_at: 1707477241 + updated_at: 1707477241 monthly_spend: 0 session_count: 0 user_count: 4 @@ -1939,7 +1944,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9a490717-286b-4f44-b1af-e0aaeb4da490 + request_id: '07877131-88f8-4e82-b1da-dba36c397209' errors: - code: unauthorized message: Access Token Invalid @@ -1991,12 +1996,12 @@ paths: data: - type: company company_id: remote_companies_scroll_2 - id: 659ec26f6abd01535c2233e0 - app_id: this_is_an_id154_that_should_be_at_least_ + id: 65c608fa86ce64d19db0c436 + app_id: this_is_an_id151_that_should_be_at_least_ name: IntercomQATest1 - remote_created_at: 1704903279 - created_at: 1704903279 - updated_at: 1704903279 + remote_created_at: 1707477242 + created_at: 1707477242 + updated_at: 1707477242 monthly_spend: 0 session_count: 0 user_count: 4 @@ -2010,7 +2015,7 @@ paths: custom_attributes: {} pages: total_count: - scroll_param: '02159f3c-62ba-4ff0-ba90-262b55646105' + scroll_param: 5c48a65d-2124-4925-8097-1ccdc631fe56 schema: "$ref": "#/components/schemas/company_scroll" '401': @@ -2021,7 +2026,7 @@ paths: Unauthorized: value: type: error.list - request_id: 76ba48d6-9a42-4592-9d22-12b0abd64bb6 + request_id: 9cc5f21c-65ad-4373-9515-27e9202fb51a errors: - code: unauthorized message: Access Token Invalid @@ -2056,12 +2061,12 @@ paths: value: type: company company_id: '1' - id: 659ec2716abd01535c2233e9 - app_id: this_is_an_id158_that_should_be_at_least_ - name: company7 - remote_created_at: 1704903281 - created_at: 1704903281 - updated_at: 1704903281 + id: 65c608fd86ce64d19db0c43f + app_id: this_is_an_id155_that_should_be_at_least_ + name: company6 + remote_created_at: 1707477245 + created_at: 1707477245 + updated_at: 1707477245 monthly_spend: 0 session_count: 0 user_count: 1 @@ -2075,6 +2080,20 @@ paths: custom_attributes: {} schema: "$ref": "#/components/schemas/company" + '400': + description: Bad Request + content: + application/json: + examples: + Bad Request: + value: + type: error.list + request_id: 2c9e3ce4-5b33-4506-bd77-57044da1be26 + errors: + - code: parameter_not_found + message: company not specified + schema: + "$ref": "#/components/schemas/error" '404': description: Company Not Found content: @@ -2083,10 +2102,10 @@ paths: Company Not Found: value: type: error.list - request_id: aa134a2c-cec5-4feb-a928-c0c7f709aa3f + request_id: a2e87701-6cd9-40a9-8a32-7cc0a40d0539 errors: - - code: not_found - message: User Not Found + - code: company_not_found + message: Company Not Found schema: "$ref": "#/components/schemas/error" '401': @@ -2097,7 +2116,7 @@ paths: Unauthorized: value: type: error.list - request_id: dbd868e0-c8cc-4e65-8eb2-cad1c1dfafe6 + request_id: 2da7162c-16db-4328-98ba-298a98ce31ff errors: - code: unauthorized message: Access Token Invalid @@ -2120,11 +2139,14 @@ paths: successful: summary: Successful value: - id: 659ec2716abd01535c2233e9 + id: 65c608fd86ce64d19db0c43f + bad_request: + summary: Bad Request + value: company_not_found: summary: Company Not Found value: - id: 659ec2716abd01535c2233ed + id: '123' get: summary: List attached companies for contact parameters: @@ -2156,13 +2178,13 @@ paths: data: - type: company company_id: '1' - id: 659ec27c6abd01535c22341b - app_id: this_is_an_id172_that_should_be_at_least_ - name: company23 - remote_created_at: 1704903292 - created_at: 1704903292 - updated_at: 1704903292 - last_request_at: 1704730492 + id: 65c6090286ce64d19db0c460 + app_id: this_is_an_id171_that_should_be_at_least_ + name: company12 + remote_created_at: 1707477250 + created_at: 1707477250 + updated_at: 1707477250 + last_request_at: 1707304450 monthly_spend: 0 session_count: 0 user_count: 1 @@ -2191,7 +2213,7 @@ paths: Contact not found: value: type: error.list - request_id: 02301cef-4670-4aab-b947-f4b7bc94cc01 + request_id: 6df280b0-032d-408e-9def-396de28d279a errors: - code: not_found message: User Not Found @@ -2205,7 +2227,7 @@ paths: Unauthorized: value: type: error.list - request_id: 176db92d-d226-4df7-b5f5-57ec2f966881 + request_id: 805ac7a3-6d6e-4b6a-a70c-6590e34c8051 errors: - code: unauthorized message: Access Token Invalid @@ -2248,12 +2270,12 @@ paths: value: type: company company_id: '1' - id: 659ec2726abd01535c2233f5 - app_id: this_is_an_id164_that_should_be_at_least_ - name: company10 - remote_created_at: 1704903282 - created_at: 1704903282 - updated_at: 1704903283 + id: 65c6090086ce64d19db0c44f + app_id: this_is_an_id163_that_should_be_at_least_ + name: company8 + remote_created_at: 1707477248 + created_at: 1707477248 + updated_at: 1707477248 monthly_spend: 0 session_count: 0 user_count: 0 @@ -2275,14 +2297,14 @@ paths: Company Not Found: value: type: error.list - request_id: 860ae6db-c1d7-470c-bef9-e360bfa50fcb + request_id: 7bb265c8-26a9-4249-9eab-b7ae14ae10fd errors: - code: company_not_found message: Company Not Found Contact Not Found: value: type: error.list - request_id: 6bde36fa-559d-48ad-87c5-e8a366ebe81e + request_id: 58e4056b-1f5f-46aa-8de7-eacfd695e17c errors: - code: not_found message: User Not Found @@ -2296,7 +2318,7 @@ paths: Unauthorized: value: type: error.list - request_id: e77699d5-540c-43a8-9f25-67c050d34d08 + request_id: c997a0d4-3c5f-4b74-a2b6-745a74452d2f errors: - code: unauthorized message: Access Token Invalid @@ -2332,44 +2354,44 @@ paths: type: list data: - type: note - id: '105' - created_at: 1704298494 + id: '55' + created_at: 1706872453 contact: type: contact - id: 659ec27e6abd01535c223426 + id: 65c6090586ce64d19db0c46b author: type: admin - id: '991268440' - name: Ciaran100 Lee - email: admin100@email.com + id: '991268377' + name: Ciaran101 Lee + email: admin101@email.com away_mode_enabled: false away_mode_reassign: false body: "This is a note.
" - type: note - id: '104' - created_at: 1704212094 + id: '54' + created_at: 1706786053 contact: type: contact - id: 659ec27e6abd01535c223426 + id: 65c6090586ce64d19db0c46b author: type: admin - id: '991268440' - name: Ciaran100 Lee - email: admin100@email.com + id: '991268377' + name: Ciaran101 Lee + email: admin101@email.com away_mode_enabled: false away_mode_reassign: false body: "This is a note.
" - type: note - id: '103' - created_at: 1704212094 + id: '53' + created_at: 1706786053 contact: type: contact - id: 659ec27e6abd01535c223426 + id: 65c6090586ce64d19db0c46b author: type: admin - id: '991268440' - name: Ciaran100 Lee - email: admin100@email.com + id: '991268377' + name: Ciaran101 Lee + email: admin101@email.com away_mode_enabled: false away_mode_reassign: false body: "This is a note.
" @@ -2390,7 +2412,7 @@ paths: Contact not found: value: type: error.list - request_id: 462de140-4170-4690-9ceb-b448657fc3b4 + request_id: 22ce10d2-2162-4ef6-8de0-3aa626affdbc errors: - code: not_found message: User Not Found @@ -2424,16 +2446,16 @@ paths: Successful response: value: type: note - id: '110' - created_at: 1704903295 + id: '60' + created_at: 1707477255 contact: type: contact - id: 659ec27f6abd01535c223428 + id: 65c6090686ce64d19db0c46d author: type: admin - id: '991268442' - name: Ciaran102 Lee - email: admin102@email.com + id: '991268379' + name: Ciaran103 Lee + email: admin103@email.com away_mode_enabled: false away_mode_reassign: false body: "Hello
" @@ -2447,14 +2469,14 @@ paths: Admin not found: value: type: error.list - request_id: 375eab82-fbb9-4f8e-87c1-8c374ea821a7 + request_id: 112e9a4b-f0a3-425b-8492-96808a58ae28 errors: - code: not_found message: Resource Not Found Contact not found: value: type: error.list - request_id: 15e88398-1e6f-4dc2-8147-42aa3eccad0c + request_id: ad07bddb-a229-4d20-8ef2-65f998e45879 errors: - code: not_found message: User Not Found @@ -2484,20 +2506,20 @@ paths: successful_response: summary: Successful response value: - contact_id: 659ec27f6abd01535c223428 - admin_id: 991268442 + contact_id: 65c6090686ce64d19db0c46d + admin_id: 991268379 body: Hello admin_not_found: summary: Admin not found value: - contact_id: 659ec27f6abd01535c223429 + contact_id: 65c6090786ce64d19db0c46e admin_id: 123 body: Hello contact_not_found: summary: Contact not found value: contact_id: 123 - admin_id: 991268444 + admin_id: 991268381 body: Hello "/contacts/{contact_id}/segments": get: @@ -2530,10 +2552,10 @@ paths: type: list data: - type: segment - id: 659ec2806abd01535c22342b + id: 65c6090886ce64d19db0c470 name: segment - created_at: 1704903296 - updated_at: 1704903296 + created_at: 1707477256 + updated_at: 1707477256 person_type: user schema: "$ref": "#/components/schemas/contact_segments" @@ -2545,7 +2567,7 @@ paths: Contact not found: value: type: error.list - request_id: f109d9a4-5a3b-450e-8468-df8637ecbd33 + request_id: 4eb154c4-3109-45bd-bc75-33002654f520 errors: - code: not_found message: User Not Found @@ -2559,7 +2581,7 @@ paths: Unauthorized: value: type: error.list - request_id: 23d000a3-af84-4653-97a7-c8b75b64f1b8 + request_id: 62b26b96-da4a-4b8e-8584-44e984e26761 errors: - code: unauthorized message: Access Token Invalid @@ -2603,7 +2625,7 @@ paths: type: list data: - type: subscription - id: '228' + id: '185' state: live consent_type: opt_out default_translation: @@ -2617,7 +2639,7 @@ paths: content_types: - email - type: subscription - id: '230' + id: '187' state: live consent_type: opt_in default_translation: @@ -2640,7 +2662,7 @@ paths: Contact not found: value: type: error.list - request_id: 3b4ba6a0-f069-4d23-95e6-e7db35d44da2 + request_id: 58cefcd6-d861-413f-8656-9c1754a9459a errors: - code: not_found message: User Not Found @@ -2654,7 +2676,7 @@ paths: Unauthorized: value: type: error.list - request_id: a5553160-35a0-4f7e-9412-811f82932a51 + request_id: a01fcd3d-ed40-4f7f-9d53-375a493205d5 errors: - code: unauthorized message: Access Token Invalid @@ -2695,7 +2717,7 @@ paths: Successful: value: type: subscription - id: '243' + id: '200' state: live consent_type: opt_in default_translation: @@ -2718,14 +2740,14 @@ paths: Contact not found: value: type: error.list - request_id: 45c29992-62fd-4e33-8012-abf944f52a65 + request_id: 0efb689b-9e75-4a10-8dc6-ba179e8ec2dd errors: - code: not_found message: User Not Found Resource not found: value: type: error.list - request_id: b7b91cef-a49a-4425-a4f1-f381fc69a7d7 + request_id: e37abab0-031a-453e-a8f8-6a2476d76d5a errors: - code: not_found message: Resource Not Found @@ -2739,7 +2761,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0ee2a3c4-cce9-4cc7-89a7-4e47b390d40c + request_id: 87934aa5-4fad-44c6-978a-4f3902799e92 errors: - code: unauthorized message: Access Token Invalid @@ -2767,12 +2789,12 @@ paths: successful: summary: Successful value: - id: 243 + id: 200 consent_type: opt_in contact_not_found: summary: Contact not found value: - id: 247 + id: 204 consent_type: opt_in resource_not_found: summary: Resource not found @@ -2818,7 +2840,7 @@ paths: Successful: value: type: subscription - id: '259' + id: '216' state: live consent_type: opt_in default_translation: @@ -2841,14 +2863,14 @@ paths: Contact not found: value: type: error.list - request_id: 53a44217-e27b-406b-a272-4022fb77ee72 + request_id: f1047901-d6cb-4323-a309-7cee1db43b2c errors: - code: not_found message: User Not Found Resource not found: value: type: error.list - request_id: 4116ec1d-928f-4dcd-ab65-20e2725c3884 + request_id: 05f17479-5cc7-4a02-bef6-89c3e58431a3 errors: - code: not_found message: Resource Not Found @@ -2862,7 +2884,7 @@ paths: Unauthorized: value: type: error.list - request_id: d98b20d7-93d9-4bd4-8b08-7f163be5f0e7 + request_id: 87fdc44c-d8d9-40a0-9418-36cd88b55913 errors: - code: unauthorized message: Access Token Invalid @@ -2900,7 +2922,7 @@ paths: type: list data: - type: tag - id: '203' + id: '156' name: Manual tag schema: "$ref": "#/components/schemas/tag_list" @@ -2912,7 +2934,7 @@ paths: Contact not found: value: type: error.list - request_id: 43998ba7-8f64-4a3d-9c45-fca5a3b45b1a + request_id: 358ec53f-8502-42e0-9012-d34c9f2ac87e errors: - code: not_found message: User Not Found @@ -2926,7 +2948,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8012ba75-70fc-495f-8b82-669550d78bcb + request_id: b4f70018-2637-4466-ab68-934bd3b41bc6 errors: - code: unauthorized message: Access Token Invalid @@ -2961,7 +2983,7 @@ paths: successful: value: type: tag - id: '204' + id: '157' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -2973,14 +2995,14 @@ paths: Contact not found: value: type: error.list - request_id: 77e387ed-617c-40bb-b8cc-387e0be8d3ad + request_id: 5bcb7ec9-eef0-4c7f-b767-37a83f41968c errors: - code: not_found message: User Not Found Tag not found: value: type: error.list - request_id: d5321068-cbb7-4430-81dc-4e5a209cb9b8 + request_id: 40ada6eb-2539-486e-9bee-41cee4c9d58c errors: - code: not_found message: Resource Not Found @@ -2994,7 +3016,7 @@ paths: Unauthorized: value: type: error.list - request_id: 41f6cb46-715d-4ccb-8a9b-446631a05ba9 + request_id: 4ddeffce-0237-4cf3-9588-acb936c89c18 errors: - code: unauthorized message: Access Token Invalid @@ -3017,11 +3039,11 @@ paths: successful: summary: successful value: - id: 204 + id: 157 contact_not_found: summary: Contact not found value: - id: 205 + id: 158 tag_not_found: summary: Tag not found value: @@ -3063,7 +3085,7 @@ paths: successful: value: type: tag - id: '207' + id: '160' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -3075,14 +3097,14 @@ paths: Contact not found: value: type: error.list - request_id: c2adb115-9491-431b-9e2e-2c898e9f48bd + request_id: ef35da6a-030f-4732-b9af-75f06318ac4f errors: - code: not_found message: User Not Found Tag not found: value: type: error.list - request_id: '09efd627-9856-4ae5-9cec-823b7e3a9295' + request_id: 17d04d47-6aa5-4a92-9731-0295abb98fdd errors: - code: not_found message: Resource Not Found @@ -3096,7 +3118,7 @@ paths: Unauthorized: value: type: error.list - request_id: 183e227a-2c78-406d-902c-8829ce44797a + request_id: b3ebd867-7b55-4c49-884a-b0c7ad826a6e errors: - code: unauthorized message: Access Token Invalid @@ -3130,8 +3152,8 @@ paths: successful: value: type: contact - id: 659ec28c6abd01535c223442 - workspace_id: this_is_an_id238_that_should_be_at_least_ + id: 65c6091586ce64d19db0c487 + workspace_id: this_is_an_id237_that_should_be_at_least_ external_id: '70' role: user email: joebloggs@intercom.io @@ -3145,9 +3167,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1704903308 - updated_at: 1704903308 - signed_up_at: 1704903308 + created_at: 1707477269 + updated_at: 1707477269 + signed_up_at: 1707477269 last_seen_at: last_replied_at: last_contacted_at: @@ -3181,31 +3203,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ec28c6abd01535c223442/tags" + url: "/contacts/65c6091586ce64d19db0c487/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ec28c6abd01535c223442/notes" + url: "/contacts/65c6091586ce64d19db0c487/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ec28c6abd01535c223442/companies" + url: "/contacts/65c6091586ce64d19db0c487/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ec28c6abd01535c223442/subscriptions" + url: "/contacts/65c6091586ce64d19db0c487/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ec28c6abd01535c223442/subscriptions" + url: "/contacts/65c6091586ce64d19db0c487/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3224,7 +3246,7 @@ paths: Unauthorized: value: type: error.list - request_id: 6565a155-6293-4a50-81bb-b0e4a5e51b0d + request_id: c04bf7f5-0fca-444c-a807-850577474525 errors: - code: unauthorized message: Access Token Invalid @@ -3269,8 +3291,8 @@ paths: successful: value: type: contact - id: 659ec28d6abd01535c223443 - workspace_id: this_is_an_id242_that_should_be_at_least_ + id: 65c6091686ce64d19db0c488 + workspace_id: this_is_an_id241_that_should_be_at_least_ external_id: '70' role: user email: joe@bloggs.com @@ -3284,9 +3306,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1704903309 - updated_at: 1704903309 - signed_up_at: 1704903309 + created_at: 1707477270 + updated_at: 1707477270 + signed_up_at: 1707477270 last_seen_at: last_replied_at: last_contacted_at: @@ -3320,31 +3342,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ec28d6abd01535c223443/tags" + url: "/contacts/65c6091686ce64d19db0c488/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ec28d6abd01535c223443/notes" + url: "/contacts/65c6091686ce64d19db0c488/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ec28d6abd01535c223443/companies" + url: "/contacts/65c6091686ce64d19db0c488/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ec28d6abd01535c223443/subscriptions" + url: "/contacts/65c6091686ce64d19db0c488/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ec28d6abd01535c223443/subscriptions" + url: "/contacts/65c6091686ce64d19db0c488/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3363,7 +3385,7 @@ paths: Unauthorized: value: type: error.list - request_id: 5ca99505-6ef2-4f1c-a7ef-680b96283563 + request_id: 3ce08e3f-501e-4eb4-af5d-8eb15b55629f errors: - code: unauthorized message: Access Token Invalid @@ -3394,7 +3416,7 @@ paths: examples: successful: value: - id: 659ec28e6abd01535c223444 + id: 65c6091886ce64d19db0c489 external_id: '70' type: contact deleted: true @@ -3408,7 +3430,7 @@ paths: Unauthorized: value: type: error.list - request_id: eced1b53-7afe-420b-8890-03bb5df0ddfa + request_id: 8e4719be-30b7-48af-b88f-a93d1ab8f0b1 errors: - code: unauthorized message: Access Token Invalid @@ -3436,8 +3458,8 @@ paths: successful: value: type: contact - id: 659ec28f6abd01535c223446 - workspace_id: this_is_an_id250_that_should_be_at_least_ + id: 65c6091986ce64d19db0c48b + workspace_id: this_is_an_id249_that_should_be_at_least_ external_id: '70' role: user email: joe@bloggs.com @@ -3451,9 +3473,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1704903311 - updated_at: 1704903312 - signed_up_at: 1704903311 + created_at: 1707477273 + updated_at: 1707477273 + signed_up_at: 1707477273 last_seen_at: last_replied_at: last_contacted_at: @@ -3487,31 +3509,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ec28f6abd01535c223446/tags" + url: "/contacts/65c6091986ce64d19db0c48b/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ec28f6abd01535c223446/notes" + url: "/contacts/65c6091986ce64d19db0c48b/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ec28f6abd01535c223446/companies" + url: "/contacts/65c6091986ce64d19db0c48b/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ec28f6abd01535c223446/subscriptions" + url: "/contacts/65c6091986ce64d19db0c48b/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ec28f6abd01535c223446/subscriptions" + url: "/contacts/65c6091986ce64d19db0c48b/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3530,7 +3552,7 @@ paths: Unauthorized: value: type: error.list - request_id: 4b39d38a-6dd3-4345-9782-494494a7e96f + request_id: 60e9b42b-0810-481b-bfc8-45b5ea0adca9 errors: - code: unauthorized message: Access Token Invalid @@ -3545,8 +3567,8 @@ paths: successful: summary: successful value: - from: 659ec28f6abd01535c223445 - into: 659ec28f6abd01535c223446 + from: 65c6091986ce64d19db0c48a + into: 65c6091986ce64d19db0c48b "/contacts/search": post: summary: Search contacts @@ -3655,7 +3677,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8284a16c-69f7-4569-9b3b-2ae057b011e7 + request_id: e05db9b2-2d0f-4605-a350-76670b88e059 errors: - code: unauthorized message: Access Token Invalid @@ -3675,15 +3697,15 @@ paths: value: - field: id operator: "=" - value: 659ec2916abd01535c223449 + value: 65c6091b86ce64d19db0c48e - operator: OR value: - field: id operator: "=" - value: 659ec2916abd01535c223449 + value: 65c6091b86ce64d19db0c48e - field: id operator: "=" - value: 659ec2916abd01535c223449 + value: 65c6091b86ce64d19db0c48e "/contacts": get: summary: List all contacts @@ -3722,7 +3744,7 @@ paths: Unauthorized: value: type: error.list - request_id: 6b2d4d86-b8c0-4560-9c2f-8b3397f79b88 + request_id: 7f1bd9df-f486-412f-b28b-7af6eb3a301b errors: - code: unauthorized message: Access Token Invalid @@ -3748,8 +3770,8 @@ paths: successful: value: type: contact - id: 659ec2936abd01535c22344b - workspace_id: this_is_an_id262_that_should_be_at_least_ + id: 65c6091e86ce64d19db0c490 + workspace_id: this_is_an_id261_that_should_be_at_least_ external_id: role: user email: joebloggs@intercom.io @@ -3763,8 +3785,8 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1704903315 - updated_at: 1704903315 + created_at: 1707477278 + updated_at: 1707477278 signed_up_at: last_seen_at: last_replied_at: @@ -3799,31 +3821,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ec2936abd01535c22344b/tags" + url: "/contacts/65c6091e86ce64d19db0c490/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ec2936abd01535c22344b/notes" + url: "/contacts/65c6091e86ce64d19db0c490/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ec2936abd01535c22344b/companies" + url: "/contacts/65c6091e86ce64d19db0c490/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ec2936abd01535c22344b/subscriptions" + url: "/contacts/65c6091e86ce64d19db0c490/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ec2936abd01535c22344b/subscriptions" + url: "/contacts/65c6091e86ce64d19db0c490/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3842,7 +3864,7 @@ paths: Unauthorized: value: type: error.list - request_id: 18c64adc-55f2-4c8f-924d-8ffd50b499ce + request_id: 2f7d53a2-2a6b-46be-9f2b-79198deb3911 errors: - code: unauthorized message: Access Token Invalid @@ -3886,7 +3908,7 @@ paths: examples: successful: value: - id: 659ec2946abd01535c22344c + id: 65c6091f86ce64d19db0c491 external_id: '70' type: contact archived: true @@ -3919,7 +3941,7 @@ paths: examples: successful: value: - id: 659ec2946abd01535c22344d + id: 65c6091f86ce64d19db0c492 external_id: '70' type: contact archived: false @@ -3955,7 +3977,7 @@ paths: successful: value: type: tag - id: '209' + id: '162' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -3967,7 +3989,7 @@ paths: Conversation not found: value: type: error.list - request_id: 1fed5cdf-b288-4ee9-badb-003e9c67446d + request_id: cba5c655-eef2-4f30-b378-c9044bdd5175 errors: - code: not_found message: Conversation not found @@ -3981,7 +4003,7 @@ paths: Unauthorized: value: type: error.list - request_id: '0693bb9a-a244-43bf-9e4d-d07659179594' + request_id: 2403ecad-79aa-46a3-9769-638dfd9217fa errors: - code: unauthorized message: Access Token Invalid @@ -4010,13 +4032,13 @@ paths: successful: summary: successful value: - id: 209 - admin_id: 991268475 + id: 162 + admin_id: 991268412 conversation_not_found: summary: Conversation not found value: - id: 210 - admin_id: 991268477 + id: 163 + admin_id: 991268414 "/conversations/{conversation_id}/tags/{id}": delete: summary: Remove tag from a conversation @@ -4054,7 +4076,7 @@ paths: successful: value: type: tag - id: '212' + id: '165' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -4066,14 +4088,14 @@ paths: Conversation not found: value: type: error.list - request_id: cce7e672-8851-41bd-a161-570715e9b0ae + request_id: 929b2aea-c5ee-4e90-9f3a-7e237eaf7e15 errors: - code: not_found message: Conversation not found Tag not found: value: type: error.list - request_id: f16c4a33-fc24-41d0-bb5f-8d8032851838 + request_id: dda0212f-d891-4428-8536-dd453e1289f4 errors: - code: tag_not_found message: Tag not found @@ -4087,7 +4109,7 @@ paths: Unauthorized: value: type: error.list - request_id: fe95bf69-b6d8-43a2-90b2-0cc7586987de + request_id: c40d047a-fbf0-4647-8952-2b3d61599734 errors: - code: unauthorized message: Access Token Invalid @@ -4110,15 +4132,15 @@ paths: successful: summary: successful value: - admin_id: 991268479 + admin_id: 991268416 conversation_not_found: summary: Conversation not found value: - admin_id: 991268481 + admin_id: 991268418 tag_not_found: summary: Tag not found value: - admin_id: 991268482 + admin_id: 991268419 "/conversations": get: summary: List all conversations @@ -4165,22 +4187,22 @@ paths: total_count: 1 conversations: - type: conversation - id: '655' - created_at: 1704903323 - updated_at: 1704903323 + id: '562' + created_at: 1707477288 + updated_at: 1707477288 waiting_since: snoozed_until: source: type: conversation - id: '403918451' + id: '403918392' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991268485' - name: Ciaran142 Lee - email: admin142@email.com + id: '991268422' + name: Ciaran143 Lee + email: admin143@email.com attachments: [] url: redacted: false @@ -4188,7 +4210,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ec29b6abd01535c223451 + id: 65c6092786ce64d19db0c496 external_id: '70' first_contact_reply: admin_assignee_id: @@ -4223,7 +4245,7 @@ paths: Unauthorized: value: type: error.list - request_id: e1e550f4-f404-4cab-893d-5a46bba0c182 + request_id: 5675f1e3-17c0-4186-8514-7b54cabb5e98 errors: - code: unauthorized message: Access Token Invalid @@ -4237,7 +4259,7 @@ paths: API plan restricted: value: type: error.list - request_id: 6e3ceddc-6c8c-42a2-91fd-bb0957423fb0 + request_id: fed09473-dabd-48bb-afcd-54c26c097334 errors: - code: api_plan_restricted message: Active subscription needed. @@ -4269,11 +4291,11 @@ paths: conversation created: value: type: user_message - id: '403918461' - created_at: 1704903343 + id: '403918402' + created_at: 1707477311 body: Hello there message_type: inapp - conversation_id: '680' + conversation_id: '587' schema: "$ref": "#/components/schemas/message" '404': @@ -4284,7 +4306,7 @@ paths: Contact Not Found: value: type: error.list - request_id: f56767f6-6a7f-43bb-85d0-37cf6f382d18 + request_id: 322fdba7-1c1b-4118-a94a-c51ae1f60d70 errors: - code: not_found message: User Not Found @@ -4298,7 +4320,7 @@ paths: Unauthorized: value: type: error.list - request_id: e772d977-8f65-46a0-8591-662dff1c30c9 + request_id: 67d16309-5902-4c6d-a433-2261c752b1c3 errors: - code: unauthorized message: Access Token Invalid @@ -4312,7 +4334,7 @@ paths: API plan restricted: value: type: error.list - request_id: dbe651af-de24-4653-a70b-fb3db55e65a2 + request_id: 26dbf703-dc8f-4f8a-8d4c-7e39dfe45ffe errors: - code: api_plan_restricted message: Active subscription needed. @@ -4329,7 +4351,7 @@ paths: value: from: type: user - id: 659ec2ae6abd01535c223466 + id: 65c6093e86ce64d19db0c4ab body: Hello there contact_not_found: summary: Contact Not Found @@ -4381,22 +4403,22 @@ paths: conversation found: value: type: conversation - id: '684' - created_at: 1704903348 - updated_at: 1704903348 + id: '591' + created_at: 1707477318 + updated_at: 1707477318 waiting_since: snoozed_until: source: type: conversation - id: '403918465' + id: '403918406' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991268499' - name: Ciaran149 Lee - email: admin149@email.com + id: '991268436' + name: Ciaran150 Lee + email: admin150@email.com attachments: [] url: redacted: false @@ -4404,7 +4426,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ec2b36abd01535c22346a + id: 65c6094686ce64d19db0c4af external_id: '70' first_contact_reply: admin_assignee_id: @@ -4443,7 +4465,7 @@ paths: Not found: value: type: error.list - request_id: 30c33524-b8be-4376-a460-f4ee773644da + request_id: 735bd12b-75f2-4af3-bc84-450b7eb15980 errors: - code: not_found message: Resource Not Found @@ -4457,7 +4479,7 @@ paths: Unauthorized: value: type: error.list - request_id: 4a080201-3648-4404-bd87-9742c4b3b13a + request_id: 2118a0af-c6e4-4f5a-b6b1-cca9fe480efd errors: - code: unauthorized message: Access Token Invalid @@ -4471,7 +4493,7 @@ paths: API plan restricted: value: type: error.list - request_id: 7f3e1fd1-3532-4a98-af41-d55be745210b + request_id: fc6644a6-64d8-4c87-aa86-c3a8b5c7569c errors: - code: api_plan_restricted message: Active subscription needed. @@ -4514,22 +4536,22 @@ paths: conversation found: value: type: conversation - id: '688' - created_at: 1704903353 - updated_at: 1704903354 + id: '595' + created_at: 1707477325 + updated_at: 1707477326 waiting_since: snoozed_until: source: type: conversation - id: '403918469' + id: '403918410' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991268507' - name: Ciaran153 Lee - email: admin153@email.com + id: '991268444' + name: Ciaran154 Lee + email: admin154@email.com attachments: [] url: redacted: false @@ -4537,7 +4559,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ec2b96abd01535c22346e + id: 65c6094d86ce64d19db0c4b3 external_id: '70' first_contact_reply: admin_assignee_id: @@ -4568,34 +4590,34 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '125' + id: '119' part_type: conversation_attribute_updated_by_admin body: - created_at: 1704903354 - updated_at: 1704903354 - notified_at: 1704903354 + created_at: 1707477326 + updated_at: 1707477326 + notified_at: 1707477326 assigned_to: author: - id: '991268508' + id: '991268445' type: bot name: Operator - email: operator+this_is_an_id306_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id305_that_should_be_at_least_@intercom.io attachments: [] external_id: redacted: false - type: conversation_part - id: '126' + id: '120' part_type: conversation_attribute_updated_by_admin body: - created_at: 1704903354 - updated_at: 1704903354 - notified_at: 1704903354 + created_at: 1707477326 + updated_at: 1707477326 + notified_at: 1707477326 assigned_to: author: - id: '991268508' + id: '991268445' type: bot name: Operator - email: operator+this_is_an_id306_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id305_that_should_be_at_least_@intercom.io attachments: [] external_id: redacted: false @@ -4610,7 +4632,7 @@ paths: Not found: value: type: error.list - request_id: c1f34352-b336-4a5c-bc6a-04fbb9d4e03e + request_id: d5a59e7c-a471-4b0f-9723-8bc45e9ae1a8 errors: - code: not_found message: Resource Not Found @@ -4624,7 +4646,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9fa0cee0-8ac8-43e7-832c-5ad332c4161f + request_id: 50c6d6b3-777d-47de-a989-dcaddc0e0330 errors: - code: unauthorized message: Access Token Invalid @@ -4638,7 +4660,7 @@ paths: API plan restricted: value: type: error.list - request_id: cd4ae3b9-60b6-41f3-999f-eac45f311bbe + request_id: c86c7ff1-55f8-4898-a245-d4b7b94ac2a3 errors: - code: api_plan_restricted message: Active subscription needed. @@ -4757,22 +4779,22 @@ paths: total_count: 1 conversations: - type: conversation - id: '695' - created_at: 1704903362 - updated_at: 1704903362 + id: '602' + created_at: 1707477338 + updated_at: 1707477338 waiting_since: snoozed_until: source: type: conversation - id: '403918476' + id: '403918417' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991268537' - name: Ciaran176 Lee - email: admin176@email.com + id: '991268474' + name: Ciaran177 Lee + email: admin177@email.com attachments: [] url: redacted: false @@ -4780,7 +4802,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ec2c26abd01535c223475 + id: 65c6095a86ce64d19db0c4ba external_id: '70' first_contact_reply: admin_assignee_id: @@ -4821,15 +4843,15 @@ paths: value: - field: id operator: "=" - value: '695' + value: '602' - operator: OR value: - field: id operator: "=" - value: '695' + value: '602' - field: id operator: "=" - value: '695' + value: '602' "/conversations/{id}/reply": post: summary: Reply to a conversation @@ -4868,22 +4890,22 @@ paths: User reply: value: type: conversation - id: '703' - created_at: 1704903369 - updated_at: 1704903370 - waiting_since: 1704903370 + id: '610' + created_at: 1707477346 + updated_at: 1707477347 + waiting_since: 1707477347 snoozed_until: source: type: conversation - id: '403918479' + id: '403918420' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991268539' - name: Ciaran177 Lee - email: admin177@email.com + id: '991268476' + name: Ciaran178 Lee + email: admin178@email.com attachments: [] url: redacted: false @@ -4891,10 +4913,10 @@ paths: type: contact.list contacts: - type: contact - id: 659ec2c96abd01535c22347c + id: 65c6096286ce64d19db0c4c1 external_id: '70' first_contact_reply: - created_at: 1704903370 + created_at: 1707477347 type: conversation url: admin_assignee_id: @@ -4923,15 +4945,15 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '128' + id: '122' part_type: open body: "Thanks again :)
" - created_at: 1704903370 - updated_at: 1704903370 - notified_at: 1704903370 + created_at: 1707477347 + updated_at: 1707477347 + notified_at: 1707477347 assigned_to: author: - id: 659ec2c96abd01535c22347c + id: 65c6096286ce64d19db0c4c1 type: user name: Joe Bloggs email: joe@bloggs.com @@ -4942,22 +4964,22 @@ paths: Admin note reply: value: type: conversation - id: '704' - created_at: 1704903371 - updated_at: 1704903372 + id: '611' + created_at: 1707477349 + updated_at: 1707477350 waiting_since: snoozed_until: source: type: conversation - id: '403918480' + id: '403918421' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991268541' - name: Ciaran178 Lee - email: admin178@email.com + id: '991268478' + name: Ciaran179 Lee + email: admin179@email.com attachments: [] url: redacted: false @@ -4965,7 +4987,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ec2cb6abd01535c22347d + id: 65c6096486ce64d19db0c4c2 external_id: '70' first_contact_reply: admin_assignee_id: @@ -4994,7 +5016,7 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '129' + id: '123' part_type: note body: |-this is the message body
" author: type: admin - id: '991268545' - name: Ciaran180 Lee - email: admin180@email.com + id: '991268482' + name: Ciaran181 Lee + email: admin181@email.com attachments: [] url: redacted: false @@ -5048,10 +5070,10 @@ paths: type: contact.list contacts: - type: contact - id: 659ec2cd6abd01535c22347f + id: 65c6096886ce64d19db0c4c4 external_id: '70' first_contact_reply: - created_at: 1704903374 + created_at: 1707477353 type: conversation url: admin_assignee_id: @@ -5080,15 +5102,15 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '130' + id: '124' part_type: open body: "Thanks again :)
" - created_at: 1704903374 - updated_at: 1704903374 - notified_at: 1704903374 + created_at: 1707477353 + updated_at: 1707477353 + notified_at: 1707477353 assigned_to: author: - id: 659ec2cd6abd01535c22347f + id: 65c6096886ce64d19db0c4c4 type: user name: Joe Bloggs email: joe@bloggs.com @@ -5106,7 +5128,7 @@ paths: Not found: value: type: error.list - request_id: 95d1fe30-c802-4a70-90a1-9a3885422d74 + request_id: 0c70bd63-0fb8-4679-9f94-8996d7376b1f errors: - code: not_found message: Resource Not Found @@ -5120,7 +5142,7 @@ paths: Unauthorized: value: type: error.list - request_id: 679f127f-799e-4d93-93b1-46b5617354d4 + request_id: 8338076f-2e49-44fb-80a1-e8bd76d244a7 errors: - code: unauthorized message: Access Token Invalid @@ -5134,7 +5156,7 @@ paths: API plan restricted: value: type: error.list - request_id: 568d9835-1a7a-4932-a114-fa4f35004baa + request_id: 107018f9-5654-41cf-b6fc-12ec9fb07f30 errors: - code: api_plan_restricted message: Active subscription needed. @@ -5151,14 +5173,14 @@ paths: value: message_type: comment type: user - intercom_user_id: 659ec2c96abd01535c22347c + intercom_user_id: 65c6096286ce64d19db0c4c1 body: Thanks again :) admin_note_reply: summary: Admin note reply value: message_type: note type: admin - admin_id: 991268541 + admin_id: 991268478 body: "this is the message body
" author: type: admin - id: '991268553' - name: Ciaran184 Lee - email: admin184@email.com + id: '991268490' + name: Ciaran185 Lee + email: admin185@email.com attachments: [] url: redacted: false @@ -5232,7 +5254,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ec2d36abd01535c223483 + id: 65c6096f86ce64d19db0c4c8 external_id: '70' first_contact_reply: admin_assignee_id: @@ -5261,18 +5283,18 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '131' + id: '125' part_type: close body: "Goodbye :)
" - created_at: 1704903380 - updated_at: 1704903380 - notified_at: 1704903380 + created_at: 1707477360 + updated_at: 1707477360 + notified_at: 1707477360 assigned_to: author: - id: '991268553' + id: '991268490' type: admin - name: Ciaran184 Lee - email: admin184@email.com + name: Ciaran185 Lee + email: admin185@email.com attachments: [] external_id: redacted: false @@ -5280,22 +5302,22 @@ paths: Snooze a conversation: value: type: conversation - id: '711' - created_at: 1704903382 - updated_at: 1704903382 + id: '618' + created_at: 1707477362 + updated_at: 1707477364 waiting_since: - snoozed_until: 1704906982 + snoozed_until: 1707480963 source: type: conversation - id: '403918487' + id: '403918428' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991268555' - name: Ciaran185 Lee - email: admin185@email.com + id: '991268492' + name: Ciaran186 Lee + email: admin186@email.com attachments: [] url: redacted: false @@ -5303,7 +5325,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ec2d56abd01535c223484 + id: 65c6097286ce64d19db0c4c9 external_id: '70' first_contact_reply: admin_assignee_id: @@ -5332,18 +5354,18 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '132' + id: '126' part_type: snoozed body: - created_at: 1704903382 - updated_at: 1704903382 - notified_at: 1704903382 + created_at: 1707477364 + updated_at: 1707477364 + notified_at: 1707477364 assigned_to: author: - id: '991268555' + id: '991268492' type: admin - name: Ciaran185 Lee - email: admin185@email.com + name: Ciaran186 Lee + email: admin186@email.com attachments: [] external_id: redacted: false @@ -5351,22 +5373,22 @@ paths: Open a conversation: value: type: conversation - id: '716' - created_at: 1704903380 - updated_at: 1704903389 + id: '623' + created_at: 1707477362 + updated_at: 1707477370 waiting_since: snoozed_until: source: type: conversation - id: '403918488' + id: '403918429' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991268557' - name: Ciaran186 Lee - email: admin186@email.com + id: '991268494' + name: Ciaran187 Lee + email: admin187@email.com attachments: [] url: redacted: false @@ -5374,7 +5396,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ec2d96abd01535c223489 + id: 65c6097686ce64d19db0c4ce external_id: '74' first_contact_reply: admin_assignee_id: @@ -5403,18 +5425,18 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '134' + id: '128' part_type: open body: - created_at: 1704903389 - updated_at: 1704903389 - notified_at: 1704903389 + created_at: 1707477370 + updated_at: 1707477370 + notified_at: 1707477370 assigned_to: author: - id: '991268557' + id: '991268494' type: admin - name: Ciaran186 Lee - email: admin186@email.com + name: Ciaran187 Lee + email: admin187@email.com attachments: [] external_id: redacted: false @@ -5422,22 +5444,22 @@ paths: Assign a conversation: value: type: conversation - id: '720' - created_at: 1704903390 - updated_at: 1704903390 + id: '627' + created_at: 1707477371 + updated_at: 1707477372 waiting_since: snoozed_until: source: type: conversation - id: '403918491' + id: '403918432' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991268559' - name: Ciaran187 Lee - email: admin187@email.com + id: '991268496' + name: Ciaran188 Lee + email: admin188@email.com attachments: [] url: redacted: false @@ -5445,10 +5467,10 @@ paths: type: contact.list contacts: - type: contact - id: 659ec2dd6abd01535c22348c + id: 65c6097b86ce64d19db0c4d1 external_id: '70' first_contact_reply: - admin_assignee_id: 991268559 + admin_assignee_id: 991268496 team_assignee_id: open: true state: open @@ -5474,20 +5496,20 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '135' + id: '129' part_type: assign_and_reopen body: - created_at: 1704903390 - updated_at: 1704903390 - notified_at: 1704903390 + created_at: 1707477372 + updated_at: 1707477372 + notified_at: 1707477372 assigned_to: type: admin - id: '991268559' + id: '991268496' author: - id: '991268559' + id: '991268496' type: admin - name: Ciaran187 Lee - email: admin187@email.com + name: Ciaran188 Lee + email: admin188@email.com attachments: [] external_id: redacted: false @@ -5502,7 +5524,7 @@ paths: Not found: value: type: error.list - request_id: 05ac35dc-e9b5-46dc-82db-45537860a1e4 + request_id: f0e61a3d-7487-49a7-b215-06c65a021aca errors: - code: not_found message: Resource Not Found @@ -5516,7 +5538,7 @@ paths: Unauthorized: value: type: error.list - request_id: 72905166-70b8-49bc-a3e3-decaddeeef67 + request_id: 9b863b82-d609-4384-ac7d-2dafd1cd245d errors: - code: unauthorized message: Access Token Invalid @@ -5530,7 +5552,7 @@ paths: API plan restricted: value: type: error.list - request_id: f33ab72c-d97c-4895-8a1c-4920c190b875 + request_id: 1374746d-ae1a-4e20-bdb2-ca6ef1b50d98 errors: - code: api_plan_restricted message: Active subscription needed. @@ -5551,32 +5573,32 @@ paths: value: message_type: close type: admin - admin_id: 991268553 + admin_id: 991268490 body: Goodbye :) snooze_a_conversation: summary: Snooze a conversation value: message_type: snoozed - admin_id: 991268555 - snoozed_until: 1704906982 + admin_id: 991268492 + snoozed_until: 1707480963 open_a_conversation: summary: Open a conversation value: message_type: open - admin_id: 991268557 + admin_id: 991268494 assign_a_conversation: summary: Assign a conversation value: message_type: assignment type: admin - admin_id: 991268559 - assignee_id: 991268559 + admin_id: 991268496 + assignee_id: 991268496 not_found: summary: Not found value: message_type: close type: admin - admin_id: 991268561 + admin_id: 991268498 body: Goodbye :) "/conversations/{id}/run_assignment_rules": post: @@ -5607,22 +5629,22 @@ paths: Assign a conversation using assignment rules: value: type: conversation - id: '724' - created_at: 1704903395 - updated_at: 1704903396 + id: '631' + created_at: 1707477378 + updated_at: 1707477379 waiting_since: snoozed_until: source: type: conversation - id: '403918495' + id: '403918436' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991268567' - name: Ciaran191 Lee - email: admin191@email.com + id: '991268504' + name: Ciaran192 Lee + email: admin192@email.com attachments: [] url: redacted: false @@ -5630,7 +5652,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ec2e36abd01535c223490 + id: 65c6098286ce64d19db0c4d5 external_id: '70' first_contact_reply: admin_assignee_id: @@ -5659,20 +5681,20 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '136' + id: '130' part_type: default_assignment body: - created_at: 1704903396 - updated_at: 1704903396 - notified_at: 1704903396 + created_at: 1707477379 + updated_at: 1707477379 + notified_at: 1707477379 assigned_to: type: nobody_admin id: author: - id: '991268568' + id: '991268505' type: bot name: Operator - email: operator+this_is_an_id347_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id346_that_should_be_at_least_@intercom.io attachments: [] external_id: redacted: false @@ -5687,7 +5709,7 @@ paths: Not found: value: type: error.list - request_id: d4929a69-80c2-4de7-9ee9-78f4e9020d4c + request_id: db2de441-7538-456b-997c-a43bba3ffdea errors: - code: not_found message: Resource Not Found @@ -5701,7 +5723,7 @@ paths: Unauthorized: value: type: error.list - request_id: 22b4b529-5b92-4d6d-b45d-7bb6624d7b06 + request_id: 8f66d732-b849-4d91-b4f0-95d56b1ba851 errors: - code: unauthorized message: Access Token Invalid @@ -5715,7 +5737,7 @@ paths: API plan restricted: value: type: error.list - request_id: a8a7afc9-9d71-4207-ad05-c5146bff1d93 + request_id: 5e769224-6105-4638-9768-5105f58e75e5 errors: - code: api_plan_restricted message: Active subscription needed. @@ -5754,7 +5776,7 @@ paths: value: customers: - type: user - id: 659ec2e96abd01535c223494 + id: 65c6098986ce64d19db0c4d9 schema: "$ref": "#/components/schemas/conversation" '404': @@ -5765,7 +5787,7 @@ paths: Not found: value: type: error.list - request_id: 488f5fb2-8782-4b73-a3cd-a215dc75a0dc + request_id: ab11d585-0801-4272-a8a6-d0220dfcbd69 errors: - code: not_found message: Resource Not Found @@ -5779,7 +5801,7 @@ paths: Unauthorized: value: type: error.list - request_id: '03487a51-2ed5-4ada-a55a-6e4ad53a3799' + request_id: 7675d785-ff8a-437f-be75-e875226fda02 errors: - code: unauthorized message: Access Token Invalid @@ -5793,7 +5815,7 @@ paths: API plan restricted: value: type: error.list - request_id: 5ad02f95-40ed-4ca8-8e6d-1cbc45d0d243 + request_id: a94d372e-c619-4629-9906-fa6e26d4eca9 errors: - code: api_plan_restricted message: Active subscription needed. @@ -5808,15 +5830,15 @@ paths: attach_a_contact_to_a_conversation: summary: Attach a contact to a conversation value: - admin_id: 991268575 + admin_id: 991268512 customer: - intercom_user_id: 659ec2e96abd01535c223494 + intercom_user_id: 65c6098986ce64d19db0c4d9 not_found: summary: Not found value: - admin_id: 991268577 + admin_id: 991268514 customer: - intercom_user_id: 659ec2ea6abd01535c223495 + intercom_user_id: 65c6098b86ce64d19db0c4da "/conversations/{conversation_id}/customers/{contact_id}": delete: summary: Detach a contact from a group conversation @@ -5857,7 +5879,7 @@ paths: value: customers: - type: user - id: 659ec2f36abd01535c22349f + id: 65c6099886ce64d19db0c4e4 schema: "$ref": "#/components/schemas/conversation" '404': @@ -5868,14 +5890,14 @@ paths: Conversation not found: value: type: error.list - request_id: 354dd098-2a14-4b3c-9f10-6805176844d3 + request_id: 902c0ae9-c6cf-4ac2-9602-760f076da9a3 errors: - code: not_found message: Resource Not Found Contact not found: value: type: error.list - request_id: 698996c2-32b8-4a40-944e-dba81fe767c4 + request_id: bcfc866c-f6bf-456a-8217-b2414b5a62fa errors: - code: not_found message: User Not Found @@ -5889,7 +5911,7 @@ paths: Last customer: value: type: error.list - request_id: 1f2fbaf7-1ff7-4877-902f-9efaa69ee037 + request_id: 2158d0e5-b600-4bb3-be66-e5f8c18608e0 errors: - code: parameter_invalid message: Removing the last customer is not allowed @@ -5903,7 +5925,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8a506fa2-bb68-4e26-b69c-97f79c9282e9 + request_id: eb5693be-0a4d-4c00-b0fc-9c515d466be7 errors: - code: unauthorized message: Access Token Invalid @@ -5917,7 +5939,7 @@ paths: API plan restricted: value: type: error.list - request_id: c759ac69-1891-4566-8fb3-b5f7ce6adf89 + request_id: c0382caf-dd21-4145-874b-e2ddf5ddd5b0 errors: - code: api_plan_restricted message: Active subscription needed. @@ -5932,27 +5954,27 @@ paths: detach_a_contact_from_a_group_conversation: summary: Detach a contact from a group conversation value: - admin_id: 991268583 + admin_id: 991268520 customer: - intercom_user_id: 659ec2ee6abd01535c223498 + intercom_user_id: 65c6099086ce64d19db0c4dd conversation_not_found: summary: Conversation not found value: - admin_id: 991268585 + admin_id: 991268522 customer: - intercom_user_id: 659ec2f46abd01535c2234a0 + intercom_user_id: 65c6099986ce64d19db0c4e5 contact_not_found: summary: Contact not found value: - admin_id: 991268587 + admin_id: 991268524 customer: - intercom_user_id: 659ec2fa6abd01535c2234a7 + intercom_user_id: 65c609a186ce64d19db0c4ec last_customer: summary: Last customer value: - admin_id: 991268589 + admin_id: 991268526 customer: - intercom_user_id: 659ec3016abd01535c2234ae + intercom_user_id: 65c609a986ce64d19db0c4f3 "/conversations/redact": post: summary: Redact a conversation part @@ -5979,22 +6001,22 @@ paths: Redact a conversation part: value: type: conversation - id: '780' - created_at: 1704903444 - updated_at: 1704903446 - waiting_since: 1704903445 + id: '687' + created_at: 1707477440 + updated_at: 1707477443 + waiting_since: 1707477442 snoozed_until: source: type: conversation - id: '403918521' + id: '403918462' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991268595' - name: Ciaran205 Lee - email: admin205@email.com + id: '991268532' + name: Ciaran206 Lee + email: admin206@email.com attachments: [] url: redacted: false @@ -6002,10 +6024,10 @@ paths: type: contact.list contacts: - type: contact - id: 659ec3146abd01535c2234c3 + id: 65c609c086ce64d19db0c508 external_id: '70' first_contact_reply: - created_at: 1704903445 + created_at: 1707477442 type: conversation url: admin_assignee_id: @@ -6034,15 +6056,15 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '144' + id: '138' part_type: open body: "This message was deleted
" - created_at: 1704903445 - updated_at: 1704903446 - notified_at: 1704903445 + created_at: 1707477442 + updated_at: 1707477443 + notified_at: 1707477442 assigned_to: author: - id: 659ec3146abd01535c2234c3 + id: 65c609c086ce64d19db0c508 type: user name: Joe Bloggs email: joe@bloggs.com @@ -6060,7 +6082,7 @@ paths: Not found: value: type: error.list - request_id: b53e159b-672f-44ba-8945-bc7024d6ac44 + request_id: b16640a4-8ebc-401d-a057-cc5e28a1d791 errors: - code: conversation_part_or_message_not_found message: Conversation part or message not found @@ -6074,7 +6096,7 @@ paths: Unauthorized: value: type: error.list - request_id: '0218e105-4bb8-4675-bbeb-d648f10c29e9' + request_id: 777846c2-bf2b-4ddc-9b75-2aaf5edd2c7d errors: - code: unauthorized message: Access Token Invalid @@ -6090,8 +6112,8 @@ paths: summary: Redact a conversation part value: type: conversation_part - conversation_id: 780 - conversation_part_id: 144 + conversation_id: 687 + conversation_part_id: 138 not_found: summary: Not found value: @@ -6126,7 +6148,7 @@ paths: successful: value: type: ticket - id: '783' + id: '690' ticket_id: '7' ticket_attributes: {} ticket_state: submitted @@ -6136,10 +6158,10 @@ paths: name: my-ticket-type-1 description: my ticket type description is awesome. icon: "\U0001F981" - workspace_id: this_is_an_id381_that_should_be_at_least_ + workspace_id: this_is_an_id380_that_should_be_at_least_ archived: false - created_at: 1704903452 - updated_at: 1704903452 + created_at: 1707477450 + updated_at: 1707477450 is_internal: false ticket_type_attributes: type: list @@ -6149,40 +6171,40 @@ paths: type: contact.list contacts: - type: contact - id: 659ec3196abd01535c2234c6 + id: 65c609c786ce64d19db0c50b external_id: '70' admin_assignee_id: '0' team_assignee_id: '0' - created_at: 1704903449 - updated_at: 1704903452 + created_at: 1707477447 + updated_at: 1707477451 ticket_parts: type: ticket_part.list ticket_parts: - type: ticket_part - id: '146' + id: '140' part_type: comment body: "Comment for message
" - created_at: 1704903449 - updated_at: 1704903449 + created_at: 1707477447 + updated_at: 1707477447 author: - id: 659ec3196abd01535c2234c6 + id: 65c609c786ce64d19db0c50b type: user name: Joe Bloggs email: joe@bloggs.com attachments: [] redacted: false - type: ticket_part - id: '147' + id: '141' part_type: ticket_state_updated_by_admin ticket_state: submitted previous_ticket_state: submitted - created_at: 1704903452 - updated_at: 1704903452 + created_at: 1707477451 + updated_at: 1707477451 author: - id: '991268605' + id: '991268542' type: bot name: Operator - email: operator+this_is_an_id381_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id380_that_should_be_at_least_@intercom.io attachments: [] redacted: false total_count: 2 @@ -6204,7 +6226,7 @@ paths: Bad request: value: type: error.list - request_id: 5370f6d2-b1c2-4d09-8d6b-e43a57ed3d23 + request_id: 675ce4a2-fa5f-4e21-b6ac-ab9bcfb506ff errors: - code: parameter_invalid message: Ticket type is not a customer ticket type @@ -6274,6 +6296,7 @@ paths: data_type: string api_writable: true ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6285,6 +6308,7 @@ paths: data_type: string api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6297,6 +6321,7 @@ paths: data_type: date api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6308,6 +6333,7 @@ paths: data_type: date api_writable: true ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6319,6 +6345,7 @@ paths: data_type: integer api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6331,6 +6358,7 @@ paths: data_type: integer api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6343,6 +6371,7 @@ paths: data_type: string api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6354,6 +6383,7 @@ paths: data_type: float api_writable: true ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6366,6 +6396,7 @@ paths: data_type: integer api_writable: true ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6378,6 +6409,7 @@ paths: data_type: string api_writable: true ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6390,10 +6422,11 @@ paths: data_type: string api_writable: true ui_writable: false + messenger_writable: true custom: false archived: false model: company - - id: 113 + - id: 66 type: data_attribute name: The One Ring full_name: custom_attributes.The One Ring @@ -6403,11 +6436,12 @@ paths: data_type: string api_writable: true ui_writable: false + messenger_writable: true custom: true archived: false - admin_id: '991268613' - created_at: 1704903455 - updated_at: 1704903455 + admin_id: '991268559' + created_at: 1707477458 + updated_at: 1707477458 model: company - type: data_attribute name: id @@ -6417,6 +6451,7 @@ paths: data_type: string api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6428,6 +6463,7 @@ paths: data_type: date api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6439,6 +6475,7 @@ paths: data_type: date api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6450,6 +6487,7 @@ paths: data_type: string api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6461,6 +6499,7 @@ paths: data_type: string api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6474,7 +6513,7 @@ paths: Unauthorized: value: type: error.list - request_id: d63b7d26-e7aa-48f9-a257-ac7b96ab6927 + request_id: 1db1bf16-290a-4f92-9e2f-f38dfeecf382 errors: - code: unauthorized message: Access Token Invalid @@ -6499,7 +6538,7 @@ paths: examples: Successful: value: - id: 116 + id: 69 type: data_attribute name: Mithril Shirt full_name: custom_attributes.Mithril Shirt @@ -6507,11 +6546,12 @@ paths: data_type: string api_writable: true ui_writable: false + messenger_writable: true custom: true archived: false - admin_id: '991268615' - created_at: 1704903456 - updated_at: 1704903456 + admin_id: '991268561' + created_at: 1707477459 + updated_at: 1707477459 model: company schema: "$ref": "#/components/schemas/data_attribute" @@ -6523,7 +6563,7 @@ paths: Same name already exists: value: type: error.list - request_id: ea4a8b36-6a6f-4a87-a383-dd36d10a3651 + request_id: b379005c-7a1b-4c77-a8d4-1289505d3580 errors: - code: parameter_invalid message: You already have 'The One Ring' in your company data. @@ -6531,7 +6571,7 @@ paths: Invalid name: value: type: error.list - request_id: dcf7c0e0-4a0a-4977-bb74-b524438bb28f + request_id: a987c648-bda5-4501-aabe-7cb6f5ac32dd errors: - code: parameter_invalid message: Your name for this attribute must only contain alphanumeric @@ -6539,7 +6579,7 @@ paths: Attribute already exists: value: type: error.list - request_id: 9bd6e2e7-724a-4661-aa6e-cf3891208d20 + request_id: 38c9dbdf-55b7-4f42-bcb6-2946f0aa188b errors: - code: parameter_invalid message: You already have 'The One Ring' in your company data. @@ -6547,14 +6587,14 @@ paths: Invalid Data Type: value: type: error.list - request_id: b01f4c9d-c020-4461-a15f-d82c65db888c + request_id: 8a2bf989-99d1-4ce8-af67-364db03c6d34 errors: - code: parameter_invalid message: Data Type isn't an option Too few options for list: value: type: error.list - request_id: f759fb8f-bc10-4427-abc1-9d3838cdecbb + request_id: 387d7d7e-6005-453d-acbe-0beff5f150c3 errors: - code: parameter_invalid message: The Data Attribute model field must be either contact @@ -6569,7 +6609,7 @@ paths: Unauthorized: value: type: error.list - request_id: 237af7d8-b4f5-4064-8c4b-30be30ed30ae + request_id: d34025ae-8b52-4ae3-8cc3-57807a48c442 errors: - code: unauthorized message: Access Token Invalid @@ -6648,7 +6688,7 @@ paths: examples: Successful: value: - id: 123 + id: 76 type: data_attribute name: The One Ring full_name: custom_attributes.The One Ring @@ -6660,11 +6700,12 @@ paths: - 11-20 api_writable: true ui_writable: false + messenger_writable: true custom: true archived: false - admin_id: '991268622' - created_at: 1704903459 - updated_at: 1704903459 + admin_id: '991268568' + created_at: 1707477462 + updated_at: 1707477463 model: company schema: "$ref": "#/components/schemas/data_attribute" @@ -6676,7 +6717,7 @@ paths: Too few options in list: value: type: error.list - request_id: 91c64990-dbd7-4462-a49b-cb59744ea154 + request_id: 44b5e276-46b2-4318-87c6-f09b0bf9a4e9 errors: - code: parameter_invalid message: Options isn't an array @@ -6690,7 +6731,7 @@ paths: Attribute Not Found: value: type: error.list - request_id: 33f5de8c-3878-4797-b0ab-1d2fa373cfa5 + request_id: 025bf612-0dd0-406f-a2ee-f3e62d313c30 errors: - code: field_not_found message: We couldn't find that data attribute to update @@ -6704,7 +6745,7 @@ paths: Has Dependant Object: value: type: error.list - request_id: 50c33dc7-532c-454f-90ac-37ad802b62c8 + request_id: ed83aff9-0db8-442b-b0a4-a5c92927336c errors: - code: data_invalid message: The Data Attribute you are trying to archive has a @@ -6719,7 +6760,7 @@ paths: Unauthorized: value: type: error.list - request_id: f5a1a5d9-fc95-44ad-99a4-79aad8bca889 + request_id: 45d5c97a-3cfe-4834-9d38-4e7f0ae640ee errors: - code: unauthorized message: Access Token Invalid @@ -6770,63 +6811,49 @@ paths: tags: - Data Events operationId: createDataEvent - description: "\nYou will need an Access Token that has write permissions to - send Events. Once you have a key you can submit events via POST to the Events - resource, which is located at https://api.intercom.io/events, or you can send - events using one of the client libraries. When working with the HTTP API directly - a client should send the event with a `Content-Type` of `application/json`.\n\nWhen - using the JavaScript API, [adding the code to your app](http://docs.intercom.io/configuring-Intercom/tracking-user-events-in-your-app) - makes the Events API available. Once added, you can submit an event using - the `trackEvent` method. This will associate the event with the Lead or currently - logged-in user or logged-out visitor/lead and send it to Intercom. The final - parameter is a map that can be used to send optional metadata about the event.\n\nWith - the Ruby client you pass a hash describing the event to `Intercom::Event.create`, - or call the `track_user` method directly on the current user object (e.g. - `user.track_event`).\n\n| Type | Description | - Example |\n| - :-------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- - | :-------------------------------------------------------------------------------- - |\n| String | The value is a JSON String | - `\"source\":\"desktop\"` |\n| - Number | The value is a JSON Number | - `\"load\": 3.67` |\n| - Date | The key ends with the String `_date` and the value is a - [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time), assumed to be in - the [UTC](http://en.wikipedia.org/wiki/Coordinated_Universal_Time) timezone. - | `\"contact_date\": 1392036272` |\n| - Link | The value is a HTTP or HTTPS URI. | - `\"article\": \"https://example.org/ab1de.html\"` |\n| - Rich Link | The value is a JSON object that contains `url` and `value` - keys. | - `\"article\": {\"url\": \"https://example.org/ab1de.html\", \"value\":\"the - dude abides\"}` |\n| Monetary Amount | The value is a JSON object that contains - `amount` and `currency` keys. The `amount` key is a positive integer representing - the amount in cents. The price in the example to the right denotes €349.99. - \ | `\"price\": {\"amount\": 34999, \"currency\": \"eur\"}` |\n\n**NB: - For the JSON object types, please note that we do not currently support nested - JSON structure.**\n\n> \U0001F6A7 Lead Events\n>\n> When submitting events - for Leads, you will need to specify the Lead's `id`.\n\n> \U0001F4D8 Metadata - behaviour\n>\n> - We currently limit the number of tracked metadata keys to - 10 per event. Once the quota is reached, we ignore any further keys we receive. - The first 10 metadata keys are determined by the order in which they are sent - in with the event.\n> - It is not possible to change the metadata keys once - the event has been sent. A new event will need to be created with the new - keys and you can archive the old one.\n> - There might be up to 24 hrs delay - when you send a new metadata for an existing event.\n\n> \U0001F4D8 Event - de-duplication\n>\n> The API may detect and ignore duplicate events. Each - event is uniquely identified as a combination of the following data - the - Workspace identifier, the Contact external identifier, the Data Event name - and the Data Event created time. As a result, it is **strongly recommended** - to send a second granularity Unix timestamp in the `created_at` field.\n>\n> - Duplicated events are responded to using the normal `202 Accepted` code - - an error is not thrown, however repeat requests will be counted against any - rate limit that is in place.\n\n### HTTP API Responses\n\n- Successful responses - to submitted events return `202 Accepted` with an empty body.\n- Unauthorised - access will be rejected with a `401 Unauthorized` or `403 Forbidden` response - code.\n- Events sent about users that cannot be found will return a `404 Not - Found`.\n- Event lists containing duplicate events will have those duplicates - ignored.\n- Server errors will return a `500` response code and may contain - an error message in the body.\n\n" + description: |2+ + + You will need an Access Token that has write permissions to send Events. Once you have a key you can submit events via POST to the Events resource, which is located at https://api.intercom.io/events, or you can send events using one of the client libraries. When working with the HTTP API directly a client should send the event with a `Content-Type` of `application/json`. + + When using the JavaScript API, [adding the code to your app](http://docs.intercom.io/configuring-Intercom/tracking-user-events-in-your-app) makes the Events API available. Once added, you can submit an event using the `trackEvent` method. This will associate the event with the Lead or currently logged-in user or logged-out visitor/lead and send it to Intercom. The final parameter is a map that can be used to send optional metadata about the event. + + With the Ruby client you pass a hash describing the event to `Intercom::Event.create`, or call the `track_user` method directly on the current user object (e.g. `user.track_event`). + + **NB: For the JSON object types, please note that we do not currently support nested JSON structure.** + + | Type | Description | Example | + | :-------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------- | + | String | The value is a JSON String | `"source":"desktop"` | + | Number | The value is a JSON Number | `"load": 3.67` | + | Date | The key ends with the String `_date` and the value is a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time), assumed to be in the [UTC](http://en.wikipedia.org/wiki/Coordinated_Universal_Time) timezone. | `"contact_date": 1392036272` | + | Link | The value is a HTTP or HTTPS URI. | `"article": "https://example.org/ab1de.html"` | + | Rich Link | The value is a JSON object that contains `url` and `value` keys. | `"article": {"url": "https://example.org/ab1de.html", "value":"the dude abides"}` | + | Monetary Amount | The value is a JSON object that contains `amount` and `currency` keys. The `amount` key is a positive integer representing the amount in cents. The price in the example to the right denotes €349.99. | `"price": {"amount": 34999, "currency": "eur"}` | + + **Lead Events** + + When submitting events for Leads, you will need to specify the Lead's `id`. + + **Metadata behaviour** + + - We currently limit the number of tracked metadata keys to 10 per event. Once the quota is reached, we ignore any further keys we receive. The first 10 metadata keys are determined by the order in which they are sent in with the event. + - It is not possible to change the metadata keys once the event has been sent. A new event will need to be created with the new keys and you can archive the old one. + - There might be up to 24 hrs delay when you send a new metadata for an existing event. + + **Event de-duplication** + + The API may detect and ignore duplicate events. Each event is uniquely identified as a combination of the following data - the Workspace identifier, the Contact external identifier, the Data Event name and the Data Event created time. As a result, it is **strongly recommended** to send a second granularity Unix timestamp in the `created_at` field. + + Duplicated events are responded to using the normal `202 Accepted` code - an error is not thrown, however repeat requests will be counted against any rate limit that is in place. + + ### HTTP API Responses + + - Successful responses to submitted events return `202 Accepted` with an empty body. + - Unauthorised access will be rejected with a `401 Unauthorized` or `403 Forbidden` response code. + - Events sent about users that cannot be found will return a `404 Not Found`. + - Event lists containing duplicate events will have those duplicates ignored. + - Server errors will return a `500` response code and may contain an error message in the body. + responses: '202': description: successful @@ -6838,7 +6865,7 @@ paths: Unauthorized: value: type: error.list - request_id: 723b92af-b79e-4512-a8ca-ecf5b997c8c2 + request_id: eba7e9e5-09ae-4d0f-9376-c08a926eb4ff errors: - code: unauthorized message: Access Token Invalid @@ -6924,8 +6951,8 @@ paths: events: [] pages: next: http://api.intercom.test/events?next page - email: user24@email.com - intercom_user_id: 659ec32c6abd01535c2234dc + email: user26@email.com + intercom_user_id: 65c609db86ce64d19db0c511 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 schema: "$ref": "#/components/schemas/data_event_summary" @@ -6937,7 +6964,7 @@ paths: Unauthorized: value: type: error.list - request_id: 43c525b2-fa57-4593-9695-e196776a169d + request_id: 4b89b4e2-04cb-424c-8a8a-719629a7f0dd errors: - code: unauthorized message: Access Token Invalid @@ -6968,7 +6995,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9f5f7745-1e66-4195-bff9-eb43b8192de4 + request_id: 61451e1c-d3f4-47cd-837b-88b1753610ab errors: - code: unauthorized message: Access Token Invalid @@ -7012,7 +7039,7 @@ paths: examples: successful: value: - job_identifier: 86exkvb6mas0i1uv + job_identifier: w9si0b7ca05jejdj status: pending download_url: '' download_expires_at: '' @@ -7027,8 +7054,8 @@ paths: successful: summary: successful value: - created_at_after: 1704885469 - created_at_before: 1704903469 + created_at_after: 1707459469 + created_at_before: 1707477469 "/export/content/data/{job_identifier}": get: summary: Show content data export @@ -7062,7 +7089,7 @@ paths: examples: successful: value: - job_identifier: tw2utjkozhhdyelq + job_identifier: rc2i2e8vdxrwvr8a status: pending download_url: '' download_expires_at: '' @@ -7094,7 +7121,7 @@ paths: examples: successful: value: - job_identifier: m37o4vxn7s96zeuf + job_identifier: id4q6yde13cdc1re status: canceled download_url: '' download_expires_at: '' @@ -7155,32 +7182,32 @@ paths: user message created: value: type: user_message - id: '403918532' - created_at: 1704903496 + id: '403918467' + created_at: 1707477472 body: heyy message_type: inapp - conversation_id: '796' + conversation_id: '692' lead message created: value: type: user_message - id: '403918533' - created_at: 1704903497 + id: '403918468' + created_at: 1707477473 body: heyy message_type: inapp - conversation_id: '797' + conversation_id: '693' admin message created: value: type: admin_message - id: '40' - created_at: 1704903498 + id: '25' + created_at: 1707477474 subject: heyy body: heyy message_type: inapp owner: type: admin - id: '991268656' - name: Ciaran248 Lee - email: admin248@email.com + id: '991268591' + name: Ciaran258 Lee + email: admin258@email.com away_mode_enabled: false away_mode_reassign: false schema: @@ -7193,14 +7220,14 @@ paths: No body supplied for message: value: type: error.list - request_id: 8c8ca5b8-5b83-4f7c-8825-abac1d0f869c + request_id: 3d1c6bcb-85ec-463f-81d3-bd5eb3e5f0be errors: - code: parameter_invalid message: Body is required No body supplied for email message: value: type: error.list - request_id: 73d86d90-8516-49ba-9387-9b078c469067 + request_id: 0f18dfd1-79e1-403f-aa24-053047e14447 errors: - code: parameter_invalid message: Body is required @@ -7214,7 +7241,7 @@ paths: No subject supplied for email message: value: type: error.list - request_id: 3bb0e304-352e-46fb-994a-419880dd7ce8 + request_id: 19b51c4b-fed5-4afb-b485-c61d8a938428 errors: - code: parameter_not_found message: No subject supplied for email message @@ -7228,7 +7255,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0f37b79c-d7f8-4b17-b900-205d57bafcbe + request_id: 0bd0d28c-b284-4854-9292-b08ff84efa86 errors: - code: unauthorized message: Access Token Invalid @@ -7242,7 +7269,7 @@ paths: API plan restricted: value: type: error.list - request_id: d6a6d344-a4d6-4184-bbc2-99b27631b1ef + request_id: c0f6b317-6a1a-4e78-9e99-30ef8eedeb54 errors: - code: api_plan_restricted message: Active subscription needed. @@ -7259,7 +7286,7 @@ paths: value: from: type: user - id: 659ec3486abd01535c223531 + id: 65c609e086ce64d19db0c516 body: heyy referer: https://twitter.com/bob lead_message_created: @@ -7267,7 +7294,7 @@ paths: value: from: type: lead - id: 659ec3496abd01535c223532 + id: 65c609e186ce64d19db0c517 body: heyy referer: https://twitter.com/bob admin_message_created: @@ -7275,10 +7302,10 @@ paths: value: from: type: admin - id: '991268656' + id: '991268591' to: type: user - id: 659ec34a6abd01535c223533 + id: 65c609e286ce64d19db0c518 message_type: conversation body: heyy no_body_supplied_for_message: @@ -7286,10 +7313,10 @@ paths: value: from: type: admin - id: '991268658' + id: '991268593' to: type: user - id: 659ec34b6abd01535c223534 + id: 65c609e386ce64d19db0c519 message_type: inapp body: subject: heyy @@ -7298,7 +7325,7 @@ paths: value: from: type: admin - id: '991268659' + id: '991268594' to: type: user user_id: '70' @@ -7309,10 +7336,10 @@ paths: value: from: type: admin - id: '991268660' + id: '991268595' to: type: user - id: 659ec34c6abd01535c223536 + id: 65c609e486ce64d19db0c51b message_type: email body: subject: heyy @@ -7345,10 +7372,10 @@ paths: data: - id: '57' type: news-item - workspace_id: this_is_an_id453_that_should_be_at_least_ + workspace_id: this_is_an_id470_that_should_be_at_least_ title: We have news body: "Hello there,
" - sender_id: 991268665 + sender_id: 991268600 state: draft labels: [] cover_image_url: @@ -7358,15 +7385,15 @@ paths: - - deliver_silently: false - created_at: 1704903502 - updated_at: 1704903502 + created_at: 1707477478 + updated_at: 1707477478 newsfeed_assignments: [] - id: '58' type: news-item - workspace_id: this_is_an_id453_that_should_be_at_least_ + workspace_id: this_is_an_id470_that_should_be_at_least_ title: We have news body: "Hello there,
" - sender_id: 991268667 + sender_id: 991268602 state: draft labels: [] cover_image_url: @@ -7376,8 +7403,8 @@ paths: - - deliver_silently: false - created_at: 1704903502 - updated_at: 1704903502 + created_at: 1707477478 + updated_at: 1707477478 newsfeed_assignments: [] total_count: 2 schema: @@ -7390,7 +7417,7 @@ paths: Unauthorized: value: type: error.list - request_id: c7a25ea3-25bd-4b56-98c9-23e4e5ef4bcc + request_id: 3a834d58-f8f5-4e7e-8cee-8d4c6bde5276 errors: - code: unauthorized message: Access Token Invalid @@ -7417,10 +7444,10 @@ paths: value: id: '61' type: news-item - workspace_id: this_is_an_id457_that_should_be_at_least_ + workspace_id: this_is_an_id474_that_should_be_at_least_ title: Halloween is here! body: "New costumes in store for this spooky season
" - sender_id: 991268674 + sender_id: 991268609 state: live labels: - New @@ -7431,8 +7458,8 @@ paths: - "\U0001F606" - "\U0001F605" deliver_silently: true - created_at: 1704903504 - updated_at: 1704903504 + created_at: 1707477480 + updated_at: 1707477480 newsfeed_assignments: - newsfeed_id: 103 published_at: 1664638214 @@ -7446,7 +7473,7 @@ paths: Unauthorized: value: type: error.list - request_id: 3597b54d-8f96-43af-a3e5-00d890707de4 + request_id: 2aac7120-12d1-4ca3-a30e-1ec1f9539b58 errors: - code: unauthorized message: Access Token Invalid @@ -7467,7 +7494,7 @@ paths: - Product - Update - New - sender_id: 991268674 + sender_id: 991268609 deliver_silently: true reactions: - "\U0001F606" @@ -7505,10 +7532,10 @@ paths: value: id: '62' type: news-item - workspace_id: this_is_an_id461_that_should_be_at_least_ + workspace_id: this_is_an_id478_that_should_be_at_least_ title: We have news body: "Hello there,
" - sender_id: 991268677 + sender_id: 991268612 state: live labels: [] cover_image_url: @@ -7518,11 +7545,11 @@ paths: - - deliver_silently: false - created_at: 1704903505 - updated_at: 1704903505 + created_at: 1707477481 + updated_at: 1707477481 newsfeed_assignments: - newsfeed_id: 105 - published_at: 1704903505 + published_at: 1707477481 schema: "$ref": "#/components/schemas/news_item" '404': @@ -7533,7 +7560,7 @@ paths: News Item Not Found: value: type: error.list - request_id: 92ecda54-5996-4208-9f66-2800fda20b60 + request_id: 36e72a77-7a2b-410d-a68f-1347526a7265 errors: - code: not_found message: Resource Not Found @@ -7547,7 +7574,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2b4129b8-09a4-4019-aebc-532e6eca5e98 + request_id: b1ca4a22-0685-4389-8b20-50fba6246ccc errors: - code: unauthorized message: Access Token Invalid @@ -7580,10 +7607,10 @@ paths: value: id: '65' type: news-item - workspace_id: this_is_an_id467_that_should_be_at_least_ + workspace_id: this_is_an_id484_that_should_be_at_least_ title: Christmas is here! body: "New gifts in store for the jolly season
" - sender_id: 991268685 + sender_id: 991268620 state: live labels: [] cover_image_url: @@ -7591,8 +7618,8 @@ paths: - "\U0001F61D" - "\U0001F602" deliver_silently: false - created_at: 1704903506 - updated_at: 1704903506 + created_at: 1707477483 + updated_at: 1707477483 newsfeed_assignments: [] schema: "$ref": "#/components/schemas/news_item" @@ -7604,7 +7631,7 @@ paths: News Item Not Found: value: type: error.list - request_id: 6269c052-125a-4e15-b539-b58a2cfeaa70 + request_id: d889d6cb-d187-43c6-aa58-a59a4c4d50f9 errors: - code: not_found message: Resource Not Found @@ -7618,7 +7645,7 @@ paths: Unauthorized: value: type: error.list - request_id: c772ab7f-ea30-4e24-b213-ae44020a8f88 + request_id: af618fd9-3bee-4e11-bf82-2cc4f332b1ee errors: - code: unauthorized message: Access Token Invalid @@ -7635,7 +7662,7 @@ paths: value: title: Christmas is here! body: "New gifts in store for the jolly season
" - sender_id: 991268685 + sender_id: 991268620 reactions: - "\U0001F61D" - "\U0001F602" @@ -7644,7 +7671,7 @@ paths: value: title: Christmas is here! body: "New gifts in store for the jolly season
" - sender_id: 991268688 + sender_id: 991268623 reactions: - "\U0001F61D" - "\U0001F602" @@ -7687,7 +7714,7 @@ paths: News Item Not Found: value: type: error.list - request_id: eafc60ea-ac45-4723-9ca3-8c0ff31ab33d + request_id: ed48f57f-6e75-4ef1-9c3e-cde0fd1584ce errors: - code: not_found message: Resource Not Found @@ -7701,7 +7728,7 @@ paths: Unauthorized: value: type: error.list - request_id: e4826fca-7a2d-491e-b060-b9663ab2feaf + request_id: 712d59d7-641d-4358-b539-b7d52e8a9b7c errors: - code: unauthorized message: Access Token Invalid @@ -7754,7 +7781,7 @@ paths: Unauthorized: value: type: error.list - request_id: 98b6a4ae-6f50-42e1-b958-c4685febd5c7 + request_id: 2114623a-0e9c-4439-940d-eb93a0d14f62 errors: - code: unauthorized message: Access Token Invalid @@ -7790,13 +7817,13 @@ paths: - id: '118' type: newsfeed name: Visitor Feed - created_at: 1704903510 - updated_at: 1704903510 + created_at: 1707477488 + updated_at: 1707477488 - id: '119' type: newsfeed name: Visitor Feed - created_at: 1704903510 - updated_at: 1704903510 + created_at: 1707477488 + updated_at: 1707477488 total_count: 2 schema: "$ref": "#/components/schemas/paginated_response" @@ -7808,7 +7835,7 @@ paths: Unauthorized: value: type: error.list - request_id: 6e613f58-5bc8-466e-87f7-f7e0eb3d0ddd + request_id: c9ece4ec-e1e2-49e6-b8e7-5c15ffc717e6 errors: - code: unauthorized message: Access Token Invalid @@ -7845,8 +7872,8 @@ paths: id: '122' type: newsfeed name: Visitor Feed - created_at: 1704903511 - updated_at: 1704903511 + created_at: 1707477489 + updated_at: 1707477489 schema: "$ref": "#/components/schemas/newsfeed" '401': @@ -7857,7 +7884,7 @@ paths: Unauthorized: value: type: error.list - request_id: 22f7e633-2234-4686-ba76-e96aeb8f3999 + request_id: a739127f-b7f1-4bec-900a-7da231f10cb6 errors: - code: unauthorized message: Access Token Invalid @@ -7891,16 +7918,16 @@ paths: Note found: value: type: note - id: '123' - created_at: 1704212315 + id: '63' + created_at: 1706786290 contact: type: contact - id: 659ec35b6abd01535c223541 + id: 65c609f286ce64d19db0c51e author: type: admin - id: '991268704' - name: Ciaran295 Lee - email: admin295@email.com + id: '991268639' + name: Ciaran305 Lee + email: admin305@email.com away_mode_enabled: false away_mode_reassign: false body: "This is a note.
" @@ -7914,7 +7941,7 @@ paths: Note not found: value: type: error.list - request_id: f751e12d-bc72-49e0-8bba-87960265a9be + request_id: 95e06717-f613-41ba-8991-2314238fc114 errors: - code: not_found message: Resource Not Found @@ -7928,7 +7955,7 @@ paths: Unauthorized: value: type: error.list - request_id: 65d57943-1d9b-413d-aa80-9a4c0a4de36e + request_id: 07d1c3b2-4687-482e-bdf0-396e6a74c40c errors: - code: unauthorized message: Access Token Invalid @@ -7964,16 +7991,16 @@ paths: type: segment.list segments: - type: segment - id: 659ec35e6abd01535c223548 + id: 65c609f486ce64d19db0c521 name: John segment - created_at: 1704903518 - updated_at: 1704903518 + created_at: 1707477492 + updated_at: 1707477492 person_type: user - type: segment - id: 659ec35e6abd01535c223549 + id: 65c609f486ce64d19db0c522 name: Jane segment - created_at: 1704903518 - updated_at: 1704903518 + created_at: 1707477492 + updated_at: 1707477492 person_type: user schema: "$ref": "#/components/schemas/segment_list" @@ -7985,7 +8012,7 @@ paths: Unauthorized: value: type: error.list - request_id: da37977a-befc-4010-92e6-9142965f2838 + request_id: 7659cf3b-8459-45e0-80e6-e32eb056be06 errors: - code: unauthorized message: Access Token Invalid @@ -8019,10 +8046,10 @@ paths: Successful response: value: type: segment - id: 659ec35f6abd01535c22354c + id: 65c609f586ce64d19db0c525 name: John segment - created_at: 1704903519 - updated_at: 1704903519 + created_at: 1707477493 + updated_at: 1707477493 person_type: user schema: "$ref": "#/components/schemas/segment" @@ -8034,7 +8061,7 @@ paths: Segment not found: value: type: error.list - request_id: ae53ca1d-47d9-47b3-a230-59ef3375544b + request_id: 338f758a-cf6e-48d0-8a03-0bb5c789f90a errors: - code: not_found message: Resource Not Found @@ -8048,7 +8075,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2db1398e-ab0a-444e-83f8-8ff5fae11bc1 + request_id: fdaf8490-25dc-4019-ae9b-df34f9340541 errors: - code: unauthorized message: Access Token Invalid @@ -8078,7 +8105,7 @@ paths: type: list data: - type: subscription - id: '272' + id: '229' state: live consent_type: opt_out default_translation: @@ -8101,7 +8128,7 @@ paths: Unauthorized: value: type: error.list - request_id: f515be17-b048-4411-ac6d-836245d9c651 + request_id: 71787563-8041-4ae5-98ab-ebd995b9e67b errors: - code: unauthorized message: Access Token Invalid @@ -8131,7 +8158,7 @@ paths: examples: successful: value: - url: http://via.intercom.io/msgr/0df6f175-fce2-4d35-989b-38b4b3896c5d + url: http://via.intercom.io/msgr/3a25ff2b-04d4-4ee0-93af-53a45d346143 type: phone_call_redirect schema: "$ref": "#/components/schemas/phone_switch" @@ -8164,7 +8191,7 @@ paths: Unauthorized: value: type: error.list - request_id: f58ce2fc-0597-40a9-b382-b56ad7136b9f + request_id: 87d1bc37-0a78-43db-9c7d-6d8a65e2d6b8 errors: - code: unauthorized message: Access Token Invalid @@ -8227,7 +8254,7 @@ paths: type: list data: - type: tag - id: '233' + id: '178' name: Manual tag 1 schema: "$ref": "#/components/schemas/tag_list" @@ -8239,7 +8266,7 @@ paths: Unauthorized: value: type: error.list - request_id: c1f67f4c-dba3-4ea1-8708-948385aea56c + request_id: 040d5446-9a6b-4e13-ae53-836281a2df22 errors: - code: unauthorized message: Access Token Invalid @@ -8278,7 +8305,7 @@ paths: Action successful: value: type: tag - id: '236' + id: '181' name: test schema: "$ref": "#/components/schemas/tag" @@ -8290,7 +8317,7 @@ paths: Invalid parameters: value: type: error.list - request_id: 566120e4-3faa-41e4-831d-18b15f25ab67 + request_id: 55397028-9412-4ead-972c-927be775d06d errors: - code: parameter_invalid message: invalid tag parameters @@ -8304,14 +8331,14 @@ paths: Company not found: value: type: error.list - request_id: 4ca1e09e-2426-4afd-b28e-37aa6aecd5ae + request_id: 25babbdd-7008-4f4d-8d13-00dffcc9e99a errors: - code: company_not_found message: Company Not Found User not found: value: type: error.list - request_id: 6c97a5be-1b94-4482-990b-9f1691b538b0 + request_id: c06b262a-99e8-4ddb-9532-964c2ae4904f errors: - code: not_found message: User Not Found @@ -8325,7 +8352,7 @@ paths: Unauthorized: value: type: error.list - request_id: e7252229-2232-49d8-909c-40af2df07e33 + request_id: 25df4748-cbcd-4644-9506-d01e0a0bf91b errors: - code: unauthorized message: Access Token Invalid @@ -8391,7 +8418,7 @@ paths: Tag found: value: type: tag - id: '244' + id: '189' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -8403,7 +8430,7 @@ paths: Tag not found: value: type: error.list - request_id: 4b634d31-4872-4596-a204-7aeb4fdaceee + request_id: b6c4a8b0-6e7d-4d7a-8399-ea16bfd3dd74 errors: - code: not_found message: Resource Not Found @@ -8417,7 +8444,7 @@ paths: Unauthorized: value: type: error.list - request_id: 42de1ba1-7948-48ae-960a-9d08e6994bc7 + request_id: 06b49130-c6c1-40a9-b27d-7ece32a5f8bf errors: - code: unauthorized message: Access Token Invalid @@ -8453,7 +8480,7 @@ paths: Resource not found: value: type: error.list - request_id: f2a31e6c-a632-4d32-a48f-e5201e0b559b + request_id: 202ad80b-5dae-4b68-998b-46434b01a45f errors: - code: not_found message: Resource Not Found @@ -8467,7 +8494,7 @@ paths: Tag has dependent objects: value: type: error.list - request_id: 896c0b3b-9dab-4ba9-923a-f49185c8d089 + request_id: 0fc7ad22-cbee-47cb-a521-20b34dc88232 errors: - code: tag_has_dependent_objects message: 'Unable to delete Tag with dependent objects. Segments: @@ -8482,7 +8509,7 @@ paths: Unauthorized: value: type: error.list - request_id: dc83d712-9e7d-4f68-8d43-52ff9437abbc + request_id: ba0fb072-02de-4047-aaf1-901326f97853 errors: - code: unauthorized message: Access Token Invalid @@ -8520,7 +8547,7 @@ paths: Unauthorized: value: type: error.list - request_id: 69fb4a8d-5dc6-43ea-9652-b988056bd60d + request_id: cf646f14-8093-44af-9579-de7fd4931ed4 errors: - code: unauthorized message: Access Token Invalid @@ -8555,7 +8582,7 @@ paths: successful: value: type: team - id: '991268748' + id: '991268677' name: team 1 admin_ids: [] schema: @@ -8568,7 +8595,7 @@ paths: Team not found: value: type: error.list - request_id: aced07c9-581b-4244-83e6-07a9af2df17e + request_id: 5d1e4f5f-c44c-47ca-9364-d8b5fc295ecb errors: - code: team_not_found message: Team not found @@ -8582,7 +8609,7 @@ paths: Unauthorized: value: type: error.list - request_id: 11a434de-96ed-4d6d-97b3-6a657cceecb1 + request_id: 9a54996a-224a-4cad-abcb-b7f918102956 errors: - code: unauthorized message: Access Token Invalid @@ -8615,14 +8642,14 @@ paths: Ticket Type Attribute created: value: type: ticket_type_attribute - id: '191' - workspace_id: this_is_an_id559_that_should_be_at_least_ + id: '253' + workspace_id: this_is_an_id576_that_should_be_at_least_ name: Attribute Title description: Attribute Description data_type: string input_options: multiline: false - order: 0 + order: 2 required_to_create: false required_to_create_for_contacts: false visible_on_create: true @@ -8630,8 +8657,8 @@ paths: default: false ticket_type_id: 74 archived: false - created_at: 1704903538 - updated_at: 1704903538 + created_at: 1707477511 + updated_at: 1707477511 schema: "$ref": "#/components/schemas/ticket_type_attribute" '401': @@ -8642,7 +8669,7 @@ paths: Unauthorized: value: type: error.list - request_id: 6c7ebe32-755d-4e07-86df-7fa926b4a433 + request_id: a50e1a02-119f-4b15-a238-a8a957b92a4b errors: - code: unauthorized message: Access Token Invalid @@ -8695,8 +8722,8 @@ paths: Ticket Type Attribute updated: value: type: ticket_type_attribute - id: '192' - workspace_id: this_is_an_id563_that_should_be_at_least_ + id: '258' + workspace_id: this_is_an_id580_that_should_be_at_least_ name: name description: New Attribute Description data_type: string @@ -8708,8 +8735,8 @@ paths: default: false ticket_type_id: 76 archived: false - created_at: 1704903539 - updated_at: 1704903539 + created_at: 1707477512 + updated_at: 1707477512 schema: "$ref": "#/components/schemas/ticket_type_attribute" '401': @@ -8720,7 +8747,7 @@ paths: Unauthorized: value: type: error.list - request_id: bf035ced-c3d1-4b26-9e4d-190528c88d52 + request_id: a88dd076-8851-4b05-85a4-64fbc0f22f76 errors: - code: unauthorized message: Access Token Invalid @@ -8763,17 +8790,35 @@ paths: name: Bug Report description: Bug Report Template icon: "\U0001F39F️" - workspace_id: this_is_an_id567_that_should_be_at_least_ + workspace_id: this_is_an_id584_that_should_be_at_least_ archived: false - created_at: 1704903540 - updated_at: 1704903540 + created_at: 1707477513 + updated_at: 1707477513 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '193' - workspace_id: this_is_an_id567_that_should_be_at_least_ + id: '261' + workspace_id: this_is_an_id584_that_should_be_at_least_ + name: _default_title_ + description: '' + data_type: string + input_options: + multiline: false + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 78 + archived: false + created_at: 1707477513 + updated_at: 1707477513 + - type: ticket_type_attribute + id: '263' + workspace_id: this_is_an_id584_that_should_be_at_least_ name: name description: description data_type: string @@ -8786,8 +8831,26 @@ paths: default: false ticket_type_id: 78 archived: false - created_at: 1704903540 - updated_at: 1704903540 + created_at: 1707477513 + updated_at: 1707477513 + - type: ticket_type_attribute + id: '262' + workspace_id: this_is_an_id584_that_should_be_at_least_ + name: _default_description_ + description: '' + data_type: string + input_options: + multiline: true + order: 1 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 78 + archived: false + created_at: 1707477513 + updated_at: 1707477513 category: Customer schema: "$ref": "#/components/schemas/ticket_type_list" @@ -8799,7 +8862,7 @@ paths: Unauthorized: value: type: error.list - request_id: 24bd46fb-8bec-4b00-9c6d-7d2d5867a4f1 + request_id: 413eca48-1ee5-4e36-87ef-00832a10b8a4 errors: - code: unauthorized message: Access Token Invalid @@ -8832,14 +8895,50 @@ paths: name: Customer Issue description: Customer Report Template icon: "\U0001F39F️" - workspace_id: this_is_an_id571_that_should_be_at_least_ + workspace_id: this_is_an_id588_that_should_be_at_least_ archived: false - created_at: 1704903541 - updated_at: 1704903541 + created_at: 1707477514 + updated_at: 1707477514 is_internal: false ticket_type_attributes: type: list - data: [] + data: + - type: ticket_type_attribute + id: '270' + workspace_id: this_is_an_id588_that_should_be_at_least_ + name: _default_title_ + description: '' + data_type: string + input_options: + multiline: false + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 81 + archived: false + created_at: 1707477515 + updated_at: 1707477515 + - type: ticket_type_attribute + id: '271' + workspace_id: this_is_an_id588_that_should_be_at_least_ + name: _default_description_ + description: '' + data_type: string + input_options: + multiline: true + order: 1 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 81 + archived: false + created_at: 1707477515 + updated_at: 1707477515 category: Customer schema: "$ref": "#/components/schemas/ticket_type" @@ -8851,7 +8950,7 @@ paths: Unauthorized: value: type: error.list - request_id: 972710e6-086e-4954-8a16-27c5b479c1b5 + request_id: 5bad472c-b39c-4a2a-91e1-d2a104cbb7cd errors: - code: unauthorized message: Access Token Invalid @@ -8901,17 +9000,35 @@ paths: name: Bug Report description: Bug Report Template icon: "\U0001F39F️" - workspace_id: this_is_an_id575_that_should_be_at_least_ + workspace_id: this_is_an_id592_that_should_be_at_least_ archived: false - created_at: 1704903542 - updated_at: 1704903542 + created_at: 1707477515 + updated_at: 1707477515 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '197' - workspace_id: this_is_an_id575_that_should_be_at_least_ + id: '275' + workspace_id: this_is_an_id592_that_should_be_at_least_ + name: _default_title_ + description: '' + data_type: string + input_options: + multiline: false + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 83 + archived: false + created_at: 1707477515 + updated_at: 1707477515 + - type: ticket_type_attribute + id: '277' + workspace_id: this_is_an_id592_that_should_be_at_least_ name: name description: description data_type: string @@ -8924,8 +9041,26 @@ paths: default: false ticket_type_id: 83 archived: false - created_at: 1704903542 - updated_at: 1704903542 + created_at: 1707477515 + updated_at: 1707477515 + - type: ticket_type_attribute + id: '276' + workspace_id: this_is_an_id592_that_should_be_at_least_ + name: _default_description_ + description: '' + data_type: string + input_options: + multiline: true + order: 1 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 83 + archived: false + created_at: 1707477515 + updated_at: 1707477515 category: Customer schema: "$ref": "#/components/schemas/ticket_type" @@ -8937,7 +9072,7 @@ paths: Unauthorized: value: type: error.list - request_id: fb11155d-673f-4724-9588-6bc63438c77c + request_id: 63fafcd4-dd02-4910-bf8f-6938f0862b42 errors: - code: unauthorized message: Access Token Invalid @@ -8974,17 +9109,35 @@ paths: name: Bug Report 2 description: Bug Report Template icon: "\U0001F39F️" - workspace_id: this_is_an_id579_that_should_be_at_least_ + workspace_id: this_is_an_id596_that_should_be_at_least_ archived: false - created_at: 1704903542 - updated_at: 1704903543 + created_at: 1707477516 + updated_at: 1707477517 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '199' - workspace_id: this_is_an_id579_that_should_be_at_least_ + id: '281' + workspace_id: this_is_an_id596_that_should_be_at_least_ + name: _default_title_ + description: '' + data_type: string + input_options: + multiline: false + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 85 + archived: false + created_at: 1707477517 + updated_at: 1707477517 + - type: ticket_type_attribute + id: '283' + workspace_id: this_is_an_id596_that_should_be_at_least_ name: name description: description data_type: string @@ -8997,8 +9150,26 @@ paths: default: false ticket_type_id: 85 archived: false - created_at: 1704903542 - updated_at: 1704903542 + created_at: 1707477517 + updated_at: 1707477517 + - type: ticket_type_attribute + id: '282' + workspace_id: this_is_an_id596_that_should_be_at_least_ + name: _default_description_ + description: '' + data_type: string + input_options: + multiline: true + order: 1 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 85 + archived: false + created_at: 1707477517 + updated_at: 1707477517 category: Customer schema: "$ref": "#/components/schemas/ticket_type" @@ -9010,7 +9181,7 @@ paths: Unauthorized: value: type: error.list - request_id: c3cfae69-fab7-42ce-bfb0-2e96ac652c12 + request_id: 063a85da-ff57-4a21-846b-af9ccb6c82f3 errors: - code: unauthorized message: Access Token Invalid @@ -9056,22 +9227,22 @@ paths: User reply: value: type: ticket_part - id: '150' + id: '144' part_type: comment body: "Thanks again :)
" - created_at: 1704903545 - updated_at: 1704903545 + created_at: 1707477520 + updated_at: 1707477520 author: - id: 659ec3796abd01535c22357b + id: 65c60a1086ce64d19db0c548 type: user name: - email: user28@email.com + email: user30@email.com attachments: [] redacted: false Admin note reply: value: type: ticket_part - id: '152' + id: '146' part_type: note body: |-Body of the Article
- author_id: 991266822 + author_id: 991266758 state: published - created_at: 1704902043 - updated_at: 1704902043 - url: http://help-center.test/myapp-26/en/articles/38-thanks-for-everything + created_at: 1707476138 + updated_at: 1707476138 + url: http://help-center.test/myapp-26/en/articles/62-thanks-for-everything schema: "$ref": "#/components/schemas/article" '400': @@ -471,7 +471,7 @@ paths: Bad Request: value: type: error.list - request_id: 58b2ba12-0b13-4f59-a849-268ec1411b53 + request_id: 81e313be-ff50-4e01-8c8f-110584fe8771 errors: - code: parameter_not_found message: author_id must be in the main body or default locale @@ -486,7 +486,7 @@ paths: Unauthorized: value: type: error.list - request_id: bb13e39a-fc45-48f2-9c63-e31f7462a2f3 + request_id: 60d587b3-1436-4056-b643-652bc7a0a1b1 errors: - code: unauthorized message: Access Token Invalid @@ -504,16 +504,16 @@ paths: title: Thanks for everything description: Description of the Article body: Body of the Article - author_id: 991266822 + author_id: 991266758 state: published - parent_id: 147 + parent_id: 136 parent_type: collection translated_content: fr: title: Merci pour tout description: Description de l'article body: Corps de l'article - author_id: 991266822 + author_id: 991266758 state: published bad_request: summary: Bad Request @@ -550,10 +550,10 @@ paths: examples: Article found: value: - id: '41' + id: '65' type: article workspace_id: this_is_an_id32_that_should_be_at_least_4 - parent_id: 150 + parent_id: 139 parent_type: collection parent_ids: [] statistics: @@ -567,11 +567,11 @@ paths: title: This is the article title description: '' body: '' - author_id: 991266827 + author_id: 991266763 state: published - created_at: 1704902044 - updated_at: 1704902044 - url: http://help-center.test/myapp-32/en/articles/41-this-is-the-article-title + created_at: 1707476139 + updated_at: 1707476139 + url: http://help-center.test/myapp-32/en/articles/65-this-is-the-article-title schema: "$ref": "#/components/schemas/article" '404': @@ -582,7 +582,7 @@ paths: Article not found: value: type: error.list - request_id: 717c585c-f012-4651-9d10-51000e74f779 + request_id: 59424416-2e4f-4e77-a40c-c091693a50b4 errors: - code: not_found message: Resource Not Found @@ -596,7 +596,7 @@ paths: Unauthorized: value: type: error.list - request_id: 3e61d05e-0859-4d81-b70b-52f94af663f2 + request_id: 350afb69-4318-4a69-b905-df1789bcb858 errors: - code: unauthorized message: Access Token Invalid @@ -629,10 +629,10 @@ paths: examples: successful: value: - id: '44' + id: '68' type: article workspace_id: this_is_an_id38_that_should_be_at_least_4 - parent_id: 153 + parent_id: 142 parent_type: collection parent_ids: [] statistics: @@ -646,11 +646,11 @@ paths: title: Christmas is here! description: '' body:New gifts in store for the jolly season
- author_id: 991266833 + author_id: 991266769 state: published - created_at: 1704902046 - updated_at: 1704902047 - url: http://help-center.test/myapp-38/en/articles/44-christmas-is-here + created_at: 1707476141 + updated_at: 1707476142 + url: http://help-center.test/myapp-38/en/articles/68-christmas-is-here schema: "$ref": "#/components/schemas/article" '404': @@ -661,7 +661,7 @@ paths: Article Not Found: value: type: error.list - request_id: dd2a3f60-2ea9-4d8f-a906-dbc4ca48a93b + request_id: 664e873b-fe3d-4661-8c4d-181aa3b005f6 errors: - code: not_found message: Resource Not Found @@ -675,7 +675,7 @@ paths: Unauthorized: value: type: error.list - request_id: bb28cd69-a65c-41ab-8fbd-464216515ac0 + request_id: 7a908989-365e-4c41-a036-ba555bab1594 errors: - code: unauthorized message: Access Token Invalid @@ -723,7 +723,7 @@ paths: examples: successful: value: - id: '47' + id: '71' object: article deleted: true schema: @@ -736,7 +736,7 @@ paths: Article Not Found: value: type: error.list - request_id: c9d24d88-dbe5-4834-bf81-91bfd49c955a + request_id: bd4628ec-cbe5-4bd0-937a-22cd9688d94f errors: - code: not_found message: Resource Not Found @@ -750,7 +750,7 @@ paths: Unauthorized: value: type: error.list - request_id: 540fb2e7-d2e5-4a5a-8676-727d641ed1ca + request_id: e1fb11b2-7445-473b-851e-c68f91439b06 errors: - code: unauthorized message: Access Token Invalid @@ -783,16 +783,16 @@ paths: value: type: list data: - - id: '161' + - id: '150' workspace_id: this_is_an_id52_that_should_be_at_least_4 name: English collection title url: http://help-center.test/myapp-52/collection-17 order: 17 - created_at: 1704902052 - updated_at: 1704902052 + created_at: 1707476147 + updated_at: 1707476147 description: english collection description icon: bookmark - help_center_id: 89 + help_center_id: 101 type: collection total_count: 1 pages: @@ -810,7 +810,7 @@ paths: Unauthorized: value: type: error.list - request_id: 971e9132-44a2-4c70-84b4-7b6fd860250b + request_id: 9f94ce5b-38f9-4325-bee9-ebf4e2704c2c errors: - code: unauthorized message: Access Token Invalid @@ -835,16 +835,16 @@ paths: examples: collection created: value: - id: '167' + id: '156' workspace_id: this_is_an_id56_that_should_be_at_least_4 name: Thanks for everything url: http://help-center.test/myapp-56/ order: 1 - created_at: 1704902053 - updated_at: 1704902053 + created_at: 1707476148 + updated_at: 1707476148 description: '' icon: book-bookmark - help_center_id: 91 + help_center_id: 103 type: collection schema: "$ref": "#/components/schemas/collection" @@ -856,7 +856,7 @@ paths: Bad Request: value: type: error.list - request_id: b898504e-6b31-41f7-8148-e10bbf18aeb6 + request_id: 1610b863-6685-441f-b804-ffb6e5b6fc42 errors: - code: parameter_not_found message: Name is a required parameter. @@ -870,7 +870,7 @@ paths: Unauthorized: value: type: error.list - request_id: a8197143-88b1-45c6-8b51-791b36a1c9f3 + request_id: 94433482-ab52-4e38-992a-48b5cda12993 errors: - code: unauthorized message: Access Token Invalid @@ -918,16 +918,16 @@ paths: examples: Collection found: value: - id: '172' + id: '161' workspace_id: this_is_an_id62_that_should_be_at_least_4 name: English collection title url: http://help-center.test/myapp-62/collection-22 order: 22 - created_at: 1704902054 - updated_at: 1704902054 + created_at: 1707476149 + updated_at: 1707476149 description: english collection description icon: bookmark - help_center_id: 94 + help_center_id: 106 type: collection schema: "$ref": "#/components/schemas/collection" @@ -939,7 +939,7 @@ paths: Collection not found: value: type: error.list - request_id: 4f247b54-8d61-4bd6-80a7-9098ab03690b + request_id: a3a9769f-f2db-4264-b430-8e7699ecaf47 errors: - code: not_found message: Resource Not Found @@ -953,7 +953,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9a711724-1dff-41c7-8d96-38da0af27909 + request_id: 2916d2cf-d837-4dc6-930b-012acd2df3b3 errors: - code: unauthorized message: Access Token Invalid @@ -986,16 +986,16 @@ paths: examples: successful: value: - id: '178' + id: '167' workspace_id: this_is_an_id68_that_should_be_at_least_4 name: Update collection name url: http://help-center.test/myapp-68/collection-25 order: 25 - created_at: 1704902055 - updated_at: 1704902056 + created_at: 1707476150 + updated_at: 1707476151 description: english collection description icon: folder - help_center_id: 97 + help_center_id: 109 type: collection schema: "$ref": "#/components/schemas/collection" @@ -1007,7 +1007,7 @@ paths: Collection Not Found: value: type: error.list - request_id: 39a9cc9f-fcce-47df-b840-44102619ac89 + request_id: e2b426d6-f49b-4a0d-ac7c-76abc1d27ba9 errors: - code: not_found message: Resource Not Found @@ -1021,7 +1021,7 @@ paths: Unauthorized: value: type: error.list - request_id: 718d0a73-da23-4d6f-952c-93aac510f299 + request_id: c58931bf-1a51-46b9-a03e-814149ac2522 errors: - code: unauthorized message: Access Token Invalid @@ -1068,7 +1068,7 @@ paths: examples: successful: value: - id: '184' + id: '173' object: collection deleted: true schema: @@ -1081,7 +1081,7 @@ paths: collection Not Found: value: type: error.list - request_id: 1422f356-2b36-426b-91be-2381d6de2946 + request_id: b0198d2d-40de-4f62-ad0d-8301ee8b92fd errors: - code: not_found message: Resource Not Found @@ -1095,7 +1095,7 @@ paths: Unauthorized: value: type: error.list - request_id: '09edef48-f100-4089-b64a-8f0b3573fb8a' + request_id: 56ff93ed-8b6a-4a0d-87c5-a7b08353984b errors: - code: unauthorized message: Access Token Invalid @@ -1129,10 +1129,10 @@ paths: examples: Collection found: value: - id: '103' + id: '115' workspace_id: this_is_an_id80_that_should_be_at_least_4 - created_at: 1704902058 - updated_at: 1704902058 + created_at: 1707476154 + updated_at: 1707476154 identifier: help-center-1 website_turned_on: false display_name: Intercom Help Center @@ -1146,7 +1146,7 @@ paths: Collection not found: value: type: error.list - request_id: 26466774-7d70-467d-9e79-6f3ca2626e86 + request_id: 474d38a9-8a41-4a32-a188-8a6256be0a2d errors: - code: not_found message: Resource Not Found @@ -1160,7 +1160,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2a92d52d-417c-4ebb-ae0b-2c39fee9236c + request_id: ca79327b-282f-456c-b339-66e1571fc0bc errors: - code: unauthorized message: Access Token Invalid @@ -1198,7 +1198,7 @@ paths: Unauthorized: value: type: error.list - request_id: a4f397c7-dc1b-4fe7-9fa3-2e16a8a63df4 + request_id: ee96bdb5-470b-424d-8607-d2acfde11dd6 errors: - code: unauthorized message: Access Token Invalid @@ -1230,15 +1230,15 @@ paths: value: type: list data: - - id: '191' + - id: '180' workspace_id: this_is_an_id90_that_should_be_at_least_4 name: English section title url: http://help-center.test/myapp-90/section-15 order: 15 - created_at: 1704902060 - updated_at: 1704902060 + created_at: 1707476156 + updated_at: 1707476156 type: section - parent_id: 190 + parent_id: 179 total_count: 1 pages: type: pages @@ -1255,7 +1255,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8e71f2d7-c35c-4c46-b726-8b0502b3da79 + request_id: 98ad75b8-9d12-4be1-845a-ec74ea620f6d errors: - code: unauthorized message: Access Token Invalid @@ -1280,15 +1280,15 @@ paths: examples: section created: value: - id: '196' + id: '185' workspace_id: this_is_an_id94_that_should_be_at_least_4 name: Thanks for everything url: http://help-center.test/myapp-94/ order: 1 - created_at: 1704902061 - updated_at: 1704902061 + created_at: 1707476157 + updated_at: 1707476157 type: section - parent_id: '194' + parent_id: '183' schema: "$ref": "#/components/schemas/section" '401': @@ -1299,7 +1299,7 @@ paths: Unauthorized: value: type: error.list - request_id: 96c04f84-2d1b-49ef-a143-a310e7fa2c73 + request_id: 99484990-ff0b-45f2-9a4e-164504d47f81 errors: - code: unauthorized message: Access Token Invalid @@ -1315,7 +1315,7 @@ paths: summary: section created value: name: Thanks for everything - parent_id: 194 + parent_id: 183 "/help_center/sections/{id}": get: summary: Retrieve a section @@ -1344,15 +1344,15 @@ paths: examples: Section found: value: - id: '200' + id: '189' workspace_id: this_is_an_id98_that_should_be_at_least_4 name: English section title url: http://help-center.test/myapp-98/section-19 order: 19 - created_at: 1704902062 - updated_at: 1704902062 + created_at: 1707476157 + updated_at: 1707476157 type: section - parent_id: 199 + parent_id: 188 schema: "$ref": "#/components/schemas/section" '404': @@ -1363,7 +1363,7 @@ paths: Section not found: value: type: error.list - request_id: 749dd6db-963d-449f-9440-f81519db518d + request_id: 43c1d259-b2b2-440e-b22d-6da74d8016a2 errors: - code: not_found message: Resource Not Found @@ -1377,7 +1377,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9ac6a917-a6bf-4319-b612-42320373f33d + request_id: 04e91752-0de0-42b0-850c-ebcb8f550cac errors: - code: unauthorized message: Access Token Invalid @@ -1410,15 +1410,15 @@ paths: examples: successful: value: - id: '206' + id: '195' workspace_id: this_is_an_id104_that_should_be_at_least_ name: Update section name url: http://help-center.test/myapp-104/section-22 order: 22 - created_at: 1704902063 - updated_at: 1704902063 + created_at: 1707476159 + updated_at: 1707476159 type: section - parent_id: '205' + parent_id: '194' schema: "$ref": "#/components/schemas/section" '404': @@ -1429,7 +1429,7 @@ paths: Section Not Found: value: type: error.list - request_id: 14fc29eb-a345-4f87-9269-939d3e40c664 + request_id: 1d253b57-12f7-45e1-b424-a366287ab2bf errors: - code: not_found message: Resource Not Found @@ -1443,7 +1443,7 @@ paths: Unauthorized: value: type: error.list - request_id: e2bb8629-3b43-42f5-a32f-17608171aebd + request_id: 7eac9816-f8d7-4414-ac9b-e1729780d06e errors: - code: unauthorized message: Access Token Invalid @@ -1459,12 +1459,12 @@ paths: summary: successful value: name: Update section name - parent_id: 205 + parent_id: 194 section_not_found: summary: Section Not Found value: name: Update section name - parent_id: 207 + parent_id: 196 delete: summary: Delete a section parameters: @@ -1491,7 +1491,7 @@ paths: examples: successful: value: - id: '212' + id: '201' object: section deleted: true schema: @@ -1504,7 +1504,7 @@ paths: section Not Found: value: type: error.list - request_id: 860567b1-f63d-418b-900d-ae7cb7f29d4d + request_id: 7e2705f5-09f8-4fbc-acbf-661449431239 errors: - code: not_found message: Resource Not Found @@ -1518,7 +1518,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2b335f1b-8890-4bef-97f6-63ab11d07118 + request_id: 0ab08b21-a6bd-4240-a47c-892669d4f734 errors: - code: unauthorized message: Access Token Invalid @@ -1551,12 +1551,12 @@ paths: value: type: company company_id: company_remote_id - id: 659ebdb56abd014d2275aab3 - app_id: this_is_an_id119_that_should_be_at_least_ + id: 65c604c386ce64cb37830b78 + app_id: this_is_an_id116_that_should_be_at_least_ name: my company remote_created_at: 1374138000 - created_at: 1704902069 - updated_at: 1704902069 + created_at: 1707476163 + updated_at: 1707476163 monthly_spend: 0 session_count: 0 user_count: 0 @@ -1593,7 +1593,7 @@ paths: Unauthorized: value: type: error.list - request_id: 766d4202-ccc7-4797-a668-ecd796e75266 + request_id: a52c519b-956a-4efd-a6ea-65856097eada errors: - code: unauthorized message: Access Token Invalid @@ -1667,11 +1667,18 @@ paths: tags: - Companies operationId: retrieveCompany - description: "You can fetch a single company by passing in `company_id` or `name`.\n\n - \ `https://api.intercom.io/companies?name={name}`\n\n `https://api.intercom.io/companies?company_id={company_id}`\n\nYou - can fetch all companies and filter by `segment_id` or `tag_id` as a query - parameter.\n \n `https://api.intercom.io/companies?tag_id={tag_id}`\n\n - \ `https://api.intercom.io/companies?segment_id={segment_id}`\n" + description: | + You can fetch a single company by passing in `company_id` or `name`. + + `https://api.intercom.io/companies?name={name}` + + `https://api.intercom.io/companies?company_id={company_id}` + + You can fetch all companies and filter by `segment_id` or `tag_id` as a query parameter. + + `https://api.intercom.io/companies?tag_id={tag_id}` + + `https://api.intercom.io/companies?segment_id={segment_id}` responses: '200': description: Successful @@ -1684,12 +1691,12 @@ paths: data: - type: company company_id: remote_companies_scroll_2 - id: 659ebdb76abd014d2275aabb - app_id: this_is_an_id125_that_should_be_at_least_ + id: 65c604c486ce64cb37830b80 + app_id: this_is_an_id122_that_should_be_at_least_ name: IntercomQATest1 - remote_created_at: 1704902071 - created_at: 1704902071 - updated_at: 1704902071 + remote_created_at: 1707476164 + created_at: 1707476164 + updated_at: 1707476164 monthly_spend: 0 session_count: 0 user_count: 4 @@ -1718,7 +1725,7 @@ paths: Company Not Found: value: type: error.list - request_id: 766e4eb0-49c9-40ec-bf4f-8d7c18aa8ad1 + request_id: 25f42921-426c-4749-880e-a6cd3aaaa61f errors: - code: company_not_found message: Company Not Found @@ -1732,7 +1739,7 @@ paths: Unauthorized: value: type: error.list - request_id: a3a5e579-8cec-467e-910a-1c444502ed02 + request_id: 2e2b0c29-3ce4-4135-98dd-5945b25411d5 errors: - code: unauthorized message: Access Token Invalid @@ -1767,12 +1774,12 @@ paths: value: type: company company_id: '1' - id: 659ebdb96abd014d2275aac6 - app_id: this_is_an_id131_that_should_be_at_least_ - name: company2 - remote_created_at: 1704902073 - created_at: 1704902073 - updated_at: 1704902073 + id: 65c604c786ce64cb37830b8b + app_id: this_is_an_id128_that_should_be_at_least_ + name: company1 + remote_created_at: 1707476167 + created_at: 1707476167 + updated_at: 1707476167 monthly_spend: 0 session_count: 0 user_count: 1 @@ -1794,7 +1801,7 @@ paths: Company Not Found: value: type: error.list - request_id: 8ea14084-1fd2-41bb-ab85-74c0b3e75315 + request_id: bcdc9d4f-b4a4-4820-8775-1086746dbe58 errors: - code: company_not_found message: Company Not Found @@ -1808,7 +1815,7 @@ paths: Unauthorized: value: type: error.list - request_id: beb0827b-e4ae-455c-93d0-25a5483f35bd + request_id: bc962dcd-2532-4685-9c2f-57aca1cd8817 errors: - code: unauthorized message: Access Token Invalid @@ -1842,12 +1849,12 @@ paths: value: type: company company_id: '1' - id: 659ebdba6abd014d2275aad0 - app_id: this_is_an_id137_that_should_be_at_least_ - name: company3 - remote_created_at: 1704902074 - created_at: 1704902074 - updated_at: 1704902074 + id: 65c604c986ce64cb37830b95 + app_id: this_is_an_id134_that_should_be_at_least_ + name: company2 + remote_created_at: 1707476169 + created_at: 1707476169 + updated_at: 1707476169 monthly_spend: 0 session_count: 0 user_count: 1 @@ -1869,7 +1876,7 @@ paths: Company Not Found: value: type: error.list - request_id: fb277d15-5ed1-4dc5-a07c-57c4e19a579b + request_id: 98baa15a-0a69-4605-89b2-5a3a2c3ebe40 errors: - code: company_not_found message: Company Not Found @@ -1883,7 +1890,7 @@ paths: Unauthorized: value: type: error.list - request_id: 486cb645-2373-43b1-b080-dda15ba878d2 + request_id: 4a2951ed-f445-47ed-a819-21a9cd18dbdb errors: - code: unauthorized message: Access Token Invalid @@ -1915,7 +1922,7 @@ paths: examples: Successful: value: - id: 659ebdbc6abd014d2275aada + id: 65c604cb86ce64cb37830b9f object: company deleted: true schema: @@ -1928,7 +1935,7 @@ paths: Company Not Found: value: type: error.list - request_id: f4a8d604-8b83-4a56-b9fb-55283c1702fd + request_id: 8c23c9ab-3819-4509-bde6-b6394cb7ab53 errors: - code: company_not_found message: Company Not Found @@ -1942,7 +1949,7 @@ paths: Unauthorized: value: type: error.list - request_id: dee7b4ba-5b57-4585-8444-37f3519c0af2 + request_id: c734916e-818b-48de-8e1a-39200297b310 errors: - code: unauthorized message: Access Token Invalid @@ -1994,7 +2001,7 @@ paths: Company Not Found: value: type: error.list - request_id: 996b89f6-e028-4582-b62c-c0cfc9150408 + request_id: 8bc96ffe-b3aa-4ca3-9bd6-fab680865e51 errors: - code: company_not_found message: Company Not Found @@ -2008,7 +2015,7 @@ paths: Unauthorized: value: type: error.list - request_id: 48c42b40-2c81-4aa3-a020-de13681ccedc + request_id: 9f63f4f9-f182-4431-b93c-59ac331ecaaa errors: - code: unauthorized message: Access Token Invalid @@ -2053,7 +2060,7 @@ paths: Company Not Found: value: type: error.list - request_id: a9fb515f-e589-46e5-b8fe-9d3f4bbba377 + request_id: 0243da2c-f7bd-40ab-bc5c-a4655781874e errors: - code: company_not_found message: Company Not Found @@ -2067,7 +2074,7 @@ paths: Unauthorized: value: type: error.list - request_id: b9875bf6-7b48-4b9a-8d82-ed20f071fc3f + request_id: 25993b07-e1c6-409c-8a1b-4f59c475c802 errors: - code: unauthorized message: Access Token Invalid @@ -2124,12 +2131,12 @@ paths: data: - type: company company_id: remote_companies_scroll_2 - id: 659ebdc16abd014d2275aaf6 - app_id: this_is_an_id161_that_should_be_at_least_ + id: 65c604d286ce64cb37830bbb + app_id: this_is_an_id158_that_should_be_at_least_ name: IntercomQATest1 - remote_created_at: 1704902081 - created_at: 1704902081 - updated_at: 1704902081 + remote_created_at: 1707476178 + created_at: 1707476178 + updated_at: 1707476178 monthly_spend: 0 session_count: 0 user_count: 4 @@ -2158,7 +2165,7 @@ paths: Unauthorized: value: type: error.list - request_id: be321df1-9d72-4207-9783-38a564329e0e + request_id: 0b280656-447b-40a4-b798-2c94bfc340b5 errors: - code: unauthorized message: Access Token Invalid @@ -2210,12 +2217,12 @@ paths: data: - type: company company_id: remote_companies_scroll_2 - id: 659ebdc26abd014d2275aafc - app_id: this_is_an_id165_that_should_be_at_least_ + id: 65c604d386ce64cb37830bc1 + app_id: this_is_an_id162_that_should_be_at_least_ name: IntercomQATest1 - remote_created_at: 1704902082 - created_at: 1704902082 - updated_at: 1704902082 + remote_created_at: 1707476179 + created_at: 1707476179 + updated_at: 1707476179 monthly_spend: 0 session_count: 0 user_count: 4 @@ -2229,7 +2236,7 @@ paths: custom_attributes: {} pages: total_count: - scroll_param: 8daa68f3-f497-497a-bac1-791b4addf6d5 + scroll_param: 4cb616b8-2060-4032-8bf4-e1978f4d10f7 schema: "$ref": "#/components/schemas/company_scroll" '401': @@ -2240,7 +2247,7 @@ paths: Unauthorized: value: type: error.list - request_id: e60053c3-3394-464d-b241-76d021717d1c + request_id: 2fa5ee98-254a-4a2c-9a2f-6663e2dc8eb5 errors: - code: unauthorized message: Access Token Invalid @@ -2275,12 +2282,12 @@ paths: value: type: company company_id: '1' - id: 659ebdc46abd014d2275ab05 - app_id: this_is_an_id169_that_should_be_at_least_ - name: company7 - remote_created_at: 1704902084 - created_at: 1704902084 - updated_at: 1704902084 + id: 65c604d586ce64cb37830bca + app_id: this_is_an_id166_that_should_be_at_least_ + name: company6 + remote_created_at: 1707476181 + created_at: 1707476181 + updated_at: 1707476181 monthly_spend: 0 session_count: 0 user_count: 1 @@ -2294,6 +2301,20 @@ paths: custom_attributes: {} schema: "$ref": "#/components/schemas/company" + '400': + description: Bad Request + content: + application/json: + examples: + Bad Request: + value: + type: error.list + request_id: 1047e1ee-a048-4328-a77d-a3e9b192ef09 + errors: + - code: parameter_not_found + message: company not specified + schema: + "$ref": "#/components/schemas/error" '404': description: Company Not Found content: @@ -2302,10 +2323,10 @@ paths: Company Not Found: value: type: error.list - request_id: b32b9242-49db-4068-b183-6f1b5e24e0e0 + request_id: 0ca373fd-97f9-4af8-baf8-8cfb12a6be7c errors: - - code: not_found - message: User Not Found + - code: company_not_found + message: Company Not Found schema: "$ref": "#/components/schemas/error" '401': @@ -2316,7 +2337,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9f600a0a-0c9d-4ac4-8e30-f131cb16fa17 + request_id: 06a84c0b-6740-4bca-b118-74646598301c errors: - code: unauthorized message: Access Token Invalid @@ -2339,11 +2360,14 @@ paths: successful: summary: Successful value: - id: 659ebdc46abd014d2275ab05 + id: 65c604d586ce64cb37830bca + bad_request: + summary: Bad Request + value: company_not_found: summary: Company Not Found value: - id: 659ebdc56abd014d2275ab09 + id: '123' get: summary: List attached companies for contact parameters: @@ -2375,13 +2399,13 @@ paths: data: - type: company company_id: '1' - id: 659ebdd06abd014d2275ab37 - app_id: this_is_an_id183_that_should_be_at_least_ - name: company23 - remote_created_at: 1704902096 - created_at: 1704902096 - updated_at: 1704902096 - last_request_at: 1704729296 + id: 65c604dc86ce64cb37830beb + app_id: this_is_an_id182_that_should_be_at_least_ + name: company12 + remote_created_at: 1707476188 + created_at: 1707476188 + updated_at: 1707476188 + last_request_at: 1707303388 monthly_spend: 0 session_count: 0 user_count: 1 @@ -2410,7 +2434,7 @@ paths: Contact not found: value: type: error.list - request_id: eb5314e6-1c5d-4a80-aa4d-d535068b75df + request_id: 2a4963e5-31af-4d5f-b439-fbe6c3a82a1c errors: - code: not_found message: User Not Found @@ -2424,7 +2448,7 @@ paths: Unauthorized: value: type: error.list - request_id: e5f409d5-dae8-4d20-845a-d001367b2a0b + request_id: ce796345-327f-4854-9c77-6c40ca994b13 errors: - code: unauthorized message: Access Token Invalid @@ -2467,12 +2491,12 @@ paths: value: type: company company_id: '1' - id: 659ebdc66abd014d2275ab11 - app_id: this_is_an_id175_that_should_be_at_least_ - name: company10 - remote_created_at: 1704902086 - created_at: 1704902086 - updated_at: 1704902086 + id: 65c604d986ce64cb37830bda + app_id: this_is_an_id174_that_should_be_at_least_ + name: company8 + remote_created_at: 1707476185 + created_at: 1707476185 + updated_at: 1707476185 monthly_spend: 0 session_count: 0 user_count: 0 @@ -2494,14 +2518,14 @@ paths: Company Not Found: value: type: error.list - request_id: b3d025ee-426e-45fc-863f-e3237f6e39cb + request_id: 2d7e6a29-8b23-4c1e-9fc0-c412727e6470 errors: - code: company_not_found message: Company Not Found Contact Not Found: value: type: error.list - request_id: c77107d7-bbdd-4083-902f-3b38d5e1c93c + request_id: 534895e7-3e9e-44bf-8f2e-13464bd3a9db errors: - code: not_found message: User Not Found @@ -2515,7 +2539,7 @@ paths: Unauthorized: value: type: error.list - request_id: dad1c629-5b1f-4d40-82ec-389ca08d41e0 + request_id: 784e94ac-431c-419a-a09c-0cb0bc66d270 errors: - code: unauthorized message: Access Token Invalid @@ -2551,44 +2575,44 @@ paths: type: list data: - type: note - id: '36' - created_at: 1704297298 + id: '16' + created_at: 1706871391 contact: type: contact - id: 659ebdd26abd014d2275ab42 + id: 65c604df86ce64cb37830bf6 author: type: admin - id: '991266914' - name: Ciaran109 Lee - email: admin109@email.com + id: '991266851' + name: Ciaran110 Lee + email: admin110@email.com away_mode_enabled: false away_mode_reassign: false body: "This is a note.
" - type: note - id: '35' - created_at: 1704210898 + id: '15' + created_at: 1706784991 contact: type: contact - id: 659ebdd26abd014d2275ab42 + id: 65c604df86ce64cb37830bf6 author: type: admin - id: '991266914' - name: Ciaran109 Lee - email: admin109@email.com + id: '991266851' + name: Ciaran110 Lee + email: admin110@email.com away_mode_enabled: false away_mode_reassign: false body: "This is a note.
" - type: note - id: '34' - created_at: 1704210898 + id: '14' + created_at: 1706784991 contact: type: contact - id: 659ebdd26abd014d2275ab42 + id: 65c604df86ce64cb37830bf6 author: type: admin - id: '991266914' - name: Ciaran109 Lee - email: admin109@email.com + id: '991266851' + name: Ciaran110 Lee + email: admin110@email.com away_mode_enabled: false away_mode_reassign: false body: "This is a note.
" @@ -2609,7 +2633,7 @@ paths: Contact not found: value: type: error.list - request_id: 9ce4ef5c-153e-4c05-b2bf-70a0e5fd7ee1 + request_id: 6023fe35-66a4-4016-b93f-494ace3bb12e errors: - code: not_found message: User Not Found @@ -2643,16 +2667,16 @@ paths: Successful response: value: type: note - id: '41' - created_at: 1704902099 + id: '21' + created_at: 1707476192 contact: type: contact - id: 659ebdd36abd014d2275ab44 + id: 65c604e086ce64cb37830bf8 author: type: admin - id: '991266916' - name: Ciaran111 Lee - email: admin111@email.com + id: '991266853' + name: Ciaran112 Lee + email: admin112@email.com away_mode_enabled: false away_mode_reassign: false body: "Hello
" @@ -2666,14 +2690,14 @@ paths: Admin not found: value: type: error.list - request_id: b3063acc-0c0d-4cb3-bd71-c44846459371 + request_id: 788e00c8-f930-4a97-a3b7-11ee1cb46301 errors: - code: not_found message: Resource Not Found Contact not found: value: type: error.list - request_id: 317d1247-f1c4-4151-add5-865c9dbe093a + request_id: 845f2331-471f-4c48-a507-c6e87bd1e705 errors: - code: not_found message: User Not Found @@ -2703,20 +2727,20 @@ paths: successful_response: summary: Successful response value: - contact_id: 659ebdd36abd014d2275ab44 - admin_id: 991266916 + contact_id: 65c604e086ce64cb37830bf8 + admin_id: 991266853 body: Hello admin_not_found: summary: Admin not found value: - contact_id: 659ebdd36abd014d2275ab45 + contact_id: 65c604e086ce64cb37830bf9 admin_id: 123 body: Hello contact_not_found: summary: Contact not found value: contact_id: 123 - admin_id: 991266918 + admin_id: 991266855 body: Hello "/contacts/{contact_id}/segments": get: @@ -2749,10 +2773,10 @@ paths: type: list data: - type: segment - id: 659ebdd46abd014d2275ab47 + id: 65c604e286ce64cb37830bfb name: segment - created_at: 1704902100 - updated_at: 1704902100 + created_at: 1707476194 + updated_at: 1707476194 person_type: user schema: "$ref": "#/components/schemas/contact_segments" @@ -2764,7 +2788,7 @@ paths: Contact not found: value: type: error.list - request_id: 7eec073a-d0f6-469b-8749-dafbf14ed876 + request_id: 92d1b191-1a5d-432e-9fbf-e6f305c99ef0 errors: - code: not_found message: User Not Found @@ -2778,7 +2802,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9c65fd2f-6ca3-424c-8f4c-3c989bbf4f6b + request_id: 9e006793-34df-449e-9613-e4356da258e8 errors: - code: unauthorized message: Access Token Invalid @@ -2822,7 +2846,7 @@ paths: type: list data: - type: subscription - id: '90' + id: '47' state: live consent_type: opt_out default_translation: @@ -2836,7 +2860,7 @@ paths: content_types: - email - type: subscription - id: '92' + id: '49' state: live consent_type: opt_in default_translation: @@ -2859,7 +2883,7 @@ paths: Contact not found: value: type: error.list - request_id: e01a5647-e7f6-43fb-9b39-213e9aae1bf8 + request_id: 9265e3ff-6614-4b30-b477-796fd6a0b89b errors: - code: not_found message: User Not Found @@ -2873,7 +2897,7 @@ paths: Unauthorized: value: type: error.list - request_id: a5dd990a-207c-49c6-b5fd-18f4ecb52150 + request_id: 7439dacb-c35c-42aa-b615-f95c247f3fd7 errors: - code: unauthorized message: Access Token Invalid @@ -2914,7 +2938,7 @@ paths: Successful: value: type: subscription - id: '105' + id: '62' state: live consent_type: opt_in default_translation: @@ -2937,14 +2961,14 @@ paths: Contact not found: value: type: error.list - request_id: 87f83cb2-9f8e-4cc1-8be9-71d1fe14baac + request_id: 6ddea38a-0376-4ccb-a356-ef0e572a3d68 errors: - code: not_found message: User Not Found Resource not found: value: type: error.list - request_id: 58ea20fe-f3d8-4671-99e2-7918efe8c9c5 + request_id: 3df105ff-c7b2-478a-b853-c6d992feabec errors: - code: not_found message: Resource Not Found @@ -2958,7 +2982,7 @@ paths: Unauthorized: value: type: error.list - request_id: 5487aa99-9fd4-415b-950a-3355e84c123c + request_id: db1042fc-6be0-47eb-beba-f9404ce2ff5f errors: - code: unauthorized message: Access Token Invalid @@ -2986,12 +3010,12 @@ paths: successful: summary: Successful value: - id: 105 + id: 62 consent_type: opt_in contact_not_found: summary: Contact not found value: - id: 109 + id: 66 consent_type: opt_in resource_not_found: summary: Resource not found @@ -3037,7 +3061,7 @@ paths: Successful: value: type: subscription - id: '121' + id: '78' state: live consent_type: opt_in default_translation: @@ -3060,14 +3084,14 @@ paths: Contact not found: value: type: error.list - request_id: 286d4ebe-8799-4d41-bfe5-7e23b339cdb6 + request_id: 34983779-bbe7-4347-93c9-3eacd93ec5a2 errors: - code: not_found message: User Not Found Resource not found: value: type: error.list - request_id: 3dfc626d-0248-49ff-a9f0-da7f99df22c4 + request_id: 866c083e-8a1e-4f9c-b332-40993467b396 errors: - code: not_found message: Resource Not Found @@ -3081,7 +3105,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9fd08ae3-dce3-4720-ac64-f82a04fd199a + request_id: 7c874f3d-9753-4c81-a461-abb31d878e1d errors: - code: unauthorized message: Access Token Invalid @@ -3119,7 +3143,7 @@ paths: type: list data: - type: tag - id: '44' + id: '33' name: Manual tag schema: "$ref": "#/components/schemas/tag_list" @@ -3131,7 +3155,7 @@ paths: Contact not found: value: type: error.list - request_id: e541c95a-02a6-4a96-8103-97d1d1396e02 + request_id: 579a9e95-86b4-4b4f-a9a5-2800462017c0 errors: - code: not_found message: User Not Found @@ -3145,7 +3169,7 @@ paths: Unauthorized: value: type: error.list - request_id: fc0547bd-f5d2-4c23-833a-6f94a517108b + request_id: d785c369-681c-4fb9-aff6-6fe527a77e65 errors: - code: unauthorized message: Access Token Invalid @@ -3180,7 +3204,7 @@ paths: successful: value: type: tag - id: '45' + id: '34' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -3192,14 +3216,14 @@ paths: Contact not found: value: type: error.list - request_id: 5217f5a1-3529-4a45-93b7-fe7529395cba + request_id: af757b71-4404-434e-b7d5-d86bf15510e8 errors: - code: not_found message: User Not Found Tag not found: value: type: error.list - request_id: 33dd2502-1527-4e6f-8ca8-d8cd19a90cc0 + request_id: 9cec9cb3-cd54-4880-a3ee-665526059c87 errors: - code: not_found message: Resource Not Found @@ -3213,7 +3237,7 @@ paths: Unauthorized: value: type: error.list - request_id: 71420600-b78b-4067-b54d-63a7170d0e02 + request_id: 4db0ab37-8a76-4c0f-ab19-7c33d23f0098 errors: - code: unauthorized message: Access Token Invalid @@ -3236,11 +3260,11 @@ paths: successful: summary: successful value: - id: 45 + id: 34 contact_not_found: summary: Contact not found value: - id: 46 + id: 35 tag_not_found: summary: Tag not found value: @@ -3282,7 +3306,7 @@ paths: successful: value: type: tag - id: '48' + id: '37' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -3294,14 +3318,14 @@ paths: Contact not found: value: type: error.list - request_id: fe9adaa6-a972-4ecf-9855-5ec16714bec2 + request_id: 8b394246-62e2-4c1d-8e46-4b4e799a5eb5 errors: - code: not_found message: User Not Found Tag not found: value: type: error.list - request_id: 4d9528ce-de2c-4087-8d38-535ee518ecbb + request_id: 145e439b-0617-4a10-88b4-f95646ab0e25 errors: - code: not_found message: Resource Not Found @@ -3315,7 +3339,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8140748c-15e4-4e57-a875-3b65f038de51 + request_id: 1997613d-acb4-44af-a58f-7140c08b0942 errors: - code: unauthorized message: Access Token Invalid @@ -3349,8 +3373,8 @@ paths: successful: value: type: contact - id: 659ebde16abd014d2275ab5e - workspace_id: this_is_an_id249_that_should_be_at_least_ + id: 65c604ee86ce64cb37830c12 + workspace_id: this_is_an_id248_that_should_be_at_least_ external_id: '70' role: user email: joebloggs@intercom.io @@ -3364,9 +3388,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1704902113 - updated_at: 1704902113 - signed_up_at: 1704902113 + created_at: 1707476206 + updated_at: 1707476207 + signed_up_at: 1707476206 last_seen_at: last_replied_at: last_contacted_at: @@ -3400,31 +3424,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ebde16abd014d2275ab5e/tags" + url: "/contacts/65c604ee86ce64cb37830c12/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ebde16abd014d2275ab5e/notes" + url: "/contacts/65c604ee86ce64cb37830c12/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ebde16abd014d2275ab5e/companies" + url: "/contacts/65c604ee86ce64cb37830c12/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ebde16abd014d2275ab5e/subscriptions" + url: "/contacts/65c604ee86ce64cb37830c12/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ebde16abd014d2275ab5e/subscriptions" + url: "/contacts/65c604ee86ce64cb37830c12/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3443,7 +3467,7 @@ paths: Unauthorized: value: type: error.list - request_id: 94cb9572-e6a6-4dc2-9ec5-57ed09310e30 + request_id: 73d3a86a-3ef7-4a2b-87b2-04ab7c116a07 errors: - code: unauthorized message: Access Token Invalid @@ -3488,8 +3512,8 @@ paths: successful: value: type: contact - id: 659ebde26abd014d2275ab5f - workspace_id: this_is_an_id253_that_should_be_at_least_ + id: 65c604f086ce64cb37830c13 + workspace_id: this_is_an_id252_that_should_be_at_least_ external_id: '70' role: user email: joe@bloggs.com @@ -3503,9 +3527,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1704902114 - updated_at: 1704902114 - signed_up_at: 1704902114 + created_at: 1707476208 + updated_at: 1707476208 + signed_up_at: 1707476208 last_seen_at: last_replied_at: last_contacted_at: @@ -3539,31 +3563,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ebde26abd014d2275ab5f/tags" + url: "/contacts/65c604f086ce64cb37830c13/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ebde26abd014d2275ab5f/notes" + url: "/contacts/65c604f086ce64cb37830c13/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ebde26abd014d2275ab5f/companies" + url: "/contacts/65c604f086ce64cb37830c13/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ebde26abd014d2275ab5f/subscriptions" + url: "/contacts/65c604f086ce64cb37830c13/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ebde26abd014d2275ab5f/subscriptions" + url: "/contacts/65c604f086ce64cb37830c13/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3582,7 +3606,7 @@ paths: Unauthorized: value: type: error.list - request_id: 3475332d-04f8-4de5-9de1-044128c28a6f + request_id: 06a24737-9e85-48d7-a278-04f2c5766387 errors: - code: unauthorized message: Access Token Invalid @@ -3613,7 +3637,7 @@ paths: examples: successful: value: - id: 659ebde36abd014d2275ab60 + id: 65c604f186ce64cb37830c14 object: contact deleted: true schema: @@ -3626,7 +3650,7 @@ paths: Unauthorized: value: type: error.list - request_id: c1fb0e55-1e5a-40e9-a0e7-ee3c8c08dd1e + request_id: d3f00283-0a7f-43df-80e1-6188255cd3da errors: - code: unauthorized message: Access Token Invalid @@ -3654,8 +3678,8 @@ paths: successful: value: type: contact - id: 659ebde46abd014d2275ab62 - workspace_id: this_is_an_id261_that_should_be_at_least_ + id: 65c604f286ce64cb37830c16 + workspace_id: this_is_an_id260_that_should_be_at_least_ external_id: '70' role: user email: joe@bloggs.com @@ -3669,9 +3693,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1704902116 - updated_at: 1704902116 - signed_up_at: 1704902116 + created_at: 1707476210 + updated_at: 1707476211 + signed_up_at: 1707476210 last_seen_at: last_replied_at: last_contacted_at: @@ -3705,31 +3729,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ebde46abd014d2275ab62/tags" + url: "/contacts/65c604f286ce64cb37830c16/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ebde46abd014d2275ab62/notes" + url: "/contacts/65c604f286ce64cb37830c16/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ebde46abd014d2275ab62/companies" + url: "/contacts/65c604f286ce64cb37830c16/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ebde46abd014d2275ab62/subscriptions" + url: "/contacts/65c604f286ce64cb37830c16/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ebde46abd014d2275ab62/subscriptions" + url: "/contacts/65c604f286ce64cb37830c16/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3748,7 +3772,7 @@ paths: Unauthorized: value: type: error.list - request_id: 80182344-c8a5-4aed-9739-21f9293f469b + request_id: 5377e18c-9e6a-479f-8006-bcfe91cce247 errors: - code: unauthorized message: Access Token Invalid @@ -3763,8 +3787,8 @@ paths: successful: summary: successful value: - from: 659ebde46abd014d2275ab61 - into: 659ebde46abd014d2275ab62 + from: 65c604f286ce64cb37830c15 + into: 65c604f286ce64cb37830c16 "/contacts/search": post: summary: Search contacts @@ -3873,7 +3897,7 @@ paths: Unauthorized: value: type: error.list - request_id: 26e734b2-d518-4871-9bfe-75d3ed5d77a2 + request_id: b0d0174b-0f36-4258-9310-41d8b29f3435 errors: - code: unauthorized message: Access Token Invalid @@ -3893,15 +3917,15 @@ paths: value: - field: id operator: "=" - value: 659ebde56abd014d2275ab65 + value: 65c604f486ce64cb37830c19 - operator: OR value: - field: id operator: "=" - value: 659ebde56abd014d2275ab65 + value: 65c604f486ce64cb37830c19 - field: id operator: "=" - value: 659ebde56abd014d2275ab65 + value: 65c604f486ce64cb37830c19 "/contacts": get: summary: List all contacts @@ -3940,7 +3964,7 @@ paths: Unauthorized: value: type: error.list - request_id: 4dab281c-a23c-49b7-b095-6a2af261b832 + request_id: a9b265e8-05c0-4c78-9ab3-db9760f77835 errors: - code: unauthorized message: Access Token Invalid @@ -3966,8 +3990,8 @@ paths: successful: value: type: contact - id: 659ebde76abd014d2275ab67 - workspace_id: this_is_an_id273_that_should_be_at_least_ + id: 65c604f786ce64cb37830c1b + workspace_id: this_is_an_id272_that_should_be_at_least_ external_id: role: user email: joebloggs@intercom.io @@ -3981,8 +4005,8 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1704902119 - updated_at: 1704902119 + created_at: 1707476215 + updated_at: 1707476215 signed_up_at: last_seen_at: last_replied_at: @@ -4017,31 +4041,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ebde76abd014d2275ab67/tags" + url: "/contacts/65c604f786ce64cb37830c1b/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ebde76abd014d2275ab67/notes" + url: "/contacts/65c604f786ce64cb37830c1b/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ebde76abd014d2275ab67/companies" + url: "/contacts/65c604f786ce64cb37830c1b/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ebde76abd014d2275ab67/subscriptions" + url: "/contacts/65c604f786ce64cb37830c1b/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ebde76abd014d2275ab67/subscriptions" + url: "/contacts/65c604f786ce64cb37830c1b/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -4060,7 +4084,7 @@ paths: Unauthorized: value: type: error.list - request_id: 34887a34-69a2-4b2b-a161-efce8cdb9917 + request_id: 2e3044fa-b5d5-41a1-8206-87b78e697a49 errors: - code: unauthorized message: Access Token Invalid @@ -4104,7 +4128,7 @@ paths: examples: successful: value: - id: 659ebde86abd014d2275ab68 + id: 65c604f886ce64cb37830c1c object: contact archived: true schema: @@ -4136,7 +4160,7 @@ paths: examples: successful: value: - id: 659ebde86abd014d2275ab69 + id: 65c604f886ce64cb37830c1d object: contact archived: false schema: @@ -4171,7 +4195,7 @@ paths: successful: value: type: tag - id: '50' + id: '39' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -4183,7 +4207,7 @@ paths: Conversation not found: value: type: error.list - request_id: 747d73d3-04dd-49ef-8b9d-3611d119247e + request_id: 63dcfeec-9a4f-47f1-870c-ef81d2fef64e errors: - code: not_found message: Conversation not found @@ -4197,7 +4221,7 @@ paths: Unauthorized: value: type: error.list - request_id: 1041dcd2-02ce-4009-a03b-8b5a8a74c7be + request_id: '0558c47d-8bdb-4813-9984-0350a296d59b' errors: - code: unauthorized message: Access Token Invalid @@ -4226,13 +4250,13 @@ paths: successful: summary: successful value: - id: 50 - admin_id: 991266949 + id: 39 + admin_id: 991266886 conversation_not_found: summary: Conversation not found value: - id: 51 - admin_id: 991266951 + id: 40 + admin_id: 991266888 "/conversations/{conversation_id}/tags/{id}": delete: summary: Remove tag from a conversation @@ -4270,7 +4294,7 @@ paths: successful: value: type: tag - id: '53' + id: '42' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -4282,14 +4306,14 @@ paths: Conversation not found: value: type: error.list - request_id: 1c728696-64af-4b7e-b117-00eea18412f6 + request_id: 557cadc5-2bce-49ae-acd8-849fe4e54c2f errors: - code: not_found message: Conversation not found Tag not found: value: type: error.list - request_id: e4cf4851-1587-4750-b163-eac34d6bf9f5 + request_id: b36a30fc-5922-43a2-8d88-18568cb8bee4 errors: - code: tag_not_found message: Tag not found @@ -4303,7 +4327,7 @@ paths: Unauthorized: value: type: error.list - request_id: 14df234d-4eb6-4670-ad2c-276135a0b126 + request_id: 32bc4a5a-1019-405b-a42e-3b25cf3b72e8 errors: - code: unauthorized message: Access Token Invalid @@ -4326,15 +4350,15 @@ paths: successful: summary: successful value: - admin_id: 991266953 + admin_id: 991266890 conversation_not_found: summary: Conversation not found value: - admin_id: 991266955 + admin_id: 991266892 tag_not_found: summary: Tag not found value: - admin_id: 991266956 + admin_id: 991266893 "/conversations": get: summary: List all conversations @@ -4381,22 +4405,22 @@ paths: total_count: 1 conversations: - type: conversation - id: '205' - created_at: 1704902128 - updated_at: 1704902128 + id: '145' + created_at: 1707476225 + updated_at: 1707476225 waiting_since: snoozed_until: source: type: conversation - id: '403918184' + id: '403918149' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991266959' - name: Ciaran151 Lee - email: admin151@email.com + id: '991266896' + name: Ciaran152 Lee + email: admin152@email.com attachments: [] url: redacted: false @@ -4404,7 +4428,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ebdf06abd014d2275ab6d + id: 65c6050186ce64cb37830c21 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -4432,7 +4456,7 @@ paths: Unauthorized: value: type: error.list - request_id: 84946318-c95c-4dc3-b5ff-74130346aa87 + request_id: 9a4456a3-0e37-4800-90c9-b691ea7191ad errors: - code: unauthorized message: Access Token Invalid @@ -4446,7 +4470,7 @@ paths: API plan restricted: value: type: error.list - request_id: 14cc4c94-7a4b-4a82-9b63-67a5da82717b + request_id: af12c632-6550-43fb-9c13-cd5a004e2d28 errors: - code: api_plan_restricted message: Active subscription needed. @@ -4478,11 +4502,11 @@ paths: conversation created: value: type: user_message - id: '403918194' - created_at: 1704902151 + id: '403918159' + created_at: 1707476251 body: Hello there message_type: inapp - conversation_id: '230' + conversation_id: '170' schema: "$ref": "#/components/schemas/message" '404': @@ -4493,7 +4517,7 @@ paths: Contact Not Found: value: type: error.list - request_id: db8a0c6c-f6fb-422e-bcf0-aeee312d0606 + request_id: 8d770b69-46f2-4ac5-9e46-4667859b5ada errors: - code: not_found message: User Not Found @@ -4507,7 +4531,7 @@ paths: Unauthorized: value: type: error.list - request_id: e0d9fc07-754f-4a45-ae5e-d89565cfadb4 + request_id: 253879e8-7618-4ad3-9722-f5276e7c815c errors: - code: unauthorized message: Access Token Invalid @@ -4521,7 +4545,7 @@ paths: API plan restricted: value: type: error.list - request_id: 441b661d-9a0c-468f-8de1-223703e1b843 + request_id: 4e95c349-b1e3-454b-8eea-2a826ddebe5f errors: - code: api_plan_restricted message: Active subscription needed. @@ -4538,7 +4562,7 @@ paths: value: from: type: user - id: 659ebe066abd014d2275ab82 + id: 65c6051a86ce64cb37830c36 body: Hello there contact_not_found: summary: Contact Not Found @@ -4590,22 +4614,22 @@ paths: conversation found: value: type: conversation - id: '234' - created_at: 1704902155 - updated_at: 1704902155 + id: '174' + created_at: 1707476258 + updated_at: 1707476258 waiting_since: snoozed_until: source: type: conversation - id: '403918198' + id: '403918163' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991266973' - name: Ciaran158 Lee - email: admin158@email.com + id: '991266910' + name: Ciaran159 Lee + email: admin159@email.com attachments: [] url: redacted: false @@ -4613,7 +4637,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ebe0b6abd014d2275ab86 + id: 65c6052286ce64cb37830c3a first_contact_reply: admin_assignee_id: team_assignee_id: @@ -4645,7 +4669,7 @@ paths: Not found: value: type: error.list - request_id: 35bd2b6c-1854-4ba1-8f56-f067408ba471 + request_id: acb679d2-9c1d-4bd8-a037-393fd8602b1c errors: - code: not_found message: Resource Not Found @@ -4659,7 +4683,7 @@ paths: Unauthorized: value: type: error.list - request_id: ffe78abe-5ff1-4149-910a-223a7dcf0be4 + request_id: e79937f9-10b9-48a9-b9ba-3445991fa006 errors: - code: unauthorized message: Access Token Invalid @@ -4673,7 +4697,7 @@ paths: API plan restricted: value: type: error.list - request_id: 15b34bd2-ad5e-4551-aea2-6737eda037fa + request_id: d4a3e0d6-cbbc-4570-8f1a-ae499422afab errors: - code: api_plan_restricted message: Active subscription needed. @@ -4716,22 +4740,22 @@ paths: conversation found: value: type: conversation - id: '238' - created_at: 1704902161 - updated_at: 1704902162 + id: '178' + created_at: 1707476265 + updated_at: 1707476266 waiting_since: snoozed_until: source: type: conversation - id: '403918202' + id: '403918167' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991266981' - name: Ciaran162 Lee - email: admin162@email.com + id: '991266918' + name: Ciaran163 Lee + email: admin163@email.com attachments: [] url: redacted: false @@ -4739,7 +4763,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ebe116abd014d2275ab8a + id: 65c6052986ce64cb37830c3e first_contact_reply: admin_assignee_id: team_assignee_id: @@ -4763,34 +4787,34 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '36' + id: '30' part_type: conversation_attribute_updated_by_admin body: - created_at: 1704902162 - updated_at: 1704902162 - notified_at: 1704902162 + created_at: 1707476266 + updated_at: 1707476266 + notified_at: 1707476266 assigned_to: author: - id: '991266982' + id: '991266919' type: bot name: Operator - email: operator+this_is_an_id317_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id316_that_should_be_at_least_@intercom.io attachments: [] external_id: redacted: false - type: conversation_part - id: '37' + id: '31' part_type: conversation_attribute_updated_by_admin body: - created_at: 1704902162 - updated_at: 1704902162 - notified_at: 1704902162 + created_at: 1707476266 + updated_at: 1707476266 + notified_at: 1707476266 assigned_to: author: - id: '991266982' + id: '991266919' type: bot name: Operator - email: operator+this_is_an_id317_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id316_that_should_be_at_least_@intercom.io attachments: [] external_id: redacted: false @@ -4805,7 +4829,7 @@ paths: Not found: value: type: error.list - request_id: 7b2b2418-8b59-48c1-8a6c-2684d228b062 + request_id: 555d23bd-d333-4c63-a6be-fc947883f08e errors: - code: not_found message: Resource Not Found @@ -4819,7 +4843,7 @@ paths: Unauthorized: value: type: error.list - request_id: 4ce9f5c2-de92-4429-87db-331789c47044 + request_id: 653a0d49-8881-4be2-8378-69008e0023d4 errors: - code: unauthorized message: Access Token Invalid @@ -4833,7 +4857,7 @@ paths: API plan restricted: value: type: error.list - request_id: d48850d5-7968-4e2a-a157-a18d9b5e8496 + request_id: a5edf117-31ca-46d7-a248-a76fc6f27fc8 errors: - code: api_plan_restricted message: Active subscription needed. @@ -4952,22 +4976,22 @@ paths: total_count: 1 conversations: - type: conversation - id: '245' - created_at: 1704902172 - updated_at: 1704902172 + id: '185' + created_at: 1707476278 + updated_at: 1707476278 waiting_since: snoozed_until: source: type: conversation - id: '403918209' + id: '403918174' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991267011' - name: Ciaran185 Lee - email: admin185@email.com + id: '991266948' + name: Ciaran186 Lee + email: admin186@email.com attachments: [] url: redacted: false @@ -4975,7 +4999,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ebe1c6abd014d2275ab91 + id: 65c6053586ce64cb37830c45 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5009,15 +5033,15 @@ paths: value: - field: id operator: "=" - value: '245' + value: '185' - operator: OR value: - field: id operator: "=" - value: '245' + value: '185' - field: id operator: "=" - value: '245' + value: '185' "/conversations/{id}/reply": post: summary: Reply to a conversation @@ -5056,22 +5080,22 @@ paths: User reply: value: type: conversation - id: '253' - created_at: 1704902182 - updated_at: 1704902183 - waiting_since: 1704902183 + id: '193' + created_at: 1707476286 + updated_at: 1707476287 + waiting_since: 1707476287 snoozed_until: source: type: conversation - id: '403918212' + id: '403918177' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991267013' - name: Ciaran186 Lee - email: admin186@email.com + id: '991266950' + name: Ciaran187 Lee + email: admin187@email.com attachments: [] url: redacted: false @@ -5079,9 +5103,9 @@ paths: type: contact.list contacts: - type: contact - id: 659ebe256abd014d2275ab98 + id: 65c6053d86ce64cb37830c4c first_contact_reply: - created_at: 1704902183 + created_at: 1707476287 type: conversation url: admin_assignee_id: @@ -5104,15 +5128,15 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '39' + id: '33' part_type: open body: "Thanks again :)
" - created_at: 1704902183 - updated_at: 1704902183 - notified_at: 1704902183 + created_at: 1707476287 + updated_at: 1707476287 + notified_at: 1707476287 assigned_to: author: - id: 659ebe256abd014d2275ab98 + id: 65c6053d86ce64cb37830c4c type: user name: Joe Bloggs email: joe@bloggs.com @@ -5123,22 +5147,22 @@ paths: Admin note reply: value: type: conversation - id: '254' - created_at: 1704902184 - updated_at: 1704902185 + id: '194' + created_at: 1707476289 + updated_at: 1707476290 waiting_since: snoozed_until: source: type: conversation - id: '403918213' + id: '403918178' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991267015' - name: Ciaran187 Lee - email: admin187@email.com + id: '991266952' + name: Ciaran188 Lee + email: admin188@email.com attachments: [] url: redacted: false @@ -5146,7 +5170,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ebe286abd014d2275ab99 + id: 65c6054086ce64cb37830c4d first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5168,7 +5192,7 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '40' + id: '34' part_type: note body: |-this is the message body
" author: type: admin - id: '991267019' - name: Ciaran189 Lee - email: admin189@email.com + id: '991266956' + name: Ciaran190 Lee + email: admin190@email.com attachments: [] url: redacted: false @@ -5222,9 +5246,9 @@ paths: type: contact.list contacts: - type: contact - id: 659ebe2b6abd014d2275ab9b + id: 65c6054486ce64cb37830c4f first_contact_reply: - created_at: 1704902188 + created_at: 1707476293 type: conversation url: admin_assignee_id: @@ -5247,15 +5271,15 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '41' + id: '35' part_type: open body: "Thanks again :)
" - created_at: 1704902188 - updated_at: 1704902188 - notified_at: 1704902188 + created_at: 1707476293 + updated_at: 1707476293 + notified_at: 1707476293 assigned_to: author: - id: 659ebe2b6abd014d2275ab9b + id: 65c6054486ce64cb37830c4f type: user name: Joe Bloggs email: joe@bloggs.com @@ -5273,7 +5297,7 @@ paths: Not found: value: type: error.list - request_id: f422bbec-3b48-4774-8cde-9e5648f31214 + request_id: 6cae007c-cbf8-406b-a7e0-77ecc22d9967 errors: - code: not_found message: Resource Not Found @@ -5287,7 +5311,7 @@ paths: Unauthorized: value: type: error.list - request_id: 6b1dbbfa-0289-49b4-9be5-e28ac5827666 + request_id: c2f19b41-2c60-4426-888e-1666a2cff08b errors: - code: unauthorized message: Access Token Invalid @@ -5301,7 +5325,7 @@ paths: API plan restricted: value: type: error.list - request_id: 8bdc74c5-9dfb-45aa-a51f-6c0516e656d9 + request_id: 7c43d8f6-ea66-4278-8882-e4f827465ba0 errors: - code: api_plan_restricted message: Active subscription needed. @@ -5318,14 +5342,14 @@ paths: value: message_type: comment type: user - intercom_user_id: 659ebe256abd014d2275ab98 + intercom_user_id: 65c6053d86ce64cb37830c4c body: Thanks again :) admin_note_reply: summary: Admin note reply value: message_type: note type: admin - admin_id: 991267015 + admin_id: 991266952 body: "this is the message body
" author: type: admin - id: '991267027' - name: Ciaran193 Lee - email: admin193@email.com + id: '991266964' + name: Ciaran194 Lee + email: admin194@email.com attachments: [] url: redacted: false @@ -5399,7 +5423,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ebe326abd014d2275ab9f + id: 65c6054b86ce64cb37830c53 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5421,18 +5445,18 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '42' + id: '36' part_type: close body: "Goodbye :)
" - created_at: 1704902196 - updated_at: 1704902196 - notified_at: 1704902196 + created_at: 1707476301 + updated_at: 1707476301 + notified_at: 1707476301 assigned_to: author: - id: '991267027' + id: '991266964' type: admin - name: Ciaran193 Lee - email: admin193@email.com + name: Ciaran194 Lee + email: admin194@email.com attachments: [] external_id: redacted: false @@ -5440,22 +5464,22 @@ paths: Snooze a conversation: value: type: conversation - id: '261' - created_at: 1704902197 - updated_at: 1704902197 + id: '201' + created_at: 1707476302 + updated_at: 1707476303 waiting_since: - snoozed_until: 1704905797 + snoozed_until: 1707479903 source: type: conversation - id: '403918220' + id: '403918185' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991267029' - name: Ciaran194 Lee - email: admin194@email.com + id: '991266966' + name: Ciaran195 Lee + email: admin195@email.com attachments: [] url: redacted: false @@ -5463,7 +5487,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ebe346abd014d2275aba0 + id: 65c6054e86ce64cb37830c54 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5485,18 +5509,18 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '43' + id: '37' part_type: snoozed body: - created_at: 1704902197 - updated_at: 1704902197 - notified_at: 1704902197 + created_at: 1707476303 + updated_at: 1707476303 + notified_at: 1707476303 assigned_to: author: - id: '991267029' + id: '991266966' type: admin - name: Ciaran194 Lee - email: admin194@email.com + name: Ciaran195 Lee + email: admin195@email.com attachments: [] external_id: redacted: false @@ -5504,22 +5528,22 @@ paths: Open a conversation: value: type: conversation - id: '266' - created_at: 1704902196 - updated_at: 1704902207 + id: '206' + created_at: 1707476302 + updated_at: 1707476311 waiting_since: snoozed_until: source: type: conversation - id: '403918221' + id: '403918186' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991267031' - name: Ciaran195 Lee - email: admin195@email.com + id: '991266968' + name: Ciaran196 Lee + email: admin196@email.com attachments: [] url: redacted: false @@ -5527,7 +5551,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ebe3a6abd014d2275aba5 + id: 65c6055386ce64cb37830c59 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5549,18 +5573,18 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '45' + id: '39' part_type: open body: - created_at: 1704902207 - updated_at: 1704902207 - notified_at: 1704902207 + created_at: 1707476311 + updated_at: 1707476311 + notified_at: 1707476311 assigned_to: author: - id: '991267031' + id: '991266968' type: admin - name: Ciaran195 Lee - email: admin195@email.com + name: Ciaran196 Lee + email: admin196@email.com attachments: [] external_id: redacted: false @@ -5568,22 +5592,22 @@ paths: Assign a conversation: value: type: conversation - id: '270' - created_at: 1704902208 - updated_at: 1704902209 + id: '210' + created_at: 1707476312 + updated_at: 1707476314 waiting_since: snoozed_until: source: type: conversation - id: '403918224' + id: '403918189' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991267033' - name: Ciaran196 Lee - email: admin196@email.com + id: '991266970' + name: Ciaran197 Lee + email: admin197@email.com attachments: [] url: redacted: false @@ -5591,9 +5615,9 @@ paths: type: contact.list contacts: - type: contact - id: 659ebe406abd014d2275aba8 + id: 65c6055886ce64cb37830c5c first_contact_reply: - admin_assignee_id: 991267033 + admin_assignee_id: 991266970 team_assignee_id: open: true state: open @@ -5613,20 +5637,20 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '46' + id: '40' part_type: assign_and_reopen body: - created_at: 1704902209 - updated_at: 1704902209 - notified_at: 1704902209 + created_at: 1707476314 + updated_at: 1707476314 + notified_at: 1707476314 assigned_to: type: admin - id: '991267033' + id: '991266970' author: - id: '991267033' + id: '991266970' type: admin - name: Ciaran196 Lee - email: admin196@email.com + name: Ciaran197 Lee + email: admin197@email.com attachments: [] external_id: redacted: false @@ -5641,7 +5665,7 @@ paths: Not found: value: type: error.list - request_id: 51df0dd7-7e67-49f8-8a6c-dbcdd505ed91 + request_id: 52b6a111-6b9f-4d98-af91-b34665f0bfad errors: - code: not_found message: Resource Not Found @@ -5655,7 +5679,7 @@ paths: Unauthorized: value: type: error.list - request_id: 48b2b545-88ab-4dd0-9176-728c47114999 + request_id: 36ed06c9-6616-4b6d-9469-debc7a86451d errors: - code: unauthorized message: Access Token Invalid @@ -5669,7 +5693,7 @@ paths: API plan restricted: value: type: error.list - request_id: fe540041-7382-4539-a1e2-00a3146af631 + request_id: 6cd812e3-bed1-4ba0-9e4c-55da7e1d063c errors: - code: api_plan_restricted message: Active subscription needed. @@ -5690,32 +5714,32 @@ paths: value: message_type: close type: admin - admin_id: 991267027 + admin_id: 991266964 body: Goodbye :) snooze_a_conversation: summary: Snooze a conversation value: message_type: snoozed - admin_id: 991267029 - snoozed_until: 1704905797 + admin_id: 991266966 + snoozed_until: 1707479903 open_a_conversation: summary: Open a conversation value: message_type: open - admin_id: 991267031 + admin_id: 991266968 assign_a_conversation: summary: Assign a conversation value: message_type: assignment type: admin - admin_id: 991267033 - assignee_id: 991267033 + admin_id: 991266970 + assignee_id: 991266970 not_found: summary: Not found value: message_type: close type: admin - admin_id: 991267035 + admin_id: 991266972 body: Goodbye :) "/conversations/{id}/run_assignment_rules": post: @@ -5746,22 +5770,22 @@ paths: Assign a conversation using assignment rules: value: type: conversation - id: '274' - created_at: 1704902215 - updated_at: 1704902216 + id: '214' + created_at: 1707476320 + updated_at: 1707476321 waiting_since: snoozed_until: source: type: conversation - id: '403918228' + id: '403918193' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991267041' - name: Ciaran200 Lee - email: admin200@email.com + id: '991266978' + name: Ciaran201 Lee + email: admin201@email.com attachments: [] url: redacted: false @@ -5769,7 +5793,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ebe476abd014d2275abac + id: 65c6056086ce64cb37830c60 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5791,20 +5815,20 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '47' + id: '41' part_type: default_assignment body: - created_at: 1704902216 - updated_at: 1704902216 - notified_at: 1704902216 + created_at: 1707476321 + updated_at: 1707476321 + notified_at: 1707476321 assigned_to: type: nobody_admin id: author: - id: '991267042' + id: '991266979' type: bot name: Operator - email: operator+this_is_an_id358_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id357_that_should_be_at_least_@intercom.io attachments: [] external_id: redacted: false @@ -5819,7 +5843,7 @@ paths: Not found: value: type: error.list - request_id: 8eb4fba0-6fe6-4d61-b1b6-3fd17808f0f2 + request_id: 107fba6b-1f67-423d-8fe9-8fd2b26eb58d errors: - code: not_found message: Resource Not Found @@ -5833,7 +5857,7 @@ paths: Unauthorized: value: type: error.list - request_id: 10bb192b-9490-40a3-a435-39a61d97ae26 + request_id: 0ee4c25b-6daa-43e9-81a5-0f4964b66999 errors: - code: unauthorized message: Access Token Invalid @@ -5847,7 +5871,7 @@ paths: API plan restricted: value: type: error.list - request_id: 485b0484-0d2b-4ffd-9b47-4e403f285606 + request_id: 04bd34e5-c48b-4184-8c5e-edd0eb74179e errors: - code: api_plan_restricted message: Active subscription needed. @@ -5886,7 +5910,7 @@ paths: value: customers: - type: user - id: 659ebe4d6abd014d2275abb0 + id: 65c6056786ce64cb37830c64 schema: "$ref": "#/components/schemas/conversation" '404': @@ -5897,7 +5921,7 @@ paths: Not found: value: type: error.list - request_id: ca0ec060-8ca2-402e-9567-dd5bedded1e3 + request_id: 7a6201ae-22b1-47a5-9f7e-c0d1b32ba226 errors: - code: not_found message: Resource Not Found @@ -5911,7 +5935,7 @@ paths: Unauthorized: value: type: error.list - request_id: aa796a88-e9a5-4f4e-bc20-4df4435b585a + request_id: 3086aaed-0c1d-4282-9dd2-68b374219c73 errors: - code: unauthorized message: Access Token Invalid @@ -5925,7 +5949,7 @@ paths: API plan restricted: value: type: error.list - request_id: 6d01231a-9e5e-41d5-b1c2-34ceddf76992 + request_id: 9346c3a3-3cfd-4e55-a4f9-878d6372f5f2 errors: - code: api_plan_restricted message: Active subscription needed. @@ -5940,15 +5964,15 @@ paths: attach_a_contact_to_a_conversation: summary: Attach a contact to a conversation value: - admin_id: 991267049 + admin_id: 991266986 customer: - intercom_user_id: 659ebe4d6abd014d2275abb0 + intercom_user_id: 65c6056786ce64cb37830c64 not_found: summary: Not found value: - admin_id: 991267051 + admin_id: 991266988 customer: - intercom_user_id: 659ebe4f6abd014d2275abb1 + intercom_user_id: 65c6056986ce64cb37830c65 "/conversations/{conversation_id}/customers/{contact_id}": delete: summary: Detach a contact from a group conversation @@ -5989,7 +6013,7 @@ paths: value: customers: - type: user - id: 659ebe5d6abd014d2275abbb + id: 65c6057686ce64cb37830c6f schema: "$ref": "#/components/schemas/conversation" '404': @@ -6000,14 +6024,14 @@ paths: Conversation not found: value: type: error.list - request_id: 840d17c5-b0c9-4440-9a72-86c6df3c7e9a + request_id: d2385cee-0be5-4147-be8d-e2252b4056bd errors: - code: not_found message: Resource Not Found Contact not found: value: type: error.list - request_id: '01963e78-781b-442a-91df-84d0865312b7' + request_id: de40b483-49e2-44d5-91ac-c471fd9b9aa2 errors: - code: not_found message: User Not Found @@ -6021,7 +6045,7 @@ paths: Last customer: value: type: error.list - request_id: b30d8c10-a21d-4fc8-bcdb-8bdfc64f0d6b + request_id: '0719cd16-5d95-465c-83b7-b780fb1204be' errors: - code: parameter_invalid message: Removing the last customer is not allowed @@ -6035,7 +6059,7 @@ paths: Unauthorized: value: type: error.list - request_id: 49e36e56-8e0c-401c-9bad-9abd319a4791 + request_id: 9aaadfff-fdbc-4dd1-92ec-7dda4f98387d errors: - code: unauthorized message: Access Token Invalid @@ -6049,7 +6073,7 @@ paths: API plan restricted: value: type: error.list - request_id: bc05bcff-2601-4817-8b3e-1edeb1ca6cb6 + request_id: 5705817e-5d82-454c-a27d-d7cdc1446192 errors: - code: api_plan_restricted message: Active subscription needed. @@ -6064,27 +6088,27 @@ paths: detach_a_contact_from_a_group_conversation: summary: Detach a contact from a group conversation value: - admin_id: 991267057 + admin_id: 991266994 customer: - intercom_user_id: 659ebe546abd014d2275abb4 + intercom_user_id: 65c6056f86ce64cb37830c68 conversation_not_found: summary: Conversation not found value: - admin_id: 991267059 + admin_id: 991266996 customer: - intercom_user_id: 659ebe5e6abd014d2275abbc + intercom_user_id: 65c6057786ce64cb37830c70 contact_not_found: summary: Contact not found value: - admin_id: 991267061 + admin_id: 991266998 customer: - intercom_user_id: 659ebe676abd014d2275abc3 + intercom_user_id: 65c6058086ce64cb37830c77 last_customer: summary: Last customer value: - admin_id: 991267063 + admin_id: 991267000 customer: - intercom_user_id: 659ebe6f6abd014d2275abca + intercom_user_id: 65c6058786ce64cb37830c7e "/conversations/redact": post: summary: Redact a conversation part @@ -6111,22 +6135,22 @@ paths: Redact a conversation part: value: type: conversation - id: '330' - created_at: 1704902277 - updated_at: 1704902278 - waiting_since: 1704902277 + id: '270' + created_at: 1707476385 + updated_at: 1707476387 + waiting_since: 1707476385 snoozed_until: source: type: conversation - id: '403918254' + id: '403918219' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991267069' - name: Ciaran214 Lee - email: admin214@email.com + id: '991267006' + name: Ciaran215 Lee + email: admin215@email.com attachments: [] url: redacted: false @@ -6134,9 +6158,9 @@ paths: type: contact.list contacts: - type: contact - id: 659ebe856abd014d2275abdf + id: 65c605a086ce64cb37830c93 first_contact_reply: - created_at: 1704902277 + created_at: 1707476385 type: conversation url: admin_assignee_id: @@ -6159,15 +6183,15 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '55' + id: '49' part_type: open body: "This message was deleted
" - created_at: 1704902277 - updated_at: 1704902278 - notified_at: 1704902277 + created_at: 1707476385 + updated_at: 1707476387 + notified_at: 1707476385 assigned_to: author: - id: 659ebe856abd014d2275abdf + id: 65c605a086ce64cb37830c93 type: user name: Joe Bloggs email: joe@bloggs.com @@ -6185,7 +6209,7 @@ paths: Not found: value: type: error.list - request_id: 1d0015d0-25f2-43e4-adff-f014f6499cae + request_id: 2af239fb-93a5-4e4d-9403-a7b90e9a2156 errors: - code: conversation_part_or_message_not_found message: Conversation part or message not found @@ -6199,7 +6223,7 @@ paths: Unauthorized: value: type: error.list - request_id: ce0fb3c4-4b09-424c-b6ba-88261dc36247 + request_id: 2e69758f-240b-48c0-b70e-1d747185fa36 errors: - code: unauthorized message: Access Token Invalid @@ -6215,8 +6239,8 @@ paths: summary: Redact a conversation part value: type: conversation_part - conversation_id: 330 - conversation_part_id: 55 + conversation_id: 270 + conversation_part_id: 49 not_found: summary: Not found value: @@ -6273,6 +6297,7 @@ paths: data_type: string api_writable: true ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6284,6 +6309,7 @@ paths: data_type: string api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6296,6 +6322,7 @@ paths: data_type: date api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6307,6 +6334,7 @@ paths: data_type: date api_writable: true ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6318,6 +6346,7 @@ paths: data_type: integer api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6330,6 +6359,7 @@ paths: data_type: integer api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6342,6 +6372,7 @@ paths: data_type: string api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6353,6 +6384,7 @@ paths: data_type: float api_writable: true ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6365,6 +6397,7 @@ paths: data_type: integer api_writable: true ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6377,6 +6410,7 @@ paths: data_type: string api_writable: true ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6389,10 +6423,11 @@ paths: data_type: string api_writable: true ui_writable: false + messenger_writable: true custom: false archived: false model: company - - id: 38 + - id: 18 type: data_attribute name: The One Ring full_name: custom_attributes.The One Ring @@ -6402,11 +6437,12 @@ paths: data_type: string api_writable: true ui_writable: false + messenger_writable: true custom: true archived: false - admin_id: '991267085' - created_at: 1704902286 - updated_at: 1704902286 + admin_id: '991267031' + created_at: 1707476401 + updated_at: 1707476401 model: company - type: data_attribute name: id @@ -6416,6 +6452,7 @@ paths: data_type: string api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6427,6 +6464,7 @@ paths: data_type: date api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6438,6 +6476,7 @@ paths: data_type: date api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6449,6 +6488,7 @@ paths: data_type: string api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6460,6 +6500,7 @@ paths: data_type: string api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6473,7 +6514,7 @@ paths: Unauthorized: value: type: error.list - request_id: 5064dad4-eef1-4c6e-8758-e650fbfa1b6b + request_id: d3245e4c-d938-4598-968b-e6203217b946 errors: - code: unauthorized message: Access Token Invalid @@ -6498,7 +6539,7 @@ paths: examples: Successful: value: - id: 41 + id: 21 type: data_attribute name: Mithril Shirt full_name: custom_attributes.Mithril Shirt @@ -6506,11 +6547,12 @@ paths: data_type: string api_writable: true ui_writable: false + messenger_writable: true custom: true archived: false - admin_id: '991267087' - created_at: 1704902287 - updated_at: 1704902287 + admin_id: '991267033' + created_at: 1707476402 + updated_at: 1707476402 model: company schema: "$ref": "#/components/schemas/data_attribute" @@ -6522,7 +6564,7 @@ paths: Same name already exists: value: type: error.list - request_id: b860f3f9-4e50-47f4-a0c3-706185cbd0d9 + request_id: de8feda7-770f-4f8d-bd8f-935c10c4f1d2 errors: - code: parameter_invalid message: You already have 'The One Ring' in your company data. @@ -6530,7 +6572,7 @@ paths: Invalid name: value: type: error.list - request_id: 390a0c95-1429-47bc-9b80-c7226d3bcc4d + request_id: 991f2aa4-9b9f-4350-a8e3-6c44e340feaa errors: - code: parameter_invalid message: Your name for this attribute must only contain alphanumeric @@ -6538,7 +6580,7 @@ paths: Attribute already exists: value: type: error.list - request_id: f90f7a7b-3543-471b-ac9e-11ef393774f0 + request_id: 109defae-1665-49cf-afce-4a4dc2cc2165 errors: - code: parameter_invalid message: You already have 'The One Ring' in your company data. @@ -6546,14 +6588,14 @@ paths: Invalid Data Type: value: type: error.list - request_id: fd5530d5-0406-4ca8-8b36-43ee0bf3ed97 + request_id: 8f7f06a1-5fa5-4d2f-b6eb-a023ef2e752c errors: - code: parameter_invalid message: Data Type isn't an option Too few options for list: value: type: error.list - request_id: 33054e20-093d-4452-ae42-75f698dc5a0e + request_id: 48a5a458-7ae1-4abc-8cd9-512630bcc299 errors: - code: parameter_invalid message: The Data Attribute model field must be either contact @@ -6568,7 +6610,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0b542575-15f3-48d2-b3e6-37df7dba4217 + request_id: 1b475fb6-c962-4a12-bebd-e1c7e33b2d19 errors: - code: unauthorized message: Access Token Invalid @@ -6647,7 +6689,7 @@ paths: examples: Successful: value: - id: 48 + id: 28 type: data_attribute name: The One Ring full_name: custom_attributes.The One Ring @@ -6659,11 +6701,12 @@ paths: - 11-20 api_writable: true ui_writable: false + messenger_writable: true custom: true archived: false - admin_id: '991267094' - created_at: 1704902290 - updated_at: 1704902290 + admin_id: '991267040' + created_at: 1707476405 + updated_at: 1707476405 model: company schema: "$ref": "#/components/schemas/data_attribute" @@ -6675,7 +6718,7 @@ paths: Too few options in list: value: type: error.list - request_id: e9b5e2a7-2d4e-4cd6-ad8e-5704dd81572b + request_id: 2f58a295-d4f1-47ee-b22d-018bfb874ade errors: - code: parameter_invalid message: Options isn't an array @@ -6689,7 +6732,7 @@ paths: Attribute Not Found: value: type: error.list - request_id: 15bef0cf-be70-4ffd-b387-90e6a1a9c5c8 + request_id: a87bc34c-4bab-46c0-931b-f2d7a00abb93 errors: - code: field_not_found message: We couldn't find that data attribute to update @@ -6703,7 +6746,7 @@ paths: Has Dependant Object: value: type: error.list - request_id: 5ea8d29f-3110-4d01-825d-4e05ff9e3593 + request_id: e3072d89-48e7-4256-b7d8-8ae31fc5ac6d errors: - code: data_invalid message: The Data Attribute you are trying to archive has a @@ -6718,7 +6761,7 @@ paths: Unauthorized: value: type: error.list - request_id: 05d97f93-8a02-4e49-9faf-b868eed2ae54 + request_id: 1085011c-e507-4555-b932-152f0789d6cc errors: - code: unauthorized message: Access Token Invalid @@ -6769,63 +6812,49 @@ paths: tags: - Data Events operationId: createDataEvent - description: "\nYou will need an Access Token that has write permissions to - send Events. Once you have a key you can submit events via POST to the Events - resource, which is located at https://api.intercom.io/events, or you can send - events using one of the client libraries. When working with the HTTP API directly - a client should send the event with a `Content-Type` of `application/json`.\n\nWhen - using the JavaScript API, [adding the code to your app](http://docs.intercom.io/configuring-Intercom/tracking-user-events-in-your-app) - makes the Events API available. Once added, you can submit an event using - the `trackEvent` method. This will associate the event with the Lead or currently - logged-in user or logged-out visitor/lead and send it to Intercom. The final - parameter is a map that can be used to send optional metadata about the event.\n\nWith - the Ruby client you pass a hash describing the event to `Intercom::Event.create`, - or call the `track_user` method directly on the current user object (e.g. - `user.track_event`).\n\n| Type | Description | - Example |\n| - :-------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- - | :-------------------------------------------------------------------------------- - |\n| String | The value is a JSON String | - `\"source\":\"desktop\"` |\n| - Number | The value is a JSON Number | - `\"load\": 3.67` |\n| - Date | The key ends with the String `_date` and the value is a - [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time), assumed to be in - the [UTC](http://en.wikipedia.org/wiki/Coordinated_Universal_Time) timezone. - | `\"contact_date\": 1392036272` |\n| - Link | The value is a HTTP or HTTPS URI. | - `\"article\": \"https://example.org/ab1de.html\"` |\n| - Rich Link | The value is a JSON object that contains `url` and `value` - keys. | - `\"article\": {\"url\": \"https://example.org/ab1de.html\", \"value\":\"the - dude abides\"}` |\n| Monetary Amount | The value is a JSON object that contains - `amount` and `currency` keys. The `amount` key is a positive integer representing - the amount in cents. The price in the example to the right denotes €349.99. - \ | `\"price\": {\"amount\": 34999, \"currency\": \"eur\"}` |\n\n**NB: - For the JSON object types, please note that we do not currently support nested - JSON structure.**\n\n> \U0001F6A7 Lead Events\n>\n> When submitting events - for Leads, you will need to specify the Lead's `id`.\n\n> \U0001F4D8 Metadata - behaviour\n>\n> - We currently limit the number of tracked metadata keys to - 10 per event. Once the quota is reached, we ignore any further keys we receive. - The first 10 metadata keys are determined by the order in which they are sent - in with the event.\n> - It is not possible to change the metadata keys once - the event has been sent. A new event will need to be created with the new - keys and you can archive the old one.\n> - There might be up to 24 hrs delay - when you send a new metadata for an existing event.\n\n> \U0001F4D8 Event - de-duplication\n>\n> The API may detect and ignore duplicate events. Each - event is uniquely identified as a combination of the following data - the - Workspace identifier, the Contact external identifier, the Data Event name - and the Data Event created time. As a result, it is **strongly recommended** - to send a second granularity Unix timestamp in the `created_at` field.\n>\n> - Duplicated events are responded to using the normal `202 Accepted` code - - an error is not thrown, however repeat requests will be counted against any - rate limit that is in place.\n\n### HTTP API Responses\n\n- Successful responses - to submitted events return `202 Accepted` with an empty body.\n- Unauthorised - access will be rejected with a `401 Unauthorized` or `403 Forbidden` response - code.\n- Events sent about users that cannot be found will return a `404 Not - Found`.\n- Event lists containing duplicate events will have those duplicates - ignored.\n- Server errors will return a `500` response code and may contain - an error message in the body.\n\n" + description: |2+ + + You will need an Access Token that has write permissions to send Events. Once you have a key you can submit events via POST to the Events resource, which is located at https://api.intercom.io/events, or you can send events using one of the client libraries. When working with the HTTP API directly a client should send the event with a `Content-Type` of `application/json`. + + When using the JavaScript API, [adding the code to your app](http://docs.intercom.io/configuring-Intercom/tracking-user-events-in-your-app) makes the Events API available. Once added, you can submit an event using the `trackEvent` method. This will associate the event with the Lead or currently logged-in user or logged-out visitor/lead and send it to Intercom. The final parameter is a map that can be used to send optional metadata about the event. + + With the Ruby client you pass a hash describing the event to `Intercom::Event.create`, or call the `track_user` method directly on the current user object (e.g. `user.track_event`). + + **NB: For the JSON object types, please note that we do not currently support nested JSON structure.** + + | Type | Description | Example | + | :-------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------- | + | String | The value is a JSON String | `"source":"desktop"` | + | Number | The value is a JSON Number | `"load": 3.67` | + | Date | The key ends with the String `_date` and the value is a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time), assumed to be in the [UTC](http://en.wikipedia.org/wiki/Coordinated_Universal_Time) timezone. | `"contact_date": 1392036272` | + | Link | The value is a HTTP or HTTPS URI. | `"article": "https://example.org/ab1de.html"` | + | Rich Link | The value is a JSON object that contains `url` and `value` keys. | `"article": {"url": "https://example.org/ab1de.html", "value":"the dude abides"}` | + | Monetary Amount | The value is a JSON object that contains `amount` and `currency` keys. The `amount` key is a positive integer representing the amount in cents. The price in the example to the right denotes €349.99. | `"price": {"amount": 34999, "currency": "eur"}` | + + **Lead Events** + + When submitting events for Leads, you will need to specify the Lead's `id`. + + **Metadata behaviour** + + - We currently limit the number of tracked metadata keys to 10 per event. Once the quota is reached, we ignore any further keys we receive. The first 10 metadata keys are determined by the order in which they are sent in with the event. + - It is not possible to change the metadata keys once the event has been sent. A new event will need to be created with the new keys and you can archive the old one. + - There might be up to 24 hrs delay when you send a new metadata for an existing event. + + **Event de-duplication** + + The API may detect and ignore duplicate events. Each event is uniquely identified as a combination of the following data - the Workspace identifier, the Contact external identifier, the Data Event name and the Data Event created time. As a result, it is **strongly recommended** to send a second granularity Unix timestamp in the `created_at` field. + + Duplicated events are responded to using the normal `202 Accepted` code - an error is not thrown, however repeat requests will be counted against any rate limit that is in place. + + ### HTTP API Responses + + - Successful responses to submitted events return `202 Accepted` with an empty body. + - Unauthorised access will be rejected with a `401 Unauthorized` or `403 Forbidden` response code. + - Events sent about users that cannot be found will return a `404 Not Found`. + - Event lists containing duplicate events will have those duplicates ignored. + - Server errors will return a `500` response code and may contain an error message in the body. + responses: '202': description: successful @@ -6837,7 +6866,7 @@ paths: Unauthorized: value: type: error.list - request_id: e8a31b61-8a17-463f-9d26-89702e3e2947 + request_id: d6371ef1-ee48-4a5d-9b45-7176d831961c errors: - code: unauthorized message: Access Token Invalid @@ -6923,8 +6952,8 @@ paths: events: [] pages: next: http://api.intercom.test/events?next page - email: user24@email.com - intercom_user_id: 659ebe9a6abd014d2275abf8 + email: user26@email.com + intercom_user_id: 65c605ba86ce64cb37830c9c user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 schema: "$ref": "#/components/schemas/data_event_summary" @@ -6936,7 +6965,7 @@ paths: Unauthorized: value: type: error.list - request_id: 563a3fae-c399-45c6-a6ae-8c9242d0fca0 + request_id: ba5ba20b-5f56-4dad-a467-571c88914c2e errors: - code: unauthorized message: Access Token Invalid @@ -6967,7 +6996,7 @@ paths: Unauthorized: value: type: error.list - request_id: 7bed7383-946e-4bb4-af48-94a6eb56027b + request_id: 2f047dbe-32b4-4356-a9db-3afcc546101b errors: - code: unauthorized message: Access Token Invalid @@ -7011,7 +7040,7 @@ paths: examples: successful: value: - job_identifier: azt9r3sad8hy30oz + job_identifier: ie25sjnyjivpwqa4 status: pending download_url: '' download_expires_at: '' @@ -7026,8 +7055,8 @@ paths: successful: summary: successful value: - created_at_after: 1704884300 - created_at_before: 1704902300 + created_at_after: 1707458412 + created_at_before: 1707476412 "/export/content/data/{job_identifier}": get: summary: Show content data export @@ -7061,7 +7090,7 @@ paths: examples: successful: value: - job_identifier: 58tm0u6qqudiw1wg + job_identifier: r0d8cthxj53gm4iq status: pending download_url: '' download_expires_at: '' @@ -7093,7 +7122,7 @@ paths: examples: successful: value: - job_identifier: 265qguretsv4rw80 + job_identifier: cgs6unery7mei3wt status: canceled download_url: '' download_expires_at: '' @@ -7154,32 +7183,32 @@ paths: user message created: value: type: user_message - id: '403918265' - created_at: 1704902327 + id: '403918224' + created_at: 1707476414 body: heyy message_type: inapp - conversation_id: '346' + conversation_id: '275' lead message created: value: type: user_message - id: '403918266' - created_at: 1704902328 + id: '403918225' + created_at: 1707476415 body: heyy message_type: inapp - conversation_id: '347' + conversation_id: '276' admin message created: value: type: admin_message - id: '16' - created_at: 1704902329 + id: '10' + created_at: 1707476417 subject: heyy body: heyy message_type: inapp owner: type: admin - id: '991267128' - name: Ciaran255 Lee - email: admin255@email.com + id: '991267063' + name: Ciaran265 Lee + email: admin265@email.com away_mode_enabled: false away_mode_reassign: false schema: @@ -7192,14 +7221,14 @@ paths: No body supplied for message: value: type: error.list - request_id: 83111350-c2cd-4745-a4d4-aa17a5fa1cbe + request_id: ad4c0d1f-0b93-4e3d-ae3d-6eef8bc397b1 errors: - code: parameter_invalid message: Body is required No body supplied for email message: value: type: error.list - request_id: bd703bb2-675b-4488-b09f-dfce369f304f + request_id: 4c08fce2-6da7-4aba-a0c7-3084948cc5fd errors: - code: parameter_invalid message: Body is required @@ -7213,7 +7242,7 @@ paths: No subject supplied for email message: value: type: error.list - request_id: 964a512e-6458-4a49-ad30-e86e9750382d + request_id: fa396451-c6b7-4c26-bee5-d37e8be09619 errors: - code: parameter_not_found message: No subject supplied for email message @@ -7227,7 +7256,7 @@ paths: Unauthorized: value: type: error.list - request_id: 5e552874-2b5c-4571-b7ba-20c0e65832fc + request_id: 80712e8f-1cc8-4aca-be7c-58a4ebf17175 errors: - code: unauthorized message: Access Token Invalid @@ -7241,7 +7270,7 @@ paths: API plan restricted: value: type: error.list - request_id: f8c94e3f-b089-4a66-8b53-0e968b44f289 + request_id: 1e3ffdd9-3871-4c90-a927-e71b9e5e9b24 errors: - code: api_plan_restricted message: Active subscription needed. @@ -7258,7 +7287,7 @@ paths: value: from: type: user - id: 659ebeb76abd014d2275ac4d + id: 65c605be86ce64cb37830ca1 body: heyy referer: https://twitter.com/bob lead_message_created: @@ -7266,7 +7295,7 @@ paths: value: from: type: lead - id: 659ebeb86abd014d2275ac4e + id: 65c605bf86ce64cb37830ca2 body: heyy referer: https://twitter.com/bob admin_message_created: @@ -7274,10 +7303,10 @@ paths: value: from: type: admin - id: '991267128' + id: '991267063' to: type: user - id: 659ebeb96abd014d2275ac4f + id: 65c605c086ce64cb37830ca3 message_type: conversation body: heyy no_body_supplied_for_message: @@ -7285,10 +7314,10 @@ paths: value: from: type: admin - id: '991267130' + id: '991267065' to: type: user - id: 659ebeba6abd014d2275ac50 + id: 65c605c186ce64cb37830ca4 message_type: inapp body: subject: heyy @@ -7297,7 +7326,7 @@ paths: value: from: type: admin - id: '991267131' + id: '991267066' to: type: user user_id: '70' @@ -7308,10 +7337,10 @@ paths: value: from: type: admin - id: '991267132' + id: '991267067' to: type: user - id: 659ebebb6abd014d2275ac52 + id: 65c605c286ce64cb37830ca6 message_type: email body: subject: heyy @@ -7344,10 +7373,10 @@ paths: data: - id: '15' type: news-item - workspace_id: this_is_an_id462_that_should_be_at_least_ + workspace_id: this_is_an_id479_that_should_be_at_least_ title: We have news body: "Hello there,
" - sender_id: 991267137 + sender_id: 991267072 state: draft labels: [] cover_image_url: @@ -7357,15 +7386,15 @@ paths: - - deliver_silently: false - created_at: 1704902333 - updated_at: 1704902333 + created_at: 1707476420 + updated_at: 1707476420 newsfeed_assignments: [] - id: '16' type: news-item - workspace_id: this_is_an_id462_that_should_be_at_least_ + workspace_id: this_is_an_id479_that_should_be_at_least_ title: We have news body: "Hello there,
" - sender_id: 991267139 + sender_id: 991267074 state: draft labels: [] cover_image_url: @@ -7375,8 +7404,8 @@ paths: - - deliver_silently: false - created_at: 1704902333 - updated_at: 1704902333 + created_at: 1707476420 + updated_at: 1707476420 newsfeed_assignments: [] total_count: 2 schema: @@ -7389,7 +7418,7 @@ paths: Unauthorized: value: type: error.list - request_id: d10360b2-369e-43d5-acb8-ae02f85e5311 + request_id: 73352bcc-575e-4f97-8467-0d64253357cc errors: - code: unauthorized message: Access Token Invalid @@ -7416,10 +7445,10 @@ paths: value: id: '19' type: news-item - workspace_id: this_is_an_id466_that_should_be_at_least_ + workspace_id: this_is_an_id483_that_should_be_at_least_ title: Halloween is here! body: "New costumes in store for this spooky season
" - sender_id: 991267146 + sender_id: 991267081 state: live labels: - New @@ -7430,8 +7459,8 @@ paths: - "\U0001F606" - "\U0001F605" deliver_silently: true - created_at: 1704902335 - updated_at: 1704902335 + created_at: 1707476422 + updated_at: 1707476422 newsfeed_assignments: - newsfeed_id: 28 published_at: 1664638214 @@ -7445,7 +7474,7 @@ paths: Unauthorized: value: type: error.list - request_id: 4e6f92c6-bcef-4faf-9337-8df194bd9a08 + request_id: 3f135477-b64e-408b-a7d2-52f6cab64043 errors: - code: unauthorized message: Access Token Invalid @@ -7466,7 +7495,7 @@ paths: - Product - Update - New - sender_id: 991267146 + sender_id: 991267081 deliver_silently: true reactions: - "\U0001F606" @@ -7504,10 +7533,10 @@ paths: value: id: '20' type: news-item - workspace_id: this_is_an_id470_that_should_be_at_least_ + workspace_id: this_is_an_id487_that_should_be_at_least_ title: We have news body: "Hello there,
" - sender_id: 991267149 + sender_id: 991267084 state: live labels: [] cover_image_url: @@ -7517,11 +7546,11 @@ paths: - - deliver_silently: false - created_at: 1704902336 - updated_at: 1704902336 + created_at: 1707476423 + updated_at: 1707476423 newsfeed_assignments: - newsfeed_id: 30 - published_at: 1704902336 + published_at: 1707476423 schema: "$ref": "#/components/schemas/news_item" '404': @@ -7532,7 +7561,7 @@ paths: News Item Not Found: value: type: error.list - request_id: 537cc56f-444c-49ba-8faf-399e25b5b6ab + request_id: '0947d7ec-5411-4154-b5f7-e3dc16a277c2' errors: - code: not_found message: Resource Not Found @@ -7546,7 +7575,7 @@ paths: Unauthorized: value: type: error.list - request_id: 83f95f28-b352-405b-9910-38ef2c951cb6 + request_id: 6c42e7d6-b3ad-4898-aa49-ca97b68c6d1c errors: - code: unauthorized message: Access Token Invalid @@ -7579,10 +7608,10 @@ paths: value: id: '23' type: news-item - workspace_id: this_is_an_id476_that_should_be_at_least_ + workspace_id: this_is_an_id493_that_should_be_at_least_ title: Christmas is here! body: "New gifts in store for the jolly season
" - sender_id: 991267157 + sender_id: 991267092 state: live labels: [] cover_image_url: @@ -7590,8 +7619,8 @@ paths: - "\U0001F61D" - "\U0001F602" deliver_silently: false - created_at: 1704902337 - updated_at: 1704902338 + created_at: 1707476425 + updated_at: 1707476426 newsfeed_assignments: [] schema: "$ref": "#/components/schemas/news_item" @@ -7603,7 +7632,7 @@ paths: News Item Not Found: value: type: error.list - request_id: 64210c76-336f-4082-89bf-1adef968afd6 + request_id: 2596caeb-7e9f-4d1a-a04d-1435da758f42 errors: - code: not_found message: Resource Not Found @@ -7617,7 +7646,7 @@ paths: Unauthorized: value: type: error.list - request_id: 5b5f4993-dbad-435a-a276-cc7e47359e1a + request_id: 76f2622b-51ff-4de0-9a68-0c8cc9c1f1f1 errors: - code: unauthorized message: Access Token Invalid @@ -7634,7 +7663,7 @@ paths: value: title: Christmas is here! body: "New gifts in store for the jolly season
" - sender_id: 991267157 + sender_id: 991267092 reactions: - "\U0001F61D" - "\U0001F602" @@ -7643,7 +7672,7 @@ paths: value: title: Christmas is here! body: "New gifts in store for the jolly season
" - sender_id: 991267160 + sender_id: 991267095 reactions: - "\U0001F61D" - "\U0001F602" @@ -7686,7 +7715,7 @@ paths: News Item Not Found: value: type: error.list - request_id: dc4e11b7-5b10-45d8-b252-0be98ccc79c9 + request_id: e1b33323-6d4a-404b-935b-38aec370d5dc errors: - code: not_found message: Resource Not Found @@ -7700,7 +7729,7 @@ paths: Unauthorized: value: type: error.list - request_id: 7570b2de-e25a-4d83-b644-98c182bf3e00 + request_id: 51b590bb-c7a1-4611-86cd-2fec83233a07 errors: - code: unauthorized message: Access Token Invalid @@ -7753,7 +7782,7 @@ paths: Unauthorized: value: type: error.list - request_id: b6d7eab4-d558-41db-a461-b18d9fd339d6 + request_id: d4131d45-a736-4e7e-8dcb-76f9ddf721c9 errors: - code: unauthorized message: Access Token Invalid @@ -7789,13 +7818,13 @@ paths: - id: '43' type: newsfeed name: Visitor Feed - created_at: 1704902342 - updated_at: 1704902342 + created_at: 1707476430 + updated_at: 1707476430 - id: '44' type: newsfeed name: Visitor Feed - created_at: 1704902342 - updated_at: 1704902342 + created_at: 1707476430 + updated_at: 1707476430 total_count: 2 schema: "$ref": "#/components/schemas/paginated_response" @@ -7807,7 +7836,7 @@ paths: Unauthorized: value: type: error.list - request_id: df3f0af8-4f76-4699-85fd-ce08b25c9d74 + request_id: d47c7415-ddb6-470b-8731-9405eabeca03 errors: - code: unauthorized message: Access Token Invalid @@ -7844,8 +7873,8 @@ paths: id: '47' type: newsfeed name: Visitor Feed - created_at: 1704902343 - updated_at: 1704902343 + created_at: 1707476431 + updated_at: 1707476431 schema: "$ref": "#/components/schemas/newsfeed" '401': @@ -7856,7 +7885,7 @@ paths: Unauthorized: value: type: error.list - request_id: 54838234-2c28-4101-8abe-52e52ed7c204 + request_id: db3e13b6-ed12-4909-81fe-3835e67dacf7 errors: - code: unauthorized message: Access Token Invalid @@ -7890,16 +7919,16 @@ paths: Note found: value: type: note - id: '54' - created_at: 1704211146 + id: '24' + created_at: 1706785232 contact: type: contact - id: 659ebeca6abd014d2275ac5d + id: 65c605d086ce64cb37830ca9 author: type: admin - id: '991267176' - name: Ciaran302 Lee - email: admin302@email.com + id: '991267111' + name: Ciaran312 Lee + email: admin312@email.com away_mode_enabled: false away_mode_reassign: false body: "This is a note.
" @@ -7913,7 +7942,7 @@ paths: Note not found: value: type: error.list - request_id: 2444c7ec-53e8-4958-b6ad-5b859b005805 + request_id: bacb800a-3612-4c48-94b8-d4e93f7ce698 errors: - code: not_found message: Resource Not Found @@ -7927,7 +7956,7 @@ paths: Unauthorized: value: type: error.list - request_id: 7fa3ad29-771d-4375-b7fc-4624cae48ce9 + request_id: 5f4ccb41-cbe5-4fdb-8f5e-e93ab97d8b0b errors: - code: unauthorized message: Access Token Invalid @@ -7963,16 +7992,16 @@ paths: type: segment.list segments: - type: segment - id: 659ebece6abd014d2275ac64 + id: 65c605d286ce64cb37830cac name: John segment - created_at: 1704902350 - updated_at: 1704902350 + created_at: 1707476434 + updated_at: 1707476434 person_type: user - type: segment - id: 659ebece6abd014d2275ac65 + id: 65c605d286ce64cb37830cad name: Jane segment - created_at: 1704902350 - updated_at: 1704902350 + created_at: 1707476434 + updated_at: 1707476434 person_type: user schema: "$ref": "#/components/schemas/segment_list" @@ -7984,7 +8013,7 @@ paths: Unauthorized: value: type: error.list - request_id: 58b716c6-0fa3-4936-9f81-6a3837ef22da + request_id: 0c00eeb3-75a2-4ab6-af1d-972f13be415a errors: - code: unauthorized message: Access Token Invalid @@ -8018,10 +8047,10 @@ paths: Successful response: value: type: segment - id: 659ebecf6abd014d2275ac68 + id: 65c605d386ce64cb37830cb0 name: John segment - created_at: 1704902351 - updated_at: 1704902351 + created_at: 1707476435 + updated_at: 1707476435 person_type: user schema: "$ref": "#/components/schemas/segment" @@ -8033,7 +8062,7 @@ paths: Segment not found: value: type: error.list - request_id: c70f69ba-04af-4397-aad6-d2499d039cf5 + request_id: 73114545-d22c-4317-9472-c47b12868a49 errors: - code: not_found message: Resource Not Found @@ -8047,7 +8076,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9bbc3cfd-186d-4261-b8db-3e0e78ebf529 + request_id: 4c3ad1c8-b76c-46c2-9b19-2a04465864fe errors: - code: unauthorized message: Access Token Invalid @@ -8077,7 +8106,7 @@ paths: type: list data: - type: subscription - id: '134' + id: '91' state: live consent_type: opt_out default_translation: @@ -8100,7 +8129,7 @@ paths: Unauthorized: value: type: error.list - request_id: ca5068dd-322b-4b4a-82e5-3a51f3eb72e5 + request_id: da0a10bd-8b3c-43e5-a915-385510acd6a4 errors: - code: unauthorized message: Access Token Invalid @@ -8130,7 +8159,7 @@ paths: examples: successful: value: - url: http://via.intercom.io/msgr/36c5c4a5-5179-4939-bb60-617772a72baa + url: http://via.intercom.io/msgr/4c45a2d1-f763-42fe-bddc-29d7df2aa317 type: phone_call_redirect schema: "$ref": "#/components/schemas/phone_switch" @@ -8163,7 +8192,7 @@ paths: Unauthorized: value: type: error.list - request_id: f3d24edb-d37d-47c9-b31c-e077bdcc337a + request_id: ad561e1b-4ba3-4c05-8d0c-52234056b295 errors: - code: unauthorized message: Access Token Invalid @@ -8226,7 +8255,7 @@ paths: type: list data: - type: tag - id: '74' + id: '55' name: Manual tag 1 schema: "$ref": "#/components/schemas/tag_list" @@ -8238,7 +8267,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9dff0d23-f00d-484a-afbf-84217a6e534b + request_id: 5461cf30-a46a-4c03-b42b-8a9ea3262396 errors: - code: unauthorized message: Access Token Invalid @@ -8277,7 +8306,7 @@ paths: Action successful: value: type: tag - id: '77' + id: '58' name: test schema: "$ref": "#/components/schemas/tag" @@ -8289,7 +8318,7 @@ paths: Invalid parameters: value: type: error.list - request_id: de91a882-bcdf-4091-aee7-4a0d194a4bba + request_id: 28ba78e8-6760-4bc6-bf60-ad5dd0687b64 errors: - code: parameter_invalid message: invalid tag parameters @@ -8303,14 +8332,14 @@ paths: Company not found: value: type: error.list - request_id: 5537dcaf-f960-453a-9095-8d7e7ac06ee7 + request_id: 5ebb0f23-172f-4c86-8c0b-7e3cd92f4578 errors: - code: company_not_found message: Company Not Found User not found: value: type: error.list - request_id: c766b1f2-fdd9-47a4-8fc0-d4e1d7d7e985 + request_id: cdfbc7b1-72a4-462d-b54c-e4015de4f57e errors: - code: not_found message: User Not Found @@ -8324,7 +8353,7 @@ paths: Unauthorized: value: type: error.list - request_id: 6f06b092-0ab0-4f0a-b90f-516e4f973376 + request_id: 465a0090-0b57-4cc4-a394-05e1fd95ca53 errors: - code: unauthorized message: Access Token Invalid @@ -8390,7 +8419,7 @@ paths: Tag found: value: type: tag - id: '85' + id: '66' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -8402,7 +8431,7 @@ paths: Tag not found: value: type: error.list - request_id: bddd7bea-e5b3-4dd8-ade1-027e1677b8f0 + request_id: 2027ba64-8de1-41ca-af65-2b66bf1bced9 errors: - code: not_found message: Resource Not Found @@ -8416,7 +8445,7 @@ paths: Unauthorized: value: type: error.list - request_id: 192bff70-9676-432c-b61d-fd2a86e741f1 + request_id: b0940cdb-2932-4f76-9c28-c8c6ce5f932c errors: - code: unauthorized message: Access Token Invalid @@ -8452,7 +8481,7 @@ paths: Resource not found: value: type: error.list - request_id: adfccecf-2769-47cb-8ba3-ac32d39d7f5c + request_id: de813e3b-fcfa-41ee-b020-ccd63b296cae errors: - code: not_found message: Resource Not Found @@ -8466,7 +8495,7 @@ paths: Tag has dependent objects: value: type: error.list - request_id: 734a14d9-de2a-46f2-822b-db996bccbdaa + request_id: f35343a3-1e39-4174-add7-37024e60b148 errors: - code: tag_has_dependent_objects message: 'Unable to delete Tag with dependent objects. Segments: @@ -8481,7 +8510,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2da05771-3e0d-45f2-97e4-a279658694cc + request_id: 8309b696-7707-411f-8610-6bc068edc005 errors: - code: unauthorized message: Access Token Invalid @@ -8519,7 +8548,7 @@ paths: Unauthorized: value: type: error.list - request_id: eae07671-81a6-41a2-a48d-a44c8eea16cf + request_id: 9415adf4-7190-437c-9e6c-8bafe81d717f errors: - code: unauthorized message: Access Token Invalid @@ -8554,7 +8583,7 @@ paths: successful: value: type: team - id: '991267220' + id: '991267149' name: team 1 admin_ids: [] schema: @@ -8567,7 +8596,7 @@ paths: Team not found: value: type: error.list - request_id: 9d49b19c-8339-4edc-8b8e-eb49038035d2 + request_id: e88c29e8-6940-491e-b194-c8f07a29e504 errors: - code: team_not_found message: Team not found @@ -8581,7 +8610,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2179a27b-9a20-4928-b700-b6484f5c38ab + request_id: 66694041-cc8f-46ac-a117-43e80df744aa errors: - code: unauthorized message: Access Token Invalid @@ -8613,26 +8642,26 @@ paths: successful: value: type: visitor - id: 659ebf116abd014d2275ad82 + id: 65c605f186ce64cb37830cd4 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' phone: name: Gareth Bale - pseudonym: Lime Cat + pseudonym: Rose Cloud avatar: type: avatar - image_url: https://static.intercomassets.com/app/pseudonym_avatars_2019/lime-cat.png - app_id: this_is_an_id592_that_should_be_at_least_ + image_url: https://static.intercomassets.com/app/pseudonym_avatars_2019/rose-cloud.png + app_id: this_is_an_id609_that_should_be_at_least_ companies: type: company.list companies: [] location_data: {} last_request_at: - created_at: 1704902417 - remote_created_at: 1704902417 - signed_up_at: 1704902417 - updated_at: 1704902417 + created_at: 1707476465 + remote_created_at: 1707476465 + signed_up_at: 1707476465 + updated_at: 1707476466 session_count: 0 social_profiles: type: social_profile.list @@ -8665,7 +8694,7 @@ paths: visitor Not Found: value: type: error.list - request_id: 85aaf8aa-46fa-4dcc-95ad-fbb97b9b5e7f + request_id: '0490f74e-ce9b-4090-84d9-80f2b8a64313' errors: - code: not_found message: Visitor Not Found @@ -8679,7 +8708,7 @@ paths: Unauthorized: value: type: error.list - request_id: 81777aa9-9cdf-4033-9bb4-8657aeb849b1 + request_id: 82b79013-a003-465e-a0d1-050b854e3e14 errors: - code: unauthorized message: Access Token Invalid @@ -8694,7 +8723,7 @@ paths: successful: summary: successful value: - id: 659ebf116abd014d2275ad82 + id: 65c605f186ce64cb37830cd4 name: Gareth Bale visitor_not_found: summary: visitor Not Found @@ -8727,7 +8756,7 @@ paths: successful: value: type: visitor - id: 659ebf136abd014d2275ad88 + id: 65c605f386ce64cb37830cda user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' @@ -8737,16 +8766,16 @@ paths: avatar: type: avatar image_url: - app_id: this_is_an_id598_that_should_be_at_least_ + app_id: this_is_an_id615_that_should_be_at_least_ companies: type: company.list companies: [] location_data: {} last_request_at: - created_at: 1704902419 - remote_created_at: 1704902419 - signed_up_at: 1704902419 - updated_at: 1704902419 + created_at: 1707476467 + remote_created_at: 1707476467 + signed_up_at: 1707476467 + updated_at: 1707476467 session_count: 0 social_profiles: type: social_profile.list @@ -8779,7 +8808,7 @@ paths: Visitor not found: value: type: error.list - request_id: e55e6ab1-204e-495b-b6f2-3ad50e00aa1c + request_id: 70aa93e8-4fe8-4514-b33e-f1cd212223a6 errors: - code: not_found message: Visitor Not Found @@ -8793,7 +8822,7 @@ paths: Unauthorized: value: type: error.list - request_id: 7b040ea5-ff0f-441b-8a83-119f6cac5cd9 + request_id: f19f87de-21fd-4d2b-9655-b610e942d46e errors: - code: unauthorized message: Access Token Invalid @@ -8827,7 +8856,7 @@ paths: successful: value: type: visitor - id: 659ebf146abd014d2275ad8e + id: 65c605f586ce64cb37830ce0 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' @@ -8837,16 +8866,16 @@ paths: avatar: type: avatar image_url: - app_id: this_is_an_id604_that_should_be_at_least_ + app_id: this_is_an_id621_that_should_be_at_least_ companies: type: company.list companies: [] location_data: {} last_request_at: - created_at: 1704902420 - remote_created_at: 1704902420 - signed_up_at: 1704902420 - updated_at: 1704902420 + created_at: 1707476469 + remote_created_at: 1707476469 + signed_up_at: 1707476469 + updated_at: 1707476469 session_count: 0 social_profiles: type: social_profile.list @@ -8879,7 +8908,7 @@ paths: Visitor not found: value: type: error.list - request_id: a060e92d-bf93-440e-aa95-ce24bd1bd19e + request_id: d3e6652a-21f1-466a-b352-c0bc3831a2b9 errors: - code: not_found message: Visitor Not Found @@ -8893,7 +8922,7 @@ paths: Unauthorized: value: type: error.list - request_id: 7970295d-b57f-43f9-b4a7-b62e99d17bec + request_id: 66a11456-d2a0-4780-af83-6f5e7e5d01c7 errors: - code: unauthorized message: Access Token Invalid @@ -8926,7 +8955,7 @@ paths: successful: value: type: visitor - id: 659ebf166abd014d2275ad94 + id: 65c605f786ce64cb37830ce6 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' @@ -8936,16 +8965,16 @@ paths: avatar: type: avatar image_url: - app_id: this_is_an_id610_that_should_be_at_least_ + app_id: this_is_an_id627_that_should_be_at_least_ companies: type: company.list companies: [] location_data: {} last_request_at: - created_at: 1704902422 - remote_created_at: 1704902422 - signed_up_at: 1704902422 - updated_at: 1704902422 + created_at: 1707476471 + remote_created_at: 1707476471 + signed_up_at: 1707476471 + updated_at: 1707476471 session_count: 0 social_profiles: type: social_profile.list @@ -8978,7 +9007,7 @@ paths: Visitor Not Found: value: type: error.list - request_id: 2cd4d57b-25d7-4caa-adee-53babcf27438 + request_id: 1054c56c-96e1-4bdd-bb12-f2c5db9d1521 errors: - code: not_found message: User Not Found @@ -8992,7 +9021,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8bb1ea72-3aa0-4542-bd0c-a67d626d00b5 + request_id: e0d03da2-6971-49e4-95b4-99ac4cb0ab41 errors: - code: unauthorized message: Access Token Invalid @@ -9023,8 +9052,8 @@ paths: successful: value: type: contact - id: 659ebf176abd014d2275ad9b - workspace_id: this_is_an_id616_that_should_be_at_least_ + id: 65c605f886ce64cb37830ced + workspace_id: this_is_an_id633_that_should_be_at_least_ external_id: role: user email: foo@bar.com @@ -9038,9 +9067,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1704902423 - updated_at: 1704902424 - signed_up_at: 1704902423 + created_at: 1707476472 + updated_at: 1707476472 + signed_up_at: 1707476472 last_seen_at: last_replied_at: last_contacted_at: @@ -9074,31 +9103,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ebf176abd014d2275ad9b/tags" + url: "/contacts/65c605f886ce64cb37830ced/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ebf176abd014d2275ad9b/notes" + url: "/contacts/65c605f886ce64cb37830ced/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ebf176abd014d2275ad9b/companies" + url: "/contacts/65c605f886ce64cb37830ced/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ebf176abd014d2275ad9b/subscriptions" + url: "/contacts/65c605f886ce64cb37830ced/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ebf176abd014d2275ad9b/subscriptions" + url: "/contacts/65c605f886ce64cb37830ced/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -9117,7 +9146,7 @@ paths: Unauthorized: value: type: error.list - request_id: 3f2d3e00-b163-4326-aebe-df6dae6814c5 + request_id: 12af8915-c7d1-4fe9-ab53-dd57d9c09c4b errors: - code: unauthorized message: Access Token Invalid @@ -11656,6 +11685,10 @@ components: example: - option1 - option2 + messenger_writable: + type: boolean + description: Can this attribute be updated by the Messenger + example: false required: - name - model @@ -11683,7 +11716,8 @@ components: example: '314159' id: type: string - description: Your identifier for a lead or a user. + description: The unique identifier for the contact (lead or user) which + is given by Intercom. example: 8a88a590-e1c3-41e2-a502-e0649dbf721c email: type: string @@ -11999,6 +12033,8 @@ components: custom_object_instance: title: Custom Object Instance type: object + x-tags: + - Custom Object Instances nullable: true description: An instance of a Custom Object Type. properties: @@ -12119,6 +12155,10 @@ components: type: boolean description: Can this attribute be updated through API example: true + messenger_writable: + type: boolean + description: Can this attribute be updated by the Messenger + example: false ui_writable: type: boolean description: Can this attribute be updated in the UI @@ -14072,6 +14112,10 @@ components: example: - option1 - option2 + messenger_writable: + type: boolean + description: Can this attribute be updated by the Messenger + example: false update_section_request: description: You can update a Section type: object diff --git a/descriptions/2.8/api.intercom.io.yaml b/descriptions/2.8/api.intercom.io.yaml index fca43e6..afffd2f 100644 --- a/descriptions/2.8/api.intercom.io.yaml +++ b/descriptions/2.8/api.intercom.io.yaml @@ -37,7 +37,7 @@ paths: Successful response: value: type: admin - id: '991267306' + id: '991267243' email: admin1@email.com name: Ciaran1 Lee email_verified: true @@ -45,7 +45,7 @@ paths: type: app id_code: this_is_an_id1_that_should_be_at_least_40 name: MyApp 1 - created_at: 1704902439 + created_at: 1707476484 secure: false identity_verification: false timezone: America/Los_Angeles @@ -83,7 +83,7 @@ paths: Successful response: value: type: admin - id: '991267307' + id: '991267244' name: Ciaran2 Lee email: admin2@email.com away_mode_enabled: true @@ -100,7 +100,7 @@ paths: Admin not found: value: type: error.list - request_id: a8b928ff-6547-49ae-8293-cdd4dd433dde + request_id: c737ddc6-dcb3-4a3d-8c77-73e9597dd2da errors: - code: admin_not_found message: Admin for admin_id not found @@ -114,7 +114,7 @@ paths: Unauthorized: value: type: error.list - request_id: 035b6c27-eb89-45ac-80bf-f522e55422f3 + request_id: 29bed061-66de-47ba-870b-955469cc22fd errors: - code: unauthorized message: Access Token Invalid @@ -201,23 +201,10 @@ paths: per_page: 20 total_pages: 1 activity_logs: - - id: d00e320e-ca14-490a-94c5-9a37b32ca476 + - id: 1e0743a9-e15e-4386-9212-612d6337a904 performed_by: type: admin - id: '991267311' - email: admin5@email.com - ip: 127.0.0.1 - metadata: - before: before - after: after - created_at: 1704902443 - activity_type: app_name_change - activity_description: Ciaran5 Lee changed your app name from - before to after. - - id: 701dcdd8-0f98-4085-a7e5-c14fa3ddcbdd - performed_by: - type: admin - id: '991267311' + id: '991267248' email: admin5@email.com ip: 127.0.0.1 metadata: @@ -226,11 +213,24 @@ paths: title: Initial message title before: Initial message title after: Eventual message title - created_at: 1704902443 + created_at: 1707476490 activity_type: message_state_change activity_description: Ciaran5 Lee changed your Initial message title message from Initial message title to Eventual message title. + - id: 1e64dfcf-eff1-4821-a58c-ccd8d59bf1a8 + performed_by: + type: admin + id: '991267248' + email: admin5@email.com + ip: 127.0.0.1 + metadata: + before: before + after: after + created_at: 1707476490 + 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: dab333e2-224a-46b7-bd1a-7b7e8d774f39 + request_id: 4eb171f1-00fe-45d5-b47e-f3d219b0557a errors: - code: unauthorized message: Access Token Invalid @@ -271,7 +271,7 @@ paths: admins: - type: admin email: admin7@email.com - id: '991267314' + id: '991267250' name: Ciaran7 Lee away_mode_enabled: false away_mode_reassign: false @@ -287,7 +287,7 @@ paths: Unauthorized: value: type: error.list - request_id: e226c8a0-b386-4521-9470-39c3d87720c1 + request_id: 2d446122-1d81-40bb-b110-53b36b5ae60b errors: - code: unauthorized message: Access Token Invalid @@ -321,7 +321,7 @@ paths: Admin found: value: type: admin - id: '991267316' + id: '991267252' 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: b95b11cb-a58f-4529-b807-abc15c5b027c + request_id: 750ae59b-a2ac-4eb1-8a41-184fa7b6d73b errors: - code: admin_not_found message: Admin not found @@ -352,7 +352,7 @@ paths: Unauthorized: value: type: error.list - request_id: 1280b76b-74c3-49cb-9f3f-73458ab59110 + request_id: c15134e6-7d9c-437f-8020-3a33efd802e8 errors: - code: unauthorized message: Access Token Invalid @@ -390,20 +390,20 @@ paths: total_pages: 1 total_count: 1 data: - - id: '52' + - id: '76' type: article workspace_id: this_is_an_id22_that_should_be_at_least_4 - parent_id: 217 + parent_id: 206 parent_type: collection parent_ids: [] title: This is the article title description: '' body: '' - author_id: 991267319 + author_id: 991267255 state: published - created_at: 1704902448 - updated_at: 1704902448 - url: http://help-center.test/myapp-22/en/articles/52-this-is-the-article-title + created_at: 1707476494 + updated_at: 1707476494 + url: http://help-center.test/myapp-22/en/articles/76-this-is-the-article-title schema: "$ref": "#/components/schemas/article_list" '401': @@ -414,7 +414,7 @@ paths: Unauthorized: value: type: error.list - request_id: 82e58a3d-21f2-4e3a-b2b1-c8237ff1e361 + request_id: 922f9db1-7e9a-45e5-9428-b99f7ffca568 errors: - code: unauthorized message: Access Token Invalid @@ -439,10 +439,10 @@ paths: examples: article created: value: - id: '55' + id: '79' type: article workspace_id: this_is_an_id26_that_should_be_at_least_4 - parent_id: 219 + parent_id: 208 parent_type: collection parent_ids: [] statistics: @@ -456,11 +456,11 @@ paths: title: Thanks for everything description: Description of the Article body:Body of the Article
- author_id: 991267324 + author_id: 991267260 state: published - created_at: 1704902450 - updated_at: 1704902450 - url: http://help-center.test/myapp-26/en/articles/55-thanks-for-everything + created_at: 1707476496 + updated_at: 1707476496 + url: http://help-center.test/myapp-26/en/articles/79-thanks-for-everything schema: "$ref": "#/components/schemas/article" '400': @@ -471,7 +471,7 @@ paths: Bad Request: value: type: error.list - request_id: 995a9d24-9f03-466a-b8d9-656b30386f04 + request_id: d7709409-aac4-4770-9c35-cd3d7d3fc0a3 errors: - code: parameter_not_found message: author_id must be in the main body or default locale @@ -486,7 +486,7 @@ paths: Unauthorized: value: type: error.list - request_id: 92f4683a-d856-4294-80ce-c935ffa1f5d9 + request_id: 722a0086-903d-4f69-a9d9-06cc2359d409 errors: - code: unauthorized message: Access Token Invalid @@ -504,16 +504,16 @@ paths: title: Thanks for everything description: Description of the Article body: Body of the Article - author_id: 991267324 + author_id: 991267260 state: published - parent_id: 219 + parent_id: 208 parent_type: collection translated_content: fr: title: Merci pour tout description: Description de l'article body: Corps de l'article - author_id: 991267324 + author_id: 991267260 state: published bad_request: summary: Bad Request @@ -550,10 +550,10 @@ paths: examples: Article found: value: - id: '58' + id: '82' type: article workspace_id: this_is_an_id32_that_should_be_at_least_4 - parent_id: 222 + parent_id: 211 parent_type: collection parent_ids: [] statistics: @@ -567,11 +567,11 @@ paths: title: This is the article title description: '' body: '' - author_id: 991267329 + author_id: 991267265 state: published - created_at: 1704902451 - updated_at: 1704902451 - url: http://help-center.test/myapp-32/en/articles/58-this-is-the-article-title + created_at: 1707476498 + updated_at: 1707476498 + url: http://help-center.test/myapp-32/en/articles/82-this-is-the-article-title schema: "$ref": "#/components/schemas/article" '404': @@ -582,7 +582,7 @@ paths: Article not found: value: type: error.list - request_id: 9e203bf7-6835-4d01-8ace-daf59b2482df + request_id: '058fa66e-fb9f-4c81-84ff-df2e1e2d08c6' errors: - code: not_found message: Resource Not Found @@ -596,7 +596,7 @@ paths: Unauthorized: value: type: error.list - request_id: 1eafa422-d203-4f0f-9241-219ef5c4e7eb + request_id: ab317977-1cb4-45b6-a0f3-58149bff90e3 errors: - code: unauthorized message: Access Token Invalid @@ -629,10 +629,10 @@ paths: examples: successful: value: - id: '61' + id: '85' type: article workspace_id: this_is_an_id38_that_should_be_at_least_4 - parent_id: 225 + parent_id: 214 parent_type: collection parent_ids: [] statistics: @@ -646,11 +646,11 @@ paths: title: Christmas is here! description: '' body:New gifts in store for the jolly season
- author_id: 991267335 + author_id: 991267271 state: published - created_at: 1704902453 - updated_at: 1704902454 - url: http://help-center.test/myapp-38/en/articles/61-christmas-is-here + created_at: 1707476500 + updated_at: 1707476501 + url: http://help-center.test/myapp-38/en/articles/85-christmas-is-here schema: "$ref": "#/components/schemas/article" '404': @@ -661,7 +661,7 @@ paths: Article Not Found: value: type: error.list - request_id: 53ea4e06-053c-42b1-b3bb-729a634dd821 + request_id: c77088f9-3a39-41c8-955f-a02f6ee46652 errors: - code: not_found message: Resource Not Found @@ -675,7 +675,7 @@ paths: Unauthorized: value: type: error.list - request_id: d5704800-8588-4938-b192-15266a94160e + request_id: 50af8e5b-542f-4455-8544-eb3153e739a2 errors: - code: unauthorized message: Access Token Invalid @@ -723,7 +723,7 @@ paths: examples: successful: value: - id: '64' + id: '88' object: article deleted: true schema: @@ -736,7 +736,7 @@ paths: Article Not Found: value: type: error.list - request_id: 53f645c1-4940-4eb4-99c6-887944bcb5f0 + request_id: 6fb19166-95db-4183-b04a-00f1c91467b0 errors: - code: not_found message: Resource Not Found @@ -750,7 +750,7 @@ paths: Unauthorized: value: type: error.list - request_id: cd64499e-f75a-4af2-a64e-545cfba974e2 + request_id: 79eb9b0f-c25d-447e-89b8-824bc53b4c96 errors: - code: unauthorized message: Access Token Invalid @@ -783,16 +783,16 @@ paths: value: type: list data: - - id: '233' + - id: '222' workspace_id: this_is_an_id52_that_should_be_at_least_4 name: English collection title url: http://help-center.test/myapp-52/collection-17 order: 17 - created_at: 1704902459 - updated_at: 1704902459 + created_at: 1707476505 + updated_at: 1707476505 description: english collection description icon: bookmark - help_center_id: 125 + help_center_id: 137 type: collection total_count: 1 pages: @@ -810,7 +810,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9f3f69df-8dc5-4000-b589-39ba4e88df3a + request_id: a1fa64e0-31c2-4be8-8e88-265218f047fa errors: - code: unauthorized message: Access Token Invalid @@ -835,16 +835,16 @@ paths: examples: collection created: value: - id: '239' + id: '228' workspace_id: this_is_an_id56_that_should_be_at_least_4 name: Thanks for everything url: http://help-center.test/myapp-56/ order: 1 - created_at: 1704902460 - updated_at: 1704902460 + created_at: 1707476506 + updated_at: 1707476506 description: '' icon: book-bookmark - help_center_id: 127 + help_center_id: 139 type: collection schema: "$ref": "#/components/schemas/collection" @@ -856,7 +856,7 @@ paths: Bad Request: value: type: error.list - request_id: 3f88285f-3184-496d-8144-137691c56cf7 + request_id: 622b88f5-c5d2-43dc-989b-eeefd17d41b1 errors: - code: parameter_not_found message: Name is a required parameter. @@ -870,7 +870,7 @@ paths: Unauthorized: value: type: error.list - request_id: c5ae5569-651f-4f05-bcbc-c8bd594a4654 + request_id: 38153cef-cc7c-4a45-ba39-bb0d3d19c733 errors: - code: unauthorized message: Access Token Invalid @@ -918,16 +918,16 @@ paths: examples: Collection found: value: - id: '244' + id: '233' workspace_id: this_is_an_id62_that_should_be_at_least_4 name: English collection title url: http://help-center.test/myapp-62/collection-22 order: 22 - created_at: 1704902461 - updated_at: 1704902461 + created_at: 1707476508 + updated_at: 1707476508 description: english collection description icon: bookmark - help_center_id: 130 + help_center_id: 142 type: collection schema: "$ref": "#/components/schemas/collection" @@ -939,7 +939,7 @@ paths: Collection not found: value: type: error.list - request_id: d07d25f1-0c54-46d0-a4f9-3112138726aa + request_id: a683e569-a8bd-4fd8-a01f-920c821c5ee4 errors: - code: not_found message: Resource Not Found @@ -953,7 +953,7 @@ paths: Unauthorized: value: type: error.list - request_id: b80a0687-5ac0-4cf2-bac5-f1ad2d5a3ca2 + request_id: ffffd35e-3108-46c7-9b72-e43bca677a25 errors: - code: unauthorized message: Access Token Invalid @@ -986,16 +986,16 @@ paths: examples: successful: value: - id: '250' + id: '239' workspace_id: this_is_an_id68_that_should_be_at_least_4 name: Update collection name url: http://help-center.test/myapp-68/collection-25 order: 25 - created_at: 1704902462 - updated_at: 1704902463 + created_at: 1707476509 + updated_at: 1707476509 description: english collection description icon: folder - help_center_id: 133 + help_center_id: 145 type: collection schema: "$ref": "#/components/schemas/collection" @@ -1007,7 +1007,7 @@ paths: Collection Not Found: value: type: error.list - request_id: 33aebf5d-5388-4ac9-9a0c-97d9edf5d26a + request_id: 052ba5cf-0472-4c03-8f12-aabc360bbaf8 errors: - code: not_found message: Resource Not Found @@ -1021,7 +1021,7 @@ paths: Unauthorized: value: type: error.list - request_id: db9b5ec8-7ef7-4366-a4d1-3eaf73039ad7 + request_id: 7aebaa94-90a9-4692-9ac0-dddc76a9784e errors: - code: unauthorized message: Access Token Invalid @@ -1068,7 +1068,7 @@ paths: examples: successful: value: - id: '256' + id: '245' object: collection deleted: true schema: @@ -1081,7 +1081,7 @@ paths: collection Not Found: value: type: error.list - request_id: e0d5d497-3e16-4f4e-99f4-d61ddf0e0c60 + request_id: 68f566f0-6ac9-4746-afbd-bbfe2bde5222 errors: - code: not_found message: Resource Not Found @@ -1095,7 +1095,7 @@ paths: Unauthorized: value: type: error.list - request_id: 5aaa5dfc-19dc-42fa-b7c6-149d6f660173 + request_id: 2d470b07-b0d3-4211-b7b2-ad0014622b45 errors: - code: unauthorized message: Access Token Invalid @@ -1129,10 +1129,10 @@ paths: examples: Collection found: value: - id: '139' + id: '151' workspace_id: this_is_an_id80_that_should_be_at_least_4 - created_at: 1704902465 - updated_at: 1704902465 + created_at: 1707476512 + updated_at: 1707476512 identifier: help-center-1 website_turned_on: false display_name: Intercom Help Center @@ -1146,7 +1146,7 @@ paths: Collection not found: value: type: error.list - request_id: 8e141b0d-118b-41c1-aab6-7a6382e33bc2 + request_id: 27a59c52-2da6-45dd-b4bc-d740b9d78c8d errors: - code: not_found message: Resource Not Found @@ -1160,7 +1160,7 @@ paths: Unauthorized: value: type: error.list - request_id: daf41963-fde0-4901-a14d-0671c276d6bd + request_id: 4cbfd58f-cb48-44e9-8df0-0850c0c1e03e errors: - code: unauthorized message: Access Token Invalid @@ -1198,7 +1198,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2623b1ba-74ac-44d0-a9ae-44074f9f120e + request_id: ca488d57-b826-46c8-a5a0-32537300ef38 errors: - code: unauthorized message: Access Token Invalid @@ -1230,15 +1230,15 @@ paths: value: type: list data: - - id: '263' + - id: '252' workspace_id: this_is_an_id90_that_should_be_at_least_4 name: English section title url: http://help-center.test/myapp-90/section-15 order: 15 - created_at: 1704902467 - updated_at: 1704902467 + created_at: 1707476514 + updated_at: 1707476514 type: section - parent_id: 262 + parent_id: 251 total_count: 1 pages: type: pages @@ -1255,7 +1255,7 @@ paths: Unauthorized: value: type: error.list - request_id: c73a5e16-1362-4d54-90bd-4528e54747a2 + request_id: 4eaa84f7-75a7-4488-8cc4-673eeb3d7a3c errors: - code: unauthorized message: Access Token Invalid @@ -1280,15 +1280,15 @@ paths: examples: section created: value: - id: '268' + id: '257' workspace_id: this_is_an_id94_that_should_be_at_least_4 name: Thanks for everything url: http://help-center.test/myapp-94/ order: 1 - created_at: 1704902468 - updated_at: 1704902468 + created_at: 1707476516 + updated_at: 1707476516 type: section - parent_id: '266' + parent_id: '255' schema: "$ref": "#/components/schemas/section" '401': @@ -1299,7 +1299,7 @@ paths: Unauthorized: value: type: error.list - request_id: 872c1d19-6357-4466-b1c7-d5334393af9b + request_id: c32a15db-9ec6-4ad0-9f8c-005f6d8bd627 errors: - code: unauthorized message: Access Token Invalid @@ -1315,7 +1315,7 @@ paths: summary: section created value: name: Thanks for everything - parent_id: 266 + parent_id: 255 "/help_center/sections/{id}": get: summary: Retrieve a section @@ -1344,15 +1344,15 @@ paths: examples: Section found: value: - id: '272' + id: '261' workspace_id: this_is_an_id98_that_should_be_at_least_4 name: English section title url: http://help-center.test/myapp-98/section-19 order: 19 - created_at: 1704902468 - updated_at: 1704902468 + created_at: 1707476516 + updated_at: 1707476516 type: section - parent_id: 271 + parent_id: 260 schema: "$ref": "#/components/schemas/section" '404': @@ -1363,7 +1363,7 @@ paths: Section not found: value: type: error.list - request_id: a7097f21-cdb4-4e6e-b34f-9d139bed20e3 + request_id: a7bd3fa6-1723-47f6-822b-4f54410aa6a2 errors: - code: not_found message: Resource Not Found @@ -1377,7 +1377,7 @@ paths: Unauthorized: value: type: error.list - request_id: 4e607466-cbc2-4124-a8e2-dfadc08441ec + request_id: e45b55e8-e1e0-41d4-b259-de93bfc39da7 errors: - code: unauthorized message: Access Token Invalid @@ -1410,15 +1410,15 @@ paths: examples: successful: value: - id: '278' + id: '267' workspace_id: this_is_an_id104_that_should_be_at_least_ name: Update section name url: http://help-center.test/myapp-104/section-22 order: 22 - created_at: 1704902469 - updated_at: 1704902470 + created_at: 1707476517 + updated_at: 1707476517 type: section - parent_id: '277' + parent_id: '266' schema: "$ref": "#/components/schemas/section" '404': @@ -1429,7 +1429,7 @@ paths: Section Not Found: value: type: error.list - request_id: 4ca094f1-ea6f-4a33-96b5-24cf79177625 + request_id: 6fa1010b-0fbe-45bf-a8e6-0098a90a32cb errors: - code: not_found message: Resource Not Found @@ -1443,7 +1443,7 @@ paths: Unauthorized: value: type: error.list - request_id: 51cb963b-23a1-42eb-b7e0-1b68afc81a05 + request_id: c924b340-e0f8-4e89-91e4-0bb1f55f33f6 errors: - code: unauthorized message: Access Token Invalid @@ -1459,12 +1459,12 @@ paths: summary: successful value: name: Update section name - parent_id: 277 + parent_id: 266 section_not_found: summary: Section Not Found value: name: Update section name - parent_id: 279 + parent_id: 268 delete: summary: Delete a section parameters: @@ -1491,7 +1491,7 @@ paths: examples: successful: value: - id: '284' + id: '273' object: section deleted: true schema: @@ -1504,7 +1504,7 @@ paths: section Not Found: value: type: error.list - request_id: 67de3a95-ec6e-4e56-a381-5cd5596fe13e + request_id: 7a964684-5204-48f6-8bf4-f343149a42bc errors: - code: not_found message: Resource Not Found @@ -1518,7 +1518,7 @@ paths: Unauthorized: value: type: error.list - request_id: 5f02815e-88f5-449a-97e7-c42dd896fb95 + request_id: 05c538a8-6022-4e87-abb9-be5cffd19f4a errors: - code: unauthorized message: Access Token Invalid @@ -1551,12 +1551,12 @@ paths: value: type: company company_id: company_remote_id - id: 659ebf4b6abd014ef26e4c0d - app_id: this_is_an_id119_that_should_be_at_least_ + id: 65c6062986ce64ccb655f0c5 + app_id: this_is_an_id116_that_should_be_at_least_ name: my company remote_created_at: 1374138000 - created_at: 1704902475 - updated_at: 1704902475 + created_at: 1707476521 + updated_at: 1707476521 monthly_spend: 0 session_count: 0 user_count: 0 @@ -1593,7 +1593,7 @@ paths: Unauthorized: value: type: error.list - request_id: abc236c2-2602-4a34-b4ce-fa5758995e8d + request_id: 8a722c0c-f2f8-45f4-87e5-f7aa30cc400a errors: - code: unauthorized message: Access Token Invalid @@ -1667,11 +1667,18 @@ paths: tags: - Companies operationId: retrieveCompany - description: "You can fetch a single company by passing in `company_id` or `name`.\n\n - \ `https://api.intercom.io/companies?name={name}`\n\n `https://api.intercom.io/companies?company_id={company_id}`\n\nYou - can fetch all companies and filter by `segment_id` or `tag_id` as a query - parameter.\n \n `https://api.intercom.io/companies?tag_id={tag_id}`\n\n - \ `https://api.intercom.io/companies?segment_id={segment_id}`\n" + description: | + You can fetch a single company by passing in `company_id` or `name`. + + `https://api.intercom.io/companies?name={name}` + + `https://api.intercom.io/companies?company_id={company_id}` + + You can fetch all companies and filter by `segment_id` or `tag_id` as a query parameter. + + `https://api.intercom.io/companies?tag_id={tag_id}` + + `https://api.intercom.io/companies?segment_id={segment_id}` responses: '200': description: Successful @@ -1684,12 +1691,12 @@ paths: data: - type: company company_id: remote_companies_scroll_2 - id: 659ebf4d6abd014ef26e4c15 - app_id: this_is_an_id125_that_should_be_at_least_ + id: 65c6062b86ce64ccb655f0cd + app_id: this_is_an_id122_that_should_be_at_least_ name: IntercomQATest1 - remote_created_at: 1704902477 - created_at: 1704902477 - updated_at: 1704902477 + remote_created_at: 1707476523 + created_at: 1707476523 + updated_at: 1707476523 monthly_spend: 0 session_count: 0 user_count: 4 @@ -1718,7 +1725,7 @@ paths: Company Not Found: value: type: error.list - request_id: bf36c73e-ff92-480c-826f-228a2981b3be + request_id: 1c2be436-0c05-4a5c-b485-3ea0e6a2bc69 errors: - code: company_not_found message: Company Not Found @@ -1732,7 +1739,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0d8eb266-6363-4e28-8928-7cbe81946c01 + request_id: 838e6034-2695-4d01-9063-7089b76e24f6 errors: - code: unauthorized message: Access Token Invalid @@ -1767,12 +1774,12 @@ paths: value: type: company company_id: '1' - id: 659ebf4f6abd014ef26e4c20 - app_id: this_is_an_id131_that_should_be_at_least_ - name: company2 - remote_created_at: 1704902479 - created_at: 1704902479 - updated_at: 1704902479 + id: 65c6062d86ce64ccb655f0d8 + app_id: this_is_an_id128_that_should_be_at_least_ + name: company1 + remote_created_at: 1707476525 + created_at: 1707476525 + updated_at: 1707476525 monthly_spend: 0 session_count: 0 user_count: 1 @@ -1794,7 +1801,7 @@ paths: Company Not Found: value: type: error.list - request_id: 66aea7f9-7f67-40f2-abfb-e67955662b4b + request_id: 2c0ddd25-bc4d-4c95-ae7a-f15b8b753f28 errors: - code: company_not_found message: Company Not Found @@ -1808,7 +1815,7 @@ paths: Unauthorized: value: type: error.list - request_id: ebc3c785-b6af-4d73-bc3f-36968905430d + request_id: 78396832-f098-4798-ab89-da1e888bbfc8 errors: - code: unauthorized message: Access Token Invalid @@ -1842,12 +1849,12 @@ paths: value: type: company company_id: '1' - id: 659ebf506abd014ef26e4c2a - app_id: this_is_an_id137_that_should_be_at_least_ - name: company3 - remote_created_at: 1704902480 - created_at: 1704902480 - updated_at: 1704902480 + id: 65c6062f86ce64ccb655f0e2 + app_id: this_is_an_id134_that_should_be_at_least_ + name: company2 + remote_created_at: 1707476527 + created_at: 1707476527 + updated_at: 1707476527 monthly_spend: 0 session_count: 0 user_count: 1 @@ -1869,7 +1876,7 @@ paths: Company Not Found: value: type: error.list - request_id: cefa5d6d-4326-42c6-be35-b2f40eb9fa41 + request_id: 23cf4119-645a-4f55-8802-9c827ab3ea30 errors: - code: company_not_found message: Company Not Found @@ -1883,7 +1890,7 @@ paths: Unauthorized: value: type: error.list - request_id: 142ff94f-ad85-425c-8cb0-e39760a7f996 + request_id: 674e09e6-8180-40c0-8402-d99b93269538 errors: - code: unauthorized message: Access Token Invalid @@ -1915,7 +1922,7 @@ paths: examples: Successful: value: - id: 659ebf526abd014ef26e4c34 + id: 65c6063186ce64ccb655f0ec object: company deleted: true schema: @@ -1928,7 +1935,7 @@ paths: Company Not Found: value: type: error.list - request_id: 5f6477c9-90a6-444c-bfb7-a269582e6201 + request_id: 79f64462-6adb-42d9-b783-40ec8ae25502 errors: - code: company_not_found message: Company Not Found @@ -1942,7 +1949,7 @@ paths: Unauthorized: value: type: error.list - request_id: afb98fa9-81cb-4a6f-a903-08bb07d2db6e + request_id: 4f85943c-12bd-4949-937b-00690cdbc5c8 errors: - code: unauthorized message: Access Token Invalid @@ -1994,7 +2001,7 @@ paths: Company Not Found: value: type: error.list - request_id: 7167f29f-4e22-4b17-ad3c-35b38d0da775 + request_id: d0117eaa-1163-4336-b594-7efb304e927d errors: - code: company_not_found message: Company Not Found @@ -2008,7 +2015,7 @@ paths: Unauthorized: value: type: error.list - request_id: 4ce575b6-527a-4219-9263-0620b9cf09af + request_id: 40373b16-6f91-4918-83c2-fa1481f51045 errors: - code: unauthorized message: Access Token Invalid @@ -2053,7 +2060,7 @@ paths: Company Not Found: value: type: error.list - request_id: fec17f25-a713-407b-9b0d-b2bb5322598c + request_id: 2993fc60-d3fc-4a84-8f24-816509a207c1 errors: - code: company_not_found message: Company Not Found @@ -2067,7 +2074,7 @@ paths: Unauthorized: value: type: error.list - request_id: 1e86a5a8-507c-42ad-bace-17bdc3590539 + request_id: ffa92999-3cbc-4d1e-8062-f25e6e50bf4f errors: - code: unauthorized message: Access Token Invalid @@ -2124,12 +2131,12 @@ paths: data: - type: company company_id: remote_companies_scroll_2 - id: 659ebf576abd014ef26e4c50 - app_id: this_is_an_id161_that_should_be_at_least_ + id: 65c6063986ce64ccb655f108 + app_id: this_is_an_id158_that_should_be_at_least_ name: IntercomQATest1 - remote_created_at: 1704902487 - created_at: 1704902487 - updated_at: 1704902487 + remote_created_at: 1707476537 + created_at: 1707476537 + updated_at: 1707476537 monthly_spend: 0 session_count: 0 user_count: 4 @@ -2158,7 +2165,7 @@ paths: Unauthorized: value: type: error.list - request_id: a1c618d2-9944-4f92-a410-5154ae26ae5d + request_id: a30c3ced-1471-4249-a01f-7c8d2738db66 errors: - code: unauthorized message: Access Token Invalid @@ -2210,12 +2217,12 @@ paths: data: - type: company company_id: remote_companies_scroll_2 - id: 659ebf586abd014ef26e4c56 - app_id: this_is_an_id165_that_should_be_at_least_ + id: 65c6063a86ce64ccb655f10e + app_id: this_is_an_id162_that_should_be_at_least_ name: IntercomQATest1 - remote_created_at: 1704902488 - created_at: 1704902488 - updated_at: 1704902488 + remote_created_at: 1707476538 + created_at: 1707476538 + updated_at: 1707476538 monthly_spend: 0 session_count: 0 user_count: 4 @@ -2229,7 +2236,7 @@ paths: custom_attributes: {} pages: total_count: - scroll_param: 3fd171c5-b575-4a2e-badc-be356cd6e134 + scroll_param: 428aace3-90ac-4d8b-b954-0e95e1778e95 schema: "$ref": "#/components/schemas/company_scroll" '401': @@ -2240,7 +2247,7 @@ paths: Unauthorized: value: type: error.list - request_id: 501e4cee-6769-4156-a8f8-b9543d0bdf65 + request_id: 90c407b9-9918-49e9-a9bb-5e12bc19b97c errors: - code: unauthorized message: Access Token Invalid @@ -2275,12 +2282,12 @@ paths: value: type: company company_id: '1' - id: 659ebf5a6abd014ef26e4c5f - app_id: this_is_an_id169_that_should_be_at_least_ - name: company7 - remote_created_at: 1704902490 - created_at: 1704902490 - updated_at: 1704902490 + id: 65c6063c86ce64ccb655f117 + app_id: this_is_an_id166_that_should_be_at_least_ + name: company6 + remote_created_at: 1707476540 + created_at: 1707476540 + updated_at: 1707476540 monthly_spend: 0 session_count: 0 user_count: 1 @@ -2294,6 +2301,20 @@ paths: custom_attributes: {} schema: "$ref": "#/components/schemas/company" + '400': + description: Bad Request + content: + application/json: + examples: + Bad Request: + value: + type: error.list + request_id: b574ffab-6a20-4851-8f4c-f35f9cf14359 + errors: + - code: parameter_not_found + message: company not specified + schema: + "$ref": "#/components/schemas/error" '404': description: Company Not Found content: @@ -2302,10 +2323,10 @@ paths: Company Not Found: value: type: error.list - request_id: ffdd7fee-aa3a-4235-bd98-811f30d8ecbc + request_id: 94185d0b-2e1f-4921-bdf5-0198371a9c43 errors: - - code: not_found - message: User Not Found + - code: company_not_found + message: Company Not Found schema: "$ref": "#/components/schemas/error" '401': @@ -2316,7 +2337,7 @@ paths: Unauthorized: value: type: error.list - request_id: d8d024de-dfd7-48f8-9267-cd58ef7f905b + request_id: a4c76829-8dc2-4741-a137-2c2b4ab569d0 errors: - code: unauthorized message: Access Token Invalid @@ -2339,11 +2360,14 @@ paths: successful: summary: Successful value: - id: 659ebf5a6abd014ef26e4c5f + id: 65c6063c86ce64ccb655f117 + bad_request: + summary: Bad Request + value: company_not_found: summary: Company Not Found value: - id: 659ebf5a6abd014ef26e4c63 + id: '123' get: summary: List attached companies for contact parameters: @@ -2375,13 +2399,13 @@ paths: data: - type: company company_id: '1' - id: 659ebf646abd014ef26e4c91 - app_id: this_is_an_id183_that_should_be_at_least_ - name: company23 - remote_created_at: 1704902500 - created_at: 1704902500 - updated_at: 1704902500 - last_request_at: 1704729700 + id: 65c6064186ce64ccb655f138 + app_id: this_is_an_id182_that_should_be_at_least_ + name: company12 + remote_created_at: 1707476545 + created_at: 1707476545 + updated_at: 1707476545 + last_request_at: 1707303745 monthly_spend: 0 session_count: 0 user_count: 1 @@ -2410,7 +2434,7 @@ paths: Contact not found: value: type: error.list - request_id: df1d4dab-e8c0-4182-93e7-b5466258af21 + request_id: a032edbb-0c60-4813-897b-bbc80e45905d errors: - code: not_found message: User Not Found @@ -2424,7 +2448,7 @@ paths: Unauthorized: value: type: error.list - request_id: ff1e08c7-b814-4274-a49a-353ac23de3d9 + request_id: 9300fdb8-c084-4bd2-ab29-6fb139b2b982 errors: - code: unauthorized message: Access Token Invalid @@ -2467,12 +2491,12 @@ paths: value: type: company company_id: '1' - id: 659ebf5b6abd014ef26e4c6b - app_id: this_is_an_id175_that_should_be_at_least_ - name: company10 - remote_created_at: 1704902491 - created_at: 1704902491 - updated_at: 1704902492 + id: 65c6063f86ce64ccb655f127 + app_id: this_is_an_id174_that_should_be_at_least_ + name: company8 + remote_created_at: 1707476543 + created_at: 1707476543 + updated_at: 1707476543 monthly_spend: 0 session_count: 0 user_count: 0 @@ -2494,14 +2518,14 @@ paths: Company Not Found: value: type: error.list - request_id: c585132d-e60d-4797-8334-3059f47b9d3d + request_id: 8fbde6bf-c495-498c-8028-65d38b645a8c errors: - code: company_not_found message: Company Not Found Contact Not Found: value: type: error.list - request_id: 4ab55d95-b227-4ba1-b58e-56f97836f161 + request_id: 0eb0499a-a950-44da-9134-9d25b9a7d5f0 errors: - code: not_found message: User Not Found @@ -2515,7 +2539,7 @@ paths: Unauthorized: value: type: error.list - request_id: d8f49e87-c220-499b-880c-5da64a596fc1 + request_id: 7c54ef65-0701-4324-b8aa-2d25e61fcfeb errors: - code: unauthorized message: Access Token Invalid @@ -2551,44 +2575,44 @@ paths: type: list data: - type: note - id: '59' - created_at: 1704297703 + id: '29' + created_at: 1706871748 contact: type: contact - id: 659ebf676abd014ef26e4c9c + id: 65c6064486ce64ccb655f143 author: type: admin - id: '991267416' - name: Ciaran109 Lee - email: admin109@email.com + id: '991267353' + name: Ciaran110 Lee + email: admin110@email.com away_mode_enabled: false away_mode_reassign: false body: "This is a note.
" - type: note - id: '58' - created_at: 1704211303 + id: '28' + created_at: 1706785348 contact: type: contact - id: 659ebf676abd014ef26e4c9c + id: 65c6064486ce64ccb655f143 author: type: admin - id: '991267416' - name: Ciaran109 Lee - email: admin109@email.com + id: '991267353' + name: Ciaran110 Lee + email: admin110@email.com away_mode_enabled: false away_mode_reassign: false body: "This is a note.
" - type: note - id: '57' - created_at: 1704211303 + id: '27' + created_at: 1706785348 contact: type: contact - id: 659ebf676abd014ef26e4c9c + id: 65c6064486ce64ccb655f143 author: type: admin - id: '991267416' - name: Ciaran109 Lee - email: admin109@email.com + id: '991267353' + name: Ciaran110 Lee + email: admin110@email.com away_mode_enabled: false away_mode_reassign: false body: "This is a note.
" @@ -2609,7 +2633,7 @@ paths: Contact not found: value: type: error.list - request_id: c8fd2ec6-f9d4-40f6-b36c-41e1d1d1fa18 + request_id: e17e2d66-5636-4e1b-a91e-307f6537b78b errors: - code: not_found message: User Not Found @@ -2643,16 +2667,16 @@ paths: Successful response: value: type: note - id: '64' - created_at: 1704902504 + id: '34' + created_at: 1707476549 contact: type: contact - id: 659ebf686abd014ef26e4c9e + id: 65c6064586ce64ccb655f145 author: type: admin - id: '991267418' - name: Ciaran111 Lee - email: admin111@email.com + id: '991267355' + name: Ciaran112 Lee + email: admin112@email.com away_mode_enabled: false away_mode_reassign: false body: "Hello
" @@ -2666,14 +2690,14 @@ paths: Admin not found: value: type: error.list - request_id: 4ce24e7d-27d1-4ad7-85ef-a51838b70583 + request_id: 2cd7eaef-f12f-4757-971d-6042ddf96379 errors: - code: not_found message: Resource Not Found Contact not found: value: type: error.list - request_id: 37b8884d-cc01-40f7-8612-5455df4efa96 + request_id: 1b874dcf-5a0b-405b-9530-8153466d5726 errors: - code: not_found message: User Not Found @@ -2703,20 +2727,20 @@ paths: successful_response: summary: Successful response value: - contact_id: 659ebf686abd014ef26e4c9e - admin_id: 991267418 + contact_id: 65c6064586ce64ccb655f145 + admin_id: 991267355 body: Hello admin_not_found: summary: Admin not found value: - contact_id: 659ebf686abd014ef26e4c9f + contact_id: 65c6064586ce64ccb655f146 admin_id: 123 body: Hello contact_not_found: summary: Contact not found value: contact_id: 123 - admin_id: 991267420 + admin_id: 991267357 body: Hello "/contacts/{contact_id}/segments": get: @@ -2749,10 +2773,10 @@ paths: type: list data: - type: segment - id: 659ebf696abd014ef26e4ca1 + id: 65c6064786ce64ccb655f148 name: segment - created_at: 1704902505 - updated_at: 1704902505 + created_at: 1707476551 + updated_at: 1707476551 person_type: user schema: "$ref": "#/components/schemas/contact_segments" @@ -2764,7 +2788,7 @@ paths: Contact not found: value: type: error.list - request_id: 3b273c92-e4c1-42eb-a06e-339f65867aa7 + request_id: ce845a66-d706-4079-8c88-8d70a91f5aac errors: - code: not_found message: User Not Found @@ -2778,7 +2802,7 @@ paths: Unauthorized: value: type: error.list - request_id: 380623e3-9219-446b-aabc-8d3d6897f091 + request_id: b5fb6c1b-f980-4df3-bb9e-a65eefd3a71c errors: - code: unauthorized message: Access Token Invalid @@ -2822,7 +2846,7 @@ paths: type: list data: - type: subscription - id: '136' + id: '93' state: live consent_type: opt_out default_translation: @@ -2836,7 +2860,7 @@ paths: content_types: - email - type: subscription - id: '138' + id: '95' state: live consent_type: opt_in default_translation: @@ -2859,7 +2883,7 @@ paths: Contact not found: value: type: error.list - request_id: 105e9f42-7108-4546-aa01-5a0e3ab57472 + request_id: bbf805bd-a2e8-4453-90ae-da1d0fb07fd7 errors: - code: not_found message: User Not Found @@ -2873,7 +2897,7 @@ paths: Unauthorized: value: type: error.list - request_id: e68af583-ecdb-4f93-a8e6-5983a0b2f4f1 + request_id: a0d4dfa9-7487-47d0-b105-12310d728b5e errors: - code: unauthorized message: Access Token Invalid @@ -2914,7 +2938,7 @@ paths: Successful: value: type: subscription - id: '151' + id: '108' state: live consent_type: opt_in default_translation: @@ -2937,14 +2961,14 @@ paths: Contact not found: value: type: error.list - request_id: 065d6227-af09-4550-a914-6f788de1fef3 + request_id: 3a443288-37fe-44e1-9da7-a637066c294d errors: - code: not_found message: User Not Found Resource not found: value: type: error.list - request_id: 14a73ae4-0902-4e2d-98f4-de43dffe4766 + request_id: 1ce7264c-3180-4f69-b509-97531ab7649f errors: - code: not_found message: Resource Not Found @@ -2958,7 +2982,7 @@ paths: Unauthorized: value: type: error.list - request_id: 3ff1342f-f1a6-4c29-a295-e9af68d8a83c + request_id: 5a5ac5aa-8f47-4d03-87e5-b0f641f518dd errors: - code: unauthorized message: Access Token Invalid @@ -2986,12 +3010,12 @@ paths: successful: summary: Successful value: - id: 151 + id: 108 consent_type: opt_in contact_not_found: summary: Contact not found value: - id: 155 + id: 112 consent_type: opt_in resource_not_found: summary: Resource not found @@ -3037,7 +3061,7 @@ paths: Successful: value: type: subscription - id: '167' + id: '124' state: live consent_type: opt_in default_translation: @@ -3060,14 +3084,14 @@ paths: Contact not found: value: type: error.list - request_id: 32f22ebc-999e-4475-ba9d-060a679098ed + request_id: 82bf481c-a55f-42c8-bdf0-f8c19e1812e3 errors: - code: not_found message: User Not Found Resource not found: value: type: error.list - request_id: 02ad6b19-9c4e-4ca8-b128-a117b2f863a3 + request_id: 10e59e4c-1051-4bda-af7a-ef01741cfac5 errors: - code: not_found message: Resource Not Found @@ -3081,7 +3105,7 @@ paths: Unauthorized: value: type: error.list - request_id: 47f1d473-7d4c-48c8-83c2-2925eba3b03f + request_id: 8cfcf6b2-2c55-465c-a18e-2c17da7719ed errors: - code: unauthorized message: Access Token Invalid @@ -3119,7 +3143,7 @@ paths: type: list data: - type: tag - id: '97' + id: '74' name: Manual tag schema: "$ref": "#/components/schemas/tag_list" @@ -3131,7 +3155,7 @@ paths: Contact not found: value: type: error.list - request_id: 1364243c-45c2-4919-891b-0dcdcf1fd4ee + request_id: 4c350196-ad45-44cd-8ebd-252848850bc3 errors: - code: not_found message: User Not Found @@ -3145,7 +3169,7 @@ paths: Unauthorized: value: type: error.list - request_id: 687ce275-4d5e-4ac2-814e-0e8d48c98078 + request_id: 8629af56-0cd2-47e9-a1a5-0c22472dc110 errors: - code: unauthorized message: Access Token Invalid @@ -3180,7 +3204,7 @@ paths: successful: value: type: tag - id: '98' + id: '75' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -3192,14 +3216,14 @@ paths: Contact not found: value: type: error.list - request_id: 492afa81-01eb-4e9b-8aab-0ab186998461 + request_id: 3ad0609d-9299-495c-8827-398e91eb29d8 errors: - code: not_found message: User Not Found Tag not found: value: type: error.list - request_id: 2d7ca1b0-d3fe-45ce-aa8c-a61e8960edd7 + request_id: '09addc02-9baf-41e3-af99-050c51a9733c' errors: - code: not_found message: Resource Not Found @@ -3213,7 +3237,7 @@ paths: Unauthorized: value: type: error.list - request_id: ddf3580c-f0db-4e1f-a1f3-e9072b5c0771 + request_id: 29b149ae-d6ad-418c-a23e-5d92ba0105b9 errors: - code: unauthorized message: Access Token Invalid @@ -3236,11 +3260,11 @@ paths: successful: summary: successful value: - id: 98 + id: 75 contact_not_found: summary: Contact not found value: - id: 99 + id: 76 tag_not_found: summary: Tag not found value: @@ -3282,7 +3306,7 @@ paths: successful: value: type: tag - id: '101' + id: '78' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -3294,14 +3318,14 @@ paths: Contact not found: value: type: error.list - request_id: 3920759c-10ca-4dd5-a604-0b5548a8a5d1 + request_id: 3926050b-58a5-4ed7-84b6-0b4b44f5eac3 errors: - code: not_found message: User Not Found Tag not found: value: type: error.list - request_id: 70c17887-69a7-4c26-8995-6acffb381d5d + request_id: ccda6d3a-db2e-4da7-b365-9684298d6c95 errors: - code: not_found message: Resource Not Found @@ -3315,7 +3339,7 @@ paths: Unauthorized: value: type: error.list - request_id: 541fe9d7-e762-410b-8069-5b8303787407 + request_id: aae60daf-562f-4cef-868f-e48410f80475 errors: - code: unauthorized message: Access Token Invalid @@ -3349,8 +3373,8 @@ paths: successful: value: type: contact - id: 659ebf756abd014ef26e4cb8 - workspace_id: this_is_an_id249_that_should_be_at_least_ + id: 65c6065386ce64ccb655f15f + workspace_id: this_is_an_id248_that_should_be_at_least_ external_id: '70' role: user email: joebloggs@intercom.io @@ -3364,9 +3388,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1704902517 - updated_at: 1704902517 - signed_up_at: 1704902517 + created_at: 1707476563 + updated_at: 1707476564 + signed_up_at: 1707476563 last_seen_at: last_replied_at: last_contacted_at: @@ -3400,31 +3424,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ebf756abd014ef26e4cb8/tags" + url: "/contacts/65c6065386ce64ccb655f15f/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ebf756abd014ef26e4cb8/notes" + url: "/contacts/65c6065386ce64ccb655f15f/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ebf756abd014ef26e4cb8/companies" + url: "/contacts/65c6065386ce64ccb655f15f/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ebf756abd014ef26e4cb8/subscriptions" + url: "/contacts/65c6065386ce64ccb655f15f/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ebf756abd014ef26e4cb8/subscriptions" + url: "/contacts/65c6065386ce64ccb655f15f/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3443,7 +3467,7 @@ paths: Unauthorized: value: type: error.list - request_id: 1cacccfd-246c-469a-95e3-7397191e5022 + request_id: 2bc8e591-f48b-4e17-b6ae-c05307ae8efb errors: - code: unauthorized message: Access Token Invalid @@ -3488,8 +3512,8 @@ paths: successful: value: type: contact - id: 659ebf766abd014ef26e4cb9 - workspace_id: this_is_an_id253_that_should_be_at_least_ + id: 65c6065586ce64ccb655f160 + workspace_id: this_is_an_id252_that_should_be_at_least_ external_id: '70' role: user email: joe@bloggs.com @@ -3503,9 +3527,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1704902518 - updated_at: 1704902518 - signed_up_at: 1704902518 + created_at: 1707476565 + updated_at: 1707476565 + signed_up_at: 1707476565 last_seen_at: last_replied_at: last_contacted_at: @@ -3539,31 +3563,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ebf766abd014ef26e4cb9/tags" + url: "/contacts/65c6065586ce64ccb655f160/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ebf766abd014ef26e4cb9/notes" + url: "/contacts/65c6065586ce64ccb655f160/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ebf766abd014ef26e4cb9/companies" + url: "/contacts/65c6065586ce64ccb655f160/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ebf766abd014ef26e4cb9/subscriptions" + url: "/contacts/65c6065586ce64ccb655f160/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ebf766abd014ef26e4cb9/subscriptions" + url: "/contacts/65c6065586ce64ccb655f160/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3582,7 +3606,7 @@ paths: Unauthorized: value: type: error.list - request_id: eab64bc6-a582-4942-97ac-5adf173628da + request_id: 38a1f0e0-e459-487b-9870-b5eabc344f58 errors: - code: unauthorized message: Access Token Invalid @@ -3613,7 +3637,7 @@ paths: examples: successful: value: - id: 659ebf776abd014ef26e4cba + id: 65c6065686ce64ccb655f161 object: contact deleted: true schema: @@ -3626,7 +3650,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2c317d00-e7b3-464d-8d4b-2b75d767432b + request_id: 92d808e5-9007-4a52-9d26-73daf31a3e1b errors: - code: unauthorized message: Access Token Invalid @@ -3654,8 +3678,8 @@ paths: successful: value: type: contact - id: 659ebf786abd014ef26e4cbc - workspace_id: this_is_an_id261_that_should_be_at_least_ + id: 65c6065786ce64ccb655f163 + workspace_id: this_is_an_id260_that_should_be_at_least_ external_id: '70' role: user email: joe@bloggs.com @@ -3669,9 +3693,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1704902520 - updated_at: 1704902520 - signed_up_at: 1704902520 + created_at: 1707476567 + updated_at: 1707476568 + signed_up_at: 1707476567 last_seen_at: last_replied_at: last_contacted_at: @@ -3705,31 +3729,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ebf786abd014ef26e4cbc/tags" + url: "/contacts/65c6065786ce64ccb655f163/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ebf786abd014ef26e4cbc/notes" + url: "/contacts/65c6065786ce64ccb655f163/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ebf786abd014ef26e4cbc/companies" + url: "/contacts/65c6065786ce64ccb655f163/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ebf786abd014ef26e4cbc/subscriptions" + url: "/contacts/65c6065786ce64ccb655f163/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ebf786abd014ef26e4cbc/subscriptions" + url: "/contacts/65c6065786ce64ccb655f163/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3748,7 +3772,7 @@ paths: Unauthorized: value: type: error.list - request_id: c242b905-f751-44e0-a1df-91bd5fac4d40 + request_id: 5ccaa76a-341a-4c67-8cff-824cdb45665e errors: - code: unauthorized message: Access Token Invalid @@ -3763,8 +3787,8 @@ paths: successful: summary: successful value: - from: 659ebf786abd014ef26e4cbb - into: 659ebf786abd014ef26e4cbc + from: 65c6065786ce64ccb655f162 + into: 65c6065786ce64ccb655f163 "/contacts/search": post: summary: Search contacts @@ -3873,7 +3897,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9dacb8ab-4108-406b-91c9-06873c5e41b6 + request_id: 208cf7b3-b313-4079-ae64-4526be41d208 errors: - code: unauthorized message: Access Token Invalid @@ -3893,15 +3917,15 @@ paths: value: - field: id operator: "=" - value: 659ebf796abd014ef26e4cbf + value: 65c6065986ce64ccb655f166 - operator: OR value: - field: id operator: "=" - value: 659ebf796abd014ef26e4cbf + value: 65c6065986ce64ccb655f166 - field: id operator: "=" - value: 659ebf796abd014ef26e4cbf + value: 65c6065986ce64ccb655f166 "/contacts": get: summary: List all contacts @@ -3940,7 +3964,7 @@ paths: Unauthorized: value: type: error.list - request_id: fbe2441a-3578-427a-88c4-efbfee47a545 + request_id: 35dc17c4-a345-4b64-8065-ec66399e4e78 errors: - code: unauthorized message: Access Token Invalid @@ -3966,8 +3990,8 @@ paths: successful: value: type: contact - id: 659ebf7b6abd014ef26e4cc1 - workspace_id: this_is_an_id273_that_should_be_at_least_ + id: 65c6065c86ce64ccb655f168 + workspace_id: this_is_an_id272_that_should_be_at_least_ external_id: role: user email: joebloggs@intercom.io @@ -3981,8 +4005,8 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1704902523 - updated_at: 1704902523 + created_at: 1707476572 + updated_at: 1707476572 signed_up_at: last_seen_at: last_replied_at: @@ -4017,31 +4041,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ebf7b6abd014ef26e4cc1/tags" + url: "/contacts/65c6065c86ce64ccb655f168/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ebf7b6abd014ef26e4cc1/notes" + url: "/contacts/65c6065c86ce64ccb655f168/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ebf7b6abd014ef26e4cc1/companies" + url: "/contacts/65c6065c86ce64ccb655f168/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ebf7b6abd014ef26e4cc1/subscriptions" + url: "/contacts/65c6065c86ce64ccb655f168/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ebf7b6abd014ef26e4cc1/subscriptions" + url: "/contacts/65c6065c86ce64ccb655f168/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -4060,7 +4084,7 @@ paths: Unauthorized: value: type: error.list - request_id: 7b69a9fd-2505-450a-8c9a-2c37ff8c2b77 + request_id: 67a8fc72-a136-4332-952d-5c58226bf3bd errors: - code: unauthorized message: Access Token Invalid @@ -4104,7 +4128,7 @@ paths: examples: successful: value: - id: 659ebf7c6abd014ef26e4cc2 + id: 65c6065d86ce64ccb655f169 object: contact archived: true schema: @@ -4136,7 +4160,7 @@ paths: examples: successful: value: - id: 659ebf7d6abd014ef26e4cc3 + id: 65c6065e86ce64ccb655f16a object: contact archived: false schema: @@ -4171,7 +4195,7 @@ paths: successful: value: type: tag - id: '103' + id: '80' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -4183,7 +4207,7 @@ paths: Conversation not found: value: type: error.list - request_id: 13060a01-8326-4bae-9681-d96c3fb6040d + request_id: 45ccd5af-5686-4715-8da6-27c3a644142e errors: - code: not_found message: Conversation not found @@ -4197,7 +4221,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0b88b735-39a0-42ce-8aa8-d718d290b9c8 + request_id: 52b2db36-78e2-4a7c-90e9-bd5b0c821668 errors: - code: unauthorized message: Access Token Invalid @@ -4226,13 +4250,13 @@ paths: successful: summary: successful value: - id: 103 - admin_id: 991267451 + id: 80 + admin_id: 991267388 conversation_not_found: summary: Conversation not found value: - id: 104 - admin_id: 991267453 + id: 81 + admin_id: 991267390 "/conversations/{conversation_id}/tags/{id}": delete: summary: Remove tag from a conversation @@ -4270,7 +4294,7 @@ paths: successful: value: type: tag - id: '106' + id: '83' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -4282,14 +4306,14 @@ paths: Conversation not found: value: type: error.list - request_id: 577b3bb7-37eb-40b4-b93a-d24806ab4224 + request_id: '04847d8a-6b41-444c-a8b5-91678274bb1c' errors: - code: not_found message: Conversation not found Tag not found: value: type: error.list - request_id: 20371fef-3307-4ce9-84b6-39d0d13c1ed0 + request_id: 83027acf-0c7a-4091-89f2-994b6458f480 errors: - code: tag_not_found message: Tag not found @@ -4303,7 +4327,7 @@ paths: Unauthorized: value: type: error.list - request_id: fc8e1caf-a6a1-4f16-98d7-f6eb0b4b3cf1 + request_id: 549287ae-2863-484c-b574-01402e27571b errors: - code: unauthorized message: Access Token Invalid @@ -4326,15 +4350,15 @@ paths: successful: summary: successful value: - admin_id: 991267455 + admin_id: 991267392 conversation_not_found: summary: Conversation not found value: - admin_id: 991267457 + admin_id: 991267394 tag_not_found: summary: Tag not found value: - admin_id: 991267458 + admin_id: 991267395 "/conversations": get: summary: List all conversations @@ -4381,22 +4405,22 @@ paths: total_count: 1 conversations: - type: conversation - id: '353' - created_at: 1704902532 - updated_at: 1704902532 + id: '282' + created_at: 1707476583 + updated_at: 1707476583 waiting_since: snoozed_until: source: type: conversation - id: '403918273' + id: '403918230' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991267461' - name: Ciaran151 Lee - email: admin151@email.com + id: '991267398' + name: Ciaran152 Lee + email: admin152@email.com attachments: [] url: redacted: false @@ -4404,7 +4428,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ebf846abd014ef26e4cc7 + id: 65c6066786ce64ccb655f16e first_contact_reply: admin_assignee_id: team_assignee_id: @@ -4432,7 +4456,7 @@ paths: Unauthorized: value: type: error.list - request_id: 78badfe8-ec8a-4152-a91d-25a31ffd1acb + request_id: 593d6595-44dd-4539-9d83-cbbc46fdfbc8 errors: - code: unauthorized message: Access Token Invalid @@ -4446,7 +4470,7 @@ paths: API plan restricted: value: type: error.list - request_id: cc83dd79-2032-4064-9055-b4da5441caf6 + request_id: 28384e14-319f-4398-ae51-a1b56d880f84 errors: - code: api_plan_restricted message: Active subscription needed. @@ -4478,11 +4502,11 @@ paths: conversation created: value: type: user_message - id: '403918283' - created_at: 1704902554 + id: '403918240' + created_at: 1707476605 body: Hello there message_type: inapp - conversation_id: '378' + conversation_id: '307' schema: "$ref": "#/components/schemas/message" '404': @@ -4493,7 +4517,7 @@ paths: Contact Not Found: value: type: error.list - request_id: f61729e1-ecc0-4789-9d1c-0b3d640ff09b + request_id: 1068c036-2df6-4507-b279-0e60a2d3366f errors: - code: not_found message: User Not Found @@ -4507,7 +4531,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9658ad9e-91cf-4303-a01e-092222d25773 + request_id: 8e2444e8-d6f2-44a3-9bb6-073b7f9eec2b errors: - code: unauthorized message: Access Token Invalid @@ -4521,7 +4545,7 @@ paths: API plan restricted: value: type: error.list - request_id: e51bb795-85a6-4609-8eba-061af7ad3515 + request_id: bc7517a8-fc5d-40e0-be5a-ac9c343380f4 errors: - code: api_plan_restricted message: Active subscription needed. @@ -4538,7 +4562,7 @@ paths: value: from: type: user - id: 659ebf996abd014ef26e4cdc + id: 65c6067b86ce64ccb655f183 body: Hello there contact_not_found: summary: Contact Not Found @@ -4590,22 +4614,22 @@ paths: conversation found: value: type: conversation - id: '382' - created_at: 1704902559 - updated_at: 1704902559 + id: '311' + created_at: 1707476610 + updated_at: 1707476610 waiting_since: snoozed_until: source: type: conversation - id: '403918287' + id: '403918244' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991267475' - name: Ciaran158 Lee - email: admin158@email.com + id: '991267412' + name: Ciaran159 Lee + email: admin159@email.com attachments: [] url: redacted: false @@ -4613,7 +4637,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ebf9f6abd014ef26e4ce0 + id: 65c6068286ce64ccb655f187 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -4645,7 +4669,7 @@ paths: Not found: value: type: error.list - request_id: 88a9db3f-3bff-4bc6-87e6-b0ed5cb52286 + request_id: 40adcdc1-7b5f-44f0-a5c1-49dbddc989c3 errors: - code: not_found message: Resource Not Found @@ -4659,7 +4683,7 @@ paths: Unauthorized: value: type: error.list - request_id: ed1fb6b2-65d9-4cb4-98dd-6c5a129b3558 + request_id: 41774124-15f9-4c72-b4c3-24d986abe40b errors: - code: unauthorized message: Access Token Invalid @@ -4673,7 +4697,7 @@ paths: API plan restricted: value: type: error.list - request_id: dc3f7890-1700-4b12-a4e9-666f99ff52a8 + request_id: cdf6e6e9-29a7-4330-b210-e4463219b8ea errors: - code: api_plan_restricted message: Active subscription needed. @@ -4716,22 +4740,22 @@ paths: conversation found: value: type: conversation - id: '386' - created_at: 1704902564 - updated_at: 1704902565 + id: '315' + created_at: 1707476618 + updated_at: 1707476619 waiting_since: snoozed_until: source: type: conversation - id: '403918291' + id: '403918248' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991267483' - name: Ciaran162 Lee - email: admin162@email.com + id: '991267420' + name: Ciaran163 Lee + email: admin163@email.com attachments: [] url: redacted: false @@ -4739,7 +4763,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ebfa46abd014ef26e4ce4 + id: 65c6068986ce64ccb655f18b first_contact_reply: admin_assignee_id: team_assignee_id: @@ -4763,34 +4787,34 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '62' + id: '56' part_type: conversation_attribute_updated_by_admin body: - created_at: 1704902565 - updated_at: 1704902565 - notified_at: 1704902565 + created_at: 1707476619 + updated_at: 1707476619 + notified_at: 1707476619 assigned_to: author: - id: '991267484' + id: '991267421' type: bot name: Operator - email: operator+this_is_an_id317_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id316_that_should_be_at_least_@intercom.io attachments: [] external_id: redacted: false - type: conversation_part - id: '63' + id: '57' part_type: conversation_attribute_updated_by_admin body: - created_at: 1704902565 - updated_at: 1704902565 - notified_at: 1704902565 + created_at: 1707476619 + updated_at: 1707476619 + notified_at: 1707476619 assigned_to: author: - id: '991267484' + id: '991267421' type: bot name: Operator - email: operator+this_is_an_id317_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id316_that_should_be_at_least_@intercom.io attachments: [] external_id: redacted: false @@ -4805,7 +4829,7 @@ paths: Not found: value: type: error.list - request_id: dd08c04c-a6cf-47a1-9e83-54e56e619758 + request_id: 7e97ff4a-1f69-4fab-b633-db028523be88 errors: - code: not_found message: Resource Not Found @@ -4819,7 +4843,7 @@ paths: Unauthorized: value: type: error.list - request_id: 667daeeb-df03-4987-a3cf-4cbdb4a25bf3 + request_id: d150bdac-1c29-4441-a663-0d5da640f19c errors: - code: unauthorized message: Access Token Invalid @@ -4833,7 +4857,7 @@ paths: API plan restricted: value: type: error.list - request_id: a1a2a52d-7ff1-4d81-9929-60cfb814f7ac + request_id: e72dce09-8e45-47c9-9564-aa82a5f519d6 errors: - code: api_plan_restricted message: Active subscription needed. @@ -4952,22 +4976,22 @@ paths: total_count: 1 conversations: - type: conversation - id: '393' - created_at: 1704902574 - updated_at: 1704902574 + id: '322' + created_at: 1707476630 + updated_at: 1707476630 waiting_since: snoozed_until: source: type: conversation - id: '403918298' + id: '403918255' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991267513' - name: Ciaran185 Lee - email: admin185@email.com + id: '991267450' + name: Ciaran186 Lee + email: admin186@email.com attachments: [] url: redacted: false @@ -4975,7 +4999,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ebfae6abd014ef26e4ceb + id: 65c6069686ce64ccb655f192 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5009,15 +5033,15 @@ paths: value: - field: id operator: "=" - value: '393' + value: '322' - operator: OR value: - field: id operator: "=" - value: '393' + value: '322' - field: id operator: "=" - value: '393' + value: '322' "/conversations/{id}/reply": post: summary: Reply to a conversation @@ -5056,22 +5080,22 @@ paths: User reply: value: type: conversation - id: '401' - created_at: 1704902582 - updated_at: 1704902582 - waiting_since: 1704902582 + id: '330' + created_at: 1707476638 + updated_at: 1707476639 + waiting_since: 1707476639 snoozed_until: source: type: conversation - id: '403918301' + id: '403918258' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991267515' - name: Ciaran186 Lee - email: admin186@email.com + id: '991267452' + name: Ciaran187 Lee + email: admin187@email.com attachments: [] url: redacted: false @@ -5079,9 +5103,9 @@ paths: type: contact.list contacts: - type: contact - id: 659ebfb56abd014ef26e4cf2 + id: 65c6069e86ce64ccb655f199 first_contact_reply: - created_at: 1704902582 + created_at: 1707476639 type: conversation url: admin_assignee_id: @@ -5104,15 +5128,15 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '65' + id: '59' part_type: open body: "Thanks again :)
" - created_at: 1704902582 - updated_at: 1704902582 - notified_at: 1704902582 + created_at: 1707476639 + updated_at: 1707476639 + notified_at: 1707476639 assigned_to: author: - id: 659ebfb56abd014ef26e4cf2 + id: 65c6069e86ce64ccb655f199 type: user name: Joe Bloggs email: joe@bloggs.com @@ -5123,22 +5147,22 @@ paths: Admin note reply: value: type: conversation - id: '402' - created_at: 1704902583 - updated_at: 1704902584 + id: '331' + created_at: 1707476640 + updated_at: 1707476642 waiting_since: snoozed_until: source: type: conversation - id: '403918302' + id: '403918259' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991267517' - name: Ciaran187 Lee - email: admin187@email.com + id: '991267454' + name: Ciaran188 Lee + email: admin188@email.com attachments: [] url: redacted: false @@ -5146,7 +5170,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ebfb76abd014ef26e4cf3 + id: 65c606a086ce64ccb655f19a first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5168,7 +5192,7 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '66' + id: '60' part_type: note body: |-this is the message body
" author: type: admin - id: '991267521' - name: Ciaran189 Lee - email: admin189@email.com + id: '991267458' + name: Ciaran190 Lee + email: admin190@email.com attachments: [] url: redacted: false @@ -5222,9 +5246,9 @@ paths: type: contact.list contacts: - type: contact - id: 659ebfba6abd014ef26e4cf5 + id: 65c606a486ce64ccb655f19c first_contact_reply: - created_at: 1704902587 + created_at: 1707476645 type: conversation url: admin_assignee_id: @@ -5247,15 +5271,15 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '67' + id: '61' part_type: open body: "Thanks again :)
" - created_at: 1704902587 - updated_at: 1704902587 - notified_at: 1704902587 + created_at: 1707476645 + updated_at: 1707476645 + notified_at: 1707476645 assigned_to: author: - id: 659ebfba6abd014ef26e4cf5 + id: 65c606a486ce64ccb655f19c type: user name: Joe Bloggs email: joe@bloggs.com @@ -5273,7 +5297,7 @@ paths: Not found: value: type: error.list - request_id: ed08ac34-1626-4ee4-9753-f55a60218147 + request_id: af64cd68-5213-4281-870c-42445bfc1237 errors: - code: not_found message: Resource Not Found @@ -5287,7 +5311,7 @@ paths: Unauthorized: value: type: error.list - request_id: a34ef650-4b36-48c6-ace6-777e3bf0dd0e + request_id: fc09192d-5cef-4594-9168-2acbd64180b8 errors: - code: unauthorized message: Access Token Invalid @@ -5301,7 +5325,7 @@ paths: API plan restricted: value: type: error.list - request_id: 5754dc6d-7d5c-40f7-a3c4-8fb13449a5d0 + request_id: 6472adfd-f0a0-459c-9416-2f6430cf9217 errors: - code: api_plan_restricted message: Active subscription needed. @@ -5318,14 +5342,14 @@ paths: value: message_type: comment type: user - intercom_user_id: 659ebfb56abd014ef26e4cf2 + intercom_user_id: 65c6069e86ce64ccb655f199 body: Thanks again :) admin_note_reply: summary: Admin note reply value: message_type: note type: admin - admin_id: 991267517 + admin_id: 991267454 body: "this is the message body
" author: type: admin - id: '991267529' - name: Ciaran193 Lee - email: admin193@email.com + id: '991267466' + name: Ciaran194 Lee + email: admin194@email.com attachments: [] url: redacted: false @@ -5399,7 +5423,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ebfc16abd014ef26e4cf9 + id: 65c606ab86ce64ccb655f1a0 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5421,18 +5445,18 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '68' + id: '62' part_type: close body: "Goodbye :)
" - created_at: 1704902593 - updated_at: 1704902593 - notified_at: 1704902593 + created_at: 1707476653 + updated_at: 1707476653 + notified_at: 1707476653 assigned_to: author: - id: '991267529' + id: '991267466' type: admin - name: Ciaran193 Lee - email: admin193@email.com + name: Ciaran194 Lee + email: admin194@email.com attachments: [] external_id: redacted: false @@ -5440,22 +5464,22 @@ paths: Snooze a conversation: value: type: conversation - id: '409' - created_at: 1704902594 - updated_at: 1704902595 + id: '338' + created_at: 1707476654 + updated_at: 1707476655 waiting_since: - snoozed_until: 1704906195 + snoozed_until: 1707480255 source: type: conversation - id: '403918309' + id: '403918266' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991267531' - name: Ciaran194 Lee - email: admin194@email.com + id: '991267468' + name: Ciaran195 Lee + email: admin195@email.com attachments: [] url: redacted: false @@ -5463,7 +5487,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ebfc26abd014ef26e4cfa + id: 65c606ae86ce64ccb655f1a1 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5485,18 +5509,18 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '69' + id: '63' part_type: snoozed body: - created_at: 1704902595 - updated_at: 1704902595 - notified_at: 1704902595 + created_at: 1707476655 + updated_at: 1707476655 + notified_at: 1707476655 assigned_to: author: - id: '991267531' + id: '991267468' type: admin - name: Ciaran194 Lee - email: admin194@email.com + name: Ciaran195 Lee + email: admin195@email.com attachments: [] external_id: redacted: false @@ -5504,22 +5528,22 @@ paths: Open a conversation: value: type: conversation - id: '414' - created_at: 1704902594 - updated_at: 1704902603 + id: '343' + created_at: 1707476654 + updated_at: 1707476663 waiting_since: snoozed_until: source: type: conversation - id: '403918310' + id: '403918267' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991267533' - name: Ciaran195 Lee - email: admin195@email.com + id: '991267470' + name: Ciaran196 Lee + email: admin196@email.com attachments: [] url: redacted: false @@ -5527,7 +5551,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ebfc66abd014ef26e4cff + id: 65c606b386ce64ccb655f1a6 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5549,18 +5573,18 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '71' + id: '65' part_type: open body: - created_at: 1704902603 - updated_at: 1704902603 - notified_at: 1704902603 + created_at: 1707476663 + updated_at: 1707476663 + notified_at: 1707476663 assigned_to: author: - id: '991267533' + id: '991267470' type: admin - name: Ciaran195 Lee - email: admin195@email.com + name: Ciaran196 Lee + email: admin196@email.com attachments: [] external_id: redacted: false @@ -5568,22 +5592,22 @@ paths: Assign a conversation: value: type: conversation - id: '418' - created_at: 1704902604 - updated_at: 1704902604 + id: '347' + created_at: 1707476664 + updated_at: 1707476665 waiting_since: snoozed_until: source: type: conversation - id: '403918313' + id: '403918270' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991267535' - name: Ciaran196 Lee - email: admin196@email.com + id: '991267472' + name: Ciaran197 Lee + email: admin197@email.com attachments: [] url: redacted: false @@ -5591,9 +5615,9 @@ paths: type: contact.list contacts: - type: contact - id: 659ebfcc6abd014ef26e4d02 + id: 65c606b886ce64ccb655f1a9 first_contact_reply: - admin_assignee_id: 991267535 + admin_assignee_id: 991267472 team_assignee_id: open: true state: open @@ -5613,20 +5637,20 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '72' + id: '66' part_type: assign_and_reopen body: - created_at: 1704902605 - updated_at: 1704902605 - notified_at: 1704902605 + created_at: 1707476665 + updated_at: 1707476665 + notified_at: 1707476665 assigned_to: type: admin - id: '991267535' + id: '991267472' author: - id: '991267535' + id: '991267472' type: admin - name: Ciaran196 Lee - email: admin196@email.com + name: Ciaran197 Lee + email: admin197@email.com attachments: [] external_id: redacted: false @@ -5641,7 +5665,7 @@ paths: Not found: value: type: error.list - request_id: 564ec2be-da91-4d28-a747-b646d0e4e4cf + request_id: d2aef059-adbc-4003-a94e-a3fc1bef367a errors: - code: not_found message: Resource Not Found @@ -5655,7 +5679,7 @@ paths: Unauthorized: value: type: error.list - request_id: e436af9b-6afa-4236-b014-027af7395d29 + request_id: 92ed0fd1-af27-488b-861b-720a6c437ac2 errors: - code: unauthorized message: Access Token Invalid @@ -5669,7 +5693,7 @@ paths: API plan restricted: value: type: error.list - request_id: 55a49023-06d7-4583-86d9-4e1b76bcabe4 + request_id: 44a34d64-4721-482c-9b6e-3bfb0cff2228 errors: - code: api_plan_restricted message: Active subscription needed. @@ -5690,32 +5714,32 @@ paths: value: message_type: close type: admin - admin_id: 991267529 + admin_id: 991267466 body: Goodbye :) snooze_a_conversation: summary: Snooze a conversation value: message_type: snoozed - admin_id: 991267531 - snoozed_until: 1704906195 + admin_id: 991267468 + snoozed_until: 1707480255 open_a_conversation: summary: Open a conversation value: message_type: open - admin_id: 991267533 + admin_id: 991267470 assign_a_conversation: summary: Assign a conversation value: message_type: assignment type: admin - admin_id: 991267535 - assignee_id: 991267535 + admin_id: 991267472 + assignee_id: 991267472 not_found: summary: Not found value: message_type: close type: admin - admin_id: 991267537 + admin_id: 991267474 body: Goodbye :) "/conversations/{id}/run_assignment_rules": post: @@ -5746,22 +5770,22 @@ paths: Assign a conversation using assignment rules: value: type: conversation - id: '422' - created_at: 1704902609 - updated_at: 1704902610 + id: '351' + created_at: 1707476672 + updated_at: 1707476673 waiting_since: snoozed_until: source: type: conversation - id: '403918317' + id: '403918274' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991267543' - name: Ciaran200 Lee - email: admin200@email.com + id: '991267480' + name: Ciaran201 Lee + email: admin201@email.com attachments: [] url: redacted: false @@ -5769,7 +5793,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ebfd16abd014ef26e4d06 + id: 65c606c086ce64ccb655f1ad first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5791,20 +5815,20 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '73' + id: '67' part_type: default_assignment body: - created_at: 1704902610 - updated_at: 1704902610 - notified_at: 1704902610 + created_at: 1707476673 + updated_at: 1707476673 + notified_at: 1707476673 assigned_to: type: nobody_admin id: author: - id: '991267544' + id: '991267481' type: bot name: Operator - email: operator+this_is_an_id358_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id357_that_should_be_at_least_@intercom.io attachments: [] external_id: redacted: false @@ -5819,7 +5843,7 @@ paths: Not found: value: type: error.list - request_id: 79d74ccd-b6c7-4ba2-8877-c95f71ab318a + request_id: 6a0ebd18-e2fd-4361-a897-7a98f51ebdb0 errors: - code: not_found message: Resource Not Found @@ -5833,7 +5857,7 @@ paths: Unauthorized: value: type: error.list - request_id: 265be2ae-d75f-4b52-a46d-e15ec3ca0e42 + request_id: 99073940-443c-4537-a3ce-8a4c05c4fabc errors: - code: unauthorized message: Access Token Invalid @@ -5847,7 +5871,7 @@ paths: API plan restricted: value: type: error.list - request_id: 912829e2-d65f-4a98-8d6f-f6abf1e1a2cd + request_id: 5d7e3dfd-fec9-4538-a875-0e29755dd86f errors: - code: api_plan_restricted message: Active subscription needed. @@ -5886,7 +5910,7 @@ paths: value: customers: - type: user - id: 659ebfd76abd014ef26e4d0a + id: 65c606c886ce64ccb655f1b1 schema: "$ref": "#/components/schemas/conversation" '404': @@ -5897,7 +5921,7 @@ paths: Not found: value: type: error.list - request_id: 142e7af6-85ae-4d52-8eca-46018f87df78 + request_id: ea4ad849-4abe-4e40-b0bb-f9998e4b3398 errors: - code: not_found message: Resource Not Found @@ -5911,7 +5935,7 @@ paths: Unauthorized: value: type: error.list - request_id: 22a7bd4b-3712-48a3-8c0b-34f18cb67d9d + request_id: 70788538-5a5d-4867-a77f-0eaec92dc432 errors: - code: unauthorized message: Access Token Invalid @@ -5925,7 +5949,7 @@ paths: API plan restricted: value: type: error.list - request_id: '0926496b-bdb6-4aa5-b1dc-f5197304484f' + request_id: 45c7d8c3-f1b7-4084-b2d3-212f66ec6cba errors: - code: api_plan_restricted message: Active subscription needed. @@ -5940,15 +5964,15 @@ paths: attach_a_contact_to_a_conversation: summary: Attach a contact to a conversation value: - admin_id: 991267551 + admin_id: 991267488 customer: - intercom_user_id: 659ebfd76abd014ef26e4d0a + intercom_user_id: 65c606c886ce64ccb655f1b1 not_found: summary: Not found value: - admin_id: 991267553 + admin_id: 991267490 customer: - intercom_user_id: 659ebfd86abd014ef26e4d0b + intercom_user_id: 65c606ca86ce64ccb655f1b2 "/conversations/{conversation_id}/customers/{contact_id}": delete: summary: Detach a contact from a group conversation @@ -5989,7 +6013,7 @@ paths: value: customers: - type: user - id: 659ebfe36abd014ef26e4d15 + id: 65c606d786ce64ccb655f1bc schema: "$ref": "#/components/schemas/conversation" '404': @@ -6000,14 +6024,14 @@ paths: Conversation not found: value: type: error.list - request_id: 3a217d83-3e50-451c-bcf4-e78479843f97 + request_id: e71964c1-3e46-4411-9b19-5102c3db973a errors: - code: not_found message: Resource Not Found Contact not found: value: type: error.list - request_id: 5096be26-9d59-45fc-bc85-588251e45247 + request_id: 86cb6a4a-333f-47b6-8947-baeeae53e8b8 errors: - code: not_found message: User Not Found @@ -6021,7 +6045,7 @@ paths: Last customer: value: type: error.list - request_id: 35576150-ceab-4b06-ac07-694accdecd02 + request_id: 49a1ea61-0f1b-4354-99a4-d21d2354e90b errors: - code: parameter_invalid message: Removing the last customer is not allowed @@ -6035,7 +6059,7 @@ paths: Unauthorized: value: type: error.list - request_id: 4d6365e5-92b3-422a-a9cb-3a695165df16 + request_id: 98c439cc-3a42-423e-9505-563f34e72a2a errors: - code: unauthorized message: Access Token Invalid @@ -6049,7 +6073,7 @@ paths: API plan restricted: value: type: error.list - request_id: 454fc060-e915-4e60-84de-b7946b76b4c9 + request_id: 9f19bf47-6d6a-4d21-8c0a-a2b041348dde errors: - code: api_plan_restricted message: Active subscription needed. @@ -6064,27 +6088,27 @@ paths: detach_a_contact_from_a_group_conversation: summary: Detach a contact from a group conversation value: - admin_id: 991267559 + admin_id: 991267496 customer: - intercom_user_id: 659ebfdd6abd014ef26e4d0e + intercom_user_id: 65c606cf86ce64ccb655f1b5 conversation_not_found: summary: Conversation not found value: - admin_id: 991267561 + admin_id: 991267498 customer: - intercom_user_id: 659ebfe46abd014ef26e4d16 + intercom_user_id: 65c606d886ce64ccb655f1bd contact_not_found: summary: Contact not found value: - admin_id: 991267563 + admin_id: 991267500 customer: - intercom_user_id: 659ebfeb6abd014ef26e4d1d + intercom_user_id: 65c606e086ce64ccb655f1c4 last_customer: summary: Last customer value: - admin_id: 991267565 + admin_id: 991267502 customer: - intercom_user_id: 659ebff36abd014ef26e4d24 + intercom_user_id: 65c606e986ce64ccb655f1cb "/conversations/redact": post: summary: Redact a conversation part @@ -6111,22 +6135,22 @@ paths: Redact a conversation part: value: type: conversation - id: '478' - created_at: 1704902666 - updated_at: 1704902667 - waiting_since: 1704902666 + id: '407' + created_at: 1707476739 + updated_at: 1707476741 + waiting_since: 1707476740 snoozed_until: source: type: conversation - id: '403918343' + id: '403918300' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991267571' - name: Ciaran214 Lee - email: admin214@email.com + id: '991267508' + name: Ciaran215 Lee + email: admin215@email.com attachments: [] url: redacted: false @@ -6134,9 +6158,9 @@ paths: type: contact.list contacts: - type: contact - id: 659ec0096abd014ef26e4d39 + id: 65c6070286ce64ccb655f1e0 first_contact_reply: - created_at: 1704902666 + created_at: 1707476740 type: conversation url: admin_assignee_id: @@ -6159,15 +6183,15 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '81' + id: '75' part_type: open body: "This message was deleted
" - created_at: 1704902666 - updated_at: 1704902667 - notified_at: 1704902666 + created_at: 1707476740 + updated_at: 1707476741 + notified_at: 1707476740 assigned_to: author: - id: 659ec0096abd014ef26e4d39 + id: 65c6070286ce64ccb655f1e0 type: user name: Joe Bloggs email: joe@bloggs.com @@ -6185,7 +6209,7 @@ paths: Not found: value: type: error.list - request_id: c9c28803-cb75-4ef4-a84a-e91bf0e67d99 + request_id: 75f90a39-993e-41a5-b0d4-93b4ade44c86 errors: - code: conversation_part_or_message_not_found message: Conversation part or message not found @@ -6199,7 +6223,7 @@ paths: Unauthorized: value: type: error.list - request_id: '099f6c33-4434-4b7a-9fb2-35cc57fc895e' + request_id: f0ab1a60-1543-4b4d-b20b-b28ed9d987e1 errors: - code: unauthorized message: Access Token Invalid @@ -6215,8 +6239,8 @@ paths: summary: Redact a conversation part value: type: conversation_part - conversation_id: 478 - conversation_part_id: 81 + conversation_id: 407 + conversation_part_id: 75 not_found: summary: Not found value: @@ -6273,6 +6297,7 @@ paths: data_type: string api_writable: true ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6284,6 +6309,7 @@ paths: data_type: string api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6296,6 +6322,7 @@ paths: data_type: date api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6307,6 +6334,7 @@ paths: data_type: date api_writable: true ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6318,6 +6346,7 @@ paths: data_type: integer api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6330,6 +6359,7 @@ paths: data_type: integer api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6342,6 +6372,7 @@ paths: data_type: string api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6353,6 +6384,7 @@ paths: data_type: float api_writable: true ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6365,6 +6397,7 @@ paths: data_type: integer api_writable: true ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6377,6 +6410,7 @@ paths: data_type: string api_writable: true ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6389,10 +6423,11 @@ paths: data_type: string api_writable: true ui_writable: false + messenger_writable: true custom: false archived: false model: company - - id: 63 + - id: 34 type: data_attribute name: The One Ring full_name: custom_attributes.The One Ring @@ -6402,11 +6437,12 @@ paths: data_type: string api_writable: true ui_writable: false + messenger_writable: true custom: true archived: false - admin_id: '991267587' - created_at: 1704902676 - updated_at: 1704902676 + admin_id: '991267533' + created_at: 1707476755 + updated_at: 1707476755 model: company - type: data_attribute name: id @@ -6416,6 +6452,7 @@ paths: data_type: string api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6427,6 +6464,7 @@ paths: data_type: date api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6438,6 +6476,7 @@ paths: data_type: date api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6449,6 +6488,7 @@ paths: data_type: string api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6460,6 +6500,7 @@ paths: data_type: string api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6473,7 +6514,7 @@ paths: Unauthorized: value: type: error.list - request_id: b8bb4508-7fae-47a9-b909-cc250e54431e + request_id: 20343b24-3df5-4ec8-a0c1-81d6839c2fdd errors: - code: unauthorized message: Access Token Invalid @@ -6498,7 +6539,7 @@ paths: examples: Successful: value: - id: 66 + id: 37 type: data_attribute name: Mithril Shirt full_name: custom_attributes.Mithril Shirt @@ -6506,11 +6547,12 @@ paths: data_type: string api_writable: true ui_writable: false + messenger_writable: true custom: true archived: false - admin_id: '991267589' - created_at: 1704902677 - updated_at: 1704902677 + admin_id: '991267535' + created_at: 1707476756 + updated_at: 1707476756 model: company schema: "$ref": "#/components/schemas/data_attribute" @@ -6522,7 +6564,7 @@ paths: Same name already exists: value: type: error.list - request_id: 0dbe56e9-dab9-44cb-aabc-cdc5f856af06 + request_id: 140c4f8a-bfa0-41b9-881e-2be249bd380d errors: - code: parameter_invalid message: You already have 'The One Ring' in your company data. @@ -6530,7 +6572,7 @@ paths: Invalid name: value: type: error.list - request_id: '080cc651-3c92-4f63-b7aa-154f07a8cacd' + request_id: 4ddeeb7e-adde-408d-96ac-6508a3131a99 errors: - code: parameter_invalid message: Your name for this attribute must only contain alphanumeric @@ -6538,7 +6580,7 @@ paths: Attribute already exists: value: type: error.list - request_id: 0b26293c-c1f2-4c61-bf9c-103858dc4553 + request_id: 7ac7b3e4-9014-42ed-ad20-9d50844c2f88 errors: - code: parameter_invalid message: You already have 'The One Ring' in your company data. @@ -6546,14 +6588,14 @@ paths: Invalid Data Type: value: type: error.list - request_id: 2beb79ba-072b-4d3a-9ef7-be7e6125b71d + request_id: ca38055f-58f3-45d7-bc4b-a783922cefe0 errors: - code: parameter_invalid message: Data Type isn't an option Too few options for list: value: type: error.list - request_id: c15e4120-0c0e-4e5f-8710-47a26cfca97f + request_id: 6c18cccc-1915-4918-9bd5-bb2e63c75953 errors: - code: parameter_invalid message: The Data Attribute model field must be either contact @@ -6568,7 +6610,7 @@ paths: Unauthorized: value: type: error.list - request_id: b48c89a3-1b5c-4547-86e3-7ae58324d785 + request_id: 60f1bb60-2ed2-4d76-aad2-de91dc995c83 errors: - code: unauthorized message: Access Token Invalid @@ -6647,7 +6689,7 @@ paths: examples: Successful: value: - id: 73 + id: 44 type: data_attribute name: The One Ring full_name: custom_attributes.The One Ring @@ -6659,11 +6701,12 @@ paths: - 11-20 api_writable: true ui_writable: false + messenger_writable: true custom: true archived: false - admin_id: '991267596' - created_at: 1704902679 - updated_at: 1704902680 + admin_id: '991267542' + created_at: 1707476759 + updated_at: 1707476760 model: company schema: "$ref": "#/components/schemas/data_attribute" @@ -6675,7 +6718,7 @@ paths: Too few options in list: value: type: error.list - request_id: 4f96facb-cf5a-4e05-a674-63ce507dc814 + request_id: 1b257955-0a43-476f-baed-6160420dae88 errors: - code: parameter_invalid message: Options isn't an array @@ -6689,7 +6732,7 @@ paths: Attribute Not Found: value: type: error.list - request_id: 6a119cf9-02dc-4dc2-a8f3-e00aabb5ebbf + request_id: 43debf14-7061-4d23-b4fa-91a7e9996c82 errors: - code: field_not_found message: We couldn't find that data attribute to update @@ -6703,7 +6746,7 @@ paths: Has Dependant Object: value: type: error.list - request_id: e3295d23-0d29-4855-b750-87814df76277 + request_id: 6497fedb-b557-4052-bdad-d9ca404471a8 errors: - code: data_invalid message: The Data Attribute you are trying to archive has a @@ -6718,7 +6761,7 @@ paths: Unauthorized: value: type: error.list - request_id: 35f17d52-d07b-4004-9239-4ad467644e5d + request_id: 1b8eb2c8-c805-4a78-8018-c8ba9e319242 errors: - code: unauthorized message: Access Token Invalid @@ -6769,63 +6812,49 @@ paths: tags: - Data Events operationId: createDataEvent - description: "\nYou will need an Access Token that has write permissions to - send Events. Once you have a key you can submit events via POST to the Events - resource, which is located at https://api.intercom.io/events, or you can send - events using one of the client libraries. When working with the HTTP API directly - a client should send the event with a `Content-Type` of `application/json`.\n\nWhen - using the JavaScript API, [adding the code to your app](http://docs.intercom.io/configuring-Intercom/tracking-user-events-in-your-app) - makes the Events API available. Once added, you can submit an event using - the `trackEvent` method. This will associate the event with the Lead or currently - logged-in user or logged-out visitor/lead and send it to Intercom. The final - parameter is a map that can be used to send optional metadata about the event.\n\nWith - the Ruby client you pass a hash describing the event to `Intercom::Event.create`, - or call the `track_user` method directly on the current user object (e.g. - `user.track_event`).\n\n| Type | Description | - Example |\n| - :-------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- - | :-------------------------------------------------------------------------------- - |\n| String | The value is a JSON String | - `\"source\":\"desktop\"` |\n| - Number | The value is a JSON Number | - `\"load\": 3.67` |\n| - Date | The key ends with the String `_date` and the value is a - [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time), assumed to be in - the [UTC](http://en.wikipedia.org/wiki/Coordinated_Universal_Time) timezone. - | `\"contact_date\": 1392036272` |\n| - Link | The value is a HTTP or HTTPS URI. | - `\"article\": \"https://example.org/ab1de.html\"` |\n| - Rich Link | The value is a JSON object that contains `url` and `value` - keys. | - `\"article\": {\"url\": \"https://example.org/ab1de.html\", \"value\":\"the - dude abides\"}` |\n| Monetary Amount | The value is a JSON object that contains - `amount` and `currency` keys. The `amount` key is a positive integer representing - the amount in cents. The price in the example to the right denotes €349.99. - \ | `\"price\": {\"amount\": 34999, \"currency\": \"eur\"}` |\n\n**NB: - For the JSON object types, please note that we do not currently support nested - JSON structure.**\n\n> \U0001F6A7 Lead Events\n>\n> When submitting events - for Leads, you will need to specify the Lead's `id`.\n\n> \U0001F4D8 Metadata - behaviour\n>\n> - We currently limit the number of tracked metadata keys to - 10 per event. Once the quota is reached, we ignore any further keys we receive. - The first 10 metadata keys are determined by the order in which they are sent - in with the event.\n> - It is not possible to change the metadata keys once - the event has been sent. A new event will need to be created with the new - keys and you can archive the old one.\n> - There might be up to 24 hrs delay - when you send a new metadata for an existing event.\n\n> \U0001F4D8 Event - de-duplication\n>\n> The API may detect and ignore duplicate events. Each - event is uniquely identified as a combination of the following data - the - Workspace identifier, the Contact external identifier, the Data Event name - and the Data Event created time. As a result, it is **strongly recommended** - to send a second granularity Unix timestamp in the `created_at` field.\n>\n> - Duplicated events are responded to using the normal `202 Accepted` code - - an error is not thrown, however repeat requests will be counted against any - rate limit that is in place.\n\n### HTTP API Responses\n\n- Successful responses - to submitted events return `202 Accepted` with an empty body.\n- Unauthorised - access will be rejected with a `401 Unauthorized` or `403 Forbidden` response - code.\n- Events sent about users that cannot be found will return a `404 Not - Found`.\n- Event lists containing duplicate events will have those duplicates - ignored.\n- Server errors will return a `500` response code and may contain - an error message in the body.\n\n" + description: |2+ + + You will need an Access Token that has write permissions to send Events. Once you have a key you can submit events via POST to the Events resource, which is located at https://api.intercom.io/events, or you can send events using one of the client libraries. When working with the HTTP API directly a client should send the event with a `Content-Type` of `application/json`. + + When using the JavaScript API, [adding the code to your app](http://docs.intercom.io/configuring-Intercom/tracking-user-events-in-your-app) makes the Events API available. Once added, you can submit an event using the `trackEvent` method. This will associate the event with the Lead or currently logged-in user or logged-out visitor/lead and send it to Intercom. The final parameter is a map that can be used to send optional metadata about the event. + + With the Ruby client you pass a hash describing the event to `Intercom::Event.create`, or call the `track_user` method directly on the current user object (e.g. `user.track_event`). + + **NB: For the JSON object types, please note that we do not currently support nested JSON structure.** + + | Type | Description | Example | + | :-------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------- | + | String | The value is a JSON String | `"source":"desktop"` | + | Number | The value is a JSON Number | `"load": 3.67` | + | Date | The key ends with the String `_date` and the value is a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time), assumed to be in the [UTC](http://en.wikipedia.org/wiki/Coordinated_Universal_Time) timezone. | `"contact_date": 1392036272` | + | Link | The value is a HTTP or HTTPS URI. | `"article": "https://example.org/ab1de.html"` | + | Rich Link | The value is a JSON object that contains `url` and `value` keys. | `"article": {"url": "https://example.org/ab1de.html", "value":"the dude abides"}` | + | Monetary Amount | The value is a JSON object that contains `amount` and `currency` keys. The `amount` key is a positive integer representing the amount in cents. The price in the example to the right denotes €349.99. | `"price": {"amount": 34999, "currency": "eur"}` | + + **Lead Events** + + When submitting events for Leads, you will need to specify the Lead's `id`. + + **Metadata behaviour** + + - We currently limit the number of tracked metadata keys to 10 per event. Once the quota is reached, we ignore any further keys we receive. The first 10 metadata keys are determined by the order in which they are sent in with the event. + - It is not possible to change the metadata keys once the event has been sent. A new event will need to be created with the new keys and you can archive the old one. + - There might be up to 24 hrs delay when you send a new metadata for an existing event. + + **Event de-duplication** + + The API may detect and ignore duplicate events. Each event is uniquely identified as a combination of the following data - the Workspace identifier, the Contact external identifier, the Data Event name and the Data Event created time. As a result, it is **strongly recommended** to send a second granularity Unix timestamp in the `created_at` field. + + Duplicated events are responded to using the normal `202 Accepted` code - an error is not thrown, however repeat requests will be counted against any rate limit that is in place. + + ### HTTP API Responses + + - Successful responses to submitted events return `202 Accepted` with an empty body. + - Unauthorised access will be rejected with a `401 Unauthorized` or `403 Forbidden` response code. + - Events sent about users that cannot be found will return a `404 Not Found`. + - Event lists containing duplicate events will have those duplicates ignored. + - Server errors will return a `500` response code and may contain an error message in the body. + responses: '202': description: successful @@ -6837,7 +6866,7 @@ paths: Unauthorized: value: type: error.list - request_id: e7adf1b8-b34e-48db-9949-7802ca36ad0a + request_id: a4333bf2-74dd-4d58-a0a4-22199db0547b errors: - code: unauthorized message: Access Token Invalid @@ -6923,8 +6952,8 @@ paths: events: [] pages: next: http://api.intercom.test/events?next page - email: user24@email.com - intercom_user_id: 659ec0206abd014ef26e4d52 + email: user26@email.com + intercom_user_id: 65c6071c86ce64ccb655f1e9 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 schema: "$ref": "#/components/schemas/data_event_summary" @@ -6936,7 +6965,7 @@ paths: Unauthorized: value: type: error.list - request_id: f011b7bc-07be-4447-b161-afc4410d92bd + request_id: ea101549-f005-4350-92ae-eaa86f9d1886 errors: - code: unauthorized message: Access Token Invalid @@ -6967,7 +6996,7 @@ paths: Unauthorized: value: type: error.list - request_id: d3955770-d5ee-4cd9-bc97-75ca8526b5eb + request_id: 3db672ef-5ed8-4a69-95dd-9eabaa2bbd03 errors: - code: unauthorized message: Access Token Invalid @@ -7011,7 +7040,7 @@ paths: examples: successful: value: - job_identifier: qdwplfnqgdjb4wna + job_identifier: eyqk9eirvsf4h2v6 status: pending download_url: '' download_expires_at: '' @@ -7026,8 +7055,8 @@ paths: successful: summary: successful value: - created_at_after: 1704884690 - created_at_before: 1704902690 + created_at_after: 1707458766 + created_at_before: 1707476766 "/export/content/data/{job_identifier}": get: summary: Show content data export @@ -7061,7 +7090,7 @@ paths: examples: successful: value: - job_identifier: t99ds5pna2o4fgjb + job_identifier: vv4wpr3ntvbadchi status: pending download_url: '' download_expires_at: '' @@ -7093,7 +7122,7 @@ paths: examples: successful: value: - job_identifier: ho49jvgjht3objmp + job_identifier: 18lit1dp19p4m303 status: canceled download_url: '' download_expires_at: '' @@ -7154,32 +7183,32 @@ paths: user message created: value: type: user_message - id: '403918354' - created_at: 1704902716 + id: '403918305' + created_at: 1707476769 body: heyy message_type: inapp - conversation_id: '494' + conversation_id: '412' lead message created: value: type: user_message - id: '403918355' - created_at: 1704902717 + id: '403918306' + created_at: 1707476770 body: heyy message_type: inapp - conversation_id: '495' + conversation_id: '413' admin message created: value: type: admin_message - id: '24' - created_at: 1704902718 + id: '15' + created_at: 1707476771 subject: heyy body: heyy message_type: inapp owner: type: admin - id: '991267630' - name: Ciaran255 Lee - email: admin255@email.com + id: '991267565' + name: Ciaran265 Lee + email: admin265@email.com away_mode_enabled: false away_mode_reassign: false schema: @@ -7192,14 +7221,14 @@ paths: No body supplied for message: value: type: error.list - request_id: fcf08b01-bce3-4349-a989-39081c76d61b + request_id: 3a3ec129-a46c-4798-b12a-1ab7d75adb05 errors: - code: parameter_invalid message: Body is required No body supplied for email message: value: type: error.list - request_id: 3416798c-f54e-4c5d-a891-83ab4942114e + request_id: cac03339-45ad-480f-b0a2-7e16dc3ba843 errors: - code: parameter_invalid message: Body is required @@ -7213,7 +7242,7 @@ paths: No subject supplied for email message: value: type: error.list - request_id: dd4f061f-86ee-4601-a548-bc072da25b4a + request_id: d04bd242-1afe-4b07-9bf4-7f0fec91de2f errors: - code: parameter_not_found message: No subject supplied for email message @@ -7227,7 +7256,7 @@ paths: Unauthorized: value: type: error.list - request_id: f05d7fdf-69da-4058-8f90-8cb1664a7e9b + request_id: f86772cc-d884-47de-a41f-edc62dd56a07 errors: - code: unauthorized message: Access Token Invalid @@ -7241,7 +7270,7 @@ paths: API plan restricted: value: type: error.list - request_id: bc15225f-94fc-4215-a83a-45f9ac12fa6a + request_id: 11238fdb-1904-4726-a48a-dcdddeaad31e errors: - code: api_plan_restricted message: Active subscription needed. @@ -7258,7 +7287,7 @@ paths: value: from: type: user - id: 659ec03c6abd014ef26e4da7 + id: 65c6072086ce64ccb655f1ee body: heyy referer: https://twitter.com/bob lead_message_created: @@ -7266,7 +7295,7 @@ paths: value: from: type: lead - id: 659ec03d6abd014ef26e4da8 + id: 65c6072186ce64ccb655f1ef body: heyy referer: https://twitter.com/bob admin_message_created: @@ -7274,10 +7303,10 @@ paths: value: from: type: admin - id: '991267630' + id: '991267565' to: type: user - id: 659ec03e6abd014ef26e4da9 + id: 65c6072386ce64ccb655f1f0 message_type: conversation body: heyy no_body_supplied_for_message: @@ -7285,10 +7314,10 @@ paths: value: from: type: admin - id: '991267632' + id: '991267567' to: type: user - id: 659ec03f6abd014ef26e4daa + id: 65c6072386ce64ccb655f1f1 message_type: inapp body: subject: heyy @@ -7297,7 +7326,7 @@ paths: value: from: type: admin - id: '991267633' + id: '991267568' to: type: user user_id: '70' @@ -7308,10 +7337,10 @@ paths: value: from: type: admin - id: '991267634' + id: '991267569' to: type: user - id: 659ec0406abd014ef26e4dac + id: 65c6072586ce64ccb655f1f3 message_type: email body: subject: heyy @@ -7344,10 +7373,10 @@ paths: data: - id: '30' type: news-item - workspace_id: this_is_an_id462_that_should_be_at_least_ + workspace_id: this_is_an_id479_that_should_be_at_least_ title: We have news body: "Hello there,
" - sender_id: 991267641 + sender_id: 991267576 state: draft labels: [] cover_image_url: @@ -7357,15 +7386,15 @@ paths: - - deliver_silently: false - created_at: 1704902722 - updated_at: 1704902722 + created_at: 1707476775 + updated_at: 1707476775 newsfeed_assignments: [] - id: '29' type: news-item - workspace_id: this_is_an_id462_that_should_be_at_least_ + workspace_id: this_is_an_id479_that_should_be_at_least_ title: We have news body: "Hello there,
" - sender_id: 991267639 + sender_id: 991267574 state: draft labels: [] cover_image_url: @@ -7375,8 +7404,8 @@ paths: - - deliver_silently: false - created_at: 1704902721 - updated_at: 1704902721 + created_at: 1707476774 + updated_at: 1707476774 newsfeed_assignments: [] total_count: 2 schema: @@ -7389,7 +7418,7 @@ paths: Unauthorized: value: type: error.list - request_id: 45c0d233-aeb5-4b8f-b652-9893dcef6544 + request_id: d7ed8507-8b33-4338-afb6-678bd2549573 errors: - code: unauthorized message: Access Token Invalid @@ -7416,10 +7445,10 @@ paths: value: id: '33' type: news-item - workspace_id: this_is_an_id466_that_should_be_at_least_ + workspace_id: this_is_an_id483_that_should_be_at_least_ title: Halloween is here! body: "New costumes in store for this spooky season
" - sender_id: 991267648 + sender_id: 991267583 state: live labels: - New @@ -7430,8 +7459,8 @@ paths: - "\U0001F606" - "\U0001F605" deliver_silently: true - created_at: 1704902723 - updated_at: 1704902723 + created_at: 1707476776 + updated_at: 1707476776 newsfeed_assignments: - newsfeed_id: 53 published_at: 1664638214 @@ -7445,7 +7474,7 @@ paths: Unauthorized: value: type: error.list - request_id: e698bf6c-3069-47cb-9380-ac57fe87ca5b + request_id: 985dcd01-f9cb-4b84-84f7-4e2ede7d8484 errors: - code: unauthorized message: Access Token Invalid @@ -7466,7 +7495,7 @@ paths: - Product - Update - New - sender_id: 991267648 + sender_id: 991267583 deliver_silently: true reactions: - "\U0001F606" @@ -7504,10 +7533,10 @@ paths: value: id: '34' type: news-item - workspace_id: this_is_an_id470_that_should_be_at_least_ + workspace_id: this_is_an_id487_that_should_be_at_least_ title: We have news body: "Hello there,
" - sender_id: 991267651 + sender_id: 991267586 state: live labels: [] cover_image_url: @@ -7517,11 +7546,11 @@ paths: - - deliver_silently: false - created_at: 1704902724 - updated_at: 1704902724 + created_at: 1707476777 + updated_at: 1707476777 newsfeed_assignments: - newsfeed_id: 55 - published_at: 1704902724 + published_at: 1707476777 schema: "$ref": "#/components/schemas/news_item" '404': @@ -7532,7 +7561,7 @@ paths: News Item Not Found: value: type: error.list - request_id: decf1905-c5d6-48e7-bbf5-23424635271e + request_id: c03e3245-2833-44e7-9200-670e2d6f0900 errors: - code: not_found message: Resource Not Found @@ -7546,7 +7575,7 @@ paths: Unauthorized: value: type: error.list - request_id: a73ebf48-8a96-4b5b-9551-3e70c0fda634 + request_id: a58e52c2-8325-4b9f-8838-bf13db5e4fac errors: - code: unauthorized message: Access Token Invalid @@ -7579,10 +7608,10 @@ paths: value: id: '37' type: news-item - workspace_id: this_is_an_id476_that_should_be_at_least_ + workspace_id: this_is_an_id493_that_should_be_at_least_ title: Christmas is here! body: "New gifts in store for the jolly season
" - sender_id: 991267659 + sender_id: 991267594 state: live labels: [] cover_image_url: @@ -7590,8 +7619,8 @@ paths: - "\U0001F61D" - "\U0001F602" deliver_silently: false - created_at: 1704902726 - updated_at: 1704902726 + created_at: 1707476779 + updated_at: 1707476780 newsfeed_assignments: [] schema: "$ref": "#/components/schemas/news_item" @@ -7603,7 +7632,7 @@ paths: News Item Not Found: value: type: error.list - request_id: 8d269c67-ec53-486d-895e-809ba2b2fac6 + request_id: 69211b57-be66-43ba-a827-b938995be6b2 errors: - code: not_found message: Resource Not Found @@ -7617,7 +7646,7 @@ paths: Unauthorized: value: type: error.list - request_id: 778c29f5-915e-40f7-98c8-be902cbf2e31 + request_id: '082d7e83-286e-4486-8b2f-74be985704f9' errors: - code: unauthorized message: Access Token Invalid @@ -7634,7 +7663,7 @@ paths: value: title: Christmas is here! body: "New gifts in store for the jolly season
" - sender_id: 991267659 + sender_id: 991267594 reactions: - "\U0001F61D" - "\U0001F602" @@ -7643,7 +7672,7 @@ paths: value: title: Christmas is here! body: "New gifts in store for the jolly season
" - sender_id: 991267662 + sender_id: 991267597 reactions: - "\U0001F61D" - "\U0001F602" @@ -7686,7 +7715,7 @@ paths: News Item Not Found: value: type: error.list - request_id: 2dc811cd-76fa-43e8-92fe-7c83b5f7001d + request_id: 94f4cb93-1a05-437e-93ed-52efac478ccf errors: - code: not_found message: Resource Not Found @@ -7700,7 +7729,7 @@ paths: Unauthorized: value: type: error.list - request_id: a02a14d3-5cb9-439f-b05c-31b45064c37a + request_id: 0b94ae68-149a-4ce5-95bf-2564149b4a04 errors: - code: unauthorized message: Access Token Invalid @@ -7753,7 +7782,7 @@ paths: Unauthorized: value: type: error.list - request_id: 5ea01b2b-06c1-4ed1-9942-06890247fe3f + request_id: e3e39907-23c6-4801-a455-fb36cd1f051a errors: - code: unauthorized message: Access Token Invalid @@ -7789,13 +7818,13 @@ paths: - id: '68' type: newsfeed name: Visitor Feed - created_at: 1704902730 - updated_at: 1704902730 + created_at: 1707476784 + updated_at: 1707476784 - id: '69' type: newsfeed name: Visitor Feed - created_at: 1704902730 - updated_at: 1704902730 + created_at: 1707476784 + updated_at: 1707476784 total_count: 2 schema: "$ref": "#/components/schemas/paginated_response" @@ -7807,7 +7836,7 @@ paths: Unauthorized: value: type: error.list - request_id: b7b8e4fc-5843-4559-9e3e-5f10c39f140a + request_id: b58a79b0-f7f3-4c99-a984-e825f84d434d errors: - code: unauthorized message: Access Token Invalid @@ -7844,8 +7873,8 @@ paths: id: '72' type: newsfeed name: Visitor Feed - created_at: 1704902731 - updated_at: 1704902731 + created_at: 1707476785 + updated_at: 1707476785 schema: "$ref": "#/components/schemas/newsfeed" '401': @@ -7856,7 +7885,7 @@ paths: Unauthorized: value: type: error.list - request_id: 7bec245e-1d80-44a8-b04c-40728aa34c66 + request_id: 41c19b58-3c0b-451a-abda-9193dd42a4df errors: - code: unauthorized message: Access Token Invalid @@ -7890,16 +7919,16 @@ paths: Note found: value: type: note - id: '77' - created_at: 1704211534 + id: '37' + created_at: 1706785586 contact: type: contact - id: 659ec04e6abd014ef26e4db7 + id: 65c6073286ce64ccb655f1f6 author: type: admin - id: '991267678' - name: Ciaran302 Lee - email: admin302@email.com + id: '991267613' + name: Ciaran312 Lee + email: admin312@email.com away_mode_enabled: false away_mode_reassign: false body: "This is a note.
" @@ -7913,7 +7942,7 @@ paths: Note not found: value: type: error.list - request_id: 0614fee6-9d4f-423a-a053-4cfaa47482e2 + request_id: c6b2cfbc-9916-43b5-b0dd-d982dbd6652b errors: - code: not_found message: Resource Not Found @@ -7927,7 +7956,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8893816d-d388-4bf5-9cc6-5ca6d10dfe72 + request_id: 5492b131-2d62-43c5-9568-92a2d6d67265 errors: - code: unauthorized message: Access Token Invalid @@ -7963,16 +7992,16 @@ paths: type: segment.list segments: - type: segment - id: 659ec0516abd014ef26e4dbe + id: 65c6073486ce64ccb655f1f9 name: John segment - created_at: 1704902737 - updated_at: 1704902737 + created_at: 1707476788 + updated_at: 1707476788 person_type: user - type: segment - id: 659ec0516abd014ef26e4dbf + id: 65c6073486ce64ccb655f1fa name: Jane segment - created_at: 1704902737 - updated_at: 1704902737 + created_at: 1707476788 + updated_at: 1707476788 person_type: user schema: "$ref": "#/components/schemas/segment_list" @@ -7984,7 +8013,7 @@ paths: Unauthorized: value: type: error.list - request_id: 1f177e7c-8572-4af2-8dbf-790d3b4a5283 + request_id: 25fd11f5-9f98-494a-aa2d-1de26062fa17 errors: - code: unauthorized message: Access Token Invalid @@ -8018,10 +8047,10 @@ paths: Successful response: value: type: segment - id: 659ec0526abd014ef26e4dc2 + id: 65c6073586ce64ccb655f1fd name: John segment - created_at: 1704902738 - updated_at: 1704902738 + created_at: 1707476789 + updated_at: 1707476789 person_type: user schema: "$ref": "#/components/schemas/segment" @@ -8033,7 +8062,7 @@ paths: Segment not found: value: type: error.list - request_id: a61365a1-4bf7-46f6-8523-2485249f69fc + request_id: 8b962fbc-72a9-4092-9ec2-045f491dd844 errors: - code: not_found message: Resource Not Found @@ -8047,7 +8076,7 @@ paths: Unauthorized: value: type: error.list - request_id: bf02f0ae-2ee8-4e95-a19f-2339d3966de9 + request_id: 2839491c-6d6f-46d4-bf94-4f9a506a81dc errors: - code: unauthorized message: Access Token Invalid @@ -8077,7 +8106,7 @@ paths: type: list data: - type: subscription - id: '180' + id: '137' state: live consent_type: opt_out default_translation: @@ -8100,7 +8129,7 @@ paths: Unauthorized: value: type: error.list - request_id: ac3ec790-eb33-4273-bb15-94e3922ba9a1 + request_id: 7587fc85-92f8-49de-b5bb-aeb6cb246c7a errors: - code: unauthorized message: Access Token Invalid @@ -8130,7 +8159,7 @@ paths: examples: successful: value: - url: http://via.intercom.io/msgr/d5e813fc-a1e6-4feb-83c7-a5e3d7323f72 + url: http://via.intercom.io/msgr/c95ac824-216c-487d-9441-3324bfde92dd type: phone_call_redirect schema: "$ref": "#/components/schemas/phone_switch" @@ -8163,7 +8192,7 @@ paths: Unauthorized: value: type: error.list - request_id: b508c27d-2c21-4f6f-836c-cc83840765d5 + request_id: 42405afc-730e-4524-9f6b-5312126c5896 errors: - code: unauthorized message: Access Token Invalid @@ -8226,7 +8255,7 @@ paths: type: list data: - type: tag - id: '127' + id: '96' name: Manual tag 1 schema: "$ref": "#/components/schemas/tag_list" @@ -8238,7 +8267,7 @@ paths: Unauthorized: value: type: error.list - request_id: 41eb6776-5f03-4fee-85ce-d1132e4e6399 + request_id: 7d06aa3a-74df-4bf5-8348-463ed0ca0973 errors: - code: unauthorized message: Access Token Invalid @@ -8277,7 +8306,7 @@ paths: Action successful: value: type: tag - id: '130' + id: '99' name: test schema: "$ref": "#/components/schemas/tag" @@ -8289,7 +8318,7 @@ paths: Invalid parameters: value: type: error.list - request_id: 4c7feb9b-1e4b-4c13-8611-a345d2c70be5 + request_id: 77350370-e08c-4614-9661-11c7b3b13191 errors: - code: parameter_invalid message: invalid tag parameters @@ -8303,14 +8332,14 @@ paths: Company not found: value: type: error.list - request_id: ba6b73de-a50e-469a-bd24-3414e3eb8cd8 + request_id: fa88742a-db5d-4fc1-8404-e68e8565f1fd errors: - code: company_not_found message: Company Not Found User not found: value: type: error.list - request_id: 6e319ef6-07f6-4122-809b-1c40743bac49 + request_id: 62620f1e-da1f-4193-8642-89bd8759c93f errors: - code: not_found message: User Not Found @@ -8324,7 +8353,7 @@ paths: Unauthorized: value: type: error.list - request_id: 4b28d7de-40b0-4695-8d29-4a448c7fe5d2 + request_id: 67e2981b-96f4-4273-bfa5-5767433b663a errors: - code: unauthorized message: Access Token Invalid @@ -8390,7 +8419,7 @@ paths: Tag found: value: type: tag - id: '138' + id: '107' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -8402,7 +8431,7 @@ paths: Tag not found: value: type: error.list - request_id: 2a267451-14c8-4580-8f33-2d44cc2537a8 + request_id: a8432947-36b1-413e-a018-4282e8283076 errors: - code: not_found message: Resource Not Found @@ -8416,7 +8445,7 @@ paths: Unauthorized: value: type: error.list - request_id: 45fa6074-62e3-4731-b7c8-387c89dfe7d7 + request_id: 67f9b6cf-d659-4858-8415-f7cce382c9c2 errors: - code: unauthorized message: Access Token Invalid @@ -8452,7 +8481,7 @@ paths: Resource not found: value: type: error.list - request_id: 9a46fce0-7752-44af-806f-6d14aa0a1098 + request_id: 29860f6e-ab58-4980-9dab-167081eafa30 errors: - code: not_found message: Resource Not Found @@ -8466,7 +8495,7 @@ paths: Tag has dependent objects: value: type: error.list - request_id: 29e0257b-8ba4-40d8-a00b-c18642866d0a + request_id: f0f53633-f00c-4dda-a482-eaba465cac69 errors: - code: tag_has_dependent_objects message: 'Unable to delete Tag with dependent objects. Segments: @@ -8481,7 +8510,7 @@ paths: Unauthorized: value: type: error.list - request_id: 63bc2fce-112a-451c-b56f-2a8bd568394b + request_id: 0e5a240f-af1d-425e-a25e-3815c5567544 errors: - code: unauthorized message: Access Token Invalid @@ -8519,7 +8548,7 @@ paths: Unauthorized: value: type: error.list - request_id: 56e196f9-7766-4e91-9aae-7ed2098d13e5 + request_id: 66bf5009-c973-440d-940f-96edc1ae0a4c errors: - code: unauthorized message: Access Token Invalid @@ -8554,7 +8583,7 @@ paths: successful: value: type: team - id: '991267722' + id: '991267651' name: team 1 admin_ids: [] schema: @@ -8567,7 +8596,7 @@ paths: Team not found: value: type: error.list - request_id: e0d87a7d-a6be-432d-82d8-54ad1ded4bff + request_id: a8f64626-87a4-43f8-8321-f04a99359a62 errors: - code: team_not_found message: Team not found @@ -8581,7 +8610,7 @@ paths: Unauthorized: value: type: error.list - request_id: a7642b24-48cb-4640-9bcd-b92051657c54 + request_id: 6149fc4b-feba-4014-88e7-b5a7f7386432 errors: - code: unauthorized message: Access Token Invalid @@ -8613,26 +8642,26 @@ paths: successful: value: type: visitor - id: 659ec0926abd014ef26e4edc + id: 65c6075286ce64ccb655f221 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' phone: name: Gareth Bale - pseudonym: Violet Deer + pseudonym: Turquoise Locomotive avatar: type: avatar - image_url: https://static.intercomassets.com/app/pseudonym_avatars_2019/violet-deer.png - app_id: this_is_an_id592_that_should_be_at_least_ + image_url: https://static.intercomassets.com/app/pseudonym_avatars_2019/turquoise-locomotive.png + app_id: this_is_an_id609_that_should_be_at_least_ companies: type: company.list companies: [] location_data: {} last_request_at: - created_at: 1704902802 - remote_created_at: 1704902802 - signed_up_at: 1704902802 - updated_at: 1704902802 + created_at: 1707476818 + remote_created_at: 1707476818 + signed_up_at: 1707476818 + updated_at: 1707476819 session_count: 0 social_profiles: type: social_profile.list @@ -8665,7 +8694,7 @@ paths: visitor Not Found: value: type: error.list - request_id: d505b76a-c372-4f4d-a133-44c024682903 + request_id: 2cd6306d-9a17-40cd-a527-7837e0680ba9 errors: - code: not_found message: Visitor Not Found @@ -8679,7 +8708,7 @@ paths: Unauthorized: value: type: error.list - request_id: 6c9a138a-36e9-4c4a-accc-924eafa4cee8 + request_id: 75b8e6d7-316a-42eb-b021-613598a6be21 errors: - code: unauthorized message: Access Token Invalid @@ -8694,7 +8723,7 @@ paths: successful: summary: successful value: - id: 659ec0926abd014ef26e4edc + id: 65c6075286ce64ccb655f221 name: Gareth Bale visitor_not_found: summary: visitor Not Found @@ -8727,7 +8756,7 @@ paths: successful: value: type: visitor - id: 659ec0936abd014ef26e4ee2 + id: 65c6075486ce64ccb655f227 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' @@ -8737,16 +8766,16 @@ paths: avatar: type: avatar image_url: - app_id: this_is_an_id598_that_should_be_at_least_ + app_id: this_is_an_id615_that_should_be_at_least_ companies: type: company.list companies: [] location_data: {} last_request_at: - created_at: 1704902803 - remote_created_at: 1704902803 - signed_up_at: 1704902803 - updated_at: 1704902803 + created_at: 1707476820 + remote_created_at: 1707476820 + signed_up_at: 1707476820 + updated_at: 1707476820 session_count: 0 social_profiles: type: social_profile.list @@ -8779,7 +8808,7 @@ paths: Visitor not found: value: type: error.list - request_id: aa48054b-62ff-4c7b-abc4-3e8f6c2a1633 + request_id: 31be579b-8e23-4e38-81f2-764e9aa56439 errors: - code: not_found message: Visitor Not Found @@ -8793,7 +8822,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0d3ed27a-0248-47ea-95bf-3a206885761d + request_id: 9bfd6a61-9197-419c-88e5-ca46a566dcc4 errors: - code: unauthorized message: Access Token Invalid @@ -8827,7 +8856,7 @@ paths: successful: value: type: visitor - id: 659ec0956abd014ef26e4ee8 + id: 65c6075586ce64ccb655f22d user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' @@ -8837,16 +8866,16 @@ paths: avatar: type: avatar image_url: - app_id: this_is_an_id604_that_should_be_at_least_ + app_id: this_is_an_id621_that_should_be_at_least_ companies: type: company.list companies: [] location_data: {} last_request_at: - created_at: 1704902805 - remote_created_at: 1704902805 - signed_up_at: 1704902805 - updated_at: 1704902805 + created_at: 1707476821 + remote_created_at: 1707476821 + signed_up_at: 1707476821 + updated_at: 1707476821 session_count: 0 social_profiles: type: social_profile.list @@ -8879,7 +8908,7 @@ paths: Visitor not found: value: type: error.list - request_id: 335184da-c6fe-4020-b1ff-48993f7594cf + request_id: 24ef05f4-b612-4a4a-8cff-8ebc541b3a72 errors: - code: not_found message: Visitor Not Found @@ -8893,7 +8922,7 @@ paths: Unauthorized: value: type: error.list - request_id: 613b17be-6510-4373-bfa7-a1ec831e529e + request_id: e25ac92d-da28-4ad5-bfca-4cbdb71fae03 errors: - code: unauthorized message: Access Token Invalid @@ -8926,7 +8955,7 @@ paths: successful: value: type: visitor - id: 659ec0966abd014ef26e4eee + id: 65c6075786ce64ccb655f233 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' @@ -8936,16 +8965,16 @@ paths: avatar: type: avatar image_url: - app_id: this_is_an_id610_that_should_be_at_least_ + app_id: this_is_an_id627_that_should_be_at_least_ companies: type: company.list companies: [] location_data: {} last_request_at: - created_at: 1704902806 - remote_created_at: 1704902806 - signed_up_at: 1704902806 - updated_at: 1704902807 + created_at: 1707476823 + remote_created_at: 1707476823 + signed_up_at: 1707476823 + updated_at: 1707476824 session_count: 0 social_profiles: type: social_profile.list @@ -8978,7 +9007,7 @@ paths: Visitor Not Found: value: type: error.list - request_id: fb746054-43c0-49c9-acf7-1a88914445a9 + request_id: 7a894497-687a-4a44-ad57-343167f0d181 errors: - code: not_found message: User Not Found @@ -8992,7 +9021,7 @@ paths: Unauthorized: value: type: error.list - request_id: dc30cce0-e7f5-452a-ae94-5a3887df8e8b + request_id: 2aa068e1-39ae-4ab7-a507-974a0ddb0d56 errors: - code: unauthorized message: Access Token Invalid @@ -9023,8 +9052,8 @@ paths: successful: value: type: contact - id: 659ec0986abd014ef26e4ef5 - workspace_id: this_is_an_id616_that_should_be_at_least_ + id: 65c6075986ce64ccb655f23a + workspace_id: this_is_an_id633_that_should_be_at_least_ external_id: role: user email: foo@bar.com @@ -9038,9 +9067,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1704902808 - updated_at: 1704902808 - signed_up_at: 1704902808 + created_at: 1707476825 + updated_at: 1707476826 + signed_up_at: 1707476825 last_seen_at: last_replied_at: last_contacted_at: @@ -9074,31 +9103,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ec0986abd014ef26e4ef5/tags" + url: "/contacts/65c6075986ce64ccb655f23a/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ec0986abd014ef26e4ef5/notes" + url: "/contacts/65c6075986ce64ccb655f23a/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ec0986abd014ef26e4ef5/companies" + url: "/contacts/65c6075986ce64ccb655f23a/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ec0986abd014ef26e4ef5/subscriptions" + url: "/contacts/65c6075986ce64ccb655f23a/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ec0986abd014ef26e4ef5/subscriptions" + url: "/contacts/65c6075986ce64ccb655f23a/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -9117,7 +9146,7 @@ paths: Unauthorized: value: type: error.list - request_id: f3917e09-b7f7-466b-a03f-5c39af75ff09 + request_id: 151767c5-5c28-40e2-86af-694cad4bc162 errors: - code: unauthorized message: Access Token Invalid @@ -11680,6 +11709,10 @@ components: example: - option1 - option2 + messenger_writable: + type: boolean + description: Can this attribute be updated by the Messenger + example: false required: - name - model @@ -11707,7 +11740,8 @@ components: example: '314159' id: type: string - description: Your identifier for a lead or a user. + description: The unique identifier for the contact (lead or user) which + is given by Intercom. example: 8a88a590-e1c3-41e2-a502-e0649dbf721c email: type: string @@ -12023,6 +12057,8 @@ components: custom_object_instance: title: Custom Object Instance type: object + x-tags: + - Custom Object Instances nullable: true description: An instance of a Custom Object Type. properties: @@ -12143,6 +12179,10 @@ components: type: boolean description: Can this attribute be updated through API example: true + messenger_writable: + type: boolean + description: Can this attribute be updated by the Messenger + example: false ui_writable: type: boolean description: Can this attribute be updated in the UI @@ -14120,6 +14160,10 @@ components: example: - option1 - option2 + messenger_writable: + type: boolean + description: Can this attribute be updated by the Messenger + example: false update_section_request: description: You can update a Section type: object diff --git a/descriptions/2.9/api.intercom.io.yaml b/descriptions/2.9/api.intercom.io.yaml index e254724..148fd94 100644 --- a/descriptions/2.9/api.intercom.io.yaml +++ b/descriptions/2.9/api.intercom.io.yaml @@ -37,7 +37,7 @@ paths: Successful response: value: type: admin - id: '991267808' + id: '991267745' email: admin1@email.com name: Ciaran1 Lee email_verified: true @@ -45,7 +45,7 @@ paths: type: app id_code: this_is_an_id1_that_should_be_at_least_40 name: MyApp 1 - created_at: 1704902823 + created_at: 1707476837 secure: false identity_verification: false timezone: America/Los_Angeles @@ -83,7 +83,7 @@ paths: Successful response: value: type: admin - id: '991267809' + id: '991267746' name: Ciaran2 Lee email: admin2@email.com away_mode_enabled: true @@ -100,7 +100,7 @@ paths: Admin not found: value: type: error.list - request_id: adabb429-08c2-43f2-8a6b-784b9afd674c + request_id: d186d77c-a65a-496b-8f8f-23494319a108 errors: - code: admin_not_found message: Admin for admin_id not found @@ -114,7 +114,7 @@ paths: Unauthorized: value: type: error.list - request_id: 5e1b6924-2eea-42c2-8622-3741f1910d5c + request_id: 9aa85898-3727-441d-936b-57dbd7397fd0 errors: - code: unauthorized message: Access Token Invalid @@ -201,23 +201,10 @@ paths: per_page: 20 total_pages: 1 activity_logs: - - id: ee5f3abc-b0b6-41b0-a93e-cc2b5f36c9f2 + - id: 5a3e18e1-df8a-4135-ac8a-56d57ac16772 performed_by: type: admin - id: '991267813' - email: admin5@email.com - ip: 127.0.0.1 - metadata: - before: before - after: after - created_at: 1704902827 - activity_type: app_name_change - activity_description: Ciaran5 Lee changed your app name from - before to after. - - id: 8db87959-db56-4f95-ae4d-8dd5fbcb4276 - performed_by: - type: admin - id: '991267813' + id: '991267750' email: admin5@email.com ip: 127.0.0.1 metadata: @@ -226,11 +213,24 @@ paths: title: Initial message title before: Initial message title after: Eventual message title - created_at: 1704902827 + created_at: 1707476843 activity_type: message_state_change activity_description: Ciaran5 Lee changed your Initial message title message from Initial message title to Eventual message title. + - id: 608e5755-52e7-4890-a298-0340f32a796f + performed_by: + type: admin + id: '991267750' + email: admin5@email.com + ip: 127.0.0.1 + metadata: + before: before + after: after + created_at: 1707476843 + 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: 8ff769a0-9643-4d70-8294-6798ae21bb5c + request_id: 8f715c2e-3cc4-4e6e-affd-35d399d1b813 errors: - code: unauthorized message: Access Token Invalid @@ -271,7 +271,7 @@ paths: admins: - type: admin email: admin7@email.com - id: '991267816' + id: '991267752' name: Ciaran7 Lee away_mode_enabled: false away_mode_reassign: false @@ -287,7 +287,7 @@ paths: Unauthorized: value: type: error.list - request_id: 3a6c9d43-d89e-4d07-8cd8-daaece08ed1c + request_id: 2be30ae6-715b-457f-a58f-e2937a9984e7 errors: - code: unauthorized message: Access Token Invalid @@ -321,7 +321,7 @@ paths: Admin found: value: type: admin - id: '991267818' + id: '991267754' 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: c7eb7f2d-fdd3-41af-ad95-7130561ec38e + request_id: 011baf54-a7e5-4e56-b9bd-5d0da45712da errors: - code: admin_not_found message: Admin not found @@ -352,7 +352,7 @@ paths: Unauthorized: value: type: error.list - request_id: 766ffbdd-ecbe-469e-a0e8-eac8b373b5d5 + request_id: 57c0ca3f-1288-4400-a0a7-be0aa57b6ff5 errors: - code: unauthorized message: Access Token Invalid @@ -390,20 +390,20 @@ paths: total_pages: 1 total_count: 1 data: - - id: '69' + - id: '93' type: article workspace_id: this_is_an_id22_that_should_be_at_least_4 - parent_id: 289 + parent_id: 278 parent_type: collection parent_ids: [] title: This is the article title description: '' body: '' - author_id: 991267821 + author_id: 991267757 state: published - created_at: 1704902833 - updated_at: 1704902833 - url: http://help-center.test/myapp-22/en/articles/69-this-is-the-article-title + created_at: 1707476848 + updated_at: 1707476848 + url: http://help-center.test/myapp-22/en/articles/93-this-is-the-article-title schema: "$ref": "#/components/schemas/article_list" '401': @@ -414,7 +414,7 @@ paths: Unauthorized: value: type: error.list - request_id: fca23410-2d91-4784-8e7e-12dff110af80 + request_id: 6c0b241b-8eb9-422d-8108-7efe7c2825fb errors: - code: unauthorized message: Access Token Invalid @@ -439,10 +439,10 @@ paths: examples: article created: value: - id: '72' + id: '96' type: article workspace_id: this_is_an_id26_that_should_be_at_least_4 - parent_id: 291 + parent_id: 280 parent_type: collection parent_ids: [] statistics: @@ -456,11 +456,11 @@ paths: title: Thanks for everything description: Description of the Article body:Body of the Article
- author_id: 991267826 + author_id: 991267762 state: published - created_at: 1704902834 - updated_at: 1704902834 - url: http://help-center.test/myapp-26/en/articles/72-thanks-for-everything + created_at: 1707476850 + updated_at: 1707476850 + url: http://help-center.test/myapp-26/en/articles/96-thanks-for-everything schema: "$ref": "#/components/schemas/article" '400': @@ -471,7 +471,7 @@ paths: Bad Request: value: type: error.list - request_id: 84f09864-04a6-4dcc-b935-0b54c4efe7f8 + request_id: c5dc8e03-1037-449b-883c-31be83b29c38 errors: - code: parameter_not_found message: author_id must be in the main body or default locale @@ -486,7 +486,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9a17b1d3-4de5-4257-b44e-58de0e465d6d + request_id: ee0244f7-93e2-4c72-83e8-fa79e470e323 errors: - code: unauthorized message: Access Token Invalid @@ -504,16 +504,16 @@ paths: title: Thanks for everything description: Description of the Article body: Body of the Article - author_id: 991267826 + author_id: 991267762 state: published - parent_id: 291 + parent_id: 280 parent_type: collection translated_content: fr: title: Merci pour tout description: Description de l'article body: Corps de l'article - author_id: 991267826 + author_id: 991267762 state: published bad_request: summary: Bad Request @@ -550,10 +550,10 @@ paths: examples: Article found: value: - id: '75' + id: '99' type: article workspace_id: this_is_an_id32_that_should_be_at_least_4 - parent_id: 294 + parent_id: 283 parent_type: collection parent_ids: [] statistics: @@ -567,11 +567,11 @@ paths: title: This is the article title description: '' body: '' - author_id: 991267831 + author_id: 991267767 state: published - created_at: 1704902836 - updated_at: 1704902836 - url: http://help-center.test/myapp-32/en/articles/75-this-is-the-article-title + created_at: 1707476851 + updated_at: 1707476851 + url: http://help-center.test/myapp-32/en/articles/99-this-is-the-article-title schema: "$ref": "#/components/schemas/article" '404': @@ -582,7 +582,7 @@ paths: Article not found: value: type: error.list - request_id: 05d1fd22-0d8e-4d12-9323-9201bb9f0c0f + request_id: cf55d0e1-2a1d-49f0-b588-548063efd658 errors: - code: not_found message: Resource Not Found @@ -596,7 +596,7 @@ paths: Unauthorized: value: type: error.list - request_id: bc8f0fb0-6428-4249-aa88-309b37687493 + request_id: df0c2e06-86f3-443b-a7b3-c8624c72e0d8 errors: - code: unauthorized message: Access Token Invalid @@ -629,10 +629,10 @@ paths: examples: successful: value: - id: '78' + id: '102' type: article workspace_id: this_is_an_id38_that_should_be_at_least_4 - parent_id: 297 + parent_id: 286 parent_type: collection parent_ids: [] statistics: @@ -646,11 +646,11 @@ paths: title: Christmas is here! description: '' body:New gifts in store for the jolly season
- author_id: 991267837 + author_id: 991267773 state: published - created_at: 1704902838 - updated_at: 1704902839 - url: http://help-center.test/myapp-38/en/articles/78-christmas-is-here + created_at: 1707476854 + updated_at: 1707476855 + url: http://help-center.test/myapp-38/en/articles/102-christmas-is-here schema: "$ref": "#/components/schemas/article" '404': @@ -661,7 +661,7 @@ paths: Article Not Found: value: type: error.list - request_id: 35f68ce1-a650-44ee-a083-0971b276344c + request_id: 30a89d0f-86e2-4def-b39e-ed53582b4e8f errors: - code: not_found message: Resource Not Found @@ -675,7 +675,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2e09b396-5913-4582-ad9c-25c6aa366bc7 + request_id: aa1061f4-ba22-4c86-bc9f-9590fbe9f433 errors: - code: unauthorized message: Access Token Invalid @@ -723,7 +723,7 @@ paths: examples: successful: value: - id: '81' + id: '105' object: article deleted: true schema: @@ -736,7 +736,7 @@ paths: Article Not Found: value: type: error.list - request_id: dbd59725-2753-459d-90ea-fa2fa3a944fa + request_id: 6147e698-534a-4cac-bfa8-682bd371740c errors: - code: not_found message: Resource Not Found @@ -750,7 +750,7 @@ paths: Unauthorized: value: type: error.list - request_id: dd9e3b92-6042-4153-b65f-88f756982912 + request_id: acc349de-a4e4-4422-a42a-e049b2438302 errors: - code: unauthorized message: Access Token Invalid @@ -783,16 +783,16 @@ paths: value: type: list data: - - id: '305' + - id: '294' workspace_id: this_is_an_id52_that_should_be_at_least_4 name: English collection title url: http://help-center.test/myapp-52/collection-17 order: 17 - created_at: 1704902843 - updated_at: 1704902843 + created_at: 1707476860 + updated_at: 1707476860 description: english collection description icon: bookmark - help_center_id: 161 + help_center_id: 173 type: collection total_count: 1 pages: @@ -810,7 +810,7 @@ paths: Unauthorized: value: type: error.list - request_id: c98dc46d-d655-4149-aa39-58c45d2dda6f + request_id: 523f7427-ca90-4bbf-896e-9d81652f8065 errors: - code: unauthorized message: Access Token Invalid @@ -835,16 +835,16 @@ paths: examples: collection created: value: - id: '311' + id: '300' workspace_id: this_is_an_id56_that_should_be_at_least_4 name: Thanks for everything url: http://help-center.test/myapp-56/ order: 1 - created_at: 1704902844 - updated_at: 1704902844 + created_at: 1707476861 + updated_at: 1707476861 description: '' icon: book-bookmark - help_center_id: 163 + help_center_id: 175 type: collection schema: "$ref": "#/components/schemas/collection" @@ -856,7 +856,7 @@ paths: Bad Request: value: type: error.list - request_id: 67da973c-f669-4ed2-9030-c0ca347c4fe9 + request_id: e0f8dc2e-b977-4d67-92eb-1de5b5e5fd8d errors: - code: parameter_not_found message: Name is a required parameter. @@ -870,7 +870,7 @@ paths: Unauthorized: value: type: error.list - request_id: 369b40e5-2c2d-493c-a524-768958f3f579 + request_id: b2a522d9-1ced-4242-b68b-845cf7ef689f errors: - code: unauthorized message: Access Token Invalid @@ -918,16 +918,16 @@ paths: examples: Collection found: value: - id: '316' + id: '305' workspace_id: this_is_an_id62_that_should_be_at_least_4 name: English collection title url: http://help-center.test/myapp-62/collection-22 order: 22 - created_at: 1704902845 - updated_at: 1704902845 + created_at: 1707476862 + updated_at: 1707476862 description: english collection description icon: bookmark - help_center_id: 166 + help_center_id: 178 type: collection schema: "$ref": "#/components/schemas/collection" @@ -939,7 +939,7 @@ paths: Collection not found: value: type: error.list - request_id: eb68c4f4-abde-4c20-a82b-eef744f14ec2 + request_id: 3caab645-f837-4664-b291-fbd4efd6c67b errors: - code: not_found message: Resource Not Found @@ -953,7 +953,7 @@ paths: Unauthorized: value: type: error.list - request_id: e314504a-8797-4c9d-9e72-3707930d15a0 + request_id: f1f4a8b7-2b5e-4273-9ae4-9bfe99b17bf8 errors: - code: unauthorized message: Access Token Invalid @@ -986,16 +986,16 @@ paths: examples: successful: value: - id: '322' + id: '311' workspace_id: this_is_an_id68_that_should_be_at_least_4 name: Update collection name url: http://help-center.test/myapp-68/collection-25 order: 25 - created_at: 1704902846 - updated_at: 1704902847 + created_at: 1707476864 + updated_at: 1707476864 description: english collection description icon: folder - help_center_id: 169 + help_center_id: 181 type: collection schema: "$ref": "#/components/schemas/collection" @@ -1007,7 +1007,7 @@ paths: Collection Not Found: value: type: error.list - request_id: 5939266d-0a1b-43d5-bd33-db69c95859ab + request_id: 54ff696c-f7ca-4251-8458-8663cb5e378f errors: - code: not_found message: Resource Not Found @@ -1021,7 +1021,7 @@ paths: Unauthorized: value: type: error.list - request_id: 892bd4f5-c56d-46b6-a131-c2bea01008ce + request_id: 24daabbb-4019-4c70-a5fe-3fb9c87438a0 errors: - code: unauthorized message: Access Token Invalid @@ -1068,7 +1068,7 @@ paths: examples: successful: value: - id: '328' + id: '317' object: collection deleted: true schema: @@ -1081,7 +1081,7 @@ paths: collection Not Found: value: type: error.list - request_id: 3b15ff9a-f05c-4522-af82-ef4099e602f7 + request_id: 00a9938d-6456-4224-acfb-4ba6d64a3632 errors: - code: not_found message: Resource Not Found @@ -1095,7 +1095,7 @@ paths: Unauthorized: value: type: error.list - request_id: 04b9d1ee-00bc-4773-bb69-44666700524b + request_id: db79bf01-2b48-432c-80ea-5efd7946c07e errors: - code: unauthorized message: Access Token Invalid @@ -1129,10 +1129,10 @@ paths: examples: Collection found: value: - id: '175' + id: '187' workspace_id: this_is_an_id80_that_should_be_at_least_4 - created_at: 1704902849 - updated_at: 1704902849 + created_at: 1707476867 + updated_at: 1707476867 identifier: help-center-1 website_turned_on: false display_name: Intercom Help Center @@ -1146,7 +1146,7 @@ paths: Collection not found: value: type: error.list - request_id: 39268986-f572-4bb1-9fb9-0090c5f14aad + request_id: e1482ef8-d9e7-4fdf-9a26-819f179a42a6 errors: - code: not_found message: Resource Not Found @@ -1160,7 +1160,7 @@ paths: Unauthorized: value: type: error.list - request_id: 7d89793d-f51d-443e-9c6f-31c9d01f95de + request_id: dade6117-2a29-4023-b2d8-4d77a6ecccdc errors: - code: unauthorized message: Access Token Invalid @@ -1198,7 +1198,7 @@ paths: Unauthorized: value: type: error.list - request_id: 6da88f8d-86af-4255-be51-a49842a27dfe + request_id: 6c937f6b-6477-417e-b031-ac8b89ba4306 errors: - code: unauthorized message: Access Token Invalid @@ -1230,15 +1230,15 @@ paths: value: type: list data: - - id: '335' + - id: '324' workspace_id: this_is_an_id90_that_should_be_at_least_4 name: English section title url: http://help-center.test/myapp-90/section-15 order: 15 - created_at: 1704902850 - updated_at: 1704902850 + created_at: 1707476869 + updated_at: 1707476869 type: section - parent_id: 334 + parent_id: 323 total_count: 1 pages: type: pages @@ -1255,7 +1255,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9b42eafd-19ec-43e1-ad96-5231654734d6 + request_id: e174b316-6233-4c05-b6be-8c1974471ddb errors: - code: unauthorized message: Access Token Invalid @@ -1280,15 +1280,15 @@ paths: examples: section created: value: - id: '340' + id: '329' workspace_id: this_is_an_id94_that_should_be_at_least_4 name: Thanks for everything url: http://help-center.test/myapp-94/ order: 1 - created_at: 1704902851 - updated_at: 1704902851 + created_at: 1707476870 + updated_at: 1707476870 type: section - parent_id: '338' + parent_id: '327' schema: "$ref": "#/components/schemas/section" '401': @@ -1299,7 +1299,7 @@ paths: Unauthorized: value: type: error.list - request_id: 68fbf9ad-4085-4bf7-b0dd-9f9b1ae0d3ac + request_id: d796bf64-0313-4608-a89e-1df33e8d1899 errors: - code: unauthorized message: Access Token Invalid @@ -1315,7 +1315,7 @@ paths: summary: section created value: name: Thanks for everything - parent_id: 338 + parent_id: 327 "/help_center/sections/{id}": get: summary: Retrieve a section @@ -1344,15 +1344,15 @@ paths: examples: Section found: value: - id: '344' + id: '333' workspace_id: this_is_an_id98_that_should_be_at_least_4 name: English section title url: http://help-center.test/myapp-98/section-19 order: 19 - created_at: 1704902852 - updated_at: 1704902852 + created_at: 1707476871 + updated_at: 1707476871 type: section - parent_id: 343 + parent_id: 332 schema: "$ref": "#/components/schemas/section" '404': @@ -1363,7 +1363,7 @@ paths: Section not found: value: type: error.list - request_id: 4c3e97d3-4446-4e3c-b718-66c325a50c9a + request_id: 4360b739-a03e-4f44-9a66-094042af7a37 errors: - code: not_found message: Resource Not Found @@ -1377,7 +1377,7 @@ paths: Unauthorized: value: type: error.list - request_id: dcb62f52-fe34-447e-b497-304557f92427 + request_id: 8ed3135b-da64-400c-ae8e-5d8014365a6f errors: - code: unauthorized message: Access Token Invalid @@ -1410,15 +1410,15 @@ paths: examples: successful: value: - id: '350' + id: '339' workspace_id: this_is_an_id104_that_should_be_at_least_ name: Update section name url: http://help-center.test/myapp-104/section-22 order: 22 - created_at: 1704902853 - updated_at: 1704902854 + created_at: 1707476873 + updated_at: 1707476873 type: section - parent_id: '349' + parent_id: '338' schema: "$ref": "#/components/schemas/section" '404': @@ -1429,7 +1429,7 @@ paths: Section Not Found: value: type: error.list - request_id: cba3002d-bb7b-421f-80bf-ef4e287ee7ab + request_id: 01dbb902-6a61-42b4-b4f9-466805b149c8 errors: - code: not_found message: Resource Not Found @@ -1443,7 +1443,7 @@ paths: Unauthorized: value: type: error.list - request_id: 37cb6e6f-5ec5-4c2d-92b4-a2ee2fe1e186 + request_id: ec10a91d-a3b7-4cf8-8e52-dab9f57b1e21 errors: - code: unauthorized message: Access Token Invalid @@ -1459,12 +1459,12 @@ paths: summary: successful value: name: Update section name - parent_id: 349 + parent_id: 338 section_not_found: summary: Section Not Found value: name: Update section name - parent_id: 351 + parent_id: 340 delete: summary: Delete a section parameters: @@ -1491,7 +1491,7 @@ paths: examples: successful: value: - id: '356' + id: '345' object: section deleted: true schema: @@ -1504,7 +1504,7 @@ paths: section Not Found: value: type: error.list - request_id: 4b2c0687-e07b-4aad-803d-3beb53e0d805 + request_id: eee03c0d-b28c-4032-81b2-491405c554e0 errors: - code: not_found message: Resource Not Found @@ -1518,7 +1518,7 @@ paths: Unauthorized: value: type: error.list - request_id: 5ca35c91-895e-47b5-bf7a-0a032e0c3aed + request_id: 48a2d6b3-1077-4759-aecf-1735d14e09fb errors: - code: unauthorized message: Access Token Invalid @@ -1551,12 +1551,12 @@ paths: value: type: company company_id: company_remote_id - id: 659ec0cb6abd0150e7d4a1b5 - app_id: this_is_an_id119_that_should_be_at_least_ + id: 65c6078c86ce64cf2a457754 + app_id: this_is_an_id116_that_should_be_at_least_ name: my company remote_created_at: 1374138000 - created_at: 1704902859 - updated_at: 1704902859 + created_at: 1707476876 + updated_at: 1707476876 monthly_spend: 0 session_count: 0 user_count: 0 @@ -1593,7 +1593,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9a5709fd-61be-41f5-bb27-9beda021bc82 + request_id: 71ba1362-75de-42a8-8d08-1ade4bfc22cd errors: - code: unauthorized message: Access Token Invalid @@ -1667,11 +1667,18 @@ paths: tags: - Companies operationId: retrieveCompany - description: "You can fetch a single company by passing in `company_id` or `name`.\n\n - \ `https://api.intercom.io/companies?name={name}`\n\n `https://api.intercom.io/companies?company_id={company_id}`\n\nYou - can fetch all companies and filter by `segment_id` or `tag_id` as a query - parameter.\n \n `https://api.intercom.io/companies?tag_id={tag_id}`\n\n - \ `https://api.intercom.io/companies?segment_id={segment_id}`\n" + description: | + You can fetch a single company by passing in `company_id` or `name`. + + `https://api.intercom.io/companies?name={name}` + + `https://api.intercom.io/companies?company_id={company_id}` + + You can fetch all companies and filter by `segment_id` or `tag_id` as a query parameter. + + `https://api.intercom.io/companies?tag_id={tag_id}` + + `https://api.intercom.io/companies?segment_id={segment_id}` responses: '200': description: Successful @@ -1684,12 +1691,12 @@ paths: data: - type: company company_id: remote_companies_scroll_2 - id: 659ec0cd6abd0150e7d4a1bd - app_id: this_is_an_id125_that_should_be_at_least_ + id: 65c6078e86ce64cf2a45775c + app_id: this_is_an_id122_that_should_be_at_least_ name: IntercomQATest1 - remote_created_at: 1704902861 - created_at: 1704902861 - updated_at: 1704902861 + remote_created_at: 1707476878 + created_at: 1707476878 + updated_at: 1707476878 monthly_spend: 0 session_count: 0 user_count: 4 @@ -1718,7 +1725,7 @@ paths: Company Not Found: value: type: error.list - request_id: b2eb1f08-fc11-4ab7-bbcc-e701c7b71b15 + request_id: cd0db0af-3fae-455f-8065-9bb69736cdf4 errors: - code: company_not_found message: Company Not Found @@ -1732,7 +1739,7 @@ paths: Unauthorized: value: type: error.list - request_id: c2571b36-358b-46dd-b28e-87017711c463 + request_id: 217d5a5c-fd2f-48dd-a59c-b7fe82b4f90c errors: - code: unauthorized message: Access Token Invalid @@ -1767,12 +1774,12 @@ paths: value: type: company company_id: '1' - id: 659ec0cf6abd0150e7d4a1c8 - app_id: this_is_an_id131_that_should_be_at_least_ - name: company2 - remote_created_at: 1704902863 - created_at: 1704902863 - updated_at: 1704902863 + id: 65c6079086ce64cf2a457767 + app_id: this_is_an_id128_that_should_be_at_least_ + name: company1 + remote_created_at: 1707476880 + created_at: 1707476880 + updated_at: 1707476880 monthly_spend: 0 session_count: 0 user_count: 1 @@ -1794,7 +1801,7 @@ paths: Company Not Found: value: type: error.list - request_id: 1286eab5-40f4-4ccf-b723-7ccf9d25e130 + request_id: d913207a-66c1-4b35-b42d-fd463472d6eb errors: - code: company_not_found message: Company Not Found @@ -1808,7 +1815,7 @@ paths: Unauthorized: value: type: error.list - request_id: df99a5e1-3a85-4ee8-bfaa-736f1e2f3baa + request_id: 8b8df705-15b9-4400-823b-b6a0e6122806 errors: - code: unauthorized message: Access Token Invalid @@ -1842,12 +1849,12 @@ paths: value: type: company company_id: '1' - id: 659ec0d16abd0150e7d4a1d2 - app_id: this_is_an_id137_that_should_be_at_least_ - name: company3 - remote_created_at: 1704902865 - created_at: 1704902865 - updated_at: 1704902865 + id: 65c6079386ce64cf2a457771 + app_id: this_is_an_id134_that_should_be_at_least_ + name: company2 + remote_created_at: 1707476883 + created_at: 1707476883 + updated_at: 1707476883 monthly_spend: 0 session_count: 0 user_count: 1 @@ -1869,7 +1876,7 @@ paths: Company Not Found: value: type: error.list - request_id: 6d97fbfd-884b-495f-8597-3f1cc5bf3f68 + request_id: 2f8a803f-a09c-4ab2-aaa8-c71e2b86d74a errors: - code: company_not_found message: Company Not Found @@ -1883,7 +1890,7 @@ paths: Unauthorized: value: type: error.list - request_id: ea6fd60e-4f9a-4498-9157-581c1b5824b7 + request_id: 2729db27-46ce-4f31-b557-90f646c8a3b3 errors: - code: unauthorized message: Access Token Invalid @@ -1915,7 +1922,7 @@ paths: examples: Successful: value: - id: 659ec0d26abd0150e7d4a1dc + id: 65c6079586ce64cf2a45777b object: company deleted: true schema: @@ -1928,7 +1935,7 @@ paths: Company Not Found: value: type: error.list - request_id: 0a6631bb-f9ec-4f44-9a8d-4651642bd91b + request_id: 1daea551-f0ad-4d8e-a54c-fdf3853a0874 errors: - code: company_not_found message: Company Not Found @@ -1942,7 +1949,7 @@ paths: Unauthorized: value: type: error.list - request_id: 4fef364b-8faf-4cd0-9a12-63c40d27b501 + request_id: bd85c7ee-a82f-44ff-b177-8040c7e44080 errors: - code: unauthorized message: Access Token Invalid @@ -1994,7 +2001,7 @@ paths: Company Not Found: value: type: error.list - request_id: 6f6f775c-8943-4efd-91a5-f68f2d354b8a + request_id: af2fb9e0-7f0d-4f7e-aca5-b71d9bc2b2a2 errors: - code: company_not_found message: Company Not Found @@ -2008,7 +2015,7 @@ paths: Unauthorized: value: type: error.list - request_id: 1607dee9-91b8-40a7-87cf-1ab65c7395eb + request_id: 8b0857da-1337-47bb-b04a-120a74483b13 errors: - code: unauthorized message: Access Token Invalid @@ -2053,7 +2060,7 @@ paths: Company Not Found: value: type: error.list - request_id: ffa847a5-345e-436c-8b70-c372ed3c55eb + request_id: e4bfa047-4894-42b1-bcf4-542758ccea91 errors: - code: company_not_found message: Company Not Found @@ -2067,7 +2074,7 @@ paths: Unauthorized: value: type: error.list - request_id: 1961e7c4-e2ec-4f2e-a609-2a70a12f7273 + request_id: b13efa9f-ffe8-4367-844f-88c88d4ce6c8 errors: - code: unauthorized message: Access Token Invalid @@ -2124,12 +2131,12 @@ paths: data: - type: company company_id: remote_companies_scroll_2 - id: 659ec0d76abd0150e7d4a1f8 - app_id: this_is_an_id161_that_should_be_at_least_ + id: 65c6079c86ce64cf2a457797 + app_id: this_is_an_id158_that_should_be_at_least_ name: IntercomQATest1 - remote_created_at: 1704902871 - created_at: 1704902871 - updated_at: 1704902871 + remote_created_at: 1707476892 + created_at: 1707476892 + updated_at: 1707476892 monthly_spend: 0 session_count: 0 user_count: 4 @@ -2158,7 +2165,7 @@ paths: Unauthorized: value: type: error.list - request_id: 3e39baca-fa03-4ff1-9f23-57ec847d708f + request_id: be347d03-dac4-4d95-8abb-0eb26175d060 errors: - code: unauthorized message: Access Token Invalid @@ -2210,12 +2217,12 @@ paths: data: - type: company company_id: remote_companies_scroll_2 - id: 659ec0d86abd0150e7d4a1fe - app_id: this_is_an_id165_that_should_be_at_least_ + id: 65c6079e86ce64cf2a45779d + app_id: this_is_an_id162_that_should_be_at_least_ name: IntercomQATest1 - remote_created_at: 1704902872 - created_at: 1704902872 - updated_at: 1704902872 + remote_created_at: 1707476894 + created_at: 1707476894 + updated_at: 1707476894 monthly_spend: 0 session_count: 0 user_count: 4 @@ -2229,7 +2236,7 @@ paths: custom_attributes: {} pages: total_count: - scroll_param: 958fdfa5-9134-4378-9d03-2cf10be6c276 + scroll_param: d9c5fc79-7255-4d53-b540-c752fa469598 schema: "$ref": "#/components/schemas/company_scroll" '401': @@ -2240,7 +2247,7 @@ paths: Unauthorized: value: type: error.list - request_id: 159aecde-b763-4fda-8b78-82eaec4fe6ae + request_id: e49854e2-beda-4d84-9182-71e4d7122384 errors: - code: unauthorized message: Access Token Invalid @@ -2275,12 +2282,12 @@ paths: value: type: company company_id: '1' - id: 659ec0da6abd0150e7d4a207 - app_id: this_is_an_id169_that_should_be_at_least_ - name: company7 - remote_created_at: 1704902874 - created_at: 1704902874 - updated_at: 1704902874 + id: 65c6079f86ce64cf2a4577a6 + app_id: this_is_an_id166_that_should_be_at_least_ + name: company6 + remote_created_at: 1707476895 + created_at: 1707476895 + updated_at: 1707476895 monthly_spend: 0 session_count: 0 user_count: 1 @@ -2294,6 +2301,20 @@ paths: custom_attributes: {} schema: "$ref": "#/components/schemas/company" + '400': + description: Bad Request + content: + application/json: + examples: + Bad Request: + value: + type: error.list + request_id: 22f32168-f9e1-43c8-be2f-ea72eb7b7e87 + errors: + - code: parameter_not_found + message: company not specified + schema: + "$ref": "#/components/schemas/error" '404': description: Company Not Found content: @@ -2302,10 +2323,10 @@ paths: Company Not Found: value: type: error.list - request_id: 7f28d574-cf79-44c2-9f2a-5f96103cbd98 + request_id: 47bee9ec-626a-42d1-b093-44d17e6441fc errors: - - code: not_found - message: User Not Found + - code: company_not_found + message: Company Not Found schema: "$ref": "#/components/schemas/error" '401': @@ -2316,7 +2337,7 @@ paths: Unauthorized: value: type: error.list - request_id: babe1ec5-ef88-491d-b687-c0c953fe8e50 + request_id: 42193823-de5a-4dd1-bde5-56f9925f0209 errors: - code: unauthorized message: Access Token Invalid @@ -2339,11 +2360,14 @@ paths: successful: summary: Successful value: - id: 659ec0da6abd0150e7d4a207 + id: 65c6079f86ce64cf2a4577a6 + bad_request: + summary: Bad Request + value: company_not_found: summary: Company Not Found value: - id: 659ec0da6abd0150e7d4a20b + id: '123' get: summary: List attached companies for contact parameters: @@ -2375,13 +2399,13 @@ paths: data: - type: company company_id: '1' - id: 659ec0e56abd0150e7d4a239 - app_id: this_is_an_id183_that_should_be_at_least_ - name: company23 - remote_created_at: 1704902885 - created_at: 1704902885 - updated_at: 1704902885 - last_request_at: 1704730085 + id: 65c607a586ce64cf2a4577c7 + app_id: this_is_an_id182_that_should_be_at_least_ + name: company12 + remote_created_at: 1707476901 + created_at: 1707476901 + updated_at: 1707476901 + last_request_at: 1707304101 monthly_spend: 0 session_count: 0 user_count: 1 @@ -2410,7 +2434,7 @@ paths: Contact not found: value: type: error.list - request_id: 21347082-9532-4e27-a90d-8ac088450d34 + request_id: f90e5a66-9c36-4eb4-970e-ab3298029a4c errors: - code: not_found message: User Not Found @@ -2424,7 +2448,7 @@ paths: Unauthorized: value: type: error.list - request_id: eb5b95ba-3be4-4b74-bfd0-47bc77206396 + request_id: bc47bbaa-6557-45cf-b5ef-2bc9d151cf5a errors: - code: unauthorized message: Access Token Invalid @@ -2467,12 +2491,12 @@ paths: value: type: company company_id: '1' - id: 659ec0dc6abd0150e7d4a213 - app_id: this_is_an_id175_that_should_be_at_least_ - name: company10 - remote_created_at: 1704902876 - created_at: 1704902876 - updated_at: 1704902876 + id: 65c607a286ce64cf2a4577b6 + app_id: this_is_an_id174_that_should_be_at_least_ + name: company8 + remote_created_at: 1707476898 + created_at: 1707476898 + updated_at: 1707476898 monthly_spend: 0 session_count: 0 user_count: 0 @@ -2494,14 +2518,14 @@ paths: Company Not Found: value: type: error.list - request_id: 89533a08-b57b-403b-9038-494d4ea9f6f4 + request_id: 6a80c302-d117-4745-b259-81e0ccffe645 errors: - code: company_not_found message: Company Not Found Contact Not Found: value: type: error.list - request_id: 585d1fce-af5b-4965-a6ca-817512558176 + request_id: 06a8979c-ed9a-49f0-96dc-7ce0c06bebb7 errors: - code: not_found message: User Not Found @@ -2515,7 +2539,7 @@ paths: Unauthorized: value: type: error.list - request_id: 6e569ae0-7273-48f8-a6d0-af048ce2b6e6 + request_id: 3eba8fd4-a463-43c3-92f6-ac47dbe0cd02 errors: - code: unauthorized message: Access Token Invalid @@ -2551,44 +2575,44 @@ paths: type: list data: - type: note - id: '82' - created_at: 1704298087 + id: '42' + created_at: 1706872104 contact: type: contact - id: 659ec0e76abd0150e7d4a244 + id: 65c607a886ce64cf2a4577d2 author: type: admin - id: '991267918' - name: Ciaran109 Lee - email: admin109@email.com + id: '991267855' + name: Ciaran110 Lee + email: admin110@email.com away_mode_enabled: false away_mode_reassign: false body: "This is a note.
" - type: note - id: '81' - created_at: 1704211687 + id: '41' + created_at: 1706785704 contact: type: contact - id: 659ec0e76abd0150e7d4a244 + id: 65c607a886ce64cf2a4577d2 author: type: admin - id: '991267918' - name: Ciaran109 Lee - email: admin109@email.com + id: '991267855' + name: Ciaran110 Lee + email: admin110@email.com away_mode_enabled: false away_mode_reassign: false body: "This is a note.
" - type: note - id: '80' - created_at: 1704211687 + id: '40' + created_at: 1706785704 contact: type: contact - id: 659ec0e76abd0150e7d4a244 + id: 65c607a886ce64cf2a4577d2 author: type: admin - id: '991267918' - name: Ciaran109 Lee - email: admin109@email.com + id: '991267855' + name: Ciaran110 Lee + email: admin110@email.com away_mode_enabled: false away_mode_reassign: false body: "This is a note.
" @@ -2609,7 +2633,7 @@ paths: Contact not found: value: type: error.list - request_id: 734b9c3a-eb85-4e51-a9ac-d2276d1aa85d + request_id: e7d41194-80a8-4c16-a9fc-718e9c6c27ba errors: - code: not_found message: User Not Found @@ -2643,16 +2667,16 @@ paths: Successful response: value: type: note - id: '87' - created_at: 1704902888 + id: '47' + created_at: 1707476905 contact: type: contact - id: 659ec0e86abd0150e7d4a246 + id: 65c607a986ce64cf2a4577d4 author: type: admin - id: '991267920' - name: Ciaran111 Lee - email: admin111@email.com + id: '991267857' + name: Ciaran112 Lee + email: admin112@email.com away_mode_enabled: false away_mode_reassign: false body: "Hello
" @@ -2666,14 +2690,14 @@ paths: Admin not found: value: type: error.list - request_id: 2fdf4adf-e739-45c4-b761-8b6663cc0931 + request_id: 8c68b755-c075-44b0-a7a8-e22fc60c1605 errors: - code: not_found message: Resource Not Found Contact not found: value: type: error.list - request_id: c7d979e7-23c9-4251-a0a6-38363f21d3b9 + request_id: 217ee5af-2ac3-4bcd-9586-eceb0c8675e1 errors: - code: not_found message: User Not Found @@ -2703,20 +2727,20 @@ paths: successful_response: summary: Successful response value: - contact_id: 659ec0e86abd0150e7d4a246 - admin_id: 991267920 + contact_id: 65c607a986ce64cf2a4577d4 + admin_id: 991267857 body: Hello admin_not_found: summary: Admin not found value: - contact_id: 659ec0e96abd0150e7d4a247 + contact_id: 65c607aa86ce64cf2a4577d5 admin_id: 123 body: Hello contact_not_found: summary: Contact not found value: contact_id: 123 - admin_id: 991267922 + admin_id: 991267859 body: Hello "/contacts/{contact_id}/segments": get: @@ -2749,10 +2773,10 @@ paths: type: list data: - type: segment - id: 659ec0ea6abd0150e7d4a249 + id: 65c607ab86ce64cf2a4577d7 name: segment - created_at: 1704902890 - updated_at: 1704902890 + created_at: 1707476907 + updated_at: 1707476907 person_type: user schema: "$ref": "#/components/schemas/contact_segments" @@ -2764,7 +2788,7 @@ paths: Contact not found: value: type: error.list - request_id: bff9aac3-5462-45d7-85d3-34cd1711c6ee + request_id: 6ed6c639-ded6-4edd-be25-60b44105d00a errors: - code: not_found message: User Not Found @@ -2778,7 +2802,7 @@ paths: Unauthorized: value: type: error.list - request_id: 64ee93fa-162b-461c-86f5-8d00d8557ae1 + request_id: 819e043c-cfb0-44e0-9a1b-6c8c89ee5c35 errors: - code: unauthorized message: Access Token Invalid @@ -2822,7 +2846,7 @@ paths: type: list data: - type: subscription - id: '182' + id: '139' state: live consent_type: opt_out default_translation: @@ -2836,7 +2860,7 @@ paths: content_types: - email - type: subscription - id: '184' + id: '141' state: live consent_type: opt_in default_translation: @@ -2859,7 +2883,7 @@ paths: Contact not found: value: type: error.list - request_id: 8f1e0767-7d1c-4375-b4fc-50f3cf092b23 + request_id: bd7602d7-7d6c-44a0-938c-d33b739824b7 errors: - code: not_found message: User Not Found @@ -2873,7 +2897,7 @@ paths: Unauthorized: value: type: error.list - request_id: 3e63fd6d-1534-46c8-8eee-760a17d0b4d0 + request_id: 45d47538-80dd-4532-bdac-a46d90571d8a errors: - code: unauthorized message: Access Token Invalid @@ -2914,7 +2938,7 @@ paths: Successful: value: type: subscription - id: '197' + id: '154' state: live consent_type: opt_in default_translation: @@ -2937,14 +2961,14 @@ paths: Contact not found: value: type: error.list - request_id: 5aec4256-6499-460a-9341-0469caf7a5e0 + request_id: 3e40d12d-c73b-463e-8405-1f5d627283e8 errors: - code: not_found message: User Not Found Resource not found: value: type: error.list - request_id: cbb2d192-f32c-4359-96ef-afa56734e463 + request_id: 1247d277-1afd-451c-99f7-82a64fad7eb9 errors: - code: not_found message: Resource Not Found @@ -2958,7 +2982,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2f6b4e03-4296-417a-9351-c5f4236bb265 + request_id: a35f9acc-2023-4870-bab5-95fb5d26e959 errors: - code: unauthorized message: Access Token Invalid @@ -2986,12 +3010,12 @@ paths: successful: summary: Successful value: - id: 197 + id: 154 consent_type: opt_in contact_not_found: summary: Contact not found value: - id: 201 + id: 158 consent_type: opt_in resource_not_found: summary: Resource not found @@ -3037,7 +3061,7 @@ paths: Successful: value: type: subscription - id: '213' + id: '170' state: live consent_type: opt_in default_translation: @@ -3060,14 +3084,14 @@ paths: Contact not found: value: type: error.list - request_id: 604ccbe5-f431-40ff-a279-1354f5710cdd + request_id: b67d2529-308b-48d9-ae76-a6126fb2a461 errors: - code: not_found message: User Not Found Resource not found: value: type: error.list - request_id: ab578239-97fe-4526-a1e4-ee775f50fa18 + request_id: 575cdfd8-bf7b-4d96-8dd3-0530e9dd3e98 errors: - code: not_found message: Resource Not Found @@ -3081,7 +3105,7 @@ paths: Unauthorized: value: type: error.list - request_id: 02467c89-f2c6-4694-88f4-3b82213bac98 + request_id: 7ac91fa9-4bf4-4e18-afdb-bda739fbfd5c errors: - code: unauthorized message: Access Token Invalid @@ -3119,7 +3143,7 @@ paths: type: list data: - type: tag - id: '150' + id: '115' name: Manual tag schema: "$ref": "#/components/schemas/tag_list" @@ -3131,7 +3155,7 @@ paths: Contact not found: value: type: error.list - request_id: 8f1e9ab1-ac6d-4e58-8955-2c0c0bc2110a + request_id: 77377aa2-548e-4d48-91c8-5c571499c7a6 errors: - code: not_found message: User Not Found @@ -3145,7 +3169,7 @@ paths: Unauthorized: value: type: error.list - request_id: 493116be-1b5e-457f-a4e8-2075e35b0937 + request_id: c95c9639-1ae1-40a3-9115-85fd6160e7fa errors: - code: unauthorized message: Access Token Invalid @@ -3180,7 +3204,7 @@ paths: successful: value: type: tag - id: '151' + id: '116' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -3192,14 +3216,14 @@ paths: Contact not found: value: type: error.list - request_id: 86725617-bfde-4f9d-ae94-4deb40e0f247 + request_id: 0dbe8fe4-f36d-4225-b8b3-c8c003d4cb0f errors: - code: not_found message: User Not Found Tag not found: value: type: error.list - request_id: 267fb369-85c0-4219-9407-18f9df64e68d + request_id: 586d34c6-f3e1-4075-8415-e2e5046a4463 errors: - code: not_found message: Resource Not Found @@ -3213,7 +3237,7 @@ paths: Unauthorized: value: type: error.list - request_id: 660e2fbe-662a-4744-b1dc-7e3fe635620e + request_id: 1ad444a7-98cc-4ffd-8f28-2bfbd2d8b7a7 errors: - code: unauthorized message: Access Token Invalid @@ -3236,11 +3260,11 @@ paths: successful: summary: successful value: - id: 151 + id: 116 contact_not_found: summary: Contact not found value: - id: 152 + id: 117 tag_not_found: summary: Tag not found value: @@ -3282,7 +3306,7 @@ paths: successful: value: type: tag - id: '154' + id: '119' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -3294,14 +3318,14 @@ paths: Contact not found: value: type: error.list - request_id: c2f491ba-6701-4ffe-9820-e4dd9c5853c8 + request_id: c015755f-551a-4bb8-b5f5-601b8b5399f4 errors: - code: not_found message: User Not Found Tag not found: value: type: error.list - request_id: 9a57aa58-8bf3-47ef-8c36-782dc7ca8eb1 + request_id: 783eb0f1-bb97-4038-92b4-46b659ed9aa6 errors: - code: not_found message: Resource Not Found @@ -3315,7 +3339,7 @@ paths: Unauthorized: value: type: error.list - request_id: 7725f925-8de6-459c-8cbc-daae6f45c19d + request_id: 9d5f1afe-bbb9-424b-bb82-488420513240 errors: - code: unauthorized message: Access Token Invalid @@ -3349,8 +3373,8 @@ paths: successful: value: type: contact - id: 659ec0f56abd0150e7d4a260 - workspace_id: this_is_an_id249_that_should_be_at_least_ + id: 65c607b886ce64cf2a4577ee + workspace_id: this_is_an_id248_that_should_be_at_least_ external_id: '70' role: user email: joebloggs@intercom.io @@ -3364,9 +3388,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1704902901 - updated_at: 1704902901 - signed_up_at: 1704902901 + created_at: 1707476920 + updated_at: 1707476920 + signed_up_at: 1707476920 last_seen_at: last_replied_at: last_contacted_at: @@ -3400,31 +3424,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ec0f56abd0150e7d4a260/tags" + url: "/contacts/65c607b886ce64cf2a4577ee/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ec0f56abd0150e7d4a260/notes" + url: "/contacts/65c607b886ce64cf2a4577ee/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ec0f56abd0150e7d4a260/companies" + url: "/contacts/65c607b886ce64cf2a4577ee/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ec0f56abd0150e7d4a260/subscriptions" + url: "/contacts/65c607b886ce64cf2a4577ee/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ec0f56abd0150e7d4a260/subscriptions" + url: "/contacts/65c607b886ce64cf2a4577ee/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3443,7 +3467,7 @@ paths: Unauthorized: value: type: error.list - request_id: 47121a8d-212c-4056-80b9-2651473965fd + request_id: 0c8781d9-cc85-466b-ab15-9bbff64e073d errors: - code: unauthorized message: Access Token Invalid @@ -3488,8 +3512,8 @@ paths: successful: value: type: contact - id: 659ec0f66abd0150e7d4a261 - workspace_id: this_is_an_id253_that_should_be_at_least_ + id: 65c607ba86ce64cf2a4577ef + workspace_id: this_is_an_id252_that_should_be_at_least_ external_id: '70' role: user email: joe@bloggs.com @@ -3503,9 +3527,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1704902902 - updated_at: 1704902902 - signed_up_at: 1704902902 + created_at: 1707476922 + updated_at: 1707476922 + signed_up_at: 1707476922 last_seen_at: last_replied_at: last_contacted_at: @@ -3539,31 +3563,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ec0f66abd0150e7d4a261/tags" + url: "/contacts/65c607ba86ce64cf2a4577ef/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ec0f66abd0150e7d4a261/notes" + url: "/contacts/65c607ba86ce64cf2a4577ef/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ec0f66abd0150e7d4a261/companies" + url: "/contacts/65c607ba86ce64cf2a4577ef/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ec0f66abd0150e7d4a261/subscriptions" + url: "/contacts/65c607ba86ce64cf2a4577ef/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ec0f66abd0150e7d4a261/subscriptions" + url: "/contacts/65c607ba86ce64cf2a4577ef/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3582,7 +3606,7 @@ paths: Unauthorized: value: type: error.list - request_id: 7209d3c9-888b-4fa6-8687-c7a507e25ca1 + request_id: c25fc296-8076-425c-b8d0-40eb9037466a errors: - code: unauthorized message: Access Token Invalid @@ -3613,7 +3637,7 @@ paths: examples: successful: value: - id: 659ec0f76abd0150e7d4a262 + id: 65c607bb86ce64cf2a4577f0 object: contact deleted: true schema: @@ -3626,7 +3650,7 @@ paths: Unauthorized: value: type: error.list - request_id: 975d0473-04a5-4050-bf13-4660177336ac + request_id: 4bc14dc6-50fb-49ad-8411-ca76d864ed17 errors: - code: unauthorized message: Access Token Invalid @@ -3654,8 +3678,8 @@ paths: successful: value: type: contact - id: 659ec0f86abd0150e7d4a264 - workspace_id: this_is_an_id261_that_should_be_at_least_ + id: 65c607bc86ce64cf2a4577f2 + workspace_id: this_is_an_id260_that_should_be_at_least_ external_id: '70' role: user email: joe@bloggs.com @@ -3669,9 +3693,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1704902904 - updated_at: 1704902905 - signed_up_at: 1704902904 + created_at: 1707476924 + updated_at: 1707476925 + signed_up_at: 1707476924 last_seen_at: last_replied_at: last_contacted_at: @@ -3705,31 +3729,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ec0f86abd0150e7d4a264/tags" + url: "/contacts/65c607bc86ce64cf2a4577f2/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ec0f86abd0150e7d4a264/notes" + url: "/contacts/65c607bc86ce64cf2a4577f2/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ec0f86abd0150e7d4a264/companies" + url: "/contacts/65c607bc86ce64cf2a4577f2/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ec0f86abd0150e7d4a264/subscriptions" + url: "/contacts/65c607bc86ce64cf2a4577f2/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ec0f86abd0150e7d4a264/subscriptions" + url: "/contacts/65c607bc86ce64cf2a4577f2/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3748,7 +3772,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8c7b36e7-b3df-4afc-9c7c-88cd47668026 + request_id: 82582533-c53f-48ba-93b8-edec818d3395 errors: - code: unauthorized message: Access Token Invalid @@ -3763,8 +3787,8 @@ paths: successful: summary: successful value: - from: 659ec0f86abd0150e7d4a263 - into: 659ec0f86abd0150e7d4a264 + from: 65c607bc86ce64cf2a4577f1 + into: 65c607bc86ce64cf2a4577f2 "/contacts/search": post: summary: Search contacts @@ -3873,7 +3897,7 @@ paths: Unauthorized: value: type: error.list - request_id: 7e2edb61-c818-423f-8e0d-05a588b5f802 + request_id: 45b5a977-ddf1-49a2-8777-7f3e9bcaa43b errors: - code: unauthorized message: Access Token Invalid @@ -3893,15 +3917,15 @@ paths: value: - field: id operator: "=" - value: 659ec0fa6abd0150e7d4a267 + value: 65c607be86ce64cf2a4577f5 - operator: OR value: - field: id operator: "=" - value: 659ec0fa6abd0150e7d4a267 + value: 65c607be86ce64cf2a4577f5 - field: id operator: "=" - value: 659ec0fa6abd0150e7d4a267 + value: 65c607be86ce64cf2a4577f5 "/contacts": get: summary: List all contacts @@ -3940,7 +3964,7 @@ paths: Unauthorized: value: type: error.list - request_id: f8a075d2-3aea-4d38-89b3-d9cd48b5a802 + request_id: c40edb7a-560d-4557-b471-3684296dc75a errors: - code: unauthorized message: Access Token Invalid @@ -3966,8 +3990,8 @@ paths: successful: value: type: contact - id: 659ec0fc6abd0150e7d4a269 - workspace_id: this_is_an_id273_that_should_be_at_least_ + id: 65c607c086ce64cf2a4577f7 + workspace_id: this_is_an_id272_that_should_be_at_least_ external_id: role: user email: joebloggs@intercom.io @@ -3981,8 +4005,8 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1704902908 - updated_at: 1704902908 + created_at: 1707476928 + updated_at: 1707476928 signed_up_at: last_seen_at: last_replied_at: @@ -4017,31 +4041,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ec0fc6abd0150e7d4a269/tags" + url: "/contacts/65c607c086ce64cf2a4577f7/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ec0fc6abd0150e7d4a269/notes" + url: "/contacts/65c607c086ce64cf2a4577f7/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ec0fc6abd0150e7d4a269/companies" + url: "/contacts/65c607c086ce64cf2a4577f7/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ec0fc6abd0150e7d4a269/subscriptions" + url: "/contacts/65c607c086ce64cf2a4577f7/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ec0fc6abd0150e7d4a269/subscriptions" + url: "/contacts/65c607c086ce64cf2a4577f7/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -4060,7 +4084,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0011c608-bd94-4b58-ac28-6cc7a6f5d052 + request_id: 3ca89914-70ca-4e4e-a239-523c568478c0 errors: - code: unauthorized message: Access Token Invalid @@ -4104,7 +4128,7 @@ paths: examples: successful: value: - id: 659ec0fd6abd0150e7d4a26a + id: 65c607c186ce64cf2a4577f8 object: contact archived: true schema: @@ -4136,7 +4160,7 @@ paths: examples: successful: value: - id: 659ec0fd6abd0150e7d4a26b + id: 65c607c286ce64cf2a4577f9 object: contact archived: false schema: @@ -4171,7 +4195,7 @@ paths: successful: value: type: tag - id: '156' + id: '121' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -4183,7 +4207,7 @@ paths: Conversation not found: value: type: error.list - request_id: 1a9bc534-45ec-4078-a30a-73e916bf32dc + request_id: 7f0dc4c8-d437-455d-8188-b943f7554494 errors: - code: not_found message: Conversation not found @@ -4197,7 +4221,7 @@ paths: Unauthorized: value: type: error.list - request_id: 93d77b80-eec9-4055-b0aa-cfbca88f86ff + request_id: ce8a71f5-6064-4589-a35b-a7fad746dd5e errors: - code: unauthorized message: Access Token Invalid @@ -4226,13 +4250,13 @@ paths: successful: summary: successful value: - id: 156 - admin_id: 991267953 + id: 121 + admin_id: 991267890 conversation_not_found: summary: Conversation not found value: - id: 157 - admin_id: 991267955 + id: 122 + admin_id: 991267892 "/conversations/{conversation_id}/tags/{id}": delete: summary: Remove tag from a conversation @@ -4270,7 +4294,7 @@ paths: successful: value: type: tag - id: '159' + id: '124' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -4282,14 +4306,14 @@ paths: Conversation not found: value: type: error.list - request_id: 277712ce-27e0-4c7b-ae91-066ceeb19cf7 + request_id: ae2a2d47-762f-4ea7-84dd-000d0a4f8c84 errors: - code: not_found message: Conversation not found Tag not found: value: type: error.list - request_id: 8f109750-c9b8-4328-b623-e808834cf1d8 + request_id: 6ebd1bb2-494f-453b-8d4b-0e6a80d02863 errors: - code: tag_not_found message: Tag not found @@ -4303,7 +4327,7 @@ paths: Unauthorized: value: type: error.list - request_id: cf174ea1-9258-485e-b746-0855445bd20f + request_id: 7989cfc3-2119-4ee3-b139-8a26d6202e43 errors: - code: unauthorized message: Access Token Invalid @@ -4326,15 +4350,15 @@ paths: successful: summary: successful value: - admin_id: 991267957 + admin_id: 991267894 conversation_not_found: summary: Conversation not found value: - admin_id: 991267959 + admin_id: 991267896 tag_not_found: summary: Tag not found value: - admin_id: 991267960 + admin_id: 991267897 "/conversations": get: summary: List all conversations @@ -4381,22 +4405,22 @@ paths: total_count: 1 conversations: - type: conversation - id: '501' - created_at: 1704902917 - updated_at: 1704902917 + id: '419' + created_at: 1707476939 + updated_at: 1707476939 waiting_since: snoozed_until: source: type: conversation - id: '403918362' + id: '403918311' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991267963' - name: Ciaran151 Lee - email: admin151@email.com + id: '991267900' + name: Ciaran152 Lee + email: admin152@email.com attachments: [] url: redacted: false @@ -4404,7 +4428,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ec1056abd0150e7d4a26f + id: 65c607ca86ce64cf2a4577fd first_contact_reply: admin_assignee_id: team_assignee_id: @@ -4433,7 +4457,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2396f4ba-476a-4638-85a3-8ce8e9ff04cf + request_id: 6aeaf036-57a6-4e4e-b5d0-8f04c1840ac1 errors: - code: unauthorized message: Access Token Invalid @@ -4447,7 +4471,7 @@ paths: API plan restricted: value: type: error.list - request_id: 815c687f-7a92-4c2e-b80f-496d3867d0bc + request_id: bdbe8285-53e1-468e-9bea-287a43bec8f8 errors: - code: api_plan_restricted message: Active subscription needed. @@ -4479,11 +4503,11 @@ paths: conversation created: value: type: user_message - id: '403918372' - created_at: 1704902945 + id: '403918321' + created_at: 1707476959 body: Hello there message_type: inapp - conversation_id: '526' + conversation_id: '444' schema: "$ref": "#/components/schemas/message" '404': @@ -4494,7 +4518,7 @@ paths: Contact Not Found: value: type: error.list - request_id: 9ba8a498-d28d-405d-8bac-a9d4b08cf966 + request_id: cbaabc50-6e35-4b9b-bfb7-9a7cb98ddfd5 errors: - code: not_found message: User Not Found @@ -4508,7 +4532,7 @@ paths: Unauthorized: value: type: error.list - request_id: 004bcbf6-03a8-4119-8c10-6ad97eca232e + request_id: 4d083165-b5c6-45eb-a11b-3c43e277496a errors: - code: unauthorized message: Access Token Invalid @@ -4522,7 +4546,7 @@ paths: API plan restricted: value: type: error.list - request_id: 52e8f221-479a-4953-8b8a-7d9531207c3d + request_id: 9ecdd7f7-f39d-444b-ac0f-226e38eb5283 errors: - code: api_plan_restricted message: Active subscription needed. @@ -4539,7 +4563,7 @@ paths: value: from: type: user - id: 659ec1206abd0150e7d4a284 + id: 65c607de86ce64cf2a457812 body: Hello there contact_not_found: summary: Contact Not Found @@ -4591,22 +4615,22 @@ paths: conversation found: value: type: conversation - id: '530' - created_at: 1704902951 - updated_at: 1704902951 + id: '448' + created_at: 1707476965 + updated_at: 1707476965 waiting_since: snoozed_until: source: type: conversation - id: '403918376' + id: '403918325' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991267977' - name: Ciaran158 Lee - email: admin158@email.com + id: '991267914' + name: Ciaran159 Lee + email: admin159@email.com attachments: [] url: redacted: false @@ -4614,7 +4638,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ec1276abd0150e7d4a288 + id: 65c607e486ce64cf2a457816 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -4647,7 +4671,7 @@ paths: Not found: value: type: error.list - request_id: 976db409-4830-4b64-82c0-2ce5b559f2aa + request_id: 8dc888ec-dbb1-476f-aa41-2090a2cdbad2 errors: - code: not_found message: Resource Not Found @@ -4661,7 +4685,7 @@ paths: Unauthorized: value: type: error.list - request_id: 22d16229-c2c9-4c15-90dc-7ecba105ff05 + request_id: 54dcfe22-3613-430a-bdbe-a66c9e55e77e errors: - code: unauthorized message: Access Token Invalid @@ -4675,7 +4699,7 @@ paths: API plan restricted: value: type: error.list - request_id: 9f7d5e4b-469d-46fb-9b5e-1cc20be52c67 + request_id: 7f0cb54a-0e19-444b-b1ba-2e199ce1826b errors: - code: api_plan_restricted message: Active subscription needed. @@ -4718,22 +4742,22 @@ paths: conversation found: value: type: conversation - id: '534' - created_at: 1704902957 - updated_at: 1704902959 + id: '452' + created_at: 1707476971 + updated_at: 1707476973 waiting_since: snoozed_until: source: type: conversation - id: '403918380' + id: '403918329' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991267985' - name: Ciaran162 Lee - email: admin162@email.com + id: '991267922' + name: Ciaran163 Lee + email: admin163@email.com attachments: [] url: redacted: false @@ -4741,7 +4765,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ec12d6abd0150e7d4a28c + id: 65c607eb86ce64cf2a45781a first_contact_reply: admin_assignee_id: team_assignee_id: @@ -4766,34 +4790,34 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '88' + id: '82' part_type: conversation_attribute_updated_by_admin body: - created_at: 1704902959 - updated_at: 1704902959 - notified_at: 1704902959 + created_at: 1707476972 + updated_at: 1707476972 + notified_at: 1707476972 assigned_to: author: - id: '991267986' + id: '991267923' type: bot name: Operator - email: operator+this_is_an_id317_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id316_that_should_be_at_least_@intercom.io attachments: [] external_id: redacted: false - type: conversation_part - id: '89' + id: '83' part_type: conversation_attribute_updated_by_admin body: - created_at: 1704902959 - updated_at: 1704902959 - notified_at: 1704902959 + created_at: 1707476973 + updated_at: 1707476973 + notified_at: 1707476973 assigned_to: author: - id: '991267986' + id: '991267923' type: bot name: Operator - email: operator+this_is_an_id317_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id316_that_should_be_at_least_@intercom.io attachments: [] external_id: redacted: false @@ -4808,7 +4832,7 @@ paths: Not found: value: type: error.list - request_id: 4906a994-7f85-45ba-8973-a278fecc945e + request_id: ff6778dd-36a7-430b-8666-8e3ae9fb96ab errors: - code: not_found message: Resource Not Found @@ -4822,7 +4846,7 @@ paths: Unauthorized: value: type: error.list - request_id: 5f5d043c-6266-4e89-8b02-00a9c9c2c61b + request_id: 5a80c549-8af2-4e0d-877f-e2e4b0adcd5b errors: - code: unauthorized message: Access Token Invalid @@ -4836,7 +4860,7 @@ paths: API plan restricted: value: type: error.list - request_id: 86cde0a3-0310-4277-b7e6-44242c14cb77 + request_id: ce8fa670-ce6b-487b-84c1-9ef9b29ee214 errors: - code: api_plan_restricted message: Active subscription needed. @@ -4955,22 +4979,22 @@ paths: total_count: 1 conversations: - type: conversation - id: '541' - created_at: 1704902970 - updated_at: 1704902970 + id: '459' + created_at: 1707476984 + updated_at: 1707476984 waiting_since: snoozed_until: source: type: conversation - id: '403918387' + id: '403918336' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991268015' - name: Ciaran185 Lee - email: admin185@email.com + id: '991267952' + name: Ciaran186 Lee + email: admin186@email.com attachments: [] url: redacted: false @@ -4978,7 +5002,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ec13a6abd0150e7d4a293 + id: 65c607f886ce64cf2a457821 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5013,15 +5037,15 @@ paths: value: - field: id operator: "=" - value: '541' + value: '459' - operator: OR value: - field: id operator: "=" - value: '541' + value: '459' - field: id operator: "=" - value: '541' + value: '459' "/conversations/{id}/reply": post: summary: Reply to a conversation @@ -5060,22 +5084,22 @@ paths: User reply: value: type: conversation - id: '549' - created_at: 1704902979 - updated_at: 1704902980 - waiting_since: 1704902980 + id: '467' + created_at: 1707476991 + updated_at: 1707476992 + waiting_since: 1707476992 snoozed_until: source: type: conversation - id: '403918390' + id: '403918339' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991268017' - name: Ciaran186 Lee - email: admin186@email.com + id: '991267954' + name: Ciaran187 Lee + email: admin187@email.com attachments: [] url: redacted: false @@ -5083,9 +5107,9 @@ paths: type: contact.list contacts: - type: contact - id: 659ec1426abd0150e7d4a29a + id: 65c607fe86ce64cf2a457828 first_contact_reply: - created_at: 1704902980 + created_at: 1707476992 type: conversation url: admin_assignee_id: @@ -5109,15 +5133,15 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '91' + id: '85' part_type: open body: "Thanks again :)
" - created_at: 1704902980 - updated_at: 1704902980 - notified_at: 1704902980 + created_at: 1707476992 + updated_at: 1707476992 + notified_at: 1707476992 assigned_to: author: - id: 659ec1426abd0150e7d4a29a + id: 65c607fe86ce64cf2a457828 type: user name: Joe Bloggs email: joe@bloggs.com @@ -5128,22 +5152,22 @@ paths: Admin note reply: value: type: conversation - id: '550' - created_at: 1704902981 - updated_at: 1704902983 + id: '468' + created_at: 1707476993 + updated_at: 1707476994 waiting_since: snoozed_until: source: type: conversation - id: '403918391' + id: '403918340' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991268019' - name: Ciaran187 Lee - email: admin187@email.com + id: '991267956' + name: Ciaran188 Lee + email: admin188@email.com attachments: [] url: redacted: false @@ -5151,7 +5175,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ec1456abd0150e7d4a29b + id: 65c6080186ce64cf2a457829 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5174,7 +5198,7 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '92' + id: '86' part_type: note body: |-this is the message body
" author: type: admin - id: '991268023' - name: Ciaran189 Lee - email: admin189@email.com + id: '991267960' + name: Ciaran190 Lee + email: admin190@email.com attachments: [] url: redacted: false @@ -5228,9 +5252,9 @@ paths: type: contact.list contacts: - type: contact - id: 659ec1486abd0150e7d4a29d + id: 65c6080486ce64cf2a45782b first_contact_reply: - created_at: 1704902985 + created_at: 1707476997 type: conversation url: admin_assignee_id: @@ -5254,15 +5278,15 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '93' + id: '87' part_type: open body: "Thanks again :)
" - created_at: 1704902985 - updated_at: 1704902985 - notified_at: 1704902985 + created_at: 1707476997 + updated_at: 1707476997 + notified_at: 1707476997 assigned_to: author: - id: 659ec1486abd0150e7d4a29d + id: 65c6080486ce64cf2a45782b type: user name: Joe Bloggs email: joe@bloggs.com @@ -5280,7 +5304,7 @@ paths: Not found: value: type: error.list - request_id: b0430f67-8bd1-44bb-a70c-9c9da6d5dad9 + request_id: 31d8b2e2-9ef1-4531-89c2-3a7ae8e9400b errors: - code: not_found message: Resource Not Found @@ -5294,7 +5318,7 @@ paths: Unauthorized: value: type: error.list - request_id: f85784f4-8633-446e-beb7-c69244f8ad0a + request_id: 8e487648-cce9-4bbb-a286-2975dc5e4172 errors: - code: unauthorized message: Access Token Invalid @@ -5308,7 +5332,7 @@ paths: API plan restricted: value: type: error.list - request_id: 98fc3b5a-66c2-40b9-aec9-657787c6825e + request_id: f9d39e38-a18b-49b5-8aa4-5680860785c5 errors: - code: api_plan_restricted message: Active subscription needed. @@ -5325,14 +5349,14 @@ paths: value: message_type: comment type: user - intercom_user_id: 659ec1426abd0150e7d4a29a + intercom_user_id: 65c607fe86ce64cf2a457828 body: Thanks again :) admin_note_reply: summary: Admin note reply value: message_type: note type: admin - admin_id: 991268019 + admin_id: 991267956 body: "this is the message body
" author: type: admin - id: '991268031' - name: Ciaran193 Lee - email: admin193@email.com + id: '991267968' + name: Ciaran194 Lee + email: admin194@email.com attachments: [] url: redacted: false @@ -5406,7 +5430,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ec14f6abd0150e7d4a2a1 + id: 65c6080c86ce64cf2a45782f first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5429,18 +5453,18 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '94' + id: '88' part_type: close body: "Goodbye :)
" - created_at: 1704902992 - updated_at: 1704902992 - notified_at: 1704902992 + created_at: 1707477005 + updated_at: 1707477005 + notified_at: 1707477005 assigned_to: author: - id: '991268031' + id: '991267968' type: admin - name: Ciaran193 Lee - email: admin193@email.com + name: Ciaran194 Lee + email: admin194@email.com attachments: [] external_id: redacted: false @@ -5448,22 +5472,22 @@ paths: Snooze a conversation: value: type: conversation - id: '557' - created_at: 1704902993 - updated_at: 1704902994 + id: '475' + created_at: 1707477006 + updated_at: 1707477007 waiting_since: - snoozed_until: 1704906594 + snoozed_until: 1707480607 source: type: conversation - id: '403918398' + id: '403918347' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991268033' - name: Ciaran194 Lee - email: admin194@email.com + id: '991267970' + name: Ciaran195 Lee + email: admin195@email.com attachments: [] url: redacted: false @@ -5471,7 +5495,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ec1516abd0150e7d4a2a2 + id: 65c6080e86ce64cf2a457830 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5494,18 +5518,18 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '95' + id: '89' part_type: snoozed body: - created_at: 1704902994 - updated_at: 1704902994 - notified_at: 1704902994 + created_at: 1707477007 + updated_at: 1707477007 + notified_at: 1707477007 assigned_to: author: - id: '991268033' + id: '991267970' type: admin - name: Ciaran194 Lee - email: admin194@email.com + name: Ciaran195 Lee + email: admin195@email.com attachments: [] external_id: redacted: false @@ -5513,22 +5537,22 @@ paths: Open a conversation: value: type: conversation - id: '562' - created_at: 1704902992 - updated_at: 1704903001 + id: '480' + created_at: 1707477006 + updated_at: 1707477015 waiting_since: snoozed_until: source: type: conversation - id: '403918399' + id: '403918348' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991268035' - name: Ciaran195 Lee - email: admin195@email.com + id: '991267972' + name: Ciaran196 Lee + email: admin196@email.com attachments: [] url: redacted: false @@ -5536,7 +5560,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ec1556abd0150e7d4a2a7 + id: 65c6081286ce64cf2a457835 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5559,18 +5583,18 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '97' + id: '91' part_type: open body: - created_at: 1704903001 - updated_at: 1704903001 - notified_at: 1704903001 + created_at: 1707477015 + updated_at: 1707477015 + notified_at: 1707477015 assigned_to: author: - id: '991268035' + id: '991267972' type: admin - name: Ciaran195 Lee - email: admin195@email.com + name: Ciaran196 Lee + email: admin196@email.com attachments: [] external_id: redacted: false @@ -5578,22 +5602,22 @@ paths: Assign a conversation: value: type: conversation - id: '566' - created_at: 1704903002 - updated_at: 1704903003 + id: '484' + created_at: 1707477016 + updated_at: 1707477017 waiting_since: snoozed_until: source: type: conversation - id: '403918402' + id: '403918351' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991268037' - name: Ciaran196 Lee - email: admin196@email.com + id: '991267974' + name: Ciaran197 Lee + email: admin197@email.com attachments: [] url: redacted: false @@ -5601,9 +5625,9 @@ paths: type: contact.list contacts: - type: contact - id: 659ec15a6abd0150e7d4a2aa + id: 65c6081786ce64cf2a457838 first_contact_reply: - admin_assignee_id: 991268037 + admin_assignee_id: 991267974 team_assignee_id: open: true state: open @@ -5624,20 +5648,20 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '98' + id: '92' part_type: assign_and_reopen body: - created_at: 1704903003 - updated_at: 1704903003 - notified_at: 1704903003 + created_at: 1707477017 + updated_at: 1707477017 + notified_at: 1707477017 assigned_to: type: admin - id: '991268037' + id: '991267974' author: - id: '991268037' + id: '991267974' type: admin - name: Ciaran196 Lee - email: admin196@email.com + name: Ciaran197 Lee + email: admin197@email.com attachments: [] external_id: redacted: false @@ -5652,7 +5676,7 @@ paths: Not found: value: type: error.list - request_id: c48014f3-9a25-4205-a073-a07f24a43a02 + request_id: 84fb52d7-cf97-45fa-85b3-372109ff338c errors: - code: not_found message: Resource Not Found @@ -5666,7 +5690,7 @@ paths: Unauthorized: value: type: error.list - request_id: 14c5ae3e-7f3a-4127-988d-74a2e4195df2 + request_id: c5691903-6fb2-458f-8a1f-dd9e3ebe1dc1 errors: - code: unauthorized message: Access Token Invalid @@ -5680,7 +5704,7 @@ paths: API plan restricted: value: type: error.list - request_id: 2187d8df-523a-4710-9e30-b050799b1faa + request_id: b0c54fae-87d5-447f-90bc-4881d02f9b68 errors: - code: api_plan_restricted message: Active subscription needed. @@ -5701,32 +5725,32 @@ paths: value: message_type: close type: admin - admin_id: 991268031 + admin_id: 991267968 body: Goodbye :) snooze_a_conversation: summary: Snooze a conversation value: message_type: snoozed - admin_id: 991268033 - snoozed_until: 1704906594 + admin_id: 991267970 + snoozed_until: 1707480607 open_a_conversation: summary: Open a conversation value: message_type: open - admin_id: 991268035 + admin_id: 991267972 assign_a_conversation: summary: Assign a conversation value: message_type: assignment type: admin - admin_id: 991268037 - assignee_id: 991268037 + admin_id: 991267974 + assignee_id: 991267974 not_found: summary: Not found value: message_type: close type: admin - admin_id: 991268039 + admin_id: 991267976 body: Goodbye :) "/conversations/{id}/run_assignment_rules": post: @@ -5757,22 +5781,22 @@ paths: Assign a conversation using assignment rules: value: type: conversation - id: '570' - created_at: 1704903007 - updated_at: 1704903007 + id: '488' + created_at: 1707477023 + updated_at: 1707477023 waiting_since: snoozed_until: source: type: conversation - id: '403918406' + id: '403918355' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991268045' - name: Ciaran200 Lee - email: admin200@email.com + id: '991267982' + name: Ciaran201 Lee + email: admin201@email.com attachments: [] url: redacted: false @@ -5780,7 +5804,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ec15f6abd0150e7d4a2ae + id: 65c6081f86ce64cf2a45783c first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5803,20 +5827,20 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '99' + id: '93' part_type: default_assignment body: - created_at: 1704903007 - updated_at: 1704903007 - notified_at: 1704903007 + created_at: 1707477023 + updated_at: 1707477023 + notified_at: 1707477023 assigned_to: type: nobody_admin id: author: - id: '991268046' + id: '991267983' type: bot name: Operator - email: operator+this_is_an_id358_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id357_that_should_be_at_least_@intercom.io attachments: [] external_id: redacted: false @@ -5831,7 +5855,7 @@ paths: Not found: value: type: error.list - request_id: ac56d974-d053-4f54-91d3-b99f5a82c593 + request_id: 34821fd0-cd97-4d6c-89fe-0392dfc4af83 errors: - code: not_found message: Resource Not Found @@ -5845,7 +5869,7 @@ paths: Unauthorized: value: type: error.list - request_id: e9a3ba92-94cf-414a-adfb-cbcc66f6c8f5 + request_id: c6693972-6f40-4ae0-92ea-b1e9ad76ce86 errors: - code: unauthorized message: Access Token Invalid @@ -5859,7 +5883,7 @@ paths: API plan restricted: value: type: error.list - request_id: 750b2a5d-1efd-4e25-9d47-52ecf1afc481 + request_id: 25d65afa-4352-4641-ac18-131591d41ae9 errors: - code: api_plan_restricted message: Active subscription needed. @@ -5898,7 +5922,7 @@ paths: value: customers: - type: user - id: 659ec1646abd0150e7d4a2b2 + id: 65c6082586ce64cf2a457840 schema: "$ref": "#/components/schemas/conversation" '404': @@ -5909,7 +5933,7 @@ paths: Not found: value: type: error.list - request_id: 07c8070a-e2a3-4b68-a516-b4afa3baec7f + request_id: 6f18bb0d-2e08-4706-9c9e-b442510c4ae6 errors: - code: not_found message: Resource Not Found @@ -5923,7 +5947,7 @@ paths: Unauthorized: value: type: error.list - request_id: 67962eff-aac0-431a-b413-da1eb2a0b3bb + request_id: e11966de-bd34-4728-b633-e958136ec472 errors: - code: unauthorized message: Access Token Invalid @@ -5937,7 +5961,7 @@ paths: API plan restricted: value: type: error.list - request_id: 8ae1fda0-308c-43f4-83f1-ed2e65221558 + request_id: 1aa06d56-2725-4c34-9d8a-a09af5291bbc errors: - code: api_plan_restricted message: Active subscription needed. @@ -5952,15 +5976,15 @@ paths: attach_a_contact_to_a_conversation: summary: Attach a contact to a conversation value: - admin_id: 991268053 + admin_id: 991267990 customer: - intercom_user_id: 659ec1646abd0150e7d4a2b2 + intercom_user_id: 65c6082586ce64cf2a457840 not_found: summary: Not found value: - admin_id: 991268055 + admin_id: 991267992 customer: - intercom_user_id: 659ec1656abd0150e7d4a2b3 + intercom_user_id: 65c6082786ce64cf2a457841 "/conversations/{conversation_id}/customers/{contact_id}": delete: summary: Detach a contact from a group conversation @@ -6001,7 +6025,7 @@ paths: value: customers: - type: user - id: 659ec16e6abd0150e7d4a2bd + id: 65c6083286ce64cf2a45784b schema: "$ref": "#/components/schemas/conversation" '404': @@ -6012,14 +6036,14 @@ paths: Conversation not found: value: type: error.list - request_id: 44889af5-e733-45ff-95bc-c079767afac3 + request_id: 58551897-6cef-4c07-a153-2ee7e9ae71e0 errors: - code: not_found message: Resource Not Found Contact not found: value: type: error.list - request_id: 15ff32db-31f4-4ce5-b28b-298b07a388b0 + request_id: 94a53aa3-2d5c-487a-8b40-e891ade8cb83 errors: - code: not_found message: User Not Found @@ -6033,7 +6057,7 @@ paths: Last customer: value: type: error.list - request_id: 709095b4-b462-48bf-b186-978c4bdbf96e + request_id: e417fc41-e3b3-4a05-9926-3f6bc659ef4a errors: - code: parameter_invalid message: Removing the last customer is not allowed @@ -6047,7 +6071,7 @@ paths: Unauthorized: value: type: error.list - request_id: b5c691eb-4e01-4e43-bf10-822ed6c33629 + request_id: eba038e0-5c7a-464d-aaf3-f8d697eeb2f0 errors: - code: unauthorized message: Access Token Invalid @@ -6061,7 +6085,7 @@ paths: API plan restricted: value: type: error.list - request_id: 0a93505d-5e4f-4efd-a964-7f83d349939c + request_id: 3bb1c1e9-8898-41ea-89c9-9be1526ed623 errors: - code: api_plan_restricted message: Active subscription needed. @@ -6076,27 +6100,27 @@ paths: detach_a_contact_from_a_group_conversation: summary: Detach a contact from a group conversation value: - admin_id: 991268061 + admin_id: 991267998 customer: - intercom_user_id: 659ec1686abd0150e7d4a2b6 + intercom_user_id: 65c6082c86ce64cf2a457844 conversation_not_found: summary: Conversation not found value: - admin_id: 991268063 + admin_id: 991268000 customer: - intercom_user_id: 659ec16f6abd0150e7d4a2be + intercom_user_id: 65c6083386ce64cf2a45784c contact_not_found: summary: Contact not found value: - admin_id: 991268065 + admin_id: 991268002 customer: - intercom_user_id: 659ec1756abd0150e7d4a2c5 + intercom_user_id: 65c6083b86ce64cf2a457853 last_customer: summary: Last customer value: - admin_id: 991268067 + admin_id: 991268004 customer: - intercom_user_id: 659ec17c6abd0150e7d4a2cc + intercom_user_id: 65c6084286ce64cf2a45785a "/conversations/redact": post: summary: Redact a conversation part @@ -6123,22 +6147,22 @@ paths: Redact a conversation part: value: type: conversation - id: '626' - created_at: 1704903056 - updated_at: 1704903058 - waiting_since: 1704903057 + id: '544' + created_at: 1707477080 + updated_at: 1707477082 + waiting_since: 1707477081 snoozed_until: source: type: conversation - id: '403918432' + id: '403918381' delivered_as: admin_initiated subject: '' body: "this is the message body
" author: type: admin - id: '991268073' - name: Ciaran214 Lee - email: admin214@email.com + id: '991268010' + name: Ciaran215 Lee + email: admin215@email.com attachments: [] url: redacted: false @@ -6146,9 +6170,9 @@ paths: type: contact.list contacts: - type: contact - id: 659ec1906abd0150e7d4a2e1 + id: 65c6085886ce64cf2a45786f first_contact_reply: - created_at: 1704903057 + created_at: 1707477081 type: conversation url: admin_assignee_id: @@ -6172,15 +6196,15 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '107' + id: '101' part_type: open body: "This message was deleted
" - created_at: 1704903057 - updated_at: 1704903058 - notified_at: 1704903057 + created_at: 1707477081 + updated_at: 1707477082 + notified_at: 1707477081 assigned_to: author: - id: 659ec1906abd0150e7d4a2e1 + id: 65c6085886ce64cf2a45786f type: user name: Joe Bloggs email: joe@bloggs.com @@ -6198,7 +6222,7 @@ paths: Not found: value: type: error.list - request_id: f132f527-b220-4d2c-b8e1-3032b7bf624a + request_id: 22a6cafe-021a-471e-af0d-74580b65a812 errors: - code: conversation_part_or_message_not_found message: Conversation part or message not found @@ -6212,7 +6236,7 @@ paths: Unauthorized: value: type: error.list - request_id: 83bdf77e-e8fa-41e6-b804-48e89b3b5d79 + request_id: d6fe24fc-1ab0-4498-a912-477a2e3f22e9 errors: - code: unauthorized message: Access Token Invalid @@ -6228,8 +6252,8 @@ paths: summary: Redact a conversation part value: type: conversation_part - conversation_id: 626 - conversation_part_id: 107 + conversation_id: 544 + conversation_part_id: 101 not_found: summary: Not found value: @@ -6286,6 +6310,7 @@ paths: data_type: string api_writable: true ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6297,6 +6322,7 @@ paths: data_type: string api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6309,6 +6335,7 @@ paths: data_type: date api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6320,6 +6347,7 @@ paths: data_type: date api_writable: true ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6331,6 +6359,7 @@ paths: data_type: integer api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6343,6 +6372,7 @@ paths: data_type: integer api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6355,6 +6385,7 @@ paths: data_type: string api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6366,6 +6397,7 @@ paths: data_type: float api_writable: true ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6378,6 +6410,7 @@ paths: data_type: integer api_writable: true ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6390,6 +6423,7 @@ paths: data_type: string api_writable: true ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6402,10 +6436,11 @@ paths: data_type: string api_writable: true ui_writable: false + messenger_writable: true custom: false archived: false model: company - - id: 88 + - id: 50 type: data_attribute name: The One Ring full_name: custom_attributes.The One Ring @@ -6415,11 +6450,12 @@ paths: data_type: string api_writable: true ui_writable: false + messenger_writable: true custom: true archived: false - admin_id: '991268089' - created_at: 1704903065 - updated_at: 1704903065 + admin_id: '991268035' + created_at: 1707477093 + updated_at: 1707477093 model: company - type: data_attribute name: id @@ -6429,6 +6465,7 @@ paths: data_type: string api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6440,6 +6477,7 @@ paths: data_type: date api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6451,6 +6489,7 @@ paths: data_type: date api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6462,6 +6501,7 @@ paths: data_type: string api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6473,6 +6513,7 @@ paths: data_type: string api_writable: false ui_writable: false + messenger_writable: true custom: false archived: false model: company @@ -6486,7 +6527,7 @@ paths: Unauthorized: value: type: error.list - request_id: 134f4f6a-16e2-4b53-834b-1f7b3b834969 + request_id: 3aaabad1-e5c1-4733-b6ae-dc8090878232 errors: - code: unauthorized message: Access Token Invalid @@ -6511,7 +6552,7 @@ paths: examples: Successful: value: - id: 91 + id: 53 type: data_attribute name: Mithril Shirt full_name: custom_attributes.Mithril Shirt @@ -6519,11 +6560,12 @@ paths: data_type: string api_writable: true ui_writable: false + messenger_writable: true custom: true archived: false - admin_id: '991268091' - created_at: 1704903067 - updated_at: 1704903067 + admin_id: '991268037' + created_at: 1707477094 + updated_at: 1707477094 model: company schema: "$ref": "#/components/schemas/data_attribute" @@ -6535,7 +6577,7 @@ paths: Same name already exists: value: type: error.list - request_id: 719c9de8-ecd7-42cd-a817-52e8abd7d012 + request_id: 353e01bb-8db4-446f-b96d-964950ff9825 errors: - code: parameter_invalid message: You already have 'The One Ring' in your company data. @@ -6543,7 +6585,7 @@ paths: Invalid name: value: type: error.list - request_id: 72dd093e-76ff-41dd-898f-caddcc1f1bec + request_id: 417fa282-9f1b-4229-89be-493bc8e7d911 errors: - code: parameter_invalid message: Your name for this attribute must only contain alphanumeric @@ -6551,7 +6593,7 @@ paths: Attribute already exists: value: type: error.list - request_id: 0ac95dec-fdea-4f21-95a0-0faac4111ef7 + request_id: acbe0124-7820-425c-ad23-79bfafe6cb1e errors: - code: parameter_invalid message: You already have 'The One Ring' in your company data. @@ -6559,14 +6601,14 @@ paths: Invalid Data Type: value: type: error.list - request_id: adae7702-c350-467c-ae77-e359b005d2e4 + request_id: f1c32cf1-e33b-41a0-a5a5-7f60d10296ea errors: - code: parameter_invalid message: Data Type isn't an option Too few options for list: value: type: error.list - request_id: 91e8f34c-fd04-452c-ae96-641c1b30e72e + request_id: b8daf711-76c4-4a2e-8aee-55f014caf327 errors: - code: parameter_invalid message: The Data Attribute model field must be either contact @@ -6581,7 +6623,7 @@ paths: Unauthorized: value: type: error.list - request_id: add275ad-5ef1-4663-b626-1209ab51885c + request_id: ab4149bb-cbd6-4913-a48f-9a4cb18e2b95 errors: - code: unauthorized message: Access Token Invalid @@ -6660,7 +6702,7 @@ paths: examples: Successful: value: - id: 98 + id: 60 type: data_attribute name: The One Ring full_name: custom_attributes.The One Ring @@ -6672,11 +6714,12 @@ paths: - 11-20 api_writable: true ui_writable: false + messenger_writable: true custom: true archived: false - admin_id: '991268098' - created_at: 1704903069 - updated_at: 1704903070 + admin_id: '991268044' + created_at: 1707477097 + updated_at: 1707477097 model: company schema: "$ref": "#/components/schemas/data_attribute" @@ -6688,7 +6731,7 @@ paths: Too few options in list: value: type: error.list - request_id: e38502e7-7292-4914-8054-24762ad484dd + request_id: adce09d4-bb49-4920-a193-07e824f0d81d errors: - code: parameter_invalid message: Options isn't an array @@ -6702,7 +6745,7 @@ paths: Attribute Not Found: value: type: error.list - request_id: 6ab1582d-89ae-472e-a671-2dbb3f5a0737 + request_id: 72ed8110-35c9-45b0-9e91-eed16b499f4f errors: - code: field_not_found message: We couldn't find that data attribute to update @@ -6716,7 +6759,7 @@ paths: Has Dependant Object: value: type: error.list - request_id: 290b7892-5dbf-441b-b405-20c404963954 + request_id: 60bb5a46-33a3-4d93-9891-656fc65f5424 errors: - code: data_invalid message: The Data Attribute you are trying to archive has a @@ -6731,7 +6774,7 @@ paths: Unauthorized: value: type: error.list - request_id: 7664bf52-aaa1-430a-bf9a-ba21f9e5abe0 + request_id: ad5a539b-a367-46a1-8a5b-d497b4a75ebd errors: - code: unauthorized message: Access Token Invalid @@ -6782,63 +6825,49 @@ paths: tags: - Data Events operationId: createDataEvent - description: "\nYou will need an Access Token that has write permissions to - send Events. Once you have a key you can submit events via POST to the Events - resource, which is located at https://api.intercom.io/events, or you can send - events using one of the client libraries. When working with the HTTP API directly - a client should send the event with a `Content-Type` of `application/json`.\n\nWhen - using the JavaScript API, [adding the code to your app](http://docs.intercom.io/configuring-Intercom/tracking-user-events-in-your-app) - makes the Events API available. Once added, you can submit an event using - the `trackEvent` method. This will associate the event with the Lead or currently - logged-in user or logged-out visitor/lead and send it to Intercom. The final - parameter is a map that can be used to send optional metadata about the event.\n\nWith - the Ruby client you pass a hash describing the event to `Intercom::Event.create`, - or call the `track_user` method directly on the current user object (e.g. - `user.track_event`).\n\n| Type | Description | - Example |\n| - :-------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- - | :-------------------------------------------------------------------------------- - |\n| String | The value is a JSON String | - `\"source\":\"desktop\"` |\n| - Number | The value is a JSON Number | - `\"load\": 3.67` |\n| - Date | The key ends with the String `_date` and the value is a - [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time), assumed to be in - the [UTC](http://en.wikipedia.org/wiki/Coordinated_Universal_Time) timezone. - | `\"contact_date\": 1392036272` |\n| - Link | The value is a HTTP or HTTPS URI. | - `\"article\": \"https://example.org/ab1de.html\"` |\n| - Rich Link | The value is a JSON object that contains `url` and `value` - keys. | - `\"article\": {\"url\": \"https://example.org/ab1de.html\", \"value\":\"the - dude abides\"}` |\n| Monetary Amount | The value is a JSON object that contains - `amount` and `currency` keys. The `amount` key is a positive integer representing - the amount in cents. The price in the example to the right denotes €349.99. - \ | `\"price\": {\"amount\": 34999, \"currency\": \"eur\"}` |\n\n**NB: - For the JSON object types, please note that we do not currently support nested - JSON structure.**\n\n> \U0001F6A7 Lead Events\n>\n> When submitting events - for Leads, you will need to specify the Lead's `id`.\n\n> \U0001F4D8 Metadata - behaviour\n>\n> - We currently limit the number of tracked metadata keys to - 10 per event. Once the quota is reached, we ignore any further keys we receive. - The first 10 metadata keys are determined by the order in which they are sent - in with the event.\n> - It is not possible to change the metadata keys once - the event has been sent. A new event will need to be created with the new - keys and you can archive the old one.\n> - There might be up to 24 hrs delay - when you send a new metadata for an existing event.\n\n> \U0001F4D8 Event - de-duplication\n>\n> The API may detect and ignore duplicate events. Each - event is uniquely identified as a combination of the following data - the - Workspace identifier, the Contact external identifier, the Data Event name - and the Data Event created time. As a result, it is **strongly recommended** - to send a second granularity Unix timestamp in the `created_at` field.\n>\n> - Duplicated events are responded to using the normal `202 Accepted` code - - an error is not thrown, however repeat requests will be counted against any - rate limit that is in place.\n\n### HTTP API Responses\n\n- Successful responses - to submitted events return `202 Accepted` with an empty body.\n- Unauthorised - access will be rejected with a `401 Unauthorized` or `403 Forbidden` response - code.\n- Events sent about users that cannot be found will return a `404 Not - Found`.\n- Event lists containing duplicate events will have those duplicates - ignored.\n- Server errors will return a `500` response code and may contain - an error message in the body.\n\n" + description: |2+ + + You will need an Access Token that has write permissions to send Events. Once you have a key you can submit events via POST to the Events resource, which is located at https://api.intercom.io/events, or you can send events using one of the client libraries. When working with the HTTP API directly a client should send the event with a `Content-Type` of `application/json`. + + When using the JavaScript API, [adding the code to your app](http://docs.intercom.io/configuring-Intercom/tracking-user-events-in-your-app) makes the Events API available. Once added, you can submit an event using the `trackEvent` method. This will associate the event with the Lead or currently logged-in user or logged-out visitor/lead and send it to Intercom. The final parameter is a map that can be used to send optional metadata about the event. + + With the Ruby client you pass a hash describing the event to `Intercom::Event.create`, or call the `track_user` method directly on the current user object (e.g. `user.track_event`). + + **NB: For the JSON object types, please note that we do not currently support nested JSON structure.** + + | Type | Description | Example | + | :-------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------- | + | String | The value is a JSON String | `"source":"desktop"` | + | Number | The value is a JSON Number | `"load": 3.67` | + | Date | The key ends with the String `_date` and the value is a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time), assumed to be in the [UTC](http://en.wikipedia.org/wiki/Coordinated_Universal_Time) timezone. | `"contact_date": 1392036272` | + | Link | The value is a HTTP or HTTPS URI. | `"article": "https://example.org/ab1de.html"` | + | Rich Link | The value is a JSON object that contains `url` and `value` keys. | `"article": {"url": "https://example.org/ab1de.html", "value":"the dude abides"}` | + | Monetary Amount | The value is a JSON object that contains `amount` and `currency` keys. The `amount` key is a positive integer representing the amount in cents. The price in the example to the right denotes €349.99. | `"price": {"amount": 34999, "currency": "eur"}` | + + **Lead Events** + + When submitting events for Leads, you will need to specify the Lead's `id`. + + **Metadata behaviour** + + - We currently limit the number of tracked metadata keys to 10 per event. Once the quota is reached, we ignore any further keys we receive. The first 10 metadata keys are determined by the order in which they are sent in with the event. + - It is not possible to change the metadata keys once the event has been sent. A new event will need to be created with the new keys and you can archive the old one. + - There might be up to 24 hrs delay when you send a new metadata for an existing event. + + **Event de-duplication** + + The API may detect and ignore duplicate events. Each event is uniquely identified as a combination of the following data - the Workspace identifier, the Contact external identifier, the Data Event name and the Data Event created time. As a result, it is **strongly recommended** to send a second granularity Unix timestamp in the `created_at` field. + + Duplicated events are responded to using the normal `202 Accepted` code - an error is not thrown, however repeat requests will be counted against any rate limit that is in place. + + ### HTTP API Responses + + - Successful responses to submitted events return `202 Accepted` with an empty body. + - Unauthorised access will be rejected with a `401 Unauthorized` or `403 Forbidden` response code. + - Events sent about users that cannot be found will return a `404 Not Found`. + - Event lists containing duplicate events will have those duplicates ignored. + - Server errors will return a `500` response code and may contain an error message in the body. + responses: '202': description: successful @@ -6850,7 +6879,7 @@ paths: Unauthorized: value: type: error.list - request_id: e8a11750-b5c0-4d2b-8ea2-ff7c56ca74bd + request_id: 54f330a9-63ef-4629-beda-1efead7cc506 errors: - code: unauthorized message: Access Token Invalid @@ -6936,8 +6965,8 @@ paths: events: [] pages: next: http://api.intercom.test/events?next page - email: user24@email.com - intercom_user_id: 659ec1a66abd0150e7d4a2fa + email: user26@email.com + intercom_user_id: 65c6086d86ce64cf2a457878 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 schema: "$ref": "#/components/schemas/data_event_summary" @@ -6949,7 +6978,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0e835f49-86fa-49cb-8fb0-4858a0e3808d + request_id: 87d51582-346a-48f2-8c70-475bb7a3ee5c errors: - code: unauthorized message: Access Token Invalid @@ -6980,7 +7009,7 @@ paths: Unauthorized: value: type: error.list - request_id: ddc7294c-f22b-48d7-b013-effacea5dab6 + request_id: 7e4094cf-3618-4ce1-8c34-da5e84a6dda0 errors: - code: unauthorized message: Access Token Invalid @@ -7024,7 +7053,7 @@ paths: examples: successful: value: - job_identifier: mnw179sm6z9l88o9 + job_identifier: 236kx42dqyb07n91 status: pending download_url: '' download_expires_at: '' @@ -7039,8 +7068,8 @@ paths: successful: summary: successful value: - created_at_after: 1704885080 - created_at_before: 1704903080 + created_at_after: 1707459103 + created_at_before: 1707477103 "/export/content/data/{job_identifier}": get: summary: Show content data export @@ -7074,7 +7103,7 @@ paths: examples: successful: value: - job_identifier: uks44tbfv0z065ut + job_identifier: jye3y7okpvjzqeue status: pending download_url: '' download_expires_at: '' @@ -7106,7 +7135,7 @@ paths: examples: successful: value: - job_identifier: xj0yyljha1e0mnby + job_identifier: vorh3w7zipzgpd06 status: canceled download_url: '' download_expires_at: '' @@ -7167,32 +7196,32 @@ paths: user message created: value: type: user_message - id: '403918443' - created_at: 1704903108 + id: '403918386' + created_at: 1707477106 body: heyy message_type: inapp - conversation_id: '642' + conversation_id: '549' lead message created: value: type: user_message - id: '403918444' - created_at: 1704903109 + id: '403918387' + created_at: 1707477107 body: heyy message_type: inapp - conversation_id: '643' + conversation_id: '550' admin message created: value: type: admin_message - id: '32' - created_at: 1704903110 + id: '20' + created_at: 1707477109 subject: heyy body: heyy message_type: inapp owner: type: admin - id: '991268132' - name: Ciaran255 Lee - email: admin255@email.com + id: '991268067' + name: Ciaran265 Lee + email: admin265@email.com away_mode_enabled: false away_mode_reassign: false schema: @@ -7205,14 +7234,14 @@ paths: No body supplied for message: value: type: error.list - request_id: 3558f87a-c1b1-4fad-8db3-40cfe0ac29d7 + request_id: b8c4e890-c707-403d-984e-51405b908d0a errors: - code: parameter_invalid message: Body is required No body supplied for email message: value: type: error.list - request_id: 1b3f44e2-0b15-41aa-bcaf-8f12e10cb8e8 + request_id: c77e60fb-da0f-4fe4-a13c-7bc9198f3b43 errors: - code: parameter_invalid message: Body is required @@ -7226,7 +7255,7 @@ paths: No subject supplied for email message: value: type: error.list - request_id: 44b4664b-3912-42e4-b8c2-54dd543c6af1 + request_id: 1d7e5ab9-daed-4ee5-907e-ee5492f4a8c6 errors: - code: parameter_not_found message: No subject supplied for email message @@ -7240,7 +7269,7 @@ paths: Unauthorized: value: type: error.list - request_id: a282bd59-45d0-443a-a44d-05c5ba498b3c + request_id: ddb00ac4-33a8-45cd-a6af-edf0ba41ed85 errors: - code: unauthorized message: Access Token Invalid @@ -7254,7 +7283,7 @@ paths: API plan restricted: value: type: error.list - request_id: debd62af-7fbe-4821-9896-e76564f8b32d + request_id: 8e682b73-5d80-40e7-8e7b-c37daece88be errors: - code: api_plan_restricted message: Active subscription needed. @@ -7271,7 +7300,7 @@ paths: value: from: type: user - id: 659ec1c36abd0150e7d4a34f + id: 65c6087186ce64cf2a45787d body: heyy referer: https://twitter.com/bob lead_message_created: @@ -7279,7 +7308,7 @@ paths: value: from: type: lead - id: 659ec1c46abd0150e7d4a350 + id: 65c6087386ce64cf2a45787e body: heyy referer: https://twitter.com/bob admin_message_created: @@ -7287,10 +7316,10 @@ paths: value: from: type: admin - id: '991268132' + id: '991268067' to: type: user - id: 659ec1c66abd0150e7d4a351 + id: 65c6087486ce64cf2a45787f message_type: conversation body: heyy no_body_supplied_for_message: @@ -7298,10 +7327,10 @@ paths: value: from: type: admin - id: '991268134' + id: '991268069' to: type: user - id: 659ec1c76abd0150e7d4a352 + id: 65c6087586ce64cf2a457880 message_type: inapp body: subject: heyy @@ -7310,7 +7339,7 @@ paths: value: from: type: admin - id: '991268135' + id: '991268070' to: type: user user_id: '70' @@ -7321,10 +7350,10 @@ paths: value: from: type: admin - id: '991268136' + id: '991268071' to: type: user - id: 659ec1c86abd0150e7d4a354 + id: 65c6087686ce64cf2a457882 message_type: email body: subject: heyy @@ -7357,10 +7386,10 @@ paths: data: - id: '43' type: news-item - workspace_id: this_is_an_id462_that_should_be_at_least_ + workspace_id: this_is_an_id479_that_should_be_at_least_ title: We have news body: "Hello there,
" - sender_id: 991268141 + sender_id: 991268076 state: draft labels: [] cover_image_url: @@ -7370,15 +7399,15 @@ paths: - - deliver_silently: false - created_at: 1704903113 - updated_at: 1704903113 + created_at: 1707477112 + updated_at: 1707477112 newsfeed_assignments: [] - id: '44' type: news-item - workspace_id: this_is_an_id462_that_should_be_at_least_ + workspace_id: this_is_an_id479_that_should_be_at_least_ title: We have news body: "Hello there,
" - sender_id: 991268143 + sender_id: 991268078 state: draft labels: [] cover_image_url: @@ -7388,8 +7417,8 @@ paths: - - deliver_silently: false - created_at: 1704903113 - updated_at: 1704903113 + created_at: 1707477112 + updated_at: 1707477112 newsfeed_assignments: [] total_count: 2 schema: @@ -7402,7 +7431,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0602da35-fcea-44cd-85d0-7827acc88f61 + request_id: e4f3a21f-d4ef-441c-8a89-0a9b3d76d10b errors: - code: unauthorized message: Access Token Invalid @@ -7429,10 +7458,10 @@ paths: value: id: '47' type: news-item - workspace_id: this_is_an_id466_that_should_be_at_least_ + workspace_id: this_is_an_id483_that_should_be_at_least_ title: Halloween is here! body: "New costumes in store for this spooky season
" - sender_id: 991268150 + sender_id: 991268085 state: live labels: - New @@ -7443,8 +7472,8 @@ paths: - "\U0001F606" - "\U0001F605" deliver_silently: true - created_at: 1704903115 - updated_at: 1704903115 + created_at: 1707477114 + updated_at: 1707477114 newsfeed_assignments: - newsfeed_id: 78 published_at: 1664638214 @@ -7458,7 +7487,7 @@ paths: Unauthorized: value: type: error.list - request_id: b00f2529-64e4-4a6b-837d-02a403b88061 + request_id: f3efaea4-95e1-4ba0-9cc0-69e14dac1f0b errors: - code: unauthorized message: Access Token Invalid @@ -7479,7 +7508,7 @@ paths: - Product - Update - New - sender_id: 991268150 + sender_id: 991268085 deliver_silently: true reactions: - "\U0001F606" @@ -7517,10 +7546,10 @@ paths: value: id: '48' type: news-item - workspace_id: this_is_an_id470_that_should_be_at_least_ + workspace_id: this_is_an_id487_that_should_be_at_least_ title: We have news body: "Hello there,
" - sender_id: 991268153 + sender_id: 991268088 state: live labels: [] cover_image_url: @@ -7530,11 +7559,11 @@ paths: - - deliver_silently: false - created_at: 1704903116 - updated_at: 1704903116 + created_at: 1707477115 + updated_at: 1707477115 newsfeed_assignments: - newsfeed_id: 80 - published_at: 1704903116 + published_at: 1707477115 schema: "$ref": "#/components/schemas/news_item" '404': @@ -7545,7 +7574,7 @@ paths: News Item Not Found: value: type: error.list - request_id: b8eb8670-4862-471f-b437-ba15d77194a7 + request_id: 6b68965c-16a7-45c5-a299-394f57b1b2e5 errors: - code: not_found message: Resource Not Found @@ -7559,7 +7588,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8732dfef-e019-4325-b51d-45a18d4c7500 + request_id: 0040e5c1-0660-4746-9ff7-0dfd8b736721 errors: - code: unauthorized message: Access Token Invalid @@ -7592,10 +7621,10 @@ paths: value: id: '51' type: news-item - workspace_id: this_is_an_id476_that_should_be_at_least_ + workspace_id: this_is_an_id493_that_should_be_at_least_ title: Christmas is here! body: "New gifts in store for the jolly season
" - sender_id: 991268161 + sender_id: 991268096 state: live labels: [] cover_image_url: @@ -7603,8 +7632,8 @@ paths: - "\U0001F61D" - "\U0001F602" deliver_silently: false - created_at: 1704903117 - updated_at: 1704903118 + created_at: 1707477116 + updated_at: 1707477117 newsfeed_assignments: [] schema: "$ref": "#/components/schemas/news_item" @@ -7616,7 +7645,7 @@ paths: News Item Not Found: value: type: error.list - request_id: 8d07d3ac-39cc-41b4-9772-50bb72e9da96 + request_id: 8fc6707e-64a6-46fb-8cec-9f2c22d76ec3 errors: - code: not_found message: Resource Not Found @@ -7630,7 +7659,7 @@ paths: Unauthorized: value: type: error.list - request_id: d6709299-6441-4b1f-b1de-26335bf68fc9 + request_id: d06a187f-10f7-4ed1-8ce8-b28e5630806c errors: - code: unauthorized message: Access Token Invalid @@ -7647,7 +7676,7 @@ paths: value: title: Christmas is here! body: "New gifts in store for the jolly season
" - sender_id: 991268161 + sender_id: 991268096 reactions: - "\U0001F61D" - "\U0001F602" @@ -7656,7 +7685,7 @@ paths: value: title: Christmas is here! body: "New gifts in store for the jolly season
" - sender_id: 991268164 + sender_id: 991268099 reactions: - "\U0001F61D" - "\U0001F602" @@ -7699,7 +7728,7 @@ paths: News Item Not Found: value: type: error.list - request_id: fa76bc54-44ef-45f7-985b-5ee154db7eae + request_id: 26d5ba2f-c709-4f1f-af54-cb923aaf16d9 errors: - code: not_found message: Resource Not Found @@ -7713,7 +7742,7 @@ paths: Unauthorized: value: type: error.list - request_id: 72a31612-a382-48bc-a278-1104ada2e19c + request_id: ee1711ba-804c-4713-8566-55e87c733e8f errors: - code: unauthorized message: Access Token Invalid @@ -7766,7 +7795,7 @@ paths: Unauthorized: value: type: error.list - request_id: 7923cb95-d32d-4c76-97b9-16c6b27a33df + request_id: cdc25c17-19e3-4e12-97fc-014b07b03bb1 errors: - code: unauthorized message: Access Token Invalid @@ -7802,13 +7831,13 @@ paths: - id: '93' type: newsfeed name: Visitor Feed - created_at: 1704903122 - updated_at: 1704903122 + created_at: 1707477122 + updated_at: 1707477122 - id: '94' type: newsfeed name: Visitor Feed - created_at: 1704903122 - updated_at: 1704903122 + created_at: 1707477122 + updated_at: 1707477122 total_count: 2 schema: "$ref": "#/components/schemas/paginated_response" @@ -7820,7 +7849,7 @@ paths: Unauthorized: value: type: error.list - request_id: aae2be8a-f910-4e0c-80af-48e00ebe2fcb + request_id: 6a4a1624-4576-4974-a8e4-32a8f9ab9e8e errors: - code: unauthorized message: Access Token Invalid @@ -7857,8 +7886,8 @@ paths: id: '97' type: newsfeed name: Visitor Feed - created_at: 1704903123 - updated_at: 1704903123 + created_at: 1707477123 + updated_at: 1707477123 schema: "$ref": "#/components/schemas/newsfeed" '401': @@ -7869,7 +7898,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8b46d741-29a7-40b3-947a-4829480e4096 + request_id: de7ee3e4-6a6a-4ea5-ac92-93188264e633 errors: - code: unauthorized message: Access Token Invalid @@ -7903,16 +7932,16 @@ paths: Note found: value: type: note - id: '100' - created_at: 1704211926 + id: '50' + created_at: 1706785923 contact: type: contact - id: 659ec1d66abd0150e7d4a35f + id: 65c6088486ce64cf2a457885 author: type: admin - id: '991268180' - name: Ciaran302 Lee - email: admin302@email.com + id: '991268115' + name: Ciaran312 Lee + email: admin312@email.com away_mode_enabled: false away_mode_reassign: false body: "This is a note.
" @@ -7926,7 +7955,7 @@ paths: Note not found: value: type: error.list - request_id: acebba53-e776-4383-94e3-3f167030f7b5 + request_id: 51cf06f0-ab03-4b20-8ac4-c4c9f232c8c0 errors: - code: not_found message: Resource Not Found @@ -7940,7 +7969,7 @@ paths: Unauthorized: value: type: error.list - request_id: 223f3c98-a084-4699-9d50-9773c99e07ac + request_id: e886cd92-2e57-415f-b932-743021b614d8 errors: - code: unauthorized message: Access Token Invalid @@ -7976,16 +8005,16 @@ paths: type: segment.list segments: - type: segment - id: 659ec1da6abd0150e7d4a366 + id: 65c6088586ce64cf2a457888 name: John segment - created_at: 1704903130 - updated_at: 1704903130 + created_at: 1707477125 + updated_at: 1707477125 person_type: user - type: segment - id: 659ec1da6abd0150e7d4a367 + id: 65c6088586ce64cf2a457889 name: Jane segment - created_at: 1704903130 - updated_at: 1704903130 + created_at: 1707477125 + updated_at: 1707477125 person_type: user schema: "$ref": "#/components/schemas/segment_list" @@ -7997,7 +8026,7 @@ paths: Unauthorized: value: type: error.list - request_id: 87545ed9-4400-4b25-8bcd-3bde3675c989 + request_id: 8393c3ab-2438-4752-9c83-a0c2420f5ca5 errors: - code: unauthorized message: Access Token Invalid @@ -8031,10 +8060,10 @@ paths: Successful response: value: type: segment - id: 659ec1da6abd0150e7d4a36a + id: 65c6088686ce64cf2a45788c name: John segment - created_at: 1704903130 - updated_at: 1704903130 + created_at: 1707477126 + updated_at: 1707477126 person_type: user schema: "$ref": "#/components/schemas/segment" @@ -8046,7 +8075,7 @@ paths: Segment not found: value: type: error.list - request_id: 18b3d0ef-97cf-484d-a64e-ba40e8c8d467 + request_id: a6018473-73e5-40f1-a4cf-4d1d86819f5d errors: - code: not_found message: Resource Not Found @@ -8060,7 +8089,7 @@ paths: Unauthorized: value: type: error.list - request_id: 95e9f393-edb1-4865-80b0-23105345f8bf + request_id: 24d56491-2f98-4763-bc58-1c53dbb06bcf errors: - code: unauthorized message: Access Token Invalid @@ -8090,7 +8119,7 @@ paths: type: list data: - type: subscription - id: '226' + id: '183' state: live consent_type: opt_out default_translation: @@ -8113,7 +8142,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0c3d1d38-8525-4a81-af3d-8a973d8ac42c + request_id: 0b01dbfa-852f-427b-ba5c-85b7cf877d42 errors: - code: unauthorized message: Access Token Invalid @@ -8143,7 +8172,7 @@ paths: examples: successful: value: - url: http://via.intercom.io/msgr/0cae109c-4b59-4cfe-b6fe-0c39911713ba + url: http://via.intercom.io/msgr/0839d349-97f8-4dc9-b806-3769cb13f3f2 type: phone_call_redirect schema: "$ref": "#/components/schemas/phone_switch" @@ -8176,7 +8205,7 @@ paths: Unauthorized: value: type: error.list - request_id: 62c5624a-8b19-4365-b4fd-5fc1a577f273 + request_id: 5b3338e3-e240-48bc-8cd0-94a272ce019d errors: - code: unauthorized message: Access Token Invalid @@ -8239,7 +8268,7 @@ paths: type: list data: - type: tag - id: '180' + id: '137' name: Manual tag 1 schema: "$ref": "#/components/schemas/tag_list" @@ -8251,7 +8280,7 @@ paths: Unauthorized: value: type: error.list - request_id: 04e59143-670c-4733-87b0-4da28100a832 + request_id: 9f6aae76-01f3-41db-8c88-369e575fee5f errors: - code: unauthorized message: Access Token Invalid @@ -8290,7 +8319,7 @@ paths: Action successful: value: type: tag - id: '183' + id: '140' name: test schema: "$ref": "#/components/schemas/tag" @@ -8302,7 +8331,7 @@ paths: Invalid parameters: value: type: error.list - request_id: f337d11c-a9a0-4843-8b46-4fd811b81551 + request_id: 8b2ddbb0-6248-4d6b-ac77-4a070b410c5f errors: - code: parameter_invalid message: invalid tag parameters @@ -8316,14 +8345,14 @@ paths: Company not found: value: type: error.list - request_id: 9e5945a8-5c02-40e7-b7d1-c6d222ab1f03 + request_id: 3801314e-5916-4dc8-85c5-09f5ad4d804a errors: - code: company_not_found message: Company Not Found User not found: value: type: error.list - request_id: 5ece62b3-8e00-49ba-8eb8-b38f8a577979 + request_id: d4d6541a-a457-40b9-a456-5fe219f9a72b errors: - code: not_found message: User Not Found @@ -8337,7 +8366,7 @@ paths: Unauthorized: value: type: error.list - request_id: fdc1f68d-117d-479f-b28e-ae11e226da61 + request_id: ccd8d1d0-dd84-4bd2-93f6-ecb13a0011e8 errors: - code: unauthorized message: Access Token Invalid @@ -8403,7 +8432,7 @@ paths: Tag found: value: type: tag - id: '191' + id: '148' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -8415,7 +8444,7 @@ paths: Tag not found: value: type: error.list - request_id: 95e9daad-d1c9-4c3e-b12f-dffbe5137c0b + request_id: e8b348d0-4c90-4ada-9d34-243a75ddbb0d errors: - code: not_found message: Resource Not Found @@ -8429,7 +8458,7 @@ paths: Unauthorized: value: type: error.list - request_id: '075884f3-5a26-4046-943c-e26915324cdd' + request_id: 0dfa6e50-5bb9-48ee-bdee-640f2a4e39e2 errors: - code: unauthorized message: Access Token Invalid @@ -8465,7 +8494,7 @@ paths: Resource not found: value: type: error.list - request_id: 9a632310-0fa2-4b6c-a132-6150c33c6caa + request_id: 25a1961e-4f1c-4800-90cb-24b1962c162c errors: - code: not_found message: Resource Not Found @@ -8479,7 +8508,7 @@ paths: Tag has dependent objects: value: type: error.list - request_id: 69f92b81-62f7-4809-aef6-f7ac7522fd57 + request_id: 3cba86f7-37cc-4d29-8494-b992d6ed6e0d errors: - code: tag_has_dependent_objects message: 'Unable to delete Tag with dependent objects. Segments: @@ -8494,7 +8523,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9930d1fa-1006-4fe4-84d9-72b025b4a9b0 + request_id: 81b3a092-c76f-467f-8adf-0717cdf6103c errors: - code: unauthorized message: Access Token Invalid @@ -8532,7 +8561,7 @@ paths: Unauthorized: value: type: error.list - request_id: c12903f7-cb1b-48da-b4f6-28a34e1ba091 + request_id: e2ec4468-0f4d-41f3-b371-0548ab4f5a84 errors: - code: unauthorized message: Access Token Invalid @@ -8567,7 +8596,7 @@ paths: successful: value: type: team - id: '991268224' + id: '991268153' name: team 1 admin_ids: [] schema: @@ -8580,7 +8609,7 @@ paths: Team not found: value: type: error.list - request_id: 9f6bb07a-6aa1-4f82-976a-6c832e3be6ca + request_id: 4fb7c541-4caf-4b75-80cd-fa142946c244 errors: - code: team_not_found message: Team not found @@ -8594,7 +8623,7 @@ paths: Unauthorized: value: type: error.list - request_id: f1223500-e010-4943-873a-1f9190146fb2 + request_id: 81c0a752-800b-4c28-8b74-55ead5a2d3e3 errors: - code: unauthorized message: Access Token Invalid @@ -8627,14 +8656,14 @@ paths: Ticket Type Attribute created: value: type: ticket_type_attribute - id: '133' - workspace_id: this_is_an_id568_that_should_be_at_least_ + id: '169' + workspace_id: this_is_an_id585_that_should_be_at_least_ name: Attribute Title description: Attribute Description data_type: string input_options: multiline: false - order: 0 + order: 2 required_to_create: false required_to_create_for_contacts: false visible_on_create: true @@ -8642,8 +8671,8 @@ paths: default: false ticket_type_id: 45 archived: false - created_at: 1704903150 - updated_at: 1704903150 + created_at: 1707477144 + updated_at: 1707477144 schema: "$ref": "#/components/schemas/ticket_type_attribute" '401': @@ -8654,7 +8683,7 @@ paths: Unauthorized: value: type: error.list - request_id: eb17fd71-1ec6-4372-a14f-9f3043b827dd + request_id: 3a41810b-1dcc-4600-9455-ae5b18959e8e errors: - code: unauthorized message: Access Token Invalid @@ -8707,8 +8736,8 @@ paths: Ticket Type Attribute updated: value: type: ticket_type_attribute - id: '134' - workspace_id: this_is_an_id572_that_should_be_at_least_ + id: '174' + workspace_id: this_is_an_id589_that_should_be_at_least_ name: name description: New Attribute Description data_type: string @@ -8720,8 +8749,8 @@ paths: default: false ticket_type_id: 47 archived: false - created_at: 1704903151 - updated_at: 1704903151 + created_at: 1707477145 + updated_at: 1707477145 schema: "$ref": "#/components/schemas/ticket_type_attribute" '401': @@ -8732,7 +8761,7 @@ paths: Unauthorized: value: type: error.list - request_id: 22285163-10e7-40be-89d1-2ad6b9c040e2 + request_id: '08cb37a6-c12f-45fe-9674-a15d4b0e8ed0' errors: - code: unauthorized message: Access Token Invalid @@ -8775,17 +8804,35 @@ paths: name: Bug Report description: Bug Report Template icon: "\U0001F39F️" - workspace_id: this_is_an_id576_that_should_be_at_least_ + workspace_id: this_is_an_id593_that_should_be_at_least_ archived: false - created_at: 1704903152 - updated_at: 1704903152 + created_at: 1707477146 + updated_at: 1707477146 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '135' - workspace_id: this_is_an_id576_that_should_be_at_least_ + id: '177' + workspace_id: this_is_an_id593_that_should_be_at_least_ + name: _default_title_ + description: '' + data_type: string + input_options: + multiline: false + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 49 + archived: false + created_at: 1707477146 + updated_at: 1707477146 + - type: ticket_type_attribute + id: '179' + workspace_id: this_is_an_id593_that_should_be_at_least_ name: name description: description data_type: string @@ -8798,8 +8845,26 @@ paths: default: false ticket_type_id: 49 archived: false - created_at: 1704903152 - updated_at: 1704903152 + created_at: 1707477146 + updated_at: 1707477146 + - type: ticket_type_attribute + id: '178' + workspace_id: this_is_an_id593_that_should_be_at_least_ + name: _default_description_ + description: '' + data_type: string + input_options: + multiline: true + order: 1 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 49 + archived: false + created_at: 1707477146 + updated_at: 1707477146 schema: "$ref": "#/components/schemas/ticket_type_list" '401': @@ -8810,7 +8875,7 @@ paths: Unauthorized: value: type: error.list - request_id: 6aaeb527-407d-489e-ae95-c418e54f0285 + request_id: 80b78b8e-a3a5-4b89-adab-14cc1fa22af9 errors: - code: unauthorized message: Access Token Invalid @@ -8843,14 +8908,50 @@ paths: name: Customer Issue description: Customer Report Template icon: "\U0001F39F️" - workspace_id: this_is_an_id580_that_should_be_at_least_ + workspace_id: this_is_an_id597_that_should_be_at_least_ archived: false - created_at: 1704903153 - updated_at: 1704903153 + created_at: 1707477148 + updated_at: 1707477148 is_internal: false ticket_type_attributes: type: list - data: [] + data: + - type: ticket_type_attribute + id: '186' + workspace_id: this_is_an_id597_that_should_be_at_least_ + name: _default_title_ + description: '' + data_type: string + input_options: + multiline: false + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 52 + archived: false + created_at: 1707477148 + updated_at: 1707477148 + - type: ticket_type_attribute + id: '187' + workspace_id: this_is_an_id597_that_should_be_at_least_ + name: _default_description_ + description: '' + data_type: string + input_options: + multiline: true + order: 1 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 52 + archived: false + created_at: 1707477148 + updated_at: 1707477148 schema: "$ref": "#/components/schemas/ticket_type" '401': @@ -8861,7 +8962,7 @@ paths: Unauthorized: value: type: error.list - request_id: dd48c269-fbe9-43cb-937f-9ca5605126a6 + request_id: de83caeb-9e3c-4d7e-872e-fb33ce37f330 errors: - code: unauthorized message: Access Token Invalid @@ -8910,17 +9011,35 @@ paths: name: Bug Report description: Bug Report Template icon: "\U0001F39F️" - workspace_id: this_is_an_id584_that_should_be_at_least_ + workspace_id: this_is_an_id601_that_should_be_at_least_ archived: false - created_at: 1704903154 - updated_at: 1704903154 + created_at: 1707477149 + updated_at: 1707477149 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '139' - workspace_id: this_is_an_id584_that_should_be_at_least_ + id: '191' + workspace_id: this_is_an_id601_that_should_be_at_least_ + name: _default_title_ + description: '' + data_type: string + input_options: + multiline: false + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 54 + archived: false + created_at: 1707477149 + updated_at: 1707477149 + - type: ticket_type_attribute + id: '193' + workspace_id: this_is_an_id601_that_should_be_at_least_ name: name description: description data_type: string @@ -8933,8 +9052,26 @@ paths: default: false ticket_type_id: 54 archived: false - created_at: 1704903154 - updated_at: 1704903154 + created_at: 1707477149 + updated_at: 1707477149 + - type: ticket_type_attribute + id: '192' + workspace_id: this_is_an_id601_that_should_be_at_least_ + name: _default_description_ + description: '' + data_type: string + input_options: + multiline: true + order: 1 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 54 + archived: false + created_at: 1707477149 + updated_at: 1707477149 schema: "$ref": "#/components/schemas/ticket_type" '401': @@ -8945,7 +9082,7 @@ paths: Unauthorized: value: type: error.list - request_id: d4e669eb-a7a2-4cf7-a4d7-edcb6273b2a0 + request_id: 8c6d236d-4ce3-4f96-b367-a35841ec47af errors: - code: unauthorized message: Access Token Invalid @@ -8982,17 +9119,35 @@ paths: name: Bug Report 2 description: Bug Report Template icon: "\U0001F39F️" - workspace_id: this_is_an_id588_that_should_be_at_least_ + workspace_id: this_is_an_id605_that_should_be_at_least_ archived: false - created_at: 1704903155 - updated_at: 1704903155 + created_at: 1707477150 + updated_at: 1707477150 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '141' - workspace_id: this_is_an_id588_that_should_be_at_least_ + id: '197' + workspace_id: this_is_an_id605_that_should_be_at_least_ + name: _default_title_ + description: '' + data_type: string + input_options: + multiline: false + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 56 + archived: false + created_at: 1707477150 + updated_at: 1707477150 + - type: ticket_type_attribute + id: '199' + workspace_id: this_is_an_id605_that_should_be_at_least_ name: name description: description data_type: string @@ -9005,8 +9160,26 @@ paths: default: false ticket_type_id: 56 archived: false - created_at: 1704903155 - updated_at: 1704903155 + created_at: 1707477150 + updated_at: 1707477150 + - type: ticket_type_attribute + id: '198' + workspace_id: this_is_an_id605_that_should_be_at_least_ + name: _default_description_ + description: '' + data_type: string + input_options: + multiline: true + order: 1 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 56 + archived: false + created_at: 1707477150 + updated_at: 1707477150 schema: "$ref": "#/components/schemas/ticket_type" '401': @@ -9017,7 +9190,7 @@ paths: Unauthorized: value: type: error.list - request_id: 88c8603e-c424-484d-b33e-383ce0f6167f + request_id: 646d3cf6-023f-493b-b5bb-67a7bf31faf5 errors: - code: unauthorized message: Access Token Invalid @@ -9062,7 +9235,7 @@ paths: Admin note reply: value: type: ticket_part - id: '112' + id: '106' part_type: note body: |-