From 063685204e6c61d0e006574d02559a14e5bee7b3 Mon Sep 17 00:00:00 2001 From: Gabriel Anca Date: Thu, 8 Feb 2024 18:37:47 +0100 Subject: [PATCH] Add Custom Object Instances API --- descriptions/0/api.intercom.io.yaml | 2778 ++++++++++++++---------- descriptions/2.10/api.intercom.io.yaml | 2319 ++++++++++---------- descriptions/2.7/api.intercom.io.yaml | 1723 ++++++++------- descriptions/2.8/api.intercom.io.yaml | 1723 ++++++++------- descriptions/2.9/api.intercom.io.yaml | 2208 ++++++++++--------- 5 files changed, 5671 insertions(+), 5080 deletions(-) diff --git a/descriptions/0/api.intercom.io.yaml b/descriptions/0/api.intercom.io.yaml index afded43..6b6a9e6 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: '991271383' 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: 1707238789 secure: false identity_verification: false timezone: America/Los_Angeles @@ -83,7 +83,7 @@ paths: Successful response: value: type: admin - id: '991268889' + id: '991271384' 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: ba17541a-ef8e-4f3f-be8a-bb35ab98e410 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: a6993bfc-0044-4d4a-8c4d-252907f82d86 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: 9790b788-44d2-4c9a-b2fa-7b25a21ee57b 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: '991271388' 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: 1707238794 activity_type: message_state_change activity_description: Ciaran5 Lee changed your Initial message title message from Initial message title to Eventual message title. + - id: 20694aca-9abd-47f0-8144-6aa908b127dd + performed_by: + type: admin + id: '991271388' + email: admin5@email.com + ip: 127.0.0.1 + metadata: + before: before + after: after + created_at: 1707238794 + 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: a184d892-a4e2-4f47-9536-f0cdb4650e63 errors: - code: unauthorized message: Access Token Invalid @@ -271,7 +271,7 @@ paths: admins: - type: admin email: admin7@email.com - id: '991268896' + id: '991271390' 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: dc83a1f4-891f-43bb-9861-709617c4cc13 errors: - code: unauthorized message: Access Token Invalid @@ -321,7 +321,7 @@ paths: Admin found: value: type: admin - id: '991268898' + id: '991271392' 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: ac1b6cfa-5a94-40d8-aa4b-0e153951856d 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: 4bf0f6ad-458c-43fb-8809-0284d61e9b25 errors: - code: unauthorized message: Access Token Invalid @@ -379,30 +379,30 @@ paths: successful: value: data: - - id: 1 + - id: 33 type: content_import_source - last_synced_at: 1704903641 + last_synced_at: 1707238797 status: active url: https://support.example.com/us/1 sync_behavior: automatic - created_at: 1704903641 - updated_at: 1704903641 - - id: 2 + created_at: 1707238797 + updated_at: 1707238797 + - id: 34 type: content_import_source - last_synced_at: 1704903641 + last_synced_at: 1707238797 status: active url: https://support.example.com/us/2 sync_behavior: automatic - created_at: 1704903641 - updated_at: 1704903641 - - id: 3 + created_at: 1707238797 + updated_at: 1707238797 + - id: 35 type: content_import_source - last_synced_at: 1704903641 + last_synced_at: 1707238797 status: active url: https://support.example.com/us/3 sync_behavior: automatic - created_at: 1704903641 - updated_at: 1704903641 + created_at: 1707238797 + updated_at: 1707238797 pages: type: pages page: 1 @@ -420,7 +420,7 @@ paths: Unauthorized: value: type: error.list - request_id: f6f82c24-7e01-4137-ab42-9de9e8fa4f4c + request_id: f6a46f1e-309d-4fc0-bc1b-eb00cf481df9 errors: - code: unauthorized message: Access Token Invalid @@ -446,14 +446,14 @@ paths: examples: successful: value: - id: 4 + id: 36 type: content_import_source - last_synced_at: 1704903642 + last_synced_at: 1707238798 status: active url: https://www.example.com sync_behavior: api - created_at: 1704903642 - updated_at: 1704903642 + created_at: 1707238798 + updated_at: 1707238798 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: 94851e9e-b4b1-48ff-9c8f-cbbcc24b0c49 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: b2ff7fd9-4bee-42bf-a1be-e4ebf5578e2d errors: - code: unauthorized message: Access Token Invalid @@ -538,14 +538,14 @@ paths: examples: successful: value: - id: 6 + id: 38 type: content_import_source - last_synced_at: 1704903644 + last_synced_at: 1707238800 status: active url: https://support.example.com/us/5 sync_behavior: api - created_at: 1704903644 - updated_at: 1704903644 + created_at: 1707238800 + updated_at: 1707238800 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: 199c264e-c30a-4e6b-a66b-40af9e6bec96 errors: - code: unauthorized message: Access Token Invalid @@ -581,14 +581,14 @@ paths: examples: successful: value: - id: 7 + id: 39 type: content_import_source - last_synced_at: 1704903645 + last_synced_at: 1707238800 status: active url: https://www.example.com sync_behavior: api - created_at: 1704903645 - updated_at: 1704903645 + created_at: 1707238800 + updated_at: 1707238800 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: 20910902-91ef-4b12-9c61-63ad53e89a4a errors: - code: unauthorized message: Access Token Invalid @@ -637,42 +637,42 @@ paths: successful: value: data: - - id: '3' + - id: '19' type: external_page title: My External Content html: "

Hello world

This is external content

" url: https://support.example.com/us/3 fin_availability: true locale: en - source_id: 10 + source_id: 42 external_id: '3' - created_at: 1704903646 - updated_at: 1704903646 - last_ingested_at: 1704903646 - - id: '2' + created_at: 1707238801 + updated_at: 1707238801 + last_ingested_at: 1707238801 + - id: '18' type: external_page title: My External Content html: "

Hello world

This is external content

" url: https://support.example.com/us/2 fin_availability: true locale: en - source_id: 9 + source_id: 41 external_id: '2' - created_at: 1704903646 - updated_at: 1704903646 - last_ingested_at: 1704903646 - - id: '1' + created_at: 1707238801 + updated_at: 1707238801 + last_ingested_at: 1707238801 + - id: '17' type: external_page title: My External Content html: "

Hello world

This is external content

" url: https://support.example.com/us/1 fin_availability: true locale: en - source_id: 8 + source_id: 40 external_id: '1' - created_at: 1704903646 - updated_at: 1704903646 - last_ingested_at: 1704903646 + created_at: 1707238801 + updated_at: 1707238801 + last_ingested_at: 1707238801 pages: type: pages page: 1 @@ -690,7 +690,7 @@ paths: Unauthorized: value: type: error.list - request_id: 4dd5a6a5-4385-4005-abaa-c1f38d882f54 + request_id: df669971-ea13-4c92-bd84-60de4bda07c8 errors: - code: unauthorized message: Access Token Invalid @@ -717,18 +717,18 @@ paths: examples: successful: value: - id: '5' + id: '21' type: external_page title: Test html: "

Test

" url: https://www.example.com fin_availability: true locale: en - source_id: 12 + source_id: 44 external_id: abc1234 - created_at: 1704903647 - updated_at: 1704903647 - last_ingested_at: 1704903647 + created_at: 1707238802 + updated_at: 1707238803 + last_ingested_at: 1707238803 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: b044712c-71c2-4996-bb06-7ac086390364 errors: - code: unauthorized message: Access Token Invalid @@ -757,7 +757,7 @@ paths: external_id: abc1234 html: "

Test

" locale: en - source_id: 12 + source_id: 44 title: Test url: https://www.example.com "/ai/external_pages/{id}": @@ -788,18 +788,18 @@ paths: examples: successful: value: - id: '6' + id: '22' type: external_page title: My External Content html: "

Hello world

This is external content

" url: https://support.example.com/us/5 fin_availability: true locale: en - source_id: 13 + source_id: 45 external_id: '4' - created_at: 1704903648 - updated_at: 1704903648 - last_ingested_at: 1704903648 + created_at: 1707238803 + updated_at: 1707238803 + last_ingested_at: 1707238803 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: 2802dae6-5624-48c3-a21b-e6dddda2c73e errors: - code: unauthorized message: Access Token Invalid @@ -835,18 +835,18 @@ paths: examples: successful: value: - id: '7' + id: '23' type: external_page title: My External Content html: "

Hello world

This is external content

" url: https://support.example.com/us/6 fin_availability: true locale: en - source_id: 14 + source_id: 46 external_id: '5' - created_at: 1704903648 - updated_at: 1704903648 - last_ingested_at: 1704903648 + created_at: 1707238804 + updated_at: 1707238804 + last_ingested_at: 1707238804 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: 9b7f79d3-93a0-43d1-bd59-1bc57292ae93 errors: - code: unauthorized message: Access Token Invalid @@ -883,18 +883,18 @@ paths: examples: successful: value: - id: '8' + id: '24' type: external_page title: Test html: "

Test

" url: https://www.example.com fin_availability: true locale: en - source_id: 15 + source_id: 47 external_id: '5678' - created_at: 1704903649 - updated_at: 1704903649 - last_ingested_at: 1704903649 + created_at: 1707238805 + updated_at: 1707238805 + last_ingested_at: 1707238805 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: bac00e9d-db5a-4bb3-b392-1e9fc16bb715 errors: - code: unauthorized message: Access Token Invalid @@ -923,7 +923,7 @@ paths: external_id: '5678' html: "

Test

" locale: en - source_id: 15 + source_id: 47 title: Test url: https://www.example.com "/articles": @@ -958,20 +958,20 @@ paths: total_pages: 1 total_count: 1 data: - - id: '105' + - id: '196' type: article workspace_id: this_is_an_id64_that_should_be_at_least_4 - parent_id: 432 + parent_id: 789 parent_type: collection parent_ids: [] title: This is the article title description: '' body: '' - author_id: 991268922 + author_id: 991271416 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: 1707238806 + updated_at: 1707238806 + url: http://help-center.test/myapp-64/en/articles/196-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: c5c1f5a5-d427-4228-b53b-3b06db83e696 errors: - code: unauthorized message: Access Token Invalid @@ -1007,10 +1007,10 @@ paths: examples: article created: value: - id: '108' + id: '199' type: article workspace_id: this_is_an_id68_that_should_be_at_least_4 - parent_id: 434 + parent_id: 791 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: 991271421 state: published - created_at: 1704903653 - updated_at: 1704903653 - url: http://help-center.test/myapp-68/en/articles/108-thanks-for-everything + created_at: 1707238807 + updated_at: 1707238807 + url: http://help-center.test/myapp-68/en/articles/199-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: 45ccdc25-198a-4c1f-95a0-15eee918b453 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: a1499087-8f12-4eed-9f85-a2c455afd536 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: 991271421 state: published - parent_id: 434 + parent_id: 791 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: 991271421 state: published bad_request: summary: Bad Request @@ -1118,10 +1118,10 @@ paths: examples: Article found: value: - id: '111' + id: '202' type: article workspace_id: this_is_an_id74_that_should_be_at_least_4 - parent_id: 437 + parent_id: 794 parent_type: collection parent_ids: [] statistics: @@ -1135,11 +1135,11 @@ paths: title: This is the article title description: '' body: '' - author_id: 991268932 + author_id: 991271426 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: 1707238809 + updated_at: 1707238809 + url: http://help-center.test/myapp-74/en/articles/202-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: 2fcc9e66-4bc3-4b02-8f41-5df810275f27 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: 17a2c479-aee7-467d-aa9c-4459f70c56f1 errors: - code: unauthorized message: Access Token Invalid @@ -1197,10 +1197,10 @@ paths: examples: successful: value: - id: '114' + id: '205' type: article workspace_id: this_is_an_id80_that_should_be_at_least_4 - parent_id: 440 + parent_id: 797 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: 991271432 state: published - created_at: 1704903656 - updated_at: 1704903657 - url: http://help-center.test/myapp-80/en/articles/114-christmas-is-here + created_at: 1707238811 + updated_at: 1707238811 + url: http://help-center.test/myapp-80/en/articles/205-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: 28ddf801-c684-40ea-9a63-d52bcf49e8d1 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: 78f727a4-c6a8-44cc-b00e-28fc525da0eb errors: - code: unauthorized message: Access Token Invalid @@ -1291,7 +1291,7 @@ paths: examples: successful: value: - id: '117' + id: '208' 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: c479fb35-90a8-4493-99e5-188a89def6f6 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: 2f91d5fa-18aa-44fe-a38a-ab6725fb059b errors: - code: unauthorized message: Access Token Invalid @@ -1378,7 +1378,7 @@ paths: total_count: 1 data: articles: - - id: '121' + - id: '212' 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: 991271445 state: draft - created_at: 1704903660 - updated_at: 1704903660 + created_at: 1707238815 + updated_at: 1707238815 url: highlights: [] pages: @@ -1408,7 +1408,7 @@ paths: Unauthorized: value: type: error.list - request_id: e66eef28-becd-4bac-af2e-bca433e90fd2 + request_id: 406b8c67-da7b-43e0-af0a-54bf776b5bd7 errors: - code: unauthorized message: Access Token Invalid @@ -1441,27 +1441,27 @@ paths: value: type: list data: - - id: '448' + - id: '805' 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: 1707238816 + updated_at: 1707238816 description: english collection description icon: bookmark parent_id: - help_center_id: 228 - - id: '449' + help_center_id: 393 + - id: '806' 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: 1707238816 + updated_at: 1707238816 description: icon: bookmark - parent_id: '448' + parent_id: '805' 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: 323f7af4-a992-4277-84f9-a72f421c9add errors: - code: unauthorized message: Access Token Invalid @@ -1504,17 +1504,17 @@ paths: examples: collection created: value: - id: '454' + id: '811' 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: 1707238818 + updated_at: 1707238818 description: '' icon: book-bookmark parent_id: - help_center_id: 230 + help_center_id: 395 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: 0d5810cb-f673-45c5-9982-9f881708ef93 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: 98dc62b9-9912-4514-8c9e-246517f9794e errors: - code: unauthorized message: Access Token Invalid @@ -1587,17 +1587,17 @@ paths: examples: Collection found: value: - id: '459' + id: '816' 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: 1707238818 + updated_at: 1707238818 description: english collection description icon: bookmark parent_id: - help_center_id: 233 + help_center_id: 398 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: 93a0ca5a-4fc4-44bc-8de2-fcd1624454a4 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: d3276e43-cddb-48f2-a3df-c53f00c7d49f errors: - code: unauthorized message: Access Token Invalid @@ -1655,17 +1655,17 @@ paths: examples: successful: value: - id: '465' + id: '822' 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: 1707238819 + updated_at: 1707238820 description: english collection description icon: folder parent_id: - help_center_id: 236 + help_center_id: 401 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: 181ac6c5-e33e-4de6-b259-c07367c31ae3 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: 189b3e37-7f82-4f4c-b02a-3dd9c1b49147 errors: - code: unauthorized message: Access Token Invalid @@ -1737,7 +1737,7 @@ paths: examples: successful: value: - id: '471' + id: '828' 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: 81763c1f-94b3-4b62-b8ac-69c7e71a66c8 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: 1ad6ed4b-48eb-47b3-93e5-1812b8f7eccb errors: - code: unauthorized message: Access Token Invalid @@ -1798,10 +1798,10 @@ paths: examples: Collection found: value: - id: '242' + id: '407' workspace_id: this_is_an_id124_that_should_be_at_least_ - created_at: 1704903668 - updated_at: 1704903668 + created_at: 1707238822 + updated_at: 1707238822 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: 24172bcc-cb9a-4d64-96c4-b30f83b968ad 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: 1ca458bb-a60e-4744-b4ab-8e3639243fe7 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: d1906c43-f014-4f06-801f-dafdd836158f 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: 65c265a986ce64abeb648f75 + 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: 1707238825 + updated_at: 1707238825 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: bf14b0bf-dba5-4ed5-8875-73e7885aed2b 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: 65c265ab86ce64abeb648f7d + 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: 1707238827 + created_at: 1707238827 + updated_at: 1707238827 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: 023d50f6-cbf7-431e-bedc-02129b1f9ae9 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: 9995ddae-f12d-4ffd-93be-db121b60f70d 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: 65c265ad86ce64abeb648f88 + app_id: this_is_an_id159_that_should_be_at_least_ + name: company1 + remote_created_at: 1707238829 + created_at: 1707238829 + updated_at: 1707238829 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: 142d759b-b37f-40ef-8708-5a311e808f60 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: 37021604-4790-4292-8576-a28a9adca3c1 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: 65c265af86ce64abeb648f92 + app_id: this_is_an_id165_that_should_be_at_least_ + name: company2 + remote_created_at: 1707238831 + created_at: 1707238831 + updated_at: 1707238831 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: 22e28d00-fdbd-4f64-90fd-edbb28ad0df3 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: cfa99c82-037e-4484-b056-b66e42173bc2 errors: - code: unauthorized message: Access Token Invalid @@ -2264,7 +2271,7 @@ paths: examples: Successful: value: - id: 659ec4026abd0164c02885bd + id: 65c265b186ce64abeb648f9c 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: b2b95390-b6ca-45f7-af90-ad07b7f68375 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: 9aa9873f-e584-4257-96f2-4d901ed8e629 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: 98aa5d76-7981-4a93-9596-37bd408330f8 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: b643aa2e-865a-426f-b50e-d49790d933e8 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: 1e3efce3-05bc-48d6-b01d-792417ef6446 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: d427964e-68cc-4a8b-af95-e13e6cff9933 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: 65c265b786ce64abeb648fb8 + 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: 1707238839 + created_at: 1707238839 + updated_at: 1707238839 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: f7f39eeb-7fce-447a-806f-ef2471de831c 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: 65c265b886ce64abeb648fbe + 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: 1707238840 + created_at: 1707238840 + updated_at: 1707238840 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: bd650efb-6a13-4595-8234-6d7cafacff4f 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: 520a5030-5aa5-4ae3-8385-963d48d064a6 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: 65c265ba86ce64abeb648fc7 + app_id: this_is_an_id197_that_should_be_at_least_ + name: company6 + remote_created_at: 1707238842 + created_at: 1707238842 + updated_at: 1707238842 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: 15bbeef5-e0c4-4530-86dc-87a325490780 + 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: 07026f80-e8d7-4c60-80a6-b3a5f1e09e8f 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: 0ca44ea6-0df2-4e34-8ef7-a9accf322a62 errors: - code: unauthorized message: Access Token Invalid @@ -2688,11 +2709,14 @@ paths: successful: summary: Successful value: - id: 659ec40a6abd0164c02885e8 + id: 65c265ba86ce64abeb648fc7 + 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: 65c265c086ce64abeb648fe8 + app_id: this_is_an_id213_that_should_be_at_least_ + name: company12 + remote_created_at: 1707238848 + created_at: 1707238848 + updated_at: 1707238848 + last_request_at: 1707066048 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: 5e1d8979-bca3-4e4c-b619-0509fd06b324 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: eaa53337-fb12-42b7-8073-c4c3d7bb8dc7 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: 65c265bd86ce64abeb648fd7 + app_id: this_is_an_id205_that_should_be_at_least_ + name: company8 + remote_created_at: 1707238845 + created_at: 1707238845 + updated_at: 1707238845 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: 2b668051-0589-4378-be9a-0fe4cf19eb48 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: f8dbc19a-e392-4fd4-bf67-d7b8e30df1a4 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: 68218afd-e200-4faf-b1a0-78b547fac8cc errors: - code: unauthorized message: Access Token Invalid @@ -2900,44 +2924,44 @@ paths: type: list data: - type: note - id: '128' - created_at: 1704298904 + id: '140' + created_at: 1706634051 contact: type: contact - id: 659ec4186abd0164c0288625 + id: 65c265c386ce64abeb648ff3 author: type: admin - id: '991269010' - name: Ciaran121 Lee - email: admin121@email.com + id: '991271505' + 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: '139' + created_at: 1706547651 contact: type: contact - id: 659ec4186abd0164c0288625 + id: 65c265c386ce64abeb648ff3 author: type: admin - id: '991269010' - name: Ciaran121 Lee - email: admin121@email.com + id: '991271505' + 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: '138' + created_at: 1706547651 contact: type: contact - id: 659ec4186abd0164c0288625 + id: 65c265c386ce64abeb648ff3 author: type: admin - id: '991269010' - name: Ciaran121 Lee - email: admin121@email.com + id: '991271505' + 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: 35aa743d-0c28-4d1c-96f7-8d0f9eadaec1 errors: - code: not_found message: User Not Found @@ -2992,16 +3016,16 @@ paths: Successful response: value: type: note - id: '133' - created_at: 1704903705 + id: '145' + created_at: 1707238852 contact: type: contact - id: 659ec4196abd0164c0288627 + id: 65c265c486ce64abeb648ff5 author: type: admin - id: '991269012' - name: Ciaran123 Lee - email: admin123@email.com + id: '991271507' + 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: 133c2d4e-9dc3-4bf8-b2f8-6b9099d929a1 errors: - code: not_found message: Resource Not Found Contact not found: value: type: error.list - request_id: 5b53c4f6-2470-400d-b18d-6bc8228ba769 + request_id: cf9bf076-4344-4d35-b9cc-f3f2d9469050 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: 65c265c486ce64abeb648ff5 + admin_id: 991271507 body: Hello admin_not_found: summary: Admin not found value: - contact_id: 659ec4196abd0164c0288628 + contact_id: 65c265c486ce64abeb648ff6 admin_id: 123 body: Hello contact_not_found: summary: Contact not found value: contact_id: 123 - admin_id: 991269014 + admin_id: 991271509 body: Hello "/contacts/{contact_id}/segments": get: @@ -3098,10 +3122,10 @@ paths: type: list data: - type: segment - id: 659ec41a6abd0164c028862a + id: 65c265c586ce64abeb648ff8 name: segment - created_at: 1704903706 - updated_at: 1704903706 + created_at: 1707238853 + updated_at: 1707238853 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: f7b9a358-c5d9-485d-ad8d-2d9db6605ff1 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: c29e407b-5371-4cab-849c-50f68ac7f6c0 errors: - code: unauthorized message: Access Token Invalid @@ -3171,7 +3195,7 @@ paths: type: list data: - type: subscription - id: '274' + id: '503' state: live consent_type: opt_out default_translation: @@ -3185,7 +3209,7 @@ paths: content_types: - email - type: subscription - id: '276' + id: '505' 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: f3cc648d-49cf-47d9-9ceb-6fd283cd67a2 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: b9eecbc9-3689-4803-911b-5d1c905dbd8f errors: - code: unauthorized message: Access Token Invalid @@ -3263,7 +3287,7 @@ paths: Successful: value: type: subscription - id: '289' + id: '518' 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: 0e175d12-c5f9-489a-84f0-7f68914d8399 errors: - code: not_found message: User Not Found Resource not found: value: type: error.list - request_id: c8d0d520-0e15-474a-96b9-dd95245d0b5e + request_id: 0d8d85c2-0b75-4b7b-9632-7d55454cd7b2 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: e40f21b4-4eb6-472b-8f24-d93d2d3335c6 errors: - code: unauthorized message: Access Token Invalid @@ -3335,12 +3359,12 @@ paths: successful: summary: Successful value: - id: 289 + id: 518 consent_type: opt_in contact_not_found: summary: Contact not found value: - id: 293 + id: 522 consent_type: opt_in resource_not_found: summary: Resource not found @@ -3386,7 +3410,7 @@ paths: Successful: value: type: subscription - id: '305' + id: '534' 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: f68ce18d-c6fe-4d5c-8597-dcf8df748591 errors: - code: not_found message: User Not Found Resource not found: value: type: error.list - request_id: 4a246cee-ba85-46b3-8642-51d16247eee6 + request_id: fe2962f6-f841-4934-9ea2-fd6d7f69cdec 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: 95160522-c300-4bf9-b6f2-54071010671e errors: - code: unauthorized message: Access Token Invalid @@ -3468,7 +3492,7 @@ paths: type: list data: - type: tag - id: '261' + id: '415' 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: a707b331-0b79-4a5e-9267-85b8eacb90f1 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: 594ca6a3-acef-4aa4-9c9a-890f61ce2b2f errors: - code: unauthorized message: Access Token Invalid @@ -3529,7 +3553,7 @@ paths: successful: value: type: tag - id: '262' + id: '416' 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: 8ad22258-71ec-4bb6-9ba6-e186e16ba846 errors: - code: not_found message: User Not Found Tag not found: value: type: error.list - request_id: 0ae9b7c9-56ee-4db1-a1a3-1a9ee17f00a8 + request_id: bbc2aea6-c391-4b2c-93d5-022e0bd84930 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: 197daccd-1a06-490d-949a-a7c64d4a9d26 errors: - code: unauthorized message: Access Token Invalid @@ -3585,11 +3609,11 @@ paths: successful: summary: successful value: - id: 262 + id: 416 contact_not_found: summary: Contact not found value: - id: 263 + id: 417 tag_not_found: summary: Tag not found value: @@ -3631,7 +3655,7 @@ paths: successful: value: type: tag - id: '265' + id: '419' 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: f3d446e6-68c9-44b9-9d16-72edf8579b1e errors: - code: not_found message: User Not Found Tag not found: value: type: error.list - request_id: c2d252bc-acfe-41fd-8dac-7b87e51d6fe2 + request_id: c0ce02e6-c7df-4be9-8e10-7ac0a459e710 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: 6943c2f8-8ee6-426a-93b3-05683d577356 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: 65c265d086ce64abeb64900f + 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: 1707238864 + updated_at: 1707238865 + signed_up_at: 1707238864 last_seen_at: last_replied_at: last_contacted_at: @@ -3750,31 +3774,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ec4266abd0164c0288641/tags" + url: "/contacts/65c265d086ce64abeb64900f/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ec4266abd0164c0288641/notes" + url: "/contacts/65c265d086ce64abeb64900f/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ec4266abd0164c0288641/companies" + url: "/contacts/65c265d086ce64abeb64900f/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ec4266abd0164c0288641/subscriptions" + url: "/contacts/65c265d086ce64abeb64900f/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ec4266abd0164c0288641/subscriptions" + url: "/contacts/65c265d086ce64abeb64900f/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: 1895e642-50dd-4697-b6de-435984b6df5f 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: 65c265d286ce64abeb649010 + 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: 1707238866 + updated_at: 1707238866 + signed_up_at: 1707238866 last_seen_at: last_replied_at: last_contacted_at: @@ -3890,31 +3914,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ec4276abd0164c0288642/tags" + url: "/contacts/65c265d286ce64abeb649010/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ec4276abd0164c0288642/notes" + url: "/contacts/65c265d286ce64abeb649010/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ec4276abd0164c0288642/companies" + url: "/contacts/65c265d286ce64abeb649010/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ec4276abd0164c0288642/subscriptions" + url: "/contacts/65c265d286ce64abeb649010/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ec4276abd0164c0288642/subscriptions" + url: "/contacts/65c265d286ce64abeb649010/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: d3e145cb-4581-42c1-9d28-d77d7c52d9d9 errors: - code: unauthorized message: Access Token Invalid @@ -3964,7 +3988,7 @@ paths: examples: successful: value: - id: 659ec4286abd0164c0288643 + id: 65c265d386ce64abeb649011 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: 9593f579-4c1a-434b-9cfb-c50f588e8c8b 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: 65c265d486ce64abeb649013 + 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: 1707238868 + updated_at: 1707238868 + signed_up_at: 1707238868 last_seen_at: last_replied_at: last_contacted_at: @@ -4058,31 +4082,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ec4296abd0164c0288645/tags" + url: "/contacts/65c265d486ce64abeb649013/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ec4296abd0164c0288645/notes" + url: "/contacts/65c265d486ce64abeb649013/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ec4296abd0164c0288645/companies" + url: "/contacts/65c265d486ce64abeb649013/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ec4296abd0164c0288645/subscriptions" + url: "/contacts/65c265d486ce64abeb649013/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ec4296abd0164c0288645/subscriptions" + url: "/contacts/65c265d486ce64abeb649013/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: d63ef4be-f39f-45a3-bed5-dc99e1d0081a errors: - code: unauthorized message: Access Token Invalid @@ -4116,8 +4140,8 @@ paths: successful: summary: successful value: - from: 659ec4296abd0164c0288644 - into: 659ec4296abd0164c0288645 + from: 65c265d486ce64abeb649012 + into: 65c265d486ce64abeb649013 "/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: 02ac6930-fe59-4977-9cba-e7d02112fff6 errors: - code: unauthorized message: Access Token Invalid @@ -4246,15 +4270,15 @@ paths: value: - field: id operator: "=" - value: 659ec42b6abd0164c0288648 + value: 65c265d586ce64abeb649016 - operator: OR value: - field: id operator: "=" - value: 659ec42b6abd0164c0288648 + value: 65c265d586ce64abeb649016 - field: id operator: "=" - value: 659ec42b6abd0164c0288648 + value: 65c265d586ce64abeb649016 "/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: 6bf00a62-e09b-4934-a75e-6dfb12b36586 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: 65c265d886ce64abeb649018 + 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: 1707238872 + updated_at: 1707238872 signed_up_at: last_seen_at: last_replied_at: @@ -4371,31 +4395,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ec42d6abd0164c028864a/tags" + url: "/contacts/65c265d886ce64abeb649018/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ec42d6abd0164c028864a/notes" + url: "/contacts/65c265d886ce64abeb649018/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ec42d6abd0164c028864a/companies" + url: "/contacts/65c265d886ce64abeb649018/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ec42d6abd0164c028864a/subscriptions" + url: "/contacts/65c265d886ce64abeb649018/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ec42d6abd0164c028864a/subscriptions" + url: "/contacts/65c265d886ce64abeb649018/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: 2c7c5008-b874-4b76-a744-57a8e01e9f78 errors: - code: unauthorized message: Access Token Invalid @@ -4458,7 +4482,7 @@ paths: examples: successful: value: - id: 659ec42e6abd0164c028864b + id: 65c265d886ce64abeb649019 external_id: '70' type: contact archived: true @@ -4491,7 +4515,7 @@ paths: examples: successful: value: - id: 659ec42e6abd0164c028864c + id: 65c265d986ce64abeb64901a external_id: '70' type: contact archived: false @@ -4527,7 +4551,7 @@ paths: successful: value: type: tag - id: '267' + id: '421' 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: 68a87843-aa45-43e0-a7a6-5fade1453caa 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: 5570b742-cee2-47e4-b2aa-945003a76fca errors: - code: unauthorized message: Access Token Invalid @@ -4582,13 +4606,13 @@ paths: successful: summary: successful value: - id: 267 - admin_id: 991269045 + id: 421 + admin_id: 991271540 conversation_not_found: summary: Conversation not found value: - id: 268 - admin_id: 991269047 + id: 422 + admin_id: 991271542 "/conversations/{conversation_id}/tags/{id}": delete: summary: Remove tag from a conversation @@ -4626,7 +4650,7 @@ paths: successful: value: type: tag - id: '270' + id: '424' 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: b2fc3659-0592-438a-a7bc-b6eabdaeb3c2 errors: - code: not_found message: Conversation not found Tag not found: value: type: error.list - request_id: b5928124-e0a6-4647-87a4-d02e016cd8ff + request_id: 780eb9f4-01f0-4ba1-9d2e-d08a92cfb008 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: 8f8b9ff2-1ad1-4340-8660-aaa678f88da5 errors: - code: unauthorized message: Access Token Invalid @@ -4682,15 +4706,15 @@ paths: successful: summary: successful value: - admin_id: 991269049 + admin_id: 991271544 conversation_not_found: summary: Conversation not found value: - admin_id: 991269051 + admin_id: 991271546 tag_not_found: summary: Tag not found value: - admin_id: 991269052 + admin_id: 991271547 "/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: '1410' + created_at: 1707238881 + updated_at: 1707238881 waiting_since: snoozed_until: source: type: conversation - id: '403918547' + id: '403918887' delivered_as: admin_initiated subject: '' body: "

this is the message body

" author: type: admin - id: '991269055' - name: Ciaran163 Lee - email: admin163@email.com + id: '991271550' + 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: 65c265e186ce64abeb64901e 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: 3eb2b870-10b9-4102-94b5-349700c5e560 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: 4c9f607f-87af-4c09-bea2-92f5106e4e46 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: '403918897' + created_at: 1707238908 body: Hello there message_type: inapp - conversation_id: '844' + conversation_id: '1435' 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: 5ef5a0be-0d78-4302-9ff9-ef538bb22fa9 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: 26936532-f020-4c1f-a9c3-4a67dbcc5291 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: b400f512-f908-4641-8caf-575e4adacb44 errors: - code: api_plan_restricted message: Active subscription needed. @@ -4901,7 +4925,7 @@ paths: value: from: type: user - id: 659ec44c6abd0164c0288665 + id: 65c265fb86ce64abeb649033 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: '1439' + created_at: 1707238914 + updated_at: 1707238914 waiting_since: snoozed_until: source: type: conversation - id: '403918561' + id: '403918901' delivered_as: admin_initiated subject: '' body: "

this is the message body

" author: type: admin - id: '991269069' - name: Ciaran170 Lee - email: admin170@email.com + id: '991271564' + 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: 65c2660286ce64abeb649037 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: ea7f85e2-a6b3-42bb-9af9-9ae09c87ca51 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: 33ff5ced-9e40-4ddf-92c0-7c9699be5740 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: 8acdc64f-d229-4c56-b31d-12cde2cf07ca 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: '1443' + created_at: 1707238921 + updated_at: 1707238923 waiting_since: snoozed_until: source: type: conversation - id: '403918565' + id: '403918905' delivered_as: admin_initiated subject: '' body: "

this is the message body

" author: type: admin - id: '991269077' - name: Ciaran174 Lee - email: admin174@email.com + id: '991271572' + 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: 65c2660986ce64abeb64903b 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: '324' part_type: conversation_attribute_updated_by_admin body: - created_at: 1704903769 - updated_at: 1704903769 - notified_at: 1704903769 + created_at: 1707238922 + updated_at: 1707238922 + notified_at: 1707238922 assigned_to: author: - id: '991269078' + id: '991271573' 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: '325' part_type: conversation_attribute_updated_by_admin body: - created_at: 1704903769 - updated_at: 1704903769 - notified_at: 1704903769 + created_at: 1707238923 + updated_at: 1707238923 + notified_at: 1707238923 assigned_to: author: - id: '991269078' + id: '991271573' 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: 8bc0c471-c562-4855-bb49-076273d91cda 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: 3a1f2a2e-69d9-4efc-ba6d-6e9b4854df2e 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: 2b7972eb-75ac-48d9-bb81-0e7160665d7b errors: - code: api_plan_restricted message: Active subscription needed. @@ -5263,7 +5287,7 @@ paths: examples: successful: value: - id: '856' + id: '1447' object: conversation deleted: true schema: @@ -5276,7 +5300,7 @@ paths: Unauthorized: value: type: error.list - request_id: ff3712e2-b00c-486c-8099-53f54f281c0a + request_id: 1931894a-daa3-4a56-bef4-e391b889f64f 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: c2f04aed-8634-4188-975c-69804e31d35c 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: '1450' + created_at: 1707238933 + updated_at: 1707238933 waiting_since: snoozed_until: source: type: conversation - id: '403918572' + id: '403918912' delivered_as: admin_initiated subject: '' body: "

this is the message body

" author: type: admin - id: '991269107' - name: Ciaran197 Lee - email: admin197@email.com + id: '991271602' + 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: 65c2661486ce64abeb649042 external_id: '70' first_contact_reply: admin_assignee_id: @@ -5453,15 +5477,15 @@ paths: value: - field: id operator: "=" - value: '859' + value: '1450' - operator: OR value: - field: id operator: "=" - value: '859' + value: '1450' - field: id operator: "=" - value: '859' + value: '1450' "/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: '1458' + created_at: 1707238940 + updated_at: 1707238941 + waiting_since: 1707238941 snoozed_until: source: type: conversation - id: '403918575' + id: '403918915' delivered_as: admin_initiated subject: '' body: "

this is the message body

" author: type: admin - id: '991269109' - name: Ciaran198 Lee - email: admin198@email.com + id: '991271604' + 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: 65c2661b86ce64abeb649049 external_id: '70' first_contact_reply: - created_at: 1704903786 + created_at: 1707238941 type: conversation url: admin_assignee_id: @@ -5555,15 +5579,15 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '172' + id: '327' part_type: open body: "

Thanks again :)

" - created_at: 1704903786 - updated_at: 1704903786 - notified_at: 1704903786 + created_at: 1707238941 + updated_at: 1707238941 + notified_at: 1707238941 assigned_to: author: - id: 659ec4696abd0164c028867b + id: 65c2661b86ce64abeb649049 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: '1459' + created_at: 1707238942 + updated_at: 1707238943 waiting_since: snoozed_until: source: type: conversation - id: '403918576' + id: '403918916' delivered_as: admin_initiated subject: '' body: "

this is the message body

" author: type: admin - id: '991269111' - name: Ciaran199 Lee - email: admin199@email.com + id: '991271606' + 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: 65c2661e86ce64abeb64904a 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: '328' part_type: note body: |-

An Unordered HTML List

@@ -5642,15 +5666,15 @@ paths:
  • Tea
  • Milk
  • - created_at: 1704903788 - updated_at: 1704903788 - notified_at: 1704903788 + created_at: 1707238943 + updated_at: 1707238943 + notified_at: 1707238943 assigned_to: author: - id: '991269111' + id: '991271606' type: admin - name: Ciaran199 Lee - email: admin199@email.com + name: Ciaran200 Lee + email: admin200@email.com attachments: [] external_id: redacted: false @@ -5659,22 +5683,22 @@ paths: Admin quick_reply reply: value: type: conversation - id: '869' - created_at: 1704903789 - updated_at: 1704903790 + id: '1460' + created_at: 1707238944 + updated_at: 1707238945 waiting_since: snoozed_until: source: type: conversation - id: '403918577' + id: '403918917' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991269113' - name: Ciaran200 Lee - email: admin200@email.com + id: '991271608' + 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: 65c2661f86ce64abeb64904b 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: '329' part_type: quick_reply body: - created_at: 1704903790 - updated_at: 1704903790 - notified_at: 1704903790 + created_at: 1707238945 + updated_at: 1707238945 + notified_at: 1707238945 assigned_to: author: - id: '991269113' + id: '991271608' 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: '1461' + created_at: 1707238946 + updated_at: 1707238947 + waiting_since: 1707238947 snoozed_until: source: type: conversation - id: '403918578' + id: '403918918' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991269115' - name: Ciaran201 Lee - email: admin201@email.com + id: '991271610' + 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: 65c2662186ce64abeb64904c external_id: '70' first_contact_reply: - created_at: 1704903792 + created_at: 1707238947 type: conversation url: admin_assignee_id: @@ -5786,15 +5810,15 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '175' + id: '330' part_type: open body: "

    Thanks again :)

    " - created_at: 1704903792 - updated_at: 1704903792 - notified_at: 1704903792 + created_at: 1707238947 + updated_at: 1707238947 + notified_at: 1707238947 assigned_to: author: - id: 659ec46e6abd0164c028867e + id: 65c2662186ce64abeb64904c 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: d730ff42-8f71-447f-aa74-ccb029eb94d1 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: bdb040de-4ce6-4f6e-a353-ede4505d8be8 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: 627ab6ca-709f-4751-bfb5-404b38cfa02a 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: 65c2661b86ce64abeb649049 body: Thanks again :) admin_note_reply: summary: Admin note reply value: message_type: note type: admin - admin_id: 991269111 + admin_id: 991271606 body: "

    An Unordered HTML List

    An Ordered HTML List

    \
    1. Coffee
    2. Tea
    3. Milk
    @@ -5875,25 +5899,25 @@ paths: value: message_type: quick_reply type: admin - admin_id: 991269113 + admin_id: 991271608 reply_options: - text: 'Yes' - uuid: f911df8d-e94c-49a4-9e43-5f721adda7b2 + uuid: 4177f49b-99b7-4eb0-a400-13c182ade67f - text: 'No' - uuid: 67f41a56-661a-4589-80ec-4552ff9102c3 + uuid: 9cf3cea7-9b90-4aeb-be7c-c8870a297376 user_last_conversation_reply: summary: User last conversation reply value: message_type: comment type: user - intercom_user_id: 659ec46e6abd0164c028867e + intercom_user_id: 65c2662186ce64abeb64904c body: Thanks again :) not_found: summary: Not found value: message_type: comment type: user - intercom_user_id: 659ec4716abd0164c028867f + intercom_user_id: 65c2662486ce64abeb64904d body: Thanks again :) "/conversations/{id}/parts": post: @@ -5927,22 +5951,22 @@ paths: Close a conversation: value: type: conversation - id: '874' - created_at: 1704903796 - updated_at: 1704903797 + id: '1465' + created_at: 1707238952 + updated_at: 1707238953 waiting_since: snoozed_until: source: type: conversation - id: '403918582' + id: '403918922' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991269123' - name: Ciaran205 Lee - email: admin205@email.com + id: '991271618' + 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: 65c2662886ce64abeb649050 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: '331' part_type: close body: "

    Goodbye :)

    " - created_at: 1704903797 - updated_at: 1704903797 - notified_at: 1704903797 + created_at: 1707238953 + updated_at: 1707238953 + notified_at: 1707238953 assigned_to: author: - id: '991269123' + id: '991271618' 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: '1466' + created_at: 1707238954 + updated_at: 1707238954 waiting_since: - snoozed_until: 1704907400 + snoozed_until: source: type: conversation - id: '403918583' + id: '403918923' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991269125' - name: Ciaran206 Lee - email: admin206@email.com + id: '991271620' + name: Ciaran207 Lee + email: admin207@email.com attachments: [] url: redacted: false @@ -6022,13 +6046,13 @@ paths: type: contact.list contacts: - type: contact - id: 659ec4766abd0164c0288683 + id: 65c2662a86ce64abeb649051 external_id: '70' first_contact_reply: admin_assignee_id: team_assignee_id: - open: true - state: snoozed + open: false + state: closed read: false tags: type: tag.list @@ -6049,44 +6073,27 @@ paths: has_more: false conversation_parts: type: conversation_part.list - conversation_parts: - - type: conversation_part - id: '177' - part_type: snoozed - body: - created_at: 1704903800 - updated_at: 1704903800 - notified_at: 1704903800 - assigned_to: - author: - id: '991269125' - type: admin - name: Ciaran206 Lee - email: admin206@email.com - attachments: [] - external_id: - redacted: false - metadata: {} - total_count: 1 + conversation_parts: [] + total_count: 0 Open a conversation: value: type: conversation - id: '880' - created_at: 1704903799 - updated_at: 1704903807 + id: '1471' + created_at: 1707238954 + updated_at: 1707238962 waiting_since: snoozed_until: source: type: conversation - id: '403918584' + id: '403918924' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991269127' - name: Ciaran207 Lee - email: admin207@email.com + id: '991271622' + name: Ciaran208 Lee + email: admin208@email.com attachments: [] url: redacted: false @@ -6094,7 +6101,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ec47c6abd0164c0288688 + id: 65c2662e86ce64abeb649056 external_id: '74' first_contact_reply: admin_assignee_id: @@ -6123,18 +6130,18 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '179' + id: '333' part_type: open body: - created_at: 1704903807 - updated_at: 1704903807 - notified_at: 1704903807 + created_at: 1707238962 + updated_at: 1707238962 + notified_at: 1707238962 assigned_to: author: - id: '991269127' + id: '991271622' type: admin - name: Ciaran207 Lee - email: admin207@email.com + name: Ciaran208 Lee + email: admin208@email.com attachments: [] external_id: redacted: false @@ -6143,22 +6150,22 @@ paths: Assign a conversation: value: type: conversation - id: '884' - created_at: 1704903808 - updated_at: 1704903809 + id: '1475' + created_at: 1707238963 + updated_at: 1707238964 waiting_since: snoozed_until: source: type: conversation - id: '403918587' + id: '403918927' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991269129' - name: Ciaran208 Lee - email: admin208@email.com + id: '991271624' + name: Ciaran209 Lee + email: admin209@email.com attachments: [] url: redacted: false @@ -6166,10 +6173,10 @@ paths: type: contact.list contacts: - type: contact - id: 659ec4806abd0164c028868b + id: 65c2663386ce64abeb649059 external_id: '70' first_contact_reply: - admin_assignee_id: 991269129 + admin_assignee_id: 991271624 team_assignee_id: open: true state: open @@ -6195,20 +6202,20 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '180' + id: '334' part_type: assign_and_reopen body: - created_at: 1704903809 - updated_at: 1704903809 - notified_at: 1704903809 + created_at: 1707238964 + updated_at: 1707238964 + notified_at: 1707238964 assigned_to: type: admin - id: '991269129' + id: '991271624' author: - id: '991269129' + id: '991271624' type: admin - name: Ciaran208 Lee - email: admin208@email.com + name: Ciaran209 Lee + email: admin209@email.com attachments: [] external_id: redacted: false @@ -6224,7 +6231,7 @@ paths: Not found: value: type: error.list - request_id: 917eb5e0-461d-46a8-9f50-656e7ce4a3a6 + request_id: 5291336a-ccfe-4582-8993-a5376d6ff04f errors: - code: not_found message: Resource Not Found @@ -6238,7 +6245,7 @@ paths: Unauthorized: value: type: error.list - request_id: 1bf38a19-e450-4c6d-9654-98d2e4877849 + request_id: 54a7384f-3182-487d-a6fa-6f57363b677a errors: - code: unauthorized message: Access Token Invalid @@ -6252,7 +6259,7 @@ paths: API plan restricted: value: type: error.list - request_id: abb6792c-f636-4e04-b045-35e783b6bfad + request_id: ce722231-6e4d-4395-a825-cf4f5d82ac23 errors: - code: api_plan_restricted message: Active subscription needed. @@ -6273,32 +6280,32 @@ paths: value: message_type: close type: admin - admin_id: 991269123 + admin_id: 991271618 body: Goodbye :) snooze_a_conversation: summary: Snooze a conversation value: message_type: snoozed - admin_id: 991269125 - snoozed_until: 1704907400 + admin_id: 991271620 + snoozed_until: 1707242555 open_a_conversation: summary: Open a conversation value: message_type: open - admin_id: 991269127 + admin_id: 991271622 assign_a_conversation: summary: Assign a conversation value: message_type: assignment type: admin - admin_id: 991269129 - assignee_id: 991269129 + admin_id: 991271624 + assignee_id: 991271624 not_found: summary: Not found value: message_type: close type: admin - admin_id: 991269131 + admin_id: 991271626 body: Goodbye :) "/conversations/{id}/run_assignment_rules": post: @@ -6329,22 +6336,22 @@ paths: Assign a conversation using assignment rules: value: type: conversation - id: '888' - created_at: 1704903815 - updated_at: 1704903816 + id: '1479' + created_at: 1707238970 + updated_at: 1707238971 waiting_since: snoozed_until: source: type: conversation - id: '403918591' + id: '403918931' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991269137' - name: Ciaran212 Lee - email: admin212@email.com + id: '991271632' + name: Ciaran213 Lee + email: admin213@email.com attachments: [] url: redacted: false @@ -6352,7 +6359,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ec4876abd0164c028868f + id: 65c2663a86ce64abeb64905d external_id: '70' first_contact_reply: admin_assignee_id: @@ -6381,20 +6388,20 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '181' + id: '335' part_type: default_assignment body: - created_at: 1704903816 - updated_at: 1704903816 - notified_at: 1704903816 + created_at: 1707238971 + updated_at: 1707238971 + notified_at: 1707238971 assigned_to: type: nobody_admin id: author: - id: '991269138' + id: '991271633' 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 +6417,7 @@ paths: Not found: value: type: error.list - request_id: c1a35bf7-bc78-4ae8-95d8-81370a2c9d86 + request_id: 7cba54db-dffa-4386-b0e5-df099c74d485 errors: - code: not_found message: Resource Not Found @@ -6424,7 +6431,7 @@ paths: Unauthorized: value: type: error.list - request_id: 87a11dd6-6207-45f3-a352-25788e84835e + request_id: d0ab5af5-ccc6-4d7d-b136-13bf690e520e errors: - code: unauthorized message: Access Token Invalid @@ -6438,7 +6445,7 @@ paths: API plan restricted: value: type: error.list - request_id: 6a6649c6-cc1e-4514-8b1b-4ed69a2b82a6 + request_id: d1576902-eefc-4a86-b421-dd41d4206c2c errors: - code: api_plan_restricted message: Active subscription needed. @@ -6477,7 +6484,7 @@ paths: value: customers: - type: user - id: 659ec48d6abd0164c0288693 + id: 65c2664286ce64abeb649061 schema: "$ref": "#/components/schemas/conversation" '404': @@ -6488,7 +6495,7 @@ paths: Not found: value: type: error.list - request_id: 189b020e-33dd-4337-8251-0b00ec7f53d1 + request_id: 31520dbc-6bc6-4548-8743-132e7f534ecf errors: - code: not_found message: Resource Not Found @@ -6502,7 +6509,7 @@ paths: Unauthorized: value: type: error.list - request_id: 1e8d039d-ecfd-4754-9de8-00387f3d2f91 + request_id: 5218e54e-7b2a-4318-97b7-5c78cd01263c errors: - code: unauthorized message: Access Token Invalid @@ -6516,7 +6523,7 @@ paths: API plan restricted: value: type: error.list - request_id: '029f8340-b4c5-4e27-a208-e795e8d6c426' + request_id: 0274c8b2-cfe9-4062-ae09-705f993b80f5 errors: - code: api_plan_restricted message: Active subscription needed. @@ -6531,15 +6538,15 @@ paths: attach_a_contact_to_a_conversation: summary: Attach a contact to a conversation value: - admin_id: 991269145 + admin_id: 991271640 customer: - intercom_user_id: 659ec48d6abd0164c0288693 + intercom_user_id: 65c2664286ce64abeb649061 not_found: summary: Not found value: - admin_id: 991269147 + admin_id: 991271642 customer: - intercom_user_id: 659ec48f6abd0164c0288694 + intercom_user_id: 65c2664486ce64abeb649062 "/conversations/{conversation_id}/customers/{contact_id}": delete: summary: Detach a contact from a group conversation @@ -6580,7 +6587,7 @@ paths: value: customers: - type: user - id: 659ec49a6abd0164c028869e + id: 65c2665286ce64abeb64906c schema: "$ref": "#/components/schemas/conversation" '404': @@ -6591,14 +6598,14 @@ paths: Conversation not found: value: type: error.list - request_id: 61a312a0-69f6-4b68-8735-549b6c7b5236 + request_id: 9986ba6e-c1fe-432a-b2c7-74a328af62b0 errors: - code: not_found message: Resource Not Found Contact not found: value: type: error.list - request_id: 58970872-e6a2-4f14-bb7a-db32676c007c + request_id: 41c26abe-b0f1-4c31-bb13-451c6536c35d errors: - code: not_found message: User Not Found @@ -6612,7 +6619,7 @@ paths: Last customer: value: type: error.list - request_id: 4dabf0b3-3495-4d32-b065-28c1b2e9acad + request_id: cacfa8e7-357e-4ea4-b8e5-96be9e81fd88 errors: - code: parameter_invalid message: Removing the last customer is not allowed @@ -6626,7 +6633,7 @@ paths: Unauthorized: value: type: error.list - request_id: 5c48f485-e778-41f9-a2c0-461796b4662f + request_id: 9ecef7e8-1fb7-42fc-91ae-2743a3dbf0b5 errors: - code: unauthorized message: Access Token Invalid @@ -6640,7 +6647,7 @@ paths: API plan restricted: value: type: error.list - request_id: 56693267-cfb5-4d0d-8851-435c568680f3 + request_id: 3d7da828-13ea-414c-85d0-212e2732fb2f errors: - code: api_plan_restricted message: Active subscription needed. @@ -6655,27 +6662,27 @@ paths: detach_a_contact_from_a_group_conversation: summary: Detach a contact from a group conversation value: - admin_id: 991269153 + admin_id: 991271648 customer: - intercom_user_id: 659ec4926abd0164c0288697 + intercom_user_id: 65c2664a86ce64abeb649065 conversation_not_found: summary: Conversation not found value: - admin_id: 991269155 + admin_id: 991271650 customer: - intercom_user_id: 659ec49b6abd0164c028869f + intercom_user_id: 65c2665386ce64abeb64906d contact_not_found: summary: Contact not found value: - admin_id: 991269157 + admin_id: 991271652 customer: - intercom_user_id: 659ec4a36abd0164c02886a6 + intercom_user_id: 65c2665b86ce64abeb649074 last_customer: summary: Last customer value: - admin_id: 991269159 + admin_id: 991271654 customer: - intercom_user_id: 659ec4a96abd0164c02886ad + intercom_user_id: 65c2666386ce64abeb64907b "/conversations/redact": post: summary: Redact a conversation part @@ -6702,22 +6709,22 @@ paths: Redact a conversation part: value: type: conversation - id: '944' - created_at: 1704903869 - updated_at: 1704903871 - waiting_since: 1704903869 + id: '1535' + created_at: 1707239037 + updated_at: 1707239039 + waiting_since: 1707239038 snoozed_until: source: type: conversation - id: '403918617' + id: '403918957' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991269165' - name: Ciaran226 Lee - email: admin226@email.com + id: '991271660' + name: Ciaran227 Lee + email: admin227@email.com attachments: [] url: redacted: false @@ -6725,10 +6732,10 @@ paths: type: contact.list contacts: - type: contact - id: 659ec4bc6abd0164c02886c2 + id: 65c2667d86ce64abeb649090 external_id: '70' first_contact_reply: - created_at: 1704903869 + created_at: 1707239038 type: conversation url: admin_assignee_id: @@ -6757,15 +6764,15 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '189' + id: '343' part_type: open body: "

    This message was deleted

    " - created_at: 1704903869 - updated_at: 1704903871 - notified_at: 1704903869 + created_at: 1707239038 + updated_at: 1707239039 + notified_at: 1707239038 assigned_to: author: - id: 659ec4bc6abd0164c02886c2 + id: 65c2667d86ce64abeb649090 type: user name: Joe Bloggs email: joe@bloggs.com @@ -6784,7 +6791,7 @@ paths: Not found: value: type: error.list - request_id: 23c8e2eb-c9ad-4d5f-af09-bb87ac5138f9 + request_id: 1084e892-12bb-489b-a155-60c86291523c errors: - code: conversation_part_or_message_not_found message: Conversation part or message not found @@ -6798,7 +6805,7 @@ paths: Unauthorized: value: type: error.list - request_id: 36146671-8234-43bf-b8f1-6579a89fbb6e + request_id: 77adaef2-bf96-4704-83c1-d3468b3bbb29 errors: - code: unauthorized message: Access Token Invalid @@ -6814,8 +6821,8 @@ paths: summary: Redact a conversation part value: type: conversation_part - conversation_id: 944 - conversation_part_id: 189 + conversation_id: 1535 + conversation_part_id: 343 not_found: summary: Not found value: @@ -6850,20 +6857,20 @@ paths: successful: value: type: ticket - id: '947' - ticket_id: '24' + id: '1538' + ticket_id: '64' ticket_attributes: {} ticket_state: submitted ticket_type: type: ticket_type - id: '108' + id: '251' 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: 1707239048 + updated_at: 1707239048 is_internal: false ticket_type_attributes: type: list @@ -6873,40 +6880,40 @@ paths: type: contact.list contacts: - type: contact - id: 659ec4c26abd0164c02886c5 + id: 65c2668486ce64abeb649093 external_id: '70' admin_assignee_id: '0' team_assignee_id: '0' - created_at: 1704903874 - updated_at: 1704903876 + created_at: 1707239044 + updated_at: 1707239048 ticket_parts: type: ticket_part.list ticket_parts: - type: ticket_part - id: '191' + id: '345' part_type: comment body: "

    Comment for message

    " - created_at: 1704903874 - updated_at: 1704903874 + created_at: 1707239044 + updated_at: 1707239044 author: - id: 659ec4c26abd0164c02886c5 + id: 65c2668486ce64abeb649093 type: user name: Joe Bloggs email: joe@bloggs.com attachments: [] redacted: false - type: ticket_part - id: '192' + id: '346' part_type: ticket_state_updated_by_admin ticket_state: submitted previous_ticket_state: submitted - created_at: 1704903876 - updated_at: 1704903876 + created_at: 1707239048 + updated_at: 1707239048 author: - id: '991269175' + id: '991271670' 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 +6935,7 @@ paths: Bad request: value: type: error.list - request_id: ff47d2c7-957a-4765-a373-c6b2faa4cad1 + request_id: ae49a01e-bf45-4f27-8ee7-52fae81f6dcd errors: - code: parameter_invalid message: Ticket type is not a customer ticket type @@ -6943,11 +6950,242 @@ paths: successful: summary: successful value: - ticket_type_id: '108' + ticket_type_id: '251' bad_request: summary: Bad request value: - ticket_type_id: '109' + ticket_type_id: '252' + "/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: '11' + type: object_type_identifier_1 + custom_attributes: {} + external_id: '123' + external_created_at: 1392036272 + external_updated_at: 1392036272 + created_at: 1707239051 + updated_at: 1707239051 + schema: + "$ref": "#/components/schemas/custom_object_instance" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 2b5fe072-88cb-422f-9894-93237a91df52 + 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: '13' + type: object_type_identifier_4 + custom_attributes: {} + external_id: '123' + external_created_at: + external_updated_at: + created_at: 1707239052 + updated_at: 1707239052 + schema: + "$ref": "#/components/schemas/custom_object_instance" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: f45d39ec-60a4-410c-9113-aa1c3601ce64 + 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: '14' + type: object_type_identifier_6 + custom_attributes: {} + external_id: '123' + external_created_at: + external_updated_at: + created_at: 1707239053 + updated_at: 1707239053 + schema: + "$ref": "#/components/schemas/custom_object_instance" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: b088836f-d889-4553-9530-7c6e8ce5637f + 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: '15' + 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: 984352a6-036f-4be8-b06b-a2dd4c430936 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" "/data_attributes": get: summary: List all data attributes @@ -7117,7 +7355,7 @@ paths: custom: false archived: false model: company - - id: 138 + - id: 148 type: data_attribute name: The One Ring full_name: custom_attributes.The One Ring @@ -7129,9 +7367,9 @@ paths: ui_writable: false custom: true archived: false - admin_id: '991269183' - created_at: 1704903879 - updated_at: 1704903879 + admin_id: '991271687' + created_at: 1707239055 + updated_at: 1707239055 model: company - type: data_attribute name: id @@ -7198,7 +7436,7 @@ paths: Unauthorized: value: type: error.list - request_id: 23758fbb-8387-42d5-bd33-e57ffd8f8b10 + request_id: 2a50d039-8da3-4013-9616-7ef1938e222b errors: - code: unauthorized message: Access Token Invalid @@ -7223,7 +7461,7 @@ paths: examples: Successful: value: - id: 141 + id: 151 type: data_attribute name: Mithril Shirt full_name: custom_attributes.Mithril Shirt @@ -7233,9 +7471,9 @@ paths: ui_writable: false custom: true archived: false - admin_id: '991269185' - created_at: 1704903880 - updated_at: 1704903880 + admin_id: '991271689' + created_at: 1707239056 + updated_at: 1707239056 model: company schema: "$ref": "#/components/schemas/data_attribute" @@ -7247,7 +7485,7 @@ paths: Same name already exists: value: type: error.list - request_id: c0ba02a0-8bf0-4f17-ae44-0cc30b3c0255 + request_id: a760085d-bf49-4c37-bbf1-e31e57f3b1ba errors: - code: parameter_invalid message: You already have 'The One Ring' in your company data. @@ -7255,7 +7493,7 @@ paths: Invalid name: value: type: error.list - request_id: b6f86b8e-175d-4f02-9d9a-51f5d84600e0 + request_id: 91eb2175-2c28-4242-b327-c7ef0ac1dc0e errors: - code: parameter_invalid message: Your name for this attribute must only contain alphanumeric @@ -7263,7 +7501,7 @@ paths: Attribute already exists: value: type: error.list - request_id: b6b61265-a059-467d-930c-9f267d8740ae + request_id: e45e06d2-9bf2-4b58-a518-409c3f90c54f errors: - code: parameter_invalid message: You already have 'The One Ring' in your company data. @@ -7271,14 +7509,14 @@ paths: Invalid Data Type: value: type: error.list - request_id: f414dd43-7238-4113-aec1-a9698b085b04 + request_id: b5ccc267-b434-4bae-9e85-d9169e57dce6 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: db3cc2ed-1cee-4d40-bf9b-4d0a74db617b errors: - code: parameter_invalid message: The Data Attribute model field must be either contact @@ -7293,7 +7531,7 @@ paths: Unauthorized: value: type: error.list - request_id: 76ca950e-d96b-4fb4-83c3-012cb7840a1c + request_id: 05070a1f-babe-42c2-88cc-5a73b842d6b4 errors: - code: unauthorized message: Access Token Invalid @@ -7372,7 +7610,7 @@ paths: examples: Successful: value: - id: 148 + id: 158 type: data_attribute name: The One Ring full_name: custom_attributes.The One Ring @@ -7386,9 +7624,9 @@ paths: ui_writable: false custom: true archived: false - admin_id: '991269192' - created_at: 1704903883 - updated_at: 1704903883 + admin_id: '991271696' + created_at: 1707239058 + updated_at: 1707239058 model: company schema: "$ref": "#/components/schemas/data_attribute" @@ -7400,7 +7638,7 @@ paths: Too few options in list: value: type: error.list - request_id: fb2e4e2e-523b-4ef3-a602-cff95e0814b3 + request_id: 4ed6d92a-2ab2-4f83-8c13-e43800b758d6 errors: - code: parameter_invalid message: Options isn't an array @@ -7414,7 +7652,7 @@ paths: Attribute Not Found: value: type: error.list - request_id: b04d200a-7580-4865-a9b9-55443d06d9fc + request_id: c5fdcc37-6ff0-40d1-8641-0b249b0659dd errors: - code: field_not_found message: We couldn't find that data attribute to update @@ -7428,7 +7666,7 @@ paths: Has Dependant Object: value: type: error.list - request_id: 3976d450-6ee4-4bff-b82c-737bda9a43e7 + request_id: 8d54520f-5e8c-4d6e-b3d5-5b65717e9617 errors: - code: data_invalid message: The Data Attribute you are trying to archive has a @@ -7443,7 +7681,7 @@ paths: Unauthorized: value: type: error.list - request_id: be041231-fdff-4b28-bdad-32d8a80946cc + request_id: 62adf297-a0ef-4cef-9622-19975f1acd05 errors: - code: unauthorized message: Access Token Invalid @@ -7494,63 +7732,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 +7786,7 @@ paths: Unauthorized: value: type: error.list - request_id: e8f477b3-28ed-47d9-8538-a38e03e4f999 + request_id: c393c889-855d-430b-a3fe-bf1583cf7a22 errors: - code: unauthorized message: Access Token Invalid @@ -7648,8 +7872,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: 65c2669686ce64abeb649099 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 schema: "$ref": "#/components/schemas/data_event_summary" @@ -7661,7 +7885,7 @@ paths: Unauthorized: value: type: error.list - request_id: d23d8a4a-b289-47ac-ad17-868a9bb6a9e6 + request_id: b5fc5bcd-0a34-414b-9e8e-8a0122733146 errors: - code: unauthorized message: Access Token Invalid @@ -7692,7 +7916,7 @@ paths: Unauthorized: value: type: error.list - request_id: b7c55438-98b5-4cff-acf2-acfe67997ad0 + request_id: 31198f6d-5636-40a6-a939-e244e266e12a errors: - code: unauthorized message: Access Token Invalid @@ -7736,7 +7960,7 @@ paths: examples: successful: value: - job_identifier: lv4ulh4c6ywmpdor + job_identifier: ldalunmopuqmkv62 status: pending download_url: '' download_expires_at: '' @@ -7751,8 +7975,8 @@ paths: successful: summary: successful value: - created_at_after: 1704885893 - created_at_before: 1704903893 + created_at_after: 1707221064 + created_at_before: 1707239064 "/export/content/data/{job_identifier}": get: summary: Show content data export @@ -7786,7 +8010,7 @@ paths: examples: successful: value: - job_identifier: rgbw5mzyj4g4oh53 + job_identifier: g5vq492vhw9vlhpi status: pending download_url: '' download_expires_at: '' @@ -7818,7 +8042,7 @@ paths: examples: successful: value: - job_identifier: 38tdk26dluyuwzgj + job_identifier: 2ftbrv73sut2canm status: canceled download_url: '' download_expires_at: '' @@ -7879,32 +8103,32 @@ paths: user message created: value: type: user_message - id: '403918628' - created_at: 1704903920 + id: '403918962' + created_at: 1707239066 body: heyy message_type: inapp - conversation_id: '960' + conversation_id: '1540' lead message created: value: type: user_message - id: '403918629' - created_at: 1704903921 + id: '403918963' + created_at: 1707239067 body: heyy message_type: inapp - conversation_id: '961' + conversation_id: '1541' admin message created: value: type: admin_message - id: '48' - created_at: 1704903922 + id: '50' + created_at: 1707239068 subject: heyy body: heyy message_type: inapp owner: type: admin - id: '991269226' - name: Ciaran269 Lee - email: admin269@email.com + id: '991271719' + name: Ciaran279 Lee + email: admin279@email.com away_mode_enabled: false away_mode_reassign: false schema: @@ -7917,14 +8141,14 @@ paths: No body supplied for message: value: type: error.list - request_id: fa33246e-3f1d-400b-8b95-afd826704f6e + request_id: a898cb70-2569-442c-bbfc-b6fb3b316243 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: ba02e1c8-1e36-41f8-8fec-926dedc60c66 errors: - code: parameter_invalid message: Body is required @@ -7938,7 +8162,7 @@ paths: No subject supplied for email message: value: type: error.list - request_id: 59bd3793-9819-42cb-948b-f0523ed5277a + request_id: f77c6208-1a39-494e-8765-f5d86b8f7f1e errors: - code: parameter_not_found message: No subject supplied for email message @@ -7952,7 +8176,7 @@ paths: Unauthorized: value: type: error.list - request_id: b4a94fe9-bf7e-46bd-b641-6556ad8230f0 + request_id: 80db1288-c686-4f43-9aca-7b4db5bb3ad3 errors: - code: unauthorized message: Access Token Invalid @@ -7966,7 +8190,7 @@ paths: API plan restricted: value: type: error.list - request_id: a10db167-db31-4a76-a3d2-dd2c09782860 + request_id: d6b4b0ce-9e2a-4741-bb4b-8b155849464f errors: - code: api_plan_restricted message: Active subscription needed. @@ -7983,7 +8207,7 @@ paths: value: from: type: user - id: 659ec4f06abd0164c0288730 + id: 65c2669a86ce64abeb64909e body: heyy referer: https://twitter.com/bob lead_message_created: @@ -7991,7 +8215,7 @@ paths: value: from: type: lead - id: 659ec4f16abd0164c0288731 + id: 65c2669b86ce64abeb64909f body: heyy referer: https://twitter.com/bob admin_message_created: @@ -7999,10 +8223,10 @@ paths: value: from: type: admin - id: '991269226' + id: '991271719' to: type: user - id: 659ec4f26abd0164c0288732 + id: 65c2669c86ce64abeb6490a0 message_type: conversation body: heyy no_body_supplied_for_message: @@ -8010,10 +8234,10 @@ paths: value: from: type: admin - id: '991269228' + id: '991271721' to: type: user - id: 659ec4f36abd0164c0288733 + id: 65c2669c86ce64abeb6490a1 message_type: inapp body: subject: heyy @@ -8022,7 +8246,7 @@ paths: value: from: type: admin - id: '991269229' + id: '991271722' to: type: user user_id: '70' @@ -8033,10 +8257,10 @@ paths: value: from: type: admin - id: '991269230' + id: '991271723' to: type: user - id: 659ec4f46abd0164c0288735 + id: 65c2669d86ce64abeb6490a3 message_type: email body: subject: heyy @@ -8067,12 +8291,12 @@ paths: total_pages: 1 type: pages data: - - id: '72' + - id: '127' 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: 991271728 state: draft labels: [] cover_image_url: @@ -8082,15 +8306,15 @@ paths: - - deliver_silently: false - created_at: 1704903926 - updated_at: 1704903926 + created_at: 1707239071 + updated_at: 1707239071 newsfeed_assignments: [] - - id: '71' + - id: '128' 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: 991271730 state: draft labels: [] cover_image_url: @@ -8100,8 +8324,8 @@ paths: - - deliver_silently: false - created_at: 1704903925 - updated_at: 1704903925 + created_at: 1707239071 + updated_at: 1707239071 newsfeed_assignments: [] total_count: 2 schema: @@ -8114,7 +8338,7 @@ paths: Unauthorized: value: type: error.list - request_id: 396f2b22-52ef-4eec-bdf4-f6b72dd1de2d + request_id: 7fa6be70-36a0-41d5-9bf0-b1be5e418095 errors: - code: unauthorized message: Access Token Invalid @@ -8139,12 +8363,12 @@ paths: examples: successful: value: - id: '75' + id: '131' 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: 991271737 state: live labels: - New @@ -8155,10 +8379,10 @@ paths: - "\U0001F606" - "\U0001F605" deliver_silently: true - created_at: 1704903927 - updated_at: 1704903927 + created_at: 1707239073 + updated_at: 1707239073 newsfeed_assignments: - - newsfeed_id: 128 + - newsfeed_id: 228 published_at: 1664638214 schema: "$ref": "#/components/schemas/news_item" @@ -8170,7 +8394,7 @@ paths: Unauthorized: value: type: error.list - request_id: 5f9be90a-5885-43ca-bace-1db32e7e95f7 + request_id: 26a7fb29-2c8d-416e-a846-ff3ad0ca701b errors: - code: unauthorized message: Access Token Invalid @@ -8191,14 +8415,14 @@ paths: - Product - Update - New - sender_id: 991269244 + sender_id: 991271737 deliver_silently: true reactions: - "\U0001F606" - "\U0001F605" state: live newsfeed_assignments: - - newsfeed_id: 128 + - newsfeed_id: 228 published_at: 1664638214 "/news/news_items/{id}": get: @@ -8227,12 +8451,12 @@ paths: examples: successful: value: - id: '76' + id: '132' 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: 991271740 state: live labels: [] cover_image_url: @@ -8242,11 +8466,11 @@ paths: - - deliver_silently: false - created_at: 1704903928 - updated_at: 1704903928 + created_at: 1707239074 + updated_at: 1707239074 newsfeed_assignments: - - newsfeed_id: 130 - published_at: 1704903928 + - newsfeed_id: 230 + published_at: 1707239074 schema: "$ref": "#/components/schemas/news_item" '404': @@ -8257,7 +8481,7 @@ paths: News Item Not Found: value: type: error.list - request_id: f5bd1826-17f3-4c80-9ce1-c606504f6c9e + request_id: 1f872515-7206-4ac9-a5c0-7ba0fc7faa15 errors: - code: not_found message: Resource Not Found @@ -8271,7 +8495,7 @@ paths: Unauthorized: value: type: error.list - request_id: a9194a49-4864-47d2-bfbc-35e6e76fa06e + request_id: 995dd361-78ca-472d-ad7e-a820ec40aace errors: - code: unauthorized message: Access Token Invalid @@ -8302,12 +8526,12 @@ paths: examples: successful: value: - id: '79' + id: '135' 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: 991271748 state: live labels: [] cover_image_url: @@ -8315,8 +8539,8 @@ paths: - "\U0001F61D" - "\U0001F602" deliver_silently: false - created_at: 1704903930 - updated_at: 1704903930 + created_at: 1707239076 + updated_at: 1707239076 newsfeed_assignments: [] schema: "$ref": "#/components/schemas/news_item" @@ -8328,7 +8552,7 @@ paths: News Item Not Found: value: type: error.list - request_id: d87e34b9-23c9-4ad0-8193-05943f854b4e + request_id: 118acef7-6ea8-4df0-adc7-dc0fc69c96f6 errors: - code: not_found message: Resource Not Found @@ -8342,7 +8566,7 @@ paths: Unauthorized: value: type: error.list - request_id: 12f547e0-6bff-44ca-8a3c-961157010a3d + request_id: 3589adf5-4530-4d71-a214-ffa6ee908a26 errors: - code: unauthorized message: Access Token Invalid @@ -8359,7 +8583,7 @@ paths: value: title: Christmas is here! body: "

    New gifts in store for the jolly season

    " - sender_id: 991269255 + sender_id: 991271748 reactions: - "\U0001F61D" - "\U0001F602" @@ -8368,7 +8592,7 @@ paths: value: title: Christmas is here! body: "

    New gifts in store for the jolly season

    " - sender_id: 991269258 + sender_id: 991271751 reactions: - "\U0001F61D" - "\U0001F602" @@ -8398,7 +8622,7 @@ paths: examples: successful: value: - id: '82' + id: '138' object: news-item deleted: true schema: @@ -8411,7 +8635,7 @@ paths: News Item Not Found: value: type: error.list - request_id: a94679ef-21c5-4509-93f4-5be7a6c00705 + request_id: 43e22c0e-647c-43cf-81a5-97d5cdc75610 errors: - code: not_found message: Resource Not Found @@ -8425,7 +8649,7 @@ paths: Unauthorized: value: type: error.list - request_id: b61d2629-5642-4788-8e17-9f65060ad479 + request_id: 913bafdc-0730-414a-a3d2-263bb4ff0b94 errors: - code: unauthorized message: Access Token Invalid @@ -8478,7 +8702,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8dbdb1dc-3b8b-4763-a914-87f7cb315064 + request_id: bb3b4e51-318c-4d39-bad3-d8d8d77a8c41 errors: - code: unauthorized message: Access Token Invalid @@ -8511,16 +8735,16 @@ paths: total_pages: 1 type: pages data: - - id: '143' + - id: '243' type: newsfeed name: Visitor Feed - created_at: 1704903934 - updated_at: 1704903934 - - id: '144' + created_at: 1707239080 + updated_at: 1707239080 + - id: '244' type: newsfeed name: Visitor Feed - created_at: 1704903934 - updated_at: 1704903934 + created_at: 1707239080 + updated_at: 1707239080 total_count: 2 schema: "$ref": "#/components/schemas/paginated_response" @@ -8532,7 +8756,7 @@ paths: Unauthorized: value: type: error.list - request_id: bbfe34dd-fedf-4adb-b100-4416c28c887c + request_id: e44e38dc-ea72-4a59-ae16-c56c73c21ff6 errors: - code: unauthorized message: Access Token Invalid @@ -8566,11 +8790,11 @@ paths: examples: successful: value: - id: '147' + id: '247' type: newsfeed name: Visitor Feed - created_at: 1704903935 - updated_at: 1704903935 + created_at: 1707239081 + updated_at: 1707239081 schema: "$ref": "#/components/schemas/newsfeed" '401': @@ -8581,7 +8805,7 @@ paths: Unauthorized: value: type: error.list - request_id: 673b7b15-a16c-49ea-b852-4e4d34e34d6e + request_id: 2c4e8ad1-1b3f-4e5b-b4ff-0bec827943a9 errors: - code: unauthorized message: Access Token Invalid @@ -8615,16 +8839,16 @@ paths: Note found: value: type: note - id: '146' - created_at: 1704212738 + id: '148' + created_at: 1706547882 contact: type: contact - id: 659ec5026abd0164c0288740 + id: 65c266aa86ce64abeb6490a6 author: type: admin - id: '991269274' - name: Ciaran316 Lee - email: admin316@email.com + id: '991271767' + name: Ciaran326 Lee + email: admin326@email.com away_mode_enabled: false away_mode_reassign: false body: "

    This is a note.

    " @@ -8638,7 +8862,7 @@ paths: Note not found: value: type: error.list - request_id: 477bcd84-40b8-4d18-9c48-c281d75f7b6b + request_id: 34051abf-915b-4aa6-97d4-fa414745a8df errors: - code: not_found message: Resource Not Found @@ -8652,7 +8876,7 @@ paths: Unauthorized: value: type: error.list - request_id: a6c05584-a665-4881-8c57-e2fc59dc903d + request_id: bcf7123a-388e-4b91-a4c8-ce34976e852e errors: - code: unauthorized message: Access Token Invalid @@ -8688,16 +8912,16 @@ paths: type: segment.list segments: - type: segment - id: 659ec5056abd0164c0288747 + id: 65c266ab86ce64abeb6490a9 name: John segment - created_at: 1704903941 - updated_at: 1704903941 + created_at: 1707239083 + updated_at: 1707239083 person_type: user - type: segment - id: 659ec5056abd0164c0288748 + id: 65c266ab86ce64abeb6490aa name: Jane segment - created_at: 1704903941 - updated_at: 1704903941 + created_at: 1707239083 + updated_at: 1707239083 person_type: user schema: "$ref": "#/components/schemas/segment_list" @@ -8709,7 +8933,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9b496fe6-c69c-489a-af6d-838c89a8dd85 + request_id: fbb5bbf1-5fdf-4d6a-b105-932a48144aba errors: - code: unauthorized message: Access Token Invalid @@ -8743,10 +8967,10 @@ paths: Successful response: value: type: segment - id: 659ec5066abd0164c028874b + id: 65c266ac86ce64abeb6490ad name: John segment - created_at: 1704903942 - updated_at: 1704903942 + created_at: 1707239084 + updated_at: 1707239084 person_type: user schema: "$ref": "#/components/schemas/segment" @@ -8758,7 +8982,7 @@ paths: Segment not found: value: type: error.list - request_id: 2e3a1f51-be84-41ed-a388-8b2d6557354c + request_id: 0b08818a-bdcb-4cbe-944c-8f13d2593fc8 errors: - code: not_found message: Resource Not Found @@ -8772,7 +8996,7 @@ paths: Unauthorized: value: type: error.list - request_id: 668198cd-1528-412f-b81b-8f215df72bb6 + request_id: 7cef056a-01cc-4517-9df2-1bf796c390b4 errors: - code: unauthorized message: Access Token Invalid @@ -8802,7 +9026,7 @@ paths: type: list data: - type: subscription - id: '318' + id: '547' state: live consent_type: opt_out default_translation: @@ -8825,7 +9049,7 @@ paths: Unauthorized: value: type: error.list - request_id: 21357080-d104-4a11-8edf-64346f8d4a31 + request_id: 24e985d9-f271-4256-ab38-fa5fd0f66835 errors: - code: unauthorized message: Access Token Invalid @@ -8855,7 +9079,7 @@ paths: examples: successful: value: - url: http://via.intercom.io/msgr/80584690-365f-43d8-8c53-d27404b60148 + url: http://via.intercom.io/msgr/6df4865b-0893-46ad-b189-8651f058faba type: phone_call_redirect schema: "$ref": "#/components/schemas/phone_switch" @@ -8888,7 +9112,7 @@ paths: Unauthorized: value: type: error.list - request_id: 365cf128-a63c-436d-b848-11e8cbe546b8 + request_id: a109f324-8c6e-4045-8d70-fcfe8525fc0b errors: - code: unauthorized message: Access Token Invalid @@ -8951,7 +9175,7 @@ paths: type: list data: - type: tag - id: '291' + id: '437' name: Manual tag 1 schema: "$ref": "#/components/schemas/tag_list" @@ -8963,7 +9187,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9998e174-5bf3-476d-ae10-8a9cc6f223fb + request_id: 97ea562b-568f-4fb3-9f03-7ff540015248 errors: - code: unauthorized message: Access Token Invalid @@ -9002,7 +9226,7 @@ paths: Action successful: value: type: tag - id: '294' + id: '440' name: test schema: "$ref": "#/components/schemas/tag" @@ -9014,7 +9238,7 @@ paths: Invalid parameters: value: type: error.list - request_id: d34d9f8a-1f85-4f56-90f6-1a3dc59925a6 + request_id: ee81dd74-f13c-49fd-ad8b-6ecf9ffb2ed0 errors: - code: parameter_invalid message: invalid tag parameters @@ -9028,14 +9252,14 @@ paths: Company not found: value: type: error.list - request_id: 1c6548e5-afd6-47c8-bea1-e916b7595fd1 + request_id: 673d1578-978e-42a2-b1bf-1cee1e7a38ee 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: 852d3286-0b2c-4b02-ac82-7cb01e38306c errors: - code: not_found message: User Not Found @@ -9049,7 +9273,7 @@ paths: Unauthorized: value: type: error.list - request_id: 58788ccd-1207-450c-a013-1a858d06fe2c + request_id: 75f50b0f-7452-4709-9c2f-6988d5ed19a3 errors: - code: unauthorized message: Access Token Invalid @@ -9115,7 +9339,7 @@ paths: Tag found: value: type: tag - id: '302' + id: '448' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -9127,7 +9351,7 @@ paths: Tag not found: value: type: error.list - request_id: ed151a71-b388-4fee-9b14-1e3375b1e0ba + request_id: 3c3af77d-5c2e-453d-aa3d-17193e0c4f9e errors: - code: not_found message: Resource Not Found @@ -9141,7 +9365,7 @@ paths: Unauthorized: value: type: error.list - request_id: 87544aa3-71b4-4d41-a5aa-a25d07ff477d + request_id: b1a6f1a1-1ab8-4cc9-8425-24e6f71cd817 errors: - code: unauthorized message: Access Token Invalid @@ -9177,7 +9401,7 @@ paths: Resource not found: value: type: error.list - request_id: a5e003d1-0a0a-4339-939a-9a255b032364 + request_id: e2b0bcf8-cc7f-42de-88d6-a7a7b4127bfe errors: - code: not_found message: Resource Not Found @@ -9191,7 +9415,7 @@ paths: Tag has dependent objects: value: type: error.list - request_id: edd61656-e294-4dcf-9115-d9a6c0900c97 + request_id: 24f7d6f5-438c-44d1-a1fc-c22404f4bd35 errors: - code: tag_has_dependent_objects message: 'Unable to delete Tag with dependent objects. Segments: @@ -9206,7 +9430,7 @@ paths: Unauthorized: value: type: error.list - request_id: 1fdc4ebb-5107-486d-b8c0-d8f8a4ba0605 + request_id: 5f0755ed-05b6-441c-ba92-360ab688a723 errors: - code: unauthorized message: Access Token Invalid @@ -9244,7 +9468,7 @@ paths: Unauthorized: value: type: error.list - request_id: cc7ba0a6-9d3a-4df5-a2c1-481d466034e5 + request_id: ad38ba26-ccdf-4b34-9f44-5ed09de0e855 errors: - code: unauthorized message: Access Token Invalid @@ -9279,7 +9503,7 @@ paths: successful: value: type: team - id: '991269318' + id: '991271805' name: team 1 admin_ids: [] schema: @@ -9292,7 +9516,7 @@ paths: Team not found: value: type: error.list - request_id: fd588da6-8b21-4fe4-80d7-6c2b1b843ec4 + request_id: c0945147-5376-49db-8df0-6977a3d485a2 errors: - code: team_not_found message: Team not found @@ -9306,7 +9530,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0bfa928b-bf5d-4728-aaa9-f18647e22235 + request_id: 7f8f95b7-782c-4b73-bebd-6eb3fb0aa177 errors: - code: unauthorized message: Access Token Invalid @@ -9339,23 +9563,23 @@ paths: Ticket Type Attribute created: value: type: ticket_type_attribute - id: '252' - workspace_id: this_is_an_id604_that_should_be_at_least_ + id: '719' + 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 visible_to_contacts: true default: false - ticket_type_id: 110 + ticket_type_id: 253 archived: false - created_at: 1704903962 - updated_at: 1704903962 + created_at: 1707239100 + updated_at: 1707239100 schema: "$ref": "#/components/schemas/ticket_type_attribute" '401': @@ -9366,7 +9590,7 @@ paths: Unauthorized: value: type: error.list - request_id: fecfe8d4-6d8f-41ee-b68a-c7611980c08f + request_id: c1c12083-fcf0-442d-b48f-c479b9129605 errors: - code: unauthorized message: Access Token Invalid @@ -9419,8 +9643,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: '724' + workspace_id: this_is_an_id625_that_should_be_at_least_ name: name description: New Attribute Description data_type: string @@ -9430,10 +9654,10 @@ paths: visible_on_create: false visible_to_contacts: false default: false - ticket_type_id: 112 + ticket_type_id: 255 archived: false - created_at: 1704903963 - updated_at: 1704903963 + created_at: 1707239101 + updated_at: 1707239101 schema: "$ref": "#/components/schemas/ticket_type_attribute" '401': @@ -9444,7 +9668,7 @@ paths: Unauthorized: value: type: error.list - request_id: e5ea76f4-8454-4728-8fa6-ae9adc926406 + request_id: '08d44649-2d18-41d2-9708-3f14442ce00e' errors: - code: unauthorized message: Access Token Invalid @@ -9483,21 +9707,39 @@ paths: type: list data: - type: ticket_type - id: '114' + id: '257' 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: 1707239102 + updated_at: 1707239102 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: '727' + 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: 257 + archived: false + created_at: 1707239102 + updated_at: 1707239102 + - type: ticket_type_attribute + id: '729' + workspace_id: this_is_an_id629_that_should_be_at_least_ name: name description: description data_type: string @@ -9508,10 +9750,28 @@ paths: visible_on_create: false visible_to_contacts: false default: false - ticket_type_id: 114 + ticket_type_id: 257 + archived: false + created_at: 1707239102 + updated_at: 1707239102 + - type: ticket_type_attribute + id: '728' + 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: 257 archived: false - created_at: 1704903964 - updated_at: 1704903964 + created_at: 1707239102 + updated_at: 1707239102 category: Customer schema: "$ref": "#/components/schemas/ticket_type_list" @@ -9523,7 +9783,7 @@ paths: Unauthorized: value: type: error.list - request_id: 73312699-450e-4cd2-958b-21cae0e07b22 + request_id: 03e227cc-5e5e-4685-8bb1-f04096fb506b errors: - code: unauthorized message: Access Token Invalid @@ -9552,18 +9812,54 @@ paths: Ticket type created: value: type: ticket_type - id: '117' + id: '260' 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: 1707239103 + updated_at: 1707239103 is_internal: false ticket_type_attributes: type: list - data: [] + data: + - type: ticket_type_attribute + id: '736' + 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: 260 + archived: false + created_at: 1707239103 + updated_at: 1707239103 + - type: ticket_type_attribute + id: '737' + 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: 260 + archived: false + created_at: 1707239103 + updated_at: 1707239103 category: Customer schema: "$ref": "#/components/schemas/ticket_type" @@ -9575,7 +9871,7 @@ paths: Unauthorized: value: type: error.list - request_id: 646105ff-f9ec-4a00-b252-6d15b8c117d8 + request_id: 45db7454-69be-4bdf-be51-294cc244fbca errors: - code: unauthorized message: Access Token Invalid @@ -9621,21 +9917,39 @@ paths: Ticket type found: value: type: ticket_type - id: '119' + id: '262' 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: 1707239104 + updated_at: 1707239104 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: '741' + 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: 262 + archived: false + created_at: 1707239104 + updated_at: 1707239104 + - type: ticket_type_attribute + id: '743' + workspace_id: this_is_an_id637_that_should_be_at_least_ name: name description: description data_type: string @@ -9646,10 +9960,28 @@ paths: visible_on_create: false visible_to_contacts: false default: false - ticket_type_id: 119 + ticket_type_id: 262 + archived: false + created_at: 1707239104 + updated_at: 1707239104 + - type: ticket_type_attribute + id: '742' + 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: 262 archived: false - created_at: 1704903966 - updated_at: 1704903966 + created_at: 1707239104 + updated_at: 1707239104 category: Customer schema: "$ref": "#/components/schemas/ticket_type" @@ -9661,7 +9993,7 @@ paths: Unauthorized: value: type: error.list - request_id: d6cc875b-9b5d-4843-a439-33ff0d065e38 + request_id: 3c18bac9-df06-445c-83ed-439add231d28 errors: - code: unauthorized message: Access Token Invalid @@ -9694,21 +10026,39 @@ paths: Ticket type updated: value: type: ticket_type - id: '121' + id: '264' 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: 1707239105 + updated_at: 1707239105 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: '747' + 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: 264 + archived: false + created_at: 1707239105 + updated_at: 1707239105 + - type: ticket_type_attribute + id: '749' + workspace_id: this_is_an_id641_that_should_be_at_least_ name: name description: description data_type: string @@ -9719,10 +10069,28 @@ paths: visible_on_create: false visible_to_contacts: false default: false - ticket_type_id: 121 + ticket_type_id: 264 + archived: false + created_at: 1707239105 + updated_at: 1707239105 + - type: ticket_type_attribute + id: '748' + 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: 264 archived: false - created_at: 1704903966 - updated_at: 1704903966 + created_at: 1707239105 + updated_at: 1707239105 category: Customer schema: "$ref": "#/components/schemas/ticket_type" @@ -9734,7 +10102,7 @@ paths: Unauthorized: value: type: error.list - request_id: 39c4e515-cca1-4bd2-9f08-087b6cd06d91 + request_id: a5ab7d98-7b49-47a9-8667-4b1b604544c6 errors: - code: unauthorized message: Access Token Invalid @@ -9780,22 +10148,22 @@ paths: User reply: value: type: ticket_part - id: '195' + id: '349' part_type: comment body: "

    Thanks again :)

    " - created_at: 1704903969 - updated_at: 1704903969 + created_at: 1707239108 + updated_at: 1707239108 author: - id: 659ec5216abd0164c028877a + id: 65c266c486ce64abeb6490d0 type: user name: - email: user28@email.com + email: user30@email.com attachments: [] redacted: false Admin note reply: value: type: ticket_part - id: '197' + id: '351' part_type: note body: |-

    An Unordered HTML List

    @@ -9810,27 +10178,27 @@ paths:
  • Tea
  • Milk
  • - created_at: 1704903971 - updated_at: 1704903971 + created_at: 1707239111 + updated_at: 1707239111 author: - id: '991269345' + id: '991271840' type: admin - name: Ciaran381 Lee - email: admin381@email.com + name: Ciaran385 Lee + email: admin385@email.com attachments: [] redacted: false Admin quick_reply reply: value: type: ticket_part - id: '199' + id: '353' part_type: quick_reply - created_at: 1704903973 - updated_at: 1704903973 + created_at: 1707239113 + updated_at: 1707239113 author: - id: '991269350' + id: '991271845' type: admin - name: Ciaran385 Lee - email: admin385@email.com + name: Ciaran389 Lee + email: admin389@email.com attachments: [] redacted: false schema: @@ -9843,7 +10211,7 @@ paths: Not found: value: type: error.list - request_id: 77a20f70-1cfa-4994-8d6e-70d643cbe6fa + request_id: 90a6ba19-651a-49f0-b446-df62a0633589 errors: - code: not_found message: Resource Not Found @@ -9857,7 +10225,7 @@ paths: Unauthorized: value: type: error.list - request_id: e88d589a-bb01-458f-84b2-520b579c083b + request_id: 6089a8c3-a19e-4c4e-8576-7633d881babe errors: - code: unauthorized message: Access Token Invalid @@ -9874,14 +10242,14 @@ paths: value: message_type: comment type: user - intercom_user_id: 659ec5216abd0164c028877a + intercom_user_id: 65c266c486ce64abeb6490d0 body: Thanks again :) admin_note_reply: summary: Admin note reply value: message_type: note type: admin - admin_id: 991269345 + admin_id: 991271840 body: "

    An Unordered HTML List

    An Ordered HTML List

    \
    1. Coffee
    2. Tea
    3. Milk
    @@ -9891,18 +10259,18 @@ paths: value: message_type: quick_reply type: admin - admin_id: 991269350 + admin_id: 991271845 reply_options: - text: 'Yes' - uuid: f4da6ea4-cc47-4aae-8aad-66b5ebcb41ff + uuid: 4c8d0be9-6347-4c6b-8e04-6f731d81019b - text: 'No' - uuid: 79eb8e5b-969d-421f-92b0-eb60cc6960fe + uuid: 2b4946bf-231e-4b14-b129-9a09ad7cb257 not_found: summary: Not found value: message_type: comment type: user - intercom_user_id: 659ec5266abd0164c028877d + intercom_user_id: 65c266ca86ce64abeb6490d3 body: Thanks again :) "/tickets/{ticket_id}/tags": post: @@ -9934,7 +10302,7 @@ paths: successful: value: type: tag - id: '310' + id: '456' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -9946,7 +10314,7 @@ paths: Ticket not found: value: type: error.list - request_id: bcb20184-946b-4ab8-bd8d-3d9b8b4c177f + request_id: ae584b0f-fa14-4930-8c66-7037910b46c7 errors: - code: ticket_not_found message: Ticket not found @@ -9960,7 +10328,7 @@ paths: Unauthorized: value: type: error.list - request_id: 5789aef4-bdb9-41f5-a788-8364427b1769 + request_id: d2a3b358-3698-4a78-a913-678462b6955f errors: - code: unauthorized message: Access Token Invalid @@ -9989,13 +10357,13 @@ paths: successful: summary: successful value: - id: 310 - admin_id: 991269360 + id: 456 + admin_id: 991271855 ticket_not_found: summary: Ticket not found value: - id: 311 - admin_id: 991269363 + id: 457 + admin_id: 991271858 "/tickets/{ticket_id}/tags/{id}": delete: summary: Remove tag from a ticket @@ -10033,7 +10401,7 @@ paths: successful: value: type: tag - id: '313' + id: '459' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -10045,14 +10413,14 @@ paths: Ticket not found: value: type: error.list - request_id: 5fc507eb-6640-4a16-bc2f-c27228e17ed1 + request_id: 85ca8b66-5b1f-48aa-b78c-c18683285c78 errors: - code: ticket_not_found message: Ticket not found Tag not found: value: type: error.list - request_id: 67304c41-c5b1-4c9d-b3fc-b54f96200c21 + request_id: 850fc723-b90a-49d1-ad41-63c01b44d070 errors: - code: tag_not_found message: Tag not found @@ -10066,7 +10434,7 @@ paths: Unauthorized: value: type: error.list - request_id: 1d20e26e-475f-490b-b11e-858de1cfa198 + request_id: f1194844-6dd0-46f1-9400-5d43ed1c789c errors: - code: unauthorized message: Access Token Invalid @@ -10089,15 +10457,15 @@ paths: successful: summary: successful value: - admin_id: 991269369 + admin_id: 991271864 ticket_not_found: summary: Ticket not found value: - admin_id: 991269372 + admin_id: 991271867 tag_not_found: summary: Tag not found value: - admin_id: 991269375 + admin_id: 991271870 "/tickets": post: summary: Create a ticket @@ -10119,29 +10487,29 @@ paths: Successful response: value: type: ticket - id: '973' - ticket_id: '35' + id: '1553' + ticket_id: '75' ticket_attributes: title: example description: there is a problem ticket_state: submitted ticket_type: type: ticket_type - id: '135' + id: '278' name: my-ticket-type-15 description: my ticket type description is awesome. icon: "\U0001F981" - workspace_id: this_is_an_id652_that_should_be_at_least_ + workspace_id: this_is_an_id669_that_should_be_at_least_ archived: false - created_at: 1704903985 - updated_at: 1704903985 + created_at: 1707239127 + updated_at: 1707239127 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '270' - workspace_id: this_is_an_id652_that_should_be_at_least_ + id: '761' + workspace_id: this_is_an_id669_that_should_be_at_least_ name: title description: ola data_type: string @@ -10152,13 +10520,13 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 135 + ticket_type_id: 278 archived: false - created_at: 1704903985 - updated_at: 1704903985 + created_at: 1707239127 + updated_at: 1707239127 - type: ticket_type_attribute - id: '271' - workspace_id: this_is_an_id652_that_should_be_at_least_ + id: '762' + workspace_id: this_is_an_id669_that_should_be_at_least_ name: description description: ola data_type: string @@ -10169,36 +10537,36 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 135 + ticket_type_id: 278 archived: false - created_at: 1704903985 - updated_at: 1704903985 + created_at: 1707239128 + updated_at: 1707239128 category: Back-office contacts: type: contact.list contacts: - type: contact - id: 659ec5316abd0164c0288785 + id: 65c266d886ce64abeb6490db external_id: '70' admin_assignee_id: '0' team_assignee_id: '0' - created_at: 1704903986 - updated_at: 1704903986 + created_at: 1707239128 + updated_at: 1707239129 ticket_parts: type: ticket_part.list ticket_parts: - type: ticket_part - id: '200' + id: '354' part_type: ticket_state_updated_by_admin ticket_state: submitted previous_ticket_state: submitted - created_at: 1704903986 - updated_at: 1704903986 + created_at: 1707239129 + updated_at: 1707239129 author: - id: '991269387' + id: '991271882' type: bot name: Operator - email: operator+this_is_an_id652_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id669_that_should_be_at_least_@intercom.io attachments: [] redacted: false total_count: 1 @@ -10220,7 +10588,7 @@ paths: Unauthorized: value: type: error.list - request_id: 61c804f0-8df1-4ab4-b02d-5df3ddf76d23 + request_id: dbb5df7b-f326-48d6-a6f8-ee02a0b2503c errors: - code: unauthorized message: Access Token Invalid @@ -10235,9 +10603,9 @@ paths: successful_response: summary: Successful response value: - ticket_type_id: 135 + ticket_type_id: 278 contacts: - - id: 659ec5316abd0164c0288785 + - id: 65c266d886ce64abeb6490db ticket_attributes: title: example description: there is a problem @@ -10268,29 +10636,29 @@ paths: Successful response: value: type: ticket - id: '974' - ticket_id: '36' + id: '1554' + ticket_id: '76' ticket_attributes: title: example description: there is a problem ticket_state: in_progress ticket_type: type: ticket_type - id: '137' + id: '280' name: my-ticket-type-17 description: my ticket type description is awesome. icon: "\U0001F981" - workspace_id: this_is_an_id656_that_should_be_at_least_ + workspace_id: this_is_an_id673_that_should_be_at_least_ archived: false - created_at: 1704903988 - updated_at: 1704903988 + created_at: 1707239130 + updated_at: 1707239130 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '275' - workspace_id: this_is_an_id656_that_should_be_at_least_ + id: '766' + workspace_id: this_is_an_id673_that_should_be_at_least_ name: title description: ola data_type: string @@ -10301,13 +10669,13 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 137 + ticket_type_id: 280 archived: false - created_at: 1704903988 - updated_at: 1704903988 + created_at: 1707239130 + updated_at: 1707239130 - type: ticket_type_attribute - id: '276' - workspace_id: this_is_an_id656_that_should_be_at_least_ + id: '767' + workspace_id: this_is_an_id673_that_should_be_at_least_ name: description description: ola data_type: string @@ -10318,106 +10686,106 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 137 + ticket_type_id: 280 archived: false - created_at: 1704903988 - updated_at: 1704903988 + created_at: 1707239130 + updated_at: 1707239130 category: Back-office contacts: type: contact.list contacts: - type: contact - id: 659ec5346abd0164c0288786 - external_id: 642cc786-29dd-45a3-a8d0-de50de2f4041 - admin_assignee_id: '991269401' + id: 65c266da86ce64abeb6490dc + external_id: 7901108a-28eb-4d22-a44a-38ef7a8c04c9 + admin_assignee_id: '991271896' team_assignee_id: '0' - created_at: 1704903988 - updated_at: 1704903990 + created_at: 1707239130 + updated_at: 1707239132 ticket_parts: type: ticket_part.list ticket_parts: - type: ticket_part - id: '201' + id: '355' part_type: ticket_state_updated_by_admin ticket_state: submitted previous_ticket_state: submitted - created_at: 1704903988 - updated_at: 1704903988 + created_at: 1707239131 + updated_at: 1707239131 author: - id: '991269399' + id: '991271894' type: admin - name: Ciaran425 Lee - email: admin425@email.com + name: Ciaran429 Lee + email: admin429@email.com attachments: [] redacted: false - type: ticket_part - id: '202' + id: '356' part_type: ticket_attribute_updated_by_admin - created_at: 1704903989 - updated_at: 1704903989 + created_at: 1707239132 + updated_at: 1707239132 author: - id: '991269400' + id: '991271895' type: bot name: Operator - email: operator+this_is_an_id656_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id673_that_should_be_at_least_@intercom.io attachments: [] redacted: false - type: ticket_part - id: '203' + id: '357' part_type: ticket_attribute_updated_by_admin - created_at: 1704903989 - updated_at: 1704903989 + created_at: 1707239132 + updated_at: 1707239132 author: - id: '991269400' + id: '991271895' type: bot name: Operator - email: operator+this_is_an_id656_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id673_that_should_be_at_least_@intercom.io attachments: [] redacted: false - type: ticket_part - id: '204' + id: '358' part_type: ticket_state_updated_by_admin ticket_state: in_progress previous_ticket_state: submitted - created_at: 1704903990 - updated_at: 1704903990 + created_at: 1707239132 + updated_at: 1707239132 author: - id: '991269400' + id: '991271895' type: bot name: Operator - email: operator+this_is_an_id656_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id673_that_should_be_at_least_@intercom.io attachments: [] redacted: false - type: ticket_part - id: '205' + id: '359' part_type: assignment - created_at: 1704903990 - updated_at: 1704903990 + created_at: 1707239132 + updated_at: 1707239132 assigned_to: type: admin - id: '991269401' + id: '991271896' author: - id: '991269399' + id: '991271894' type: admin - name: Ciaran425 Lee - email: admin425@email.com + name: Ciaran429 Lee + email: admin429@email.com attachments: [] redacted: false - type: ticket_part - id: '206' + id: '360' part_type: snoozed - created_at: 1704903990 - updated_at: 1704903990 + created_at: 1707239133 + updated_at: 1707239133 author: - id: '991269400' + id: '991271895' type: bot name: Operator - email: operator+this_is_an_id656_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id673_that_should_be_at_least_@intercom.io attachments: [] redacted: false total_count: 6 open: true - snoozed_until: 1704992400 + snoozed_until: 1707325200 linked_objects: type: list data: [] @@ -10435,14 +10803,14 @@ paths: Admin not found: value: type: error.list - request_id: 0ab09d20-8147-49e2-ac03-77b4c8503a85 + request_id: eb16bdc6-9711-42ab-98c4-7b5a88a968c4 errors: - code: assignee_not_found message: Assignee not found Assignee not found: value: type: error.list - request_id: 5dbd5bed-bd13-42e1-a1c6-59d9ddc43b2d + request_id: fd887c04-e703-4483-84a9-b3f9eab1823e errors: - code: assignee_not_found message: Assignee not found @@ -10454,7 +10822,7 @@ paths: Unauthorized: value: type: error.list - request_id: c8f4ad69-c684-4796-9801-971545ed530b + request_id: 2ccd589e-0ff8-4f96-968f-8d0660875a8c errors: - code: unauthorized message: Access Token Invalid @@ -10474,8 +10842,8 @@ paths: description: there is a problem state: in_progress assignment: - admin_id: '991269399' - assignee_id: '991269401' + admin_id: '991271894' + assignee_id: '991271896' open: true snoozed_until: 1673609604 admin_not_found: @@ -10487,7 +10855,7 @@ paths: state: in_progress assignment: admin_id: '123' - assignee_id: '991269409' + assignee_id: '991271904' assignee_not_found: summary: Assignee not found value: @@ -10496,7 +10864,7 @@ paths: description: there is a problem state: in_progress assignment: - admin_id: '991269415' + admin_id: '991271910' assignee_id: '456' get: summary: Retrieve a ticket @@ -10524,29 +10892,29 @@ paths: Ticket found: value: type: ticket - id: '977' - ticket_id: '39' + id: '1557' + ticket_id: '79' ticket_attributes: title: attribute_value description: ticket_state: submitted ticket_type: type: ticket_type - id: '141' + id: '284' name: my-ticket-type-21 description: my ticket type description is awesome. icon: "\U0001F981" - workspace_id: this_is_an_id664_that_should_be_at_least_ + workspace_id: this_is_an_id681_that_should_be_at_least_ archived: false - created_at: 1704903995 - updated_at: 1704903995 + created_at: 1707239139 + updated_at: 1707239139 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '286' - workspace_id: this_is_an_id664_that_should_be_at_least_ + id: '777' + workspace_id: this_is_an_id681_that_should_be_at_least_ name: title description: ola data_type: string @@ -10557,13 +10925,13 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 141 + ticket_type_id: 284 archived: false - created_at: 1704903995 - updated_at: 1704903995 + created_at: 1707239139 + updated_at: 1707239139 - type: ticket_type_attribute - id: '287' - workspace_id: this_is_an_id664_that_should_be_at_least_ + id: '778' + workspace_id: this_is_an_id681_that_should_be_at_least_ name: description description: ola data_type: string @@ -10574,36 +10942,36 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 141 + ticket_type_id: 284 archived: false - created_at: 1704903995 - updated_at: 1704903995 + created_at: 1707239140 + updated_at: 1707239140 category: Back-office contacts: type: contact.list contacts: - type: contact - id: 659ec53c6abd0164c0288789 - external_id: 5ac61e7c-754a-434b-bcbe-6bbc658ea646 + id: 65c266e486ce64abeb6490df + external_id: 320617aa-ac83-47e2-a186-a8c92932f6b6 admin_assignee_id: '0' team_assignee_id: '0' - created_at: 1704903996 - updated_at: 1704903996 + created_at: 1707239140 + updated_at: 1707239140 ticket_parts: type: ticket_part.list ticket_parts: - type: ticket_part - id: '209' + id: '363' part_type: ticket_state_updated_by_admin ticket_state: submitted previous_ticket_state: submitted - created_at: 1704903996 - updated_at: 1704903996 + created_at: 1707239140 + updated_at: 1707239140 author: - id: '991269428' + id: '991271923' type: admin - name: Ciaran451 Lee - email: admin451@email.com + name: Ciaran455 Lee + email: admin455@email.com attachments: [] redacted: false total_count: 1 @@ -10625,7 +10993,7 @@ paths: Unauthorized: value: type: error.list - request_id: 055ea40e-44e6-4dc8-a3e7-1ecc643ca13d + request_id: 22ea2052-aa48-4308-95b8-ef1a6da9f3de errors: - code: unauthorized message: Access Token Invalid @@ -10690,29 +11058,29 @@ paths: total_count: 1 tickets: - type: ticket - id: '978' - ticket_id: '40' + id: '1558' + ticket_id: '80' ticket_attributes: title: attribute_value description: ticket_state: submitted ticket_type: type: ticket_type - id: '143' + id: '286' name: my-ticket-type-23 description: my ticket type description is awesome. icon: "\U0001F981" - workspace_id: this_is_an_id668_that_should_be_at_least_ + workspace_id: this_is_an_id685_that_should_be_at_least_ archived: false - created_at: 1704903998 - updated_at: 1704903998 + created_at: 1707239142 + updated_at: 1707239142 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '291' - workspace_id: this_is_an_id668_that_should_be_at_least_ + id: '782' + workspace_id: this_is_an_id685_that_should_be_at_least_ name: title description: ola data_type: string @@ -10723,13 +11091,13 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 143 + ticket_type_id: 286 archived: false - created_at: 1704903998 - updated_at: 1704903998 + created_at: 1707239142 + updated_at: 1707239142 - type: ticket_type_attribute - id: '292' - workspace_id: this_is_an_id668_that_should_be_at_least_ + id: '783' + workspace_id: this_is_an_id685_that_should_be_at_least_ name: description description: ola data_type: string @@ -10740,36 +11108,36 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 143 + ticket_type_id: 286 archived: false - created_at: 1704903998 - updated_at: 1704903998 + created_at: 1707239142 + updated_at: 1707239142 category: Back-office contacts: type: contact.list contacts: - type: contact - id: 659ec53f6abd0164c028878a - external_id: ee120b62-4925-4f06-958b-1b044c23d072 + id: 65c266e786ce64abeb6490e0 + external_id: a55f6cea-7472-4725-9e78-55221b044e14 admin_assignee_id: '0' team_assignee_id: '0' - created_at: 1704903999 - updated_at: 1704903999 + created_at: 1707239143 + updated_at: 1707239143 ticket_parts: type: ticket_part.list ticket_parts: - type: ticket_part - id: '210' + id: '364' part_type: ticket_state_updated_by_admin ticket_state: submitted previous_ticket_state: submitted - created_at: 1704903999 - updated_at: 1704903999 + created_at: 1707239143 + updated_at: 1707239143 author: - id: '991269441' + id: '991271936' type: admin - name: Ciaran463 Lee - email: admin463@email.com + name: Ciaran467 Lee + email: admin467@email.com attachments: [] redacted: false total_count: 1 @@ -10797,15 +11165,15 @@ paths: value: - field: id operator: "=" - value: '978' + value: '1558' - operator: OR value: - field: id operator: "=" - value: '978' + value: '1558' - field: id operator: "=" - value: '978' + value: '1558' "/visitors": put: summary: Update a visitor @@ -10832,26 +11200,26 @@ paths: successful: value: type: visitor - id: 659ec5636abd0164c0288877 + id: 65c266ea86ce64abeb6490e3 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' phone: name: Gareth Bale - pseudonym: Teal Domino + pseudonym: Grey Basketball avatar: type: avatar - image_url: https://static.intercomassets.com/app/pseudonym_avatars_2019/teal-domino.png - app_id: this_is_an_id672_that_should_be_at_least_ + image_url: https://static.intercomassets.com/app/pseudonym_avatars_2019/grey-basketball.png + app_id: this_is_an_id689_that_should_be_at_least_ companies: type: company.list companies: [] location_data: {} last_request_at: - created_at: 1704904035 - remote_created_at: 1704904035 - signed_up_at: 1704904035 - updated_at: 1704904035 + created_at: 1707239146 + remote_created_at: 1707239146 + signed_up_at: 1707239146 + updated_at: 1707239146 session_count: 0 social_profiles: type: social_profile.list @@ -10884,7 +11252,7 @@ paths: visitor Not Found: value: type: error.list - request_id: a4b13270-ffcf-43b5-9b11-8ec73417cb81 + request_id: b3eab868-fa3a-4698-b9e2-ba6895eddfd3 errors: - code: not_found message: Visitor Not Found @@ -10898,7 +11266,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0aa02f7c-aeb8-4150-9d79-aad07672fd5b + request_id: 1696d9cd-de92-406e-ab2f-801b1bdd361d errors: - code: unauthorized message: Access Token Invalid @@ -10913,7 +11281,7 @@ paths: successful: summary: successful value: - id: 659ec5636abd0164c0288877 + id: 65c266ea86ce64abeb6490e3 name: Gareth Bale visitor_not_found: summary: visitor Not Found @@ -10946,7 +11314,7 @@ paths: successful: value: type: visitor - id: 659ec5646abd0164c028887d + id: 65c266eb86ce64abeb6490e9 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' @@ -10956,16 +11324,16 @@ paths: avatar: type: avatar image_url: - app_id: this_is_an_id678_that_should_be_at_least_ + app_id: this_is_an_id695_that_should_be_at_least_ companies: type: company.list companies: [] location_data: {} last_request_at: - created_at: 1704904036 - remote_created_at: 1704904036 - signed_up_at: 1704904036 - updated_at: 1704904036 + created_at: 1707239147 + remote_created_at: 1707239147 + signed_up_at: 1707239147 + updated_at: 1707239147 session_count: 0 social_profiles: type: social_profile.list @@ -10998,7 +11366,7 @@ paths: Visitor not found: value: type: error.list - request_id: 9ef7111e-c70c-4554-9e97-38bc4cee90bf + request_id: e7aaef91-48b4-4feb-a156-53dd3fda2f8f errors: - code: not_found message: Visitor Not Found @@ -11012,7 +11380,7 @@ paths: Unauthorized: value: type: error.list - request_id: 04dfe2a6-9159-402b-b414-d6ff50a8fa36 + request_id: 9a2d0f4b-d0a6-481b-be1f-82203396d40d errors: - code: unauthorized message: Access Token Invalid @@ -11046,7 +11414,7 @@ paths: successful: value: type: visitor - id: 659ec5666abd0164c0288883 + id: 65c266ec86ce64abeb6490ef user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' @@ -11056,16 +11424,16 @@ paths: avatar: type: avatar image_url: - app_id: this_is_an_id684_that_should_be_at_least_ + app_id: this_is_an_id701_that_should_be_at_least_ companies: type: company.list companies: [] location_data: {} last_request_at: - created_at: 1704904038 - remote_created_at: 1704904038 - signed_up_at: 1704904038 - updated_at: 1704904038 + created_at: 1707239148 + remote_created_at: 1707239148 + signed_up_at: 1707239148 + updated_at: 1707239148 session_count: 0 social_profiles: type: social_profile.list @@ -11098,7 +11466,7 @@ paths: Visitor not found: value: type: error.list - request_id: d8d5badf-f901-4640-9a96-f2307669cf2e + request_id: 501eed15-9c7a-47dc-b5a1-200f61bd4bc0 errors: - code: not_found message: Visitor Not Found @@ -11112,7 +11480,7 @@ paths: Unauthorized: value: type: error.list - request_id: d574248d-04f8-4d5a-aa2f-954c9c062d91 + request_id: ae32c260-3225-4769-bf8d-5079cb58504f errors: - code: unauthorized message: Access Token Invalid @@ -11145,7 +11513,7 @@ paths: successful: value: type: visitor - id: 659ec5676abd0164c0288889 + id: 65c266ed86ce64abeb6490f5 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' @@ -11155,16 +11523,16 @@ paths: avatar: type: avatar image_url: - app_id: this_is_an_id690_that_should_be_at_least_ + app_id: this_is_an_id707_that_should_be_at_least_ companies: type: company.list companies: [] location_data: {} last_request_at: - created_at: 1704904039 - remote_created_at: 1704904039 - signed_up_at: 1704904039 - updated_at: 1704904040 + created_at: 1707239149 + remote_created_at: 1707239149 + signed_up_at: 1707239149 + updated_at: 1707239150 session_count: 0 social_profiles: type: social_profile.list @@ -11197,7 +11565,7 @@ paths: Visitor Not Found: value: type: error.list - request_id: 479eac30-2572-4618-9e55-c708e6d10da2 + request_id: f79ac9ba-aa66-433b-a90f-fa8fb2e116e5 errors: - code: not_found message: User Not Found @@ -11211,7 +11579,7 @@ paths: Unauthorized: value: type: error.list - request_id: '059e7955-7744-475c-b508-f827349c25b9' + request_id: 4ea94a94-4c9e-40bb-aabb-8f96ba6759f4 errors: - code: unauthorized message: Access Token Invalid @@ -11242,8 +11610,8 @@ paths: successful: value: type: contact - id: 659ec5696abd0164c0288890 - workspace_id: this_is_an_id696_that_should_be_at_least_ + id: 65c266ef86ce64abeb6490fc + workspace_id: this_is_an_id713_that_should_be_at_least_ external_id: role: user email: foo@bar.com @@ -11258,9 +11626,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1704904041 - updated_at: 1704904041 - signed_up_at: 1704904041 + created_at: 1707239151 + updated_at: 1707239151 + signed_up_at: 1707239151 last_seen_at: last_replied_at: last_contacted_at: @@ -11294,31 +11662,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ec5696abd0164c0288890/tags" + url: "/contacts/65c266ef86ce64abeb6490fc/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ec5696abd0164c0288890/notes" + url: "/contacts/65c266ef86ce64abeb6490fc/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ec5696abd0164c0288890/companies" + url: "/contacts/65c266ef86ce64abeb6490fc/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ec5696abd0164c0288890/subscriptions" + url: "/contacts/65c266ef86ce64abeb6490fc/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ec5696abd0164c0288890/subscriptions" + url: "/contacts/65c266ef86ce64abeb6490fc/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -11337,7 +11705,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8471cd2c-cfc3-4141-b94e-69cb5c2b7b3b + request_id: 2e35b4cb-f70b-46c9-b421-f00ea43220b2 errors: - code: unauthorized message: Access Token Invalid @@ -14284,7 +14652,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 @@ -14564,6 +14933,33 @@ components: 155.98 will be truncated to 155. Note that this has an upper limit of 2**31-1 or 2147483647.. example: 1000 + create_or_update_custom_object_instance_request: + description: Payload to create or update a Custom Object instance + type: object + title: Create Or Update Custom Object Instance Request Payload + properties: + external_id: + type: string + description: A unique identifier for the Custom Object instance in the external + system it originated from. + external_created_at: + type: integer + format: date-time + nullable: true + description: The time when the Custom Object instance was created in the + external system it originated from. + example: 1571672154 + external_updated_at: + type: integer + format: date-time + nullable: true + description: The time when the Custom Object instance was last updated in + the external system it originated from. + example: 1571672154 + custom_attributes: + type: object + nullable: true + description: The custom attributes which are set for the Custom Object instance. create_or_update_tag_request: description: You can create or update an existing tag. type: object @@ -14802,6 +15198,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: @@ -14823,6 +15221,24 @@ components: description: The custom attributes you have set on the custom object instance. additionalProperties: type: string + custom_object_instance_deleted: + title: Custom Object Instance Deleted + type: object + description: deleted custom object instance object + properties: + object: + type: string + description: The unique identifier of the Custom Object type that defines + the structure of the Custom Object instance. + example: Order + id: + type: string + description: The Intercom defined id representing the Custom Object instance. + example: '123' + deleted: + type: boolean + description: Whether the Custom Object instance is deleted or not. + example: true customer_request: type: object nullable: true @@ -18024,6 +18440,8 @@ tags: externalDocs: description: What is a conversation? url: https://www.intercom.com/help/en/articles/4323904-what-is-a-conversation +- name: Custom Object Instances + description: Everything about your Custom Object instances. - name: Data Attributes description: Everything about your Data Attributes - name: Data Events diff --git a/descriptions/2.10/api.intercom.io.yaml b/descriptions/2.10/api.intercom.io.yaml index d2f79e0..dbd1275 100644 --- a/descriptions/2.10/api.intercom.io.yaml +++ b/descriptions/2.10/api.intercom.io.yaml @@ -37,7 +37,7 @@ paths: Successful response: value: type: admin - id: '991268339' + id: '991270838' 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: 1704903232 + created_at: 1707238130 secure: false identity_verification: false timezone: America/Los_Angeles @@ -83,7 +83,7 @@ paths: Successful response: value: type: admin - id: '991268340' + id: '991270839' 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: 2985e31c-ecba-4ff4-9e8b-102b3e374ea0 + request_id: f9c2ad7a-4604-47a7-91b2-031550bb1934 errors: - code: admin_not_found message: Admin for admin_id not found @@ -114,7 +114,7 @@ paths: Unauthorized: value: type: error.list - request_id: d8c1c499-5cbb-4969-8b75-0803a68694a7 + request_id: d2e6c979-e663-4ef3-80c7-8aa616c71a5d errors: - code: unauthorized message: Access Token Invalid @@ -201,23 +201,10 @@ paths: per_page: 20 total_pages: 1 activity_logs: - - id: d2122adc-7f06-42d3-9b3d-5ce314f7bfd6 + - id: 712dcae6-9532-4f8d-b6fa-015b08d2c637 performed_by: type: admin - id: '991268344' - email: admin5@email.com - ip: 127.0.0.1 - metadata: - before: before - after: after - created_at: 1704903237 - activity_type: app_name_change - activity_description: Ciaran5 Lee changed your app name from - before to after. - - id: ec6c7677-ef5e-4e61-84a4-b5f568ef11f9 - performed_by: - type: admin - id: '991268344' + id: '991270843' 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: 1704903237 + created_at: 1707238135 activity_type: message_state_change activity_description: Ciaran5 Lee changed your Initial message title message from Initial message title to Eventual message title. + - id: 13869de6-6349-48d4-9481-fe30e0ca7afb + performed_by: + type: admin + id: '991270843' + email: admin5@email.com + ip: 127.0.0.1 + metadata: + before: before + after: after + created_at: 1707238135 + 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: 72a43f4e-f4e3-4b90-998c-9e7693f4807d + request_id: cb15a2c1-d517-49ae-b36e-fda90ce52757 errors: - code: unauthorized message: Access Token Invalid @@ -271,7 +271,7 @@ paths: admins: - type: admin email: admin7@email.com - id: '991268347' + id: '991270845' name: Ciaran7 Lee away_mode_enabled: false away_mode_reassign: false @@ -287,7 +287,7 @@ paths: Unauthorized: value: type: error.list - request_id: 5c1c7064-c617-4481-a2ea-55fa72b14eb9 + request_id: 5715112c-1090-44de-abcf-7f7b916f3f85 errors: - code: unauthorized message: Access Token Invalid @@ -321,7 +321,7 @@ paths: Admin found: value: type: admin - id: '991268349' + id: '991270847' 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: 2637ae2b-d683-4c7a-b3a5-af30077aef6c + request_id: 46c3963d-5bdc-4419-aefe-7f047e093211 errors: - code: admin_not_found message: Admin not found @@ -352,7 +352,7 @@ paths: Unauthorized: value: type: error.list - request_id: ce60b8b2-178d-4f8e-91ef-6fa6fe9b27b1 + request_id: 9f75d559-1fe5-49f3-89b9-57482f058606 errors: - code: unauthorized message: Access Token Invalid @@ -390,20 +390,20 @@ paths: total_pages: 1 total_count: 1 data: - - id: '86' + - id: '177' type: article workspace_id: this_is_an_id22_that_should_be_at_least_4 - parent_id: 361 + parent_id: 718 parent_type: collection parent_ids: [] title: This is the article title description: '' body: '' - author_id: 991268352 + author_id: 991270850 state: published - created_at: 1704903242 - updated_at: 1704903242 - url: http://help-center.test/myapp-22/en/articles/86-this-is-the-article-title + created_at: 1707238139 + updated_at: 1707238139 + url: http://help-center.test/myapp-22/en/articles/177-this-is-the-article-title schema: "$ref": "#/components/schemas/article_list" '401': @@ -414,7 +414,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9bdca83f-1ed9-4f97-a6b9-70e09c47e6ef + request_id: 013e1086-eb95-465b-a4ab-15352d62fbf3 errors: - code: unauthorized message: Access Token Invalid @@ -439,10 +439,10 @@ paths: examples: article created: value: - id: '89' + id: '180' type: article workspace_id: this_is_an_id26_that_should_be_at_least_4 - parent_id: 363 + parent_id: 720 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: 991268357 + author_id: 991270855 state: published - created_at: 1704903244 - updated_at: 1704903244 - url: http://help-center.test/myapp-26/en/articles/89-thanks-for-everything + created_at: 1707238141 + updated_at: 1707238141 + url: http://help-center.test/myapp-26/en/articles/180-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: f5b836c2-182c-4bd6-93b9-8dc705de964c 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: 6f78c286-1e6d-44ee-b088-fcf0d6539ea9 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: 991270855 state: published - parent_id: 363 + parent_id: 720 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: 991270855 state: published bad_request: summary: Bad Request @@ -550,10 +550,10 @@ paths: examples: Article found: value: - id: '92' + id: '183' type: article workspace_id: this_is_an_id32_that_should_be_at_least_4 - parent_id: 366 + parent_id: 723 parent_type: collection parent_ids: [] statistics: @@ -567,11 +567,11 @@ paths: title: This is the article title description: '' body: '' - author_id: 991268362 + author_id: 991270860 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: 1707238142 + updated_at: 1707238142 + url: http://help-center.test/myapp-32/en/articles/183-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: 001f3c99-b7ea-4dbc-a794-486893825c02 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: fff23696-8d4e-4df1-86b4-aa9b46322c4a errors: - code: unauthorized message: Access Token Invalid @@ -629,10 +629,10 @@ paths: examples: successful: value: - id: '95' + id: '186' type: article workspace_id: this_is_an_id38_that_should_be_at_least_4 - parent_id: 369 + parent_id: 726 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: 991270866 state: published - created_at: 1704903247 - updated_at: 1704903248 - url: http://help-center.test/myapp-38/en/articles/95-christmas-is-here + created_at: 1707238144 + updated_at: 1707238145 + url: http://help-center.test/myapp-38/en/articles/186-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: 68ba4a92-8195-45f9-99dd-a54bc97fd2d1 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: 9b6538a7-7000-431a-b86d-4f0db74413f5 errors: - code: unauthorized message: Access Token Invalid @@ -723,7 +723,7 @@ paths: examples: successful: value: - id: '98' + id: '189' object: article deleted: true schema: @@ -736,7 +736,7 @@ paths: Article Not Found: value: type: error.list - request_id: 27c6a6c0-c465-4192-b4a9-19d0755ab935 + request_id: b45d1a65-8f23-4cc0-9339-9f635beea6d3 errors: - code: not_found message: Resource Not Found @@ -750,7 +750,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8ad0c08a-9266-4258-9030-662fc6b73a94 + request_id: 1fcb4b9c-2f38-4b76-bd41-d3c365c2d151 errors: - code: unauthorized message: Access Token Invalid @@ -810,7 +810,7 @@ paths: total_count: 1 data: articles: - - id: '102' + - id: '193' type: article workspace_id: this_is_an_id50_that_should_be_at_least_4 parent_id: @@ -819,10 +819,10 @@ paths: title: Title 1 description: '' body: '' - author_id: 991268381 + author_id: 991270879 state: draft - created_at: 1704903252 - updated_at: 1704903252 + created_at: 1707238148 + updated_at: 1707238148 url: highlights: [] pages: @@ -840,7 +840,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0303ba58-8efd-4b20-8a13-8e13327b567d + request_id: c59a53ed-9add-449e-bc1d-ad48a9b0258e errors: - code: unauthorized message: Access Token Invalid @@ -873,27 +873,27 @@ paths: value: type: list data: - - id: '377' + - id: '734' 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: 1707238149 + updated_at: 1707238149 description: english collection description icon: bookmark parent_id: - help_center_id: 197 - - id: '378' + help_center_id: 362 + - id: '735' 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: 1707238149 + updated_at: 1707238149 description: icon: bookmark - parent_id: '377' + parent_id: '734' help_center_id: total_count: 2 pages: @@ -911,7 +911,7 @@ paths: Unauthorized: value: type: error.list - request_id: abae41c0-058f-4fef-a23f-fee2071f83da + request_id: 17e1cad4-3275-4dfc-8900-45f82a4731b6 errors: - code: unauthorized message: Access Token Invalid @@ -936,17 +936,17 @@ paths: examples: collection created: value: - id: '383' + id: '740' 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: 1707238150 + updated_at: 1707238150 description: '' icon: book-bookmark parent_id: - help_center_id: 199 + help_center_id: 364 schema: "$ref": "#/components/schemas/collection" '400': @@ -957,7 +957,7 @@ paths: Bad Request: value: type: error.list - request_id: eb5a4902-d00c-4e18-8b96-171aaf42ce42 + request_id: 69bd7a09-29e6-4d25-8123-4598955ee3c3 errors: - code: parameter_not_found message: Name is a required parameter. @@ -971,7 +971,7 @@ paths: Unauthorized: value: type: error.list - request_id: 3835be26-a15c-4e2e-937c-8808c5c675c4 + request_id: 251b89f0-0dbd-496d-8a4e-d34c3c5d5dd0 errors: - code: unauthorized message: Access Token Invalid @@ -1019,17 +1019,17 @@ paths: examples: Collection found: value: - id: '388' + id: '745' 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: 1707238151 + updated_at: 1707238151 description: english collection description icon: bookmark parent_id: - help_center_id: 202 + help_center_id: 367 schema: "$ref": "#/components/schemas/collection" '404': @@ -1040,7 +1040,7 @@ paths: Collection not found: value: type: error.list - request_id: d8a24da6-931f-49b4-849f-7c27d9548b3a + request_id: 1f8b86a8-d719-46be-a3dd-9ce3c3bc80d9 errors: - code: not_found message: Resource Not Found @@ -1054,7 +1054,7 @@ paths: Unauthorized: value: type: error.list - request_id: bc4222fe-422e-43a1-bcd4-880916f39c04 + request_id: 886db830-7ca0-4383-94f6-c37cc2ef4c1a errors: - code: unauthorized message: Access Token Invalid @@ -1087,17 +1087,17 @@ paths: examples: successful: value: - id: '394' + id: '751' 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: 1707238153 + updated_at: 1707238153 description: english collection description icon: folder parent_id: - help_center_id: 205 + help_center_id: 370 schema: "$ref": "#/components/schemas/collection" '404': @@ -1108,7 +1108,7 @@ paths: Collection Not Found: value: type: error.list - request_id: cdd6744a-dea1-4748-9887-b187d7c9a122 + request_id: 9991d9cf-9d2b-4517-a24b-4a146739aa3c errors: - code: not_found message: Resource Not Found @@ -1122,7 +1122,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2a97e317-df3a-4084-a071-a6f5b886f6c9 + request_id: 75bfa96e-837e-455c-a75c-ee641a10d0ff errors: - code: unauthorized message: Access Token Invalid @@ -1169,7 +1169,7 @@ paths: examples: successful: value: - id: '400' + id: '757' object: collection deleted: true schema: @@ -1182,7 +1182,7 @@ paths: collection Not Found: value: type: error.list - request_id: 0fc946dd-765d-4031-96d3-0a6cc5c0dfbd + request_id: d565733e-0f48-40af-b957-1fd1f5f8bd3b errors: - code: not_found message: Resource Not Found @@ -1196,7 +1196,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0b8bf7e3-c13e-4c02-8229-b1b2a32674f9 + request_id: 522cb6d6-4ebd-4193-99f9-fef9e785d552 errors: - code: unauthorized message: Access Token Invalid @@ -1230,10 +1230,10 @@ paths: examples: Collection found: value: - id: '211' + id: '376' workspace_id: this_is_an_id82_that_should_be_at_least_4 - created_at: 1704903259 - updated_at: 1704903259 + created_at: 1707238155 + updated_at: 1707238155 identifier: help-center-1 website_turned_on: false display_name: Intercom Help Center @@ -1247,7 +1247,7 @@ paths: Collection not found: value: type: error.list - request_id: ff346d6f-dd0c-4487-af63-f23d8162fe8d + request_id: e5414a8f-2240-4aa1-bc44-3570d69e37cd errors: - code: not_found message: Resource Not Found @@ -1261,7 +1261,7 @@ paths: Unauthorized: value: type: error.list - request_id: e12272c6-f4ca-44a7-a384-72120d58a7c8 + request_id: 2f633056-5789-4d1b-a32b-0238f4f023a9 errors: - code: unauthorized message: Access Token Invalid @@ -1299,7 +1299,7 @@ paths: Unauthorized: value: type: error.list - request_id: bb022ad5-cc3c-4017-9a3d-140250067e2e + request_id: 1134aa68-0e5d-4e20-b03b-7b6a605f057f errors: - code: unauthorized message: Access Token Invalid @@ -1332,12 +1332,12 @@ paths: value: type: company company_id: company_remote_id - id: 659ec2626abd01535c223397 - app_id: this_is_an_id108_that_should_be_at_least_ + id: 65c2630f86ce64a98769c13c + 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: 1707238159 + updated_at: 1707238159 monthly_spend: 0 session_count: 0 user_count: 0 @@ -1374,7 +1374,7 @@ paths: Unauthorized: value: type: error.list - request_id: bbac2bcf-ae91-4c6e-b422-ca60764aa997 + request_id: 2599fe3f-69d9-4c75-b06e-945673c13571 errors: - code: unauthorized message: Access Token Invalid @@ -1448,11 +1448,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 +1472,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: 65c2631186ce64a98769c144 + 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: 1707238161 + created_at: 1707238161 + updated_at: 1707238161 monthly_spend: 0 session_count: 0 user_count: 4 @@ -1499,7 +1506,7 @@ paths: Company Not Found: value: type: error.list - request_id: bcb25d3f-6d23-4f1c-bca3-8ec54cbcfb44 + request_id: 45ec428e-249f-443d-9420-f8b46a4ab900 errors: - code: company_not_found message: Company Not Found @@ -1513,7 +1520,7 @@ paths: Unauthorized: value: type: error.list - request_id: 48bc459e-b604-44f7-a1eb-5782f39af72a + request_id: 5f5d72c6-56d1-47d2-90f4-c8aab8a090b6 errors: - code: unauthorized message: Access Token Invalid @@ -1548,12 +1555,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: 65c2631386ce64a98769c14f + app_id: this_is_an_id117_that_should_be_at_least_ + name: company1 + remote_created_at: 1707238163 + created_at: 1707238163 + updated_at: 1707238163 monthly_spend: 0 session_count: 0 user_count: 1 @@ -1575,7 +1582,7 @@ paths: Company Not Found: value: type: error.list - request_id: 781d833a-dc97-4383-9fad-b9a1f401a2dd + request_id: d55d031e-1688-4160-b613-74e13744aa46 errors: - code: company_not_found message: Company Not Found @@ -1589,7 +1596,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0fd82661-dbb1-4355-8df2-4e8a21d4a5c4 + request_id: c1d8a630-d277-417a-8a1c-07cc113c7e3d errors: - code: unauthorized message: Access Token Invalid @@ -1623,12 +1630,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: 65c2631586ce64a98769c159 + app_id: this_is_an_id123_that_should_be_at_least_ + name: company2 + remote_created_at: 1707238165 + created_at: 1707238165 + updated_at: 1707238165 monthly_spend: 0 session_count: 0 user_count: 1 @@ -1650,7 +1657,7 @@ paths: Company Not Found: value: type: error.list - request_id: 2cc82fa2-e8e8-41d3-a95e-3dd83ae50a96 + request_id: 3e6695f7-66e3-43d5-aff3-8da57b945eb1 errors: - code: company_not_found message: Company Not Found @@ -1664,7 +1671,7 @@ paths: Unauthorized: value: type: error.list - request_id: c9d241f5-e7e6-494b-ad3f-ad8cc98f6ced + request_id: 5a265ec2-1202-4f12-9e99-83fcdd525b6e errors: - code: unauthorized message: Access Token Invalid @@ -1696,7 +1703,7 @@ paths: examples: Successful: value: - id: 659ec2696abd01535c2233be + id: 65c2631786ce64a98769c163 object: company deleted: true schema: @@ -1709,7 +1716,7 @@ paths: Company Not Found: value: type: error.list - request_id: 403d0fc0-b4d6-4d6c-a3a3-9ae0092a299c + request_id: 7b1da66f-88ce-400d-b936-021df2d0c27c errors: - code: company_not_found message: Company Not Found @@ -1723,7 +1730,7 @@ paths: Unauthorized: value: type: error.list - request_id: '081daf1e-35c8-48e1-a115-39c41a5b2f60' + request_id: ccc7fd05-f826-4163-853c-1e010c87660c errors: - code: unauthorized message: Access Token Invalid @@ -1775,7 +1782,7 @@ paths: Company Not Found: value: type: error.list - request_id: a2181e32-c23c-4bc1-802e-1aa11c3029c1 + request_id: c6da453c-d38c-4f19-84ae-5fa71678cb71 errors: - code: company_not_found message: Company Not Found @@ -1789,7 +1796,7 @@ paths: Unauthorized: value: type: error.list - request_id: a80ee688-d6c6-4a75-a54e-c649362c7b2e + request_id: 46455f27-51cb-4373-b211-1220f919d465 errors: - code: unauthorized message: Access Token Invalid @@ -1834,7 +1841,7 @@ paths: Company Not Found: value: type: error.list - request_id: 4b5f141e-611f-4692-a894-d98e471e7e14 + request_id: 27b36e8f-c8ab-4bb7-8255-2db83ce3e8fd errors: - code: company_not_found message: Company Not Found @@ -1848,7 +1855,7 @@ paths: Unauthorized: value: type: error.list - request_id: ff221dd8-260e-4fdc-a591-7cb18e962d0f + request_id: 01010dc5-62b1-4140-a824-4d998011b77d errors: - code: unauthorized message: Access Token Invalid @@ -1905,12 +1912,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: 65c2631d86ce64a98769c17f + 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: 1707238173 + created_at: 1707238173 + updated_at: 1707238173 monthly_spend: 0 session_count: 0 user_count: 4 @@ -1939,7 +1946,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9a490717-286b-4f44-b1af-e0aaeb4da490 + request_id: f495857f-2778-4b5c-879d-a4479c00e727 errors: - code: unauthorized message: Access Token Invalid @@ -1991,12 +1998,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: 65c2631e86ce64a98769c185 + 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: 1707238174 + created_at: 1707238174 + updated_at: 1707238174 monthly_spend: 0 session_count: 0 user_count: 4 @@ -2010,7 +2017,7 @@ paths: custom_attributes: {} pages: total_count: - scroll_param: '02159f3c-62ba-4ff0-ba90-262b55646105' + scroll_param: b6d1f9cc-b05d-4433-a1e5-335139a8df7d schema: "$ref": "#/components/schemas/company_scroll" '401': @@ -2021,7 +2028,7 @@ paths: Unauthorized: value: type: error.list - request_id: 76ba48d6-9a42-4592-9d22-12b0abd64bb6 + request_id: da0e7f00-37a0-4e41-bc43-9ef9822da08a errors: - code: unauthorized message: Access Token Invalid @@ -2056,12 +2063,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: 65c2632086ce64a98769c18e + app_id: this_is_an_id155_that_should_be_at_least_ + name: company6 + remote_created_at: 1707238176 + created_at: 1707238176 + updated_at: 1707238176 monthly_spend: 0 session_count: 0 user_count: 1 @@ -2075,6 +2082,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: cdff035b-9d4c-459c-ba0e-ad308d217ff6 + errors: + - code: parameter_not_found + message: company not specified + schema: + "$ref": "#/components/schemas/error" '404': description: Company Not Found content: @@ -2083,10 +2104,10 @@ paths: Company Not Found: value: type: error.list - request_id: aa134a2c-cec5-4feb-a928-c0c7f709aa3f + request_id: ff12f21a-fa4e-402a-bcb1-5aeb98ddc187 errors: - - code: not_found - message: User Not Found + - code: company_not_found + message: Company Not Found schema: "$ref": "#/components/schemas/error" '401': @@ -2097,7 +2118,7 @@ paths: Unauthorized: value: type: error.list - request_id: dbd868e0-c8cc-4e65-8eb2-cad1c1dfafe6 + request_id: 4e1a6dfc-0070-47fe-a1e9-b59170f239d7 errors: - code: unauthorized message: Access Token Invalid @@ -2120,11 +2141,14 @@ paths: successful: summary: Successful value: - id: 659ec2716abd01535c2233e9 + id: 65c2632086ce64a98769c18e + 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 +2180,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: 65c2632686ce64a98769c1af + app_id: this_is_an_id171_that_should_be_at_least_ + name: company12 + remote_created_at: 1707238182 + created_at: 1707238182 + updated_at: 1707238182 + last_request_at: 1707065382 monthly_spend: 0 session_count: 0 user_count: 1 @@ -2191,7 +2215,7 @@ paths: Contact not found: value: type: error.list - request_id: 02301cef-4670-4aab-b947-f4b7bc94cc01 + request_id: 0f6392f3-354b-46f8-8109-711b5330b0ad errors: - code: not_found message: User Not Found @@ -2205,7 +2229,7 @@ paths: Unauthorized: value: type: error.list - request_id: 176db92d-d226-4df7-b5f5-57ec2f966881 + request_id: 53ad8099-45a6-4d28-aab8-95e5d5b0010b errors: - code: unauthorized message: Access Token Invalid @@ -2248,12 +2272,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: 65c2632386ce64a98769c19e + app_id: this_is_an_id163_that_should_be_at_least_ + name: company8 + remote_created_at: 1707238179 + created_at: 1707238179 + updated_at: 1707238179 monthly_spend: 0 session_count: 0 user_count: 0 @@ -2275,14 +2299,14 @@ paths: Company Not Found: value: type: error.list - request_id: 860ae6db-c1d7-470c-bef9-e360bfa50fcb + request_id: 1da96206-416f-4195-a005-324dd6503883 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: ada64404-b7a8-44cf-a486-5b10533c4152 errors: - code: not_found message: User Not Found @@ -2296,7 +2320,7 @@ paths: Unauthorized: value: type: error.list - request_id: e77699d5-540c-43a8-9f25-67c050d34d08 + request_id: 572fc47b-19f0-4dcd-a197-4eee3dee3e68 errors: - code: unauthorized message: Access Token Invalid @@ -2332,44 +2356,44 @@ paths: type: list data: - type: note - id: '105' - created_at: 1704298494 + id: '127' + created_at: 1706633384 contact: type: contact - id: 659ec27e6abd01535c223426 + id: 65c2632886ce64a98769c1ba author: type: admin - id: '991268440' - name: Ciaran100 Lee - email: admin100@email.com + id: '991270939' + 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: '126' + created_at: 1706546984 contact: type: contact - id: 659ec27e6abd01535c223426 + id: 65c2632886ce64a98769c1ba author: type: admin - id: '991268440' - name: Ciaran100 Lee - email: admin100@email.com + id: '991270939' + 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: '125' + created_at: 1706546984 contact: type: contact - id: 659ec27e6abd01535c223426 + id: 65c2632886ce64a98769c1ba author: type: admin - id: '991268440' - name: Ciaran100 Lee - email: admin100@email.com + id: '991270939' + name: Ciaran101 Lee + email: admin101@email.com away_mode_enabled: false away_mode_reassign: false body: "

    This is a note.

    " @@ -2390,7 +2414,7 @@ paths: Contact not found: value: type: error.list - request_id: 462de140-4170-4690-9ceb-b448657fc3b4 + request_id: 7f30192c-44aa-4eed-b9cf-d335de85b4b1 errors: - code: not_found message: User Not Found @@ -2424,16 +2448,16 @@ paths: Successful response: value: type: note - id: '110' - created_at: 1704903295 + id: '132' + created_at: 1707238185 contact: type: contact - id: 659ec27f6abd01535c223428 + id: 65c2632986ce64a98769c1bc author: type: admin - id: '991268442' - name: Ciaran102 Lee - email: admin102@email.com + id: '991270941' + name: Ciaran103 Lee + email: admin103@email.com away_mode_enabled: false away_mode_reassign: false body: "

    Hello

    " @@ -2447,14 +2471,14 @@ paths: Admin not found: value: type: error.list - request_id: 375eab82-fbb9-4f8e-87c1-8c374ea821a7 + request_id: 7607a16a-cfe5-4510-bf83-409e0902a9e1 errors: - code: not_found message: Resource Not Found Contact not found: value: type: error.list - request_id: 15e88398-1e6f-4dc2-8147-42aa3eccad0c + request_id: '069b258e-7cc2-49d6-9f9d-9db17671deaf' errors: - code: not_found message: User Not Found @@ -2484,20 +2508,20 @@ paths: successful_response: summary: Successful response value: - contact_id: 659ec27f6abd01535c223428 - admin_id: 991268442 + contact_id: 65c2632986ce64a98769c1bc + admin_id: 991270941 body: Hello admin_not_found: summary: Admin not found value: - contact_id: 659ec27f6abd01535c223429 + contact_id: 65c2632986ce64a98769c1bd admin_id: 123 body: Hello contact_not_found: summary: Contact not found value: contact_id: 123 - admin_id: 991268444 + admin_id: 991270943 body: Hello "/contacts/{contact_id}/segments": get: @@ -2530,10 +2554,10 @@ paths: type: list data: - type: segment - id: 659ec2806abd01535c22342b + id: 65c2632a86ce64a98769c1bf name: segment - created_at: 1704903296 - updated_at: 1704903296 + created_at: 1707238186 + updated_at: 1707238186 person_type: user schema: "$ref": "#/components/schemas/contact_segments" @@ -2545,7 +2569,7 @@ paths: Contact not found: value: type: error.list - request_id: f109d9a4-5a3b-450e-8468-df8637ecbd33 + request_id: 0ce00900-3899-4225-b4df-6d62c7ff4556 errors: - code: not_found message: User Not Found @@ -2559,7 +2583,7 @@ paths: Unauthorized: value: type: error.list - request_id: 23d000a3-af84-4653-97a7-c8b75b64f1b8 + request_id: 889e5a6b-25d0-4b1c-b1a4-df16def6ddc4 errors: - code: unauthorized message: Access Token Invalid @@ -2603,7 +2627,7 @@ paths: type: list data: - type: subscription - id: '228' + id: '457' state: live consent_type: opt_out default_translation: @@ -2617,7 +2641,7 @@ paths: content_types: - email - type: subscription - id: '230' + id: '459' state: live consent_type: opt_in default_translation: @@ -2640,7 +2664,7 @@ paths: Contact not found: value: type: error.list - request_id: 3b4ba6a0-f069-4d23-95e6-e7db35d44da2 + request_id: 546ffdfa-5b5b-4450-95c3-ef0542d9c048 errors: - code: not_found message: User Not Found @@ -2654,7 +2678,7 @@ paths: Unauthorized: value: type: error.list - request_id: a5553160-35a0-4f7e-9412-811f82932a51 + request_id: 4b9c422c-c6cf-485b-9f3d-9c7b270cfedb errors: - code: unauthorized message: Access Token Invalid @@ -2695,7 +2719,7 @@ paths: Successful: value: type: subscription - id: '243' + id: '472' state: live consent_type: opt_in default_translation: @@ -2718,14 +2742,14 @@ paths: Contact not found: value: type: error.list - request_id: 45c29992-62fd-4e33-8012-abf944f52a65 + request_id: f3b4f3af-3d03-4148-abb4-25c8b9d3cf3b errors: - code: not_found message: User Not Found Resource not found: value: type: error.list - request_id: b7b91cef-a49a-4425-a4f1-f381fc69a7d7 + request_id: '0591a429-c89c-49af-a413-2dbd1b324cd9' errors: - code: not_found message: Resource Not Found @@ -2739,7 +2763,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0ee2a3c4-cce9-4cc7-89a7-4e47b390d40c + request_id: 23e96e82-96ed-4e78-a013-df8b35db52fd errors: - code: unauthorized message: Access Token Invalid @@ -2767,12 +2791,12 @@ paths: successful: summary: Successful value: - id: 243 + id: 472 consent_type: opt_in contact_not_found: summary: Contact not found value: - id: 247 + id: 476 consent_type: opt_in resource_not_found: summary: Resource not found @@ -2818,7 +2842,7 @@ paths: Successful: value: type: subscription - id: '259' + id: '488' state: live consent_type: opt_in default_translation: @@ -2841,14 +2865,14 @@ paths: Contact not found: value: type: error.list - request_id: 53a44217-e27b-406b-a272-4022fb77ee72 + request_id: a1c307e8-c0a9-43ca-9a42-d2c40af48cb7 errors: - code: not_found message: User Not Found Resource not found: value: type: error.list - request_id: 4116ec1d-928f-4dcd-ab65-20e2725c3884 + request_id: d8691d3d-c47a-4e74-b7a3-6cab454486c4 errors: - code: not_found message: Resource Not Found @@ -2862,7 +2886,7 @@ paths: Unauthorized: value: type: error.list - request_id: d98b20d7-93d9-4bd4-8b08-7f163be5f0e7 + request_id: 55b1d17b-db9c-4d1f-b386-8e96c4842fb1 errors: - code: unauthorized message: Access Token Invalid @@ -2900,7 +2924,7 @@ paths: type: list data: - type: tag - id: '203' + id: '369' name: Manual tag schema: "$ref": "#/components/schemas/tag_list" @@ -2912,7 +2936,7 @@ paths: Contact not found: value: type: error.list - request_id: 43998ba7-8f64-4a3d-9c45-fca5a3b45b1a + request_id: 5cffd79e-db0f-4e5e-b3de-bc7f0eca1615 errors: - code: not_found message: User Not Found @@ -2926,7 +2950,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8012ba75-70fc-495f-8b82-669550d78bcb + request_id: 336ef272-6401-4274-873a-9ff29beb3055 errors: - code: unauthorized message: Access Token Invalid @@ -2961,7 +2985,7 @@ paths: successful: value: type: tag - id: '204' + id: '370' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -2973,14 +2997,14 @@ paths: Contact not found: value: type: error.list - request_id: 77e387ed-617c-40bb-b8cc-387e0be8d3ad + request_id: 432dc38d-9c50-4b7a-ac97-b88d3a4dda20 errors: - code: not_found message: User Not Found Tag not found: value: type: error.list - request_id: d5321068-cbb7-4430-81dc-4e5a209cb9b8 + request_id: 3a3c8ab7-5ef1-4d0e-8d50-daa7bea6ff1f errors: - code: not_found message: Resource Not Found @@ -2994,7 +3018,7 @@ paths: Unauthorized: value: type: error.list - request_id: 41f6cb46-715d-4ccb-8a9b-446631a05ba9 + request_id: 2cc3f21f-7876-431e-b419-0d8a0dc983b3 errors: - code: unauthorized message: Access Token Invalid @@ -3017,11 +3041,11 @@ paths: successful: summary: successful value: - id: 204 + id: 370 contact_not_found: summary: Contact not found value: - id: 205 + id: 371 tag_not_found: summary: Tag not found value: @@ -3063,7 +3087,7 @@ paths: successful: value: type: tag - id: '207' + id: '373' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -3075,14 +3099,14 @@ paths: Contact not found: value: type: error.list - request_id: c2adb115-9491-431b-9e2e-2c898e9f48bd + request_id: a04b3409-35fe-4bd3-9e3a-94475ddb644b errors: - code: not_found message: User Not Found Tag not found: value: type: error.list - request_id: '09efd627-9856-4ae5-9cec-823b7e3a9295' + request_id: c2290d8d-5f46-4c87-b63f-71850a0a43ca errors: - code: not_found message: Resource Not Found @@ -3096,7 +3120,7 @@ paths: Unauthorized: value: type: error.list - request_id: 183e227a-2c78-406d-902c-8829ce44797a + request_id: ec9e5e9b-42aa-45f6-a1c3-7c673de446ed errors: - code: unauthorized message: Access Token Invalid @@ -3130,8 +3154,8 @@ paths: successful: value: type: contact - id: 659ec28c6abd01535c223442 - workspace_id: this_is_an_id238_that_should_be_at_least_ + id: 65c2633686ce64a98769c1d6 + workspace_id: this_is_an_id237_that_should_be_at_least_ external_id: '70' role: user email: joebloggs@intercom.io @@ -3145,9 +3169,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: 1707238198 + updated_at: 1707238198 + signed_up_at: 1707238198 last_seen_at: last_replied_at: last_contacted_at: @@ -3181,31 +3205,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ec28c6abd01535c223442/tags" + url: "/contacts/65c2633686ce64a98769c1d6/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ec28c6abd01535c223442/notes" + url: "/contacts/65c2633686ce64a98769c1d6/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ec28c6abd01535c223442/companies" + url: "/contacts/65c2633686ce64a98769c1d6/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ec28c6abd01535c223442/subscriptions" + url: "/contacts/65c2633686ce64a98769c1d6/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ec28c6abd01535c223442/subscriptions" + url: "/contacts/65c2633686ce64a98769c1d6/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3224,7 +3248,7 @@ paths: Unauthorized: value: type: error.list - request_id: 6565a155-6293-4a50-81bb-b0e4a5e51b0d + request_id: b5eac24f-afc7-4b5b-b756-4572b172e452 errors: - code: unauthorized message: Access Token Invalid @@ -3269,8 +3293,8 @@ paths: successful: value: type: contact - id: 659ec28d6abd01535c223443 - workspace_id: this_is_an_id242_that_should_be_at_least_ + id: 65c2633786ce64a98769c1d7 + workspace_id: this_is_an_id241_that_should_be_at_least_ external_id: '70' role: user email: joe@bloggs.com @@ -3284,9 +3308,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: 1707238199 + updated_at: 1707238199 + signed_up_at: 1707238199 last_seen_at: last_replied_at: last_contacted_at: @@ -3320,31 +3344,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ec28d6abd01535c223443/tags" + url: "/contacts/65c2633786ce64a98769c1d7/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ec28d6abd01535c223443/notes" + url: "/contacts/65c2633786ce64a98769c1d7/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ec28d6abd01535c223443/companies" + url: "/contacts/65c2633786ce64a98769c1d7/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ec28d6abd01535c223443/subscriptions" + url: "/contacts/65c2633786ce64a98769c1d7/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ec28d6abd01535c223443/subscriptions" + url: "/contacts/65c2633786ce64a98769c1d7/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3363,7 +3387,7 @@ paths: Unauthorized: value: type: error.list - request_id: 5ca99505-6ef2-4f1c-a7ef-680b96283563 + request_id: e3c3fa2e-68c6-47a2-9b6a-0822c6773354 errors: - code: unauthorized message: Access Token Invalid @@ -3394,7 +3418,7 @@ paths: examples: successful: value: - id: 659ec28e6abd01535c223444 + id: 65c2633886ce64a98769c1d8 external_id: '70' type: contact deleted: true @@ -3408,7 +3432,7 @@ paths: Unauthorized: value: type: error.list - request_id: eced1b53-7afe-420b-8890-03bb5df0ddfa + request_id: a2f6fe6d-2fa4-4ec1-9b15-ebc82ac01498 errors: - code: unauthorized message: Access Token Invalid @@ -3436,8 +3460,8 @@ paths: successful: value: type: contact - id: 659ec28f6abd01535c223446 - workspace_id: this_is_an_id250_that_should_be_at_least_ + id: 65c2633986ce64a98769c1da + workspace_id: this_is_an_id249_that_should_be_at_least_ external_id: '70' role: user email: joe@bloggs.com @@ -3451,9 +3475,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: 1707238201 + updated_at: 1707238201 + signed_up_at: 1707238201 last_seen_at: last_replied_at: last_contacted_at: @@ -3487,31 +3511,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ec28f6abd01535c223446/tags" + url: "/contacts/65c2633986ce64a98769c1da/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ec28f6abd01535c223446/notes" + url: "/contacts/65c2633986ce64a98769c1da/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ec28f6abd01535c223446/companies" + url: "/contacts/65c2633986ce64a98769c1da/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ec28f6abd01535c223446/subscriptions" + url: "/contacts/65c2633986ce64a98769c1da/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ec28f6abd01535c223446/subscriptions" + url: "/contacts/65c2633986ce64a98769c1da/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3530,7 +3554,7 @@ paths: Unauthorized: value: type: error.list - request_id: 4b39d38a-6dd3-4345-9782-494494a7e96f + request_id: d56ceefa-b8f7-41ff-b2b8-19e3eb655bd8 errors: - code: unauthorized message: Access Token Invalid @@ -3545,8 +3569,8 @@ paths: successful: summary: successful value: - from: 659ec28f6abd01535c223445 - into: 659ec28f6abd01535c223446 + from: 65c2633986ce64a98769c1d9 + into: 65c2633986ce64a98769c1da "/contacts/search": post: summary: Search contacts @@ -3655,7 +3679,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8284a16c-69f7-4569-9b3b-2ae057b011e7 + request_id: 776f3e19-bdb7-4859-8f96-4b0fad146a07 errors: - code: unauthorized message: Access Token Invalid @@ -3675,15 +3699,15 @@ paths: value: - field: id operator: "=" - value: 659ec2916abd01535c223449 + value: 65c2633a86ce64a98769c1dd - operator: OR value: - field: id operator: "=" - value: 659ec2916abd01535c223449 + value: 65c2633a86ce64a98769c1dd - field: id operator: "=" - value: 659ec2916abd01535c223449 + value: 65c2633a86ce64a98769c1dd "/contacts": get: summary: List all contacts @@ -3722,7 +3746,7 @@ paths: Unauthorized: value: type: error.list - request_id: 6b2d4d86-b8c0-4560-9c2f-8b3397f79b88 + request_id: d737e9c8-1f86-4418-987c-5f7a02fe69c1 errors: - code: unauthorized message: Access Token Invalid @@ -3748,8 +3772,8 @@ paths: successful: value: type: contact - id: 659ec2936abd01535c22344b - workspace_id: this_is_an_id262_that_should_be_at_least_ + id: 65c2633c86ce64a98769c1df + workspace_id: this_is_an_id261_that_should_be_at_least_ external_id: role: user email: joebloggs@intercom.io @@ -3763,8 +3787,8 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1704903315 - updated_at: 1704903315 + created_at: 1707238204 + updated_at: 1707238204 signed_up_at: last_seen_at: last_replied_at: @@ -3799,31 +3823,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ec2936abd01535c22344b/tags" + url: "/contacts/65c2633c86ce64a98769c1df/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ec2936abd01535c22344b/notes" + url: "/contacts/65c2633c86ce64a98769c1df/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ec2936abd01535c22344b/companies" + url: "/contacts/65c2633c86ce64a98769c1df/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ec2936abd01535c22344b/subscriptions" + url: "/contacts/65c2633c86ce64a98769c1df/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ec2936abd01535c22344b/subscriptions" + url: "/contacts/65c2633c86ce64a98769c1df/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3842,7 +3866,7 @@ paths: Unauthorized: value: type: error.list - request_id: 18c64adc-55f2-4c8f-924d-8ffd50b499ce + request_id: e7133276-f88f-49f2-8c26-db4d569e0a22 errors: - code: unauthorized message: Access Token Invalid @@ -3886,7 +3910,7 @@ paths: examples: successful: value: - id: 659ec2946abd01535c22344c + id: 65c2633d86ce64a98769c1e0 external_id: '70' type: contact archived: true @@ -3919,7 +3943,7 @@ paths: examples: successful: value: - id: 659ec2946abd01535c22344d + id: 65c2633e86ce64a98769c1e1 external_id: '70' type: contact archived: false @@ -3955,7 +3979,7 @@ paths: successful: value: type: tag - id: '209' + id: '375' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -3967,7 +3991,7 @@ paths: Conversation not found: value: type: error.list - request_id: 1fed5cdf-b288-4ee9-badb-003e9c67446d + request_id: 919cc9eb-9b9e-42a9-b8e0-97332f0976cc errors: - code: not_found message: Conversation not found @@ -3981,7 +4005,7 @@ paths: Unauthorized: value: type: error.list - request_id: '0693bb9a-a244-43bf-9e4d-d07659179594' + request_id: 7f90c539-6a61-4ad4-94d4-4c64b6d9bcbe errors: - code: unauthorized message: Access Token Invalid @@ -4010,13 +4034,13 @@ paths: successful: summary: successful value: - id: 209 - admin_id: 991268475 + id: 375 + admin_id: 991270974 conversation_not_found: summary: Conversation not found value: - id: 210 - admin_id: 991268477 + id: 376 + admin_id: 991270976 "/conversations/{conversation_id}/tags/{id}": delete: summary: Remove tag from a conversation @@ -4054,7 +4078,7 @@ paths: successful: value: type: tag - id: '212' + id: '378' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -4066,14 +4090,14 @@ paths: Conversation not found: value: type: error.list - request_id: cce7e672-8851-41bd-a161-570715e9b0ae + request_id: 7d9add92-83d6-4e02-912b-fd969c519326 errors: - code: not_found message: Conversation not found Tag not found: value: type: error.list - request_id: f16c4a33-fc24-41d0-bb5f-8d8032851838 + request_id: 83f88cb1-504c-4788-8696-c5a9069c13df errors: - code: tag_not_found message: Tag not found @@ -4087,7 +4111,7 @@ paths: Unauthorized: value: type: error.list - request_id: fe95bf69-b6d8-43a2-90b2-0cc7586987de + request_id: e5d945c8-71dc-411e-9651-a76a1e33c1e3 errors: - code: unauthorized message: Access Token Invalid @@ -4110,15 +4134,15 @@ paths: successful: summary: successful value: - admin_id: 991268479 + admin_id: 991270978 conversation_not_found: summary: Conversation not found value: - admin_id: 991268481 + admin_id: 991270980 tag_not_found: summary: Tag not found value: - admin_id: 991268482 + admin_id: 991270981 "/conversations": get: summary: List all conversations @@ -4165,22 +4189,22 @@ paths: total_count: 1 conversations: - type: conversation - id: '655' - created_at: 1704903323 - updated_at: 1704903323 + id: '1257' + created_at: 1707238213 + updated_at: 1707238213 waiting_since: snoozed_until: source: type: conversation - id: '403918451' + id: '403918799' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991268485' - name: Ciaran142 Lee - email: admin142@email.com + id: '991270984' + name: Ciaran143 Lee + email: admin143@email.com attachments: [] url: redacted: false @@ -4188,7 +4212,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ec29b6abd01535c223451 + id: 65c2634586ce64a98769c1e5 external_id: '70' first_contact_reply: admin_assignee_id: @@ -4223,7 +4247,7 @@ paths: Unauthorized: value: type: error.list - request_id: e1e550f4-f404-4cab-893d-5a46bba0c182 + request_id: 37eaa092-0de2-42ed-abe1-50d79640246c errors: - code: unauthorized message: Access Token Invalid @@ -4237,7 +4261,7 @@ paths: API plan restricted: value: type: error.list - request_id: 6e3ceddc-6c8c-42a2-91fd-bb0957423fb0 + request_id: cfca346f-3825-46b1-8775-110a4f2b65b3 errors: - code: api_plan_restricted message: Active subscription needed. @@ -4269,11 +4293,11 @@ paths: conversation created: value: type: user_message - id: '403918461' - created_at: 1704903343 + id: '403918809' + created_at: 1707238240 body: Hello there message_type: inapp - conversation_id: '680' + conversation_id: '1282' schema: "$ref": "#/components/schemas/message" '404': @@ -4284,7 +4308,7 @@ paths: Contact Not Found: value: type: error.list - request_id: f56767f6-6a7f-43bb-85d0-37cf6f382d18 + request_id: 0cba65e2-6967-4b00-b8e7-62966294dbfc errors: - code: not_found message: User Not Found @@ -4298,7 +4322,7 @@ paths: Unauthorized: value: type: error.list - request_id: e772d977-8f65-46a0-8591-662dff1c30c9 + request_id: 514a1f71-417e-4f7a-bbc1-b8147d872b62 errors: - code: unauthorized message: Access Token Invalid @@ -4312,7 +4336,7 @@ paths: API plan restricted: value: type: error.list - request_id: dbe651af-de24-4653-a70b-fb3db55e65a2 + request_id: 108a13e5-7ce0-402d-8611-ad2fd7459927 errors: - code: api_plan_restricted message: Active subscription needed. @@ -4329,7 +4353,7 @@ paths: value: from: type: user - id: 659ec2ae6abd01535c223466 + id: 65c2635f86ce64a98769c1fa body: Hello there contact_not_found: summary: Contact Not Found @@ -4381,22 +4405,22 @@ paths: conversation found: value: type: conversation - id: '684' - created_at: 1704903348 - updated_at: 1704903348 + id: '1286' + created_at: 1707238247 + updated_at: 1707238247 waiting_since: snoozed_until: source: type: conversation - id: '403918465' + id: '403918813' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991268499' - name: Ciaran149 Lee - email: admin149@email.com + id: '991270998' + name: Ciaran150 Lee + email: admin150@email.com attachments: [] url: redacted: false @@ -4404,7 +4428,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ec2b36abd01535c22346a + id: 65c2636786ce64a98769c1fe external_id: '70' first_contact_reply: admin_assignee_id: @@ -4443,7 +4467,7 @@ paths: Not found: value: type: error.list - request_id: 30c33524-b8be-4376-a460-f4ee773644da + request_id: a3fbc565-888b-4ef5-a09f-62dd88ddea04 errors: - code: not_found message: Resource Not Found @@ -4457,7 +4481,7 @@ paths: Unauthorized: value: type: error.list - request_id: 4a080201-3648-4404-bd87-9742c4b3b13a + request_id: 89e524b4-4885-4266-a4a8-6245450aac64 errors: - code: unauthorized message: Access Token Invalid @@ -4471,7 +4495,7 @@ paths: API plan restricted: value: type: error.list - request_id: 7f3e1fd1-3532-4a98-af41-d55be745210b + request_id: 9787d0cd-8311-4b47-b89d-12d5a694f2e2 errors: - code: api_plan_restricted message: Active subscription needed. @@ -4514,22 +4538,22 @@ paths: conversation found: value: type: conversation - id: '688' - created_at: 1704903353 - updated_at: 1704903354 + id: '1290' + created_at: 1707238254 + updated_at: 1707238256 waiting_since: snoozed_until: source: type: conversation - id: '403918469' + id: '403918817' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991268507' - name: Ciaran153 Lee - email: admin153@email.com + id: '991271006' + name: Ciaran154 Lee + email: admin154@email.com attachments: [] url: redacted: false @@ -4537,7 +4561,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ec2b96abd01535c22346e + id: 65c2636e86ce64a98769c202 external_id: '70' first_contact_reply: admin_assignee_id: @@ -4568,34 +4592,34 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '125' + id: '281' part_type: conversation_attribute_updated_by_admin body: - created_at: 1704903354 - updated_at: 1704903354 - notified_at: 1704903354 + created_at: 1707238256 + updated_at: 1707238256 + notified_at: 1707238256 assigned_to: author: - id: '991268508' + id: '991271007' 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: '282' part_type: conversation_attribute_updated_by_admin body: - created_at: 1704903354 - updated_at: 1704903354 - notified_at: 1704903354 + created_at: 1707238256 + updated_at: 1707238256 + notified_at: 1707238256 assigned_to: author: - id: '991268508' + id: '991271007' 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 +4634,7 @@ paths: Not found: value: type: error.list - request_id: c1f34352-b336-4a5c-bc6a-04fbb9d4e03e + request_id: 6bcec9a2-cdb7-4485-8798-a689cfe37edc errors: - code: not_found message: Resource Not Found @@ -4624,7 +4648,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9fa0cee0-8ac8-43e7-832c-5ad332c4161f + request_id: 24dba7cb-be43-420c-ad34-a44a7265a619 errors: - code: unauthorized message: Access Token Invalid @@ -4638,7 +4662,7 @@ paths: API plan restricted: value: type: error.list - request_id: cd4ae3b9-60b6-41f3-999f-eac45f311bbe + request_id: 98e839d2-f6d0-4754-ac8b-c9dbba3340e8 errors: - code: api_plan_restricted message: Active subscription needed. @@ -4757,22 +4781,22 @@ paths: total_count: 1 conversations: - type: conversation - id: '695' - created_at: 1704903362 - updated_at: 1704903362 + id: '1297' + created_at: 1707238268 + updated_at: 1707238268 waiting_since: snoozed_until: source: type: conversation - id: '403918476' + id: '403918824' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991268537' - name: Ciaran176 Lee - email: admin176@email.com + id: '991271036' + name: Ciaran177 Lee + email: admin177@email.com attachments: [] url: redacted: false @@ -4780,7 +4804,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ec2c26abd01535c223475 + id: 65c2637c86ce64a98769c209 external_id: '70' first_contact_reply: admin_assignee_id: @@ -4821,15 +4845,15 @@ paths: value: - field: id operator: "=" - value: '695' + value: '1297' - operator: OR value: - field: id operator: "=" - value: '695' + value: '1297' - field: id operator: "=" - value: '695' + value: '1297' "/conversations/{id}/reply": post: summary: Reply to a conversation @@ -4868,22 +4892,22 @@ paths: User reply: value: type: conversation - id: '703' - created_at: 1704903369 - updated_at: 1704903370 - waiting_since: 1704903370 + id: '1305' + created_at: 1707238277 + updated_at: 1707238278 + waiting_since: 1707238278 snoozed_until: source: type: conversation - id: '403918479' + id: '403918827' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991268539' - name: Ciaran177 Lee - email: admin177@email.com + id: '991271038' + name: Ciaran178 Lee + email: admin178@email.com attachments: [] url: redacted: false @@ -4891,10 +4915,10 @@ paths: type: contact.list contacts: - type: contact - id: 659ec2c96abd01535c22347c + id: 65c2638586ce64a98769c210 external_id: '70' first_contact_reply: - created_at: 1704903370 + created_at: 1707238278 type: conversation url: admin_assignee_id: @@ -4923,15 +4947,15 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '128' + id: '284' part_type: open body: "

    Thanks again :)

    " - created_at: 1704903370 - updated_at: 1704903370 - notified_at: 1704903370 + created_at: 1707238278 + updated_at: 1707238278 + notified_at: 1707238278 assigned_to: author: - id: 659ec2c96abd01535c22347c + id: 65c2638586ce64a98769c210 type: user name: Joe Bloggs email: joe@bloggs.com @@ -4942,22 +4966,22 @@ paths: Admin note reply: value: type: conversation - id: '704' - created_at: 1704903371 - updated_at: 1704903372 + id: '1306' + created_at: 1707238279 + updated_at: 1707238280 waiting_since: snoozed_until: source: type: conversation - id: '403918480' + id: '403918828' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991268541' - name: Ciaran178 Lee - email: admin178@email.com + id: '991271040' + name: Ciaran179 Lee + email: admin179@email.com attachments: [] url: redacted: false @@ -4965,7 +4989,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ec2cb6abd01535c22347d + id: 65c2638786ce64a98769c211 external_id: '70' first_contact_reply: admin_assignee_id: @@ -4994,7 +5018,7 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '129' + id: '285' part_type: note body: |-

    An Unordered HTML List

    @@ -5009,15 +5033,15 @@ paths:
  • Tea
  • Milk
  • - created_at: 1704903372 - updated_at: 1704903372 - notified_at: 1704903372 + created_at: 1707238280 + updated_at: 1707238280 + notified_at: 1707238280 assigned_to: author: - id: '991268541' + id: '991271040' type: admin - name: Ciaran178 Lee - email: admin178@email.com + name: Ciaran179 Lee + email: admin179@email.com attachments: [] external_id: redacted: false @@ -5025,22 +5049,22 @@ paths: User last conversation reply: value: type: conversation - id: '706' - created_at: 1704903374 - updated_at: 1704903374 - waiting_since: 1704903374 + id: '1308' + created_at: 1707238282 + updated_at: 1707238284 + waiting_since: 1707238284 snoozed_until: source: type: conversation - id: '403918482' + id: '403918830' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991268545' - name: Ciaran180 Lee - email: admin180@email.com + id: '991271044' + name: Ciaran181 Lee + email: admin181@email.com attachments: [] url: redacted: false @@ -5048,10 +5072,10 @@ paths: type: contact.list contacts: - type: contact - id: 659ec2cd6abd01535c22347f + id: 65c2638a86ce64a98769c213 external_id: '70' first_contact_reply: - created_at: 1704903374 + created_at: 1707238284 type: conversation url: admin_assignee_id: @@ -5080,15 +5104,15 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '130' + id: '286' part_type: open body: "

    Thanks again :)

    " - created_at: 1704903374 - updated_at: 1704903374 - notified_at: 1704903374 + created_at: 1707238284 + updated_at: 1707238284 + notified_at: 1707238284 assigned_to: author: - id: 659ec2cd6abd01535c22347f + id: 65c2638a86ce64a98769c213 type: user name: Joe Bloggs email: joe@bloggs.com @@ -5106,7 +5130,7 @@ paths: Not found: value: type: error.list - request_id: 95d1fe30-c802-4a70-90a1-9a3885422d74 + request_id: a1eb6d1a-1cb0-4dde-bd15-8236b65ca6f2 errors: - code: not_found message: Resource Not Found @@ -5120,7 +5144,7 @@ paths: Unauthorized: value: type: error.list - request_id: 679f127f-799e-4d93-93b1-46b5617354d4 + request_id: 66f9afd8-55ac-4bd5-a960-799fac889f1c errors: - code: unauthorized message: Access Token Invalid @@ -5134,7 +5158,7 @@ paths: API plan restricted: value: type: error.list - request_id: 568d9835-1a7a-4932-a114-fa4f35004baa + request_id: ab944942-1e34-44a8-833b-760ec105b583 errors: - code: api_plan_restricted message: Active subscription needed. @@ -5151,14 +5175,14 @@ paths: value: message_type: comment type: user - intercom_user_id: 659ec2c96abd01535c22347c + intercom_user_id: 65c2638586ce64a98769c210 body: Thanks again :) admin_note_reply: summary: Admin note reply value: message_type: note type: admin - admin_id: 991268541 + admin_id: 991271040 body: "

    An Unordered HTML List

    An Ordered HTML List

    \
    1. Coffee
    2. Tea
    3. Milk
    @@ -5168,14 +5192,14 @@ paths: value: message_type: comment type: user - intercom_user_id: 659ec2cd6abd01535c22347f + intercom_user_id: 65c2638a86ce64a98769c213 body: Thanks again :) not_found: summary: Not found value: message_type: comment type: user - intercom_user_id: 659ec2cf6abd01535c223480 + intercom_user_id: 65c2638d86ce64a98769c214 body: Thanks again :) "/conversations/{id}/parts": post: @@ -5209,22 +5233,22 @@ paths: Close a conversation: value: type: conversation - id: '710' - created_at: 1704903379 - updated_at: 1704903380 + id: '1312' + created_at: 1707238289 + updated_at: 1707238291 waiting_since: snoozed_until: source: type: conversation - id: '403918486' + id: '403918834' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991268553' - name: Ciaran184 Lee - email: admin184@email.com + id: '991271052' + name: Ciaran185 Lee + email: admin185@email.com attachments: [] url: redacted: false @@ -5232,7 +5256,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ec2d36abd01535c223483 + id: 65c2639186ce64a98769c217 external_id: '70' first_contact_reply: admin_assignee_id: @@ -5261,18 +5285,18 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '131' + id: '287' part_type: close body: "

    Goodbye :)

    " - created_at: 1704903380 - updated_at: 1704903380 - notified_at: 1704903380 + created_at: 1707238291 + updated_at: 1707238291 + notified_at: 1707238291 assigned_to: author: - id: '991268553' + id: '991271052' type: admin - name: Ciaran184 Lee - email: admin184@email.com + name: Ciaran185 Lee + email: admin185@email.com attachments: [] external_id: redacted: false @@ -5280,22 +5304,22 @@ paths: Snooze a conversation: value: type: conversation - id: '711' - created_at: 1704903382 - updated_at: 1704903382 + id: '1313' + created_at: 1707238292 + updated_at: 1707238292 waiting_since: - snoozed_until: 1704906982 + snoozed_until: source: type: conversation - id: '403918487' + id: '403918835' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991268555' - name: Ciaran185 Lee - email: admin185@email.com + id: '991271054' + name: Ciaran186 Lee + email: admin186@email.com attachments: [] url: redacted: false @@ -5303,13 +5327,13 @@ paths: type: contact.list contacts: - type: contact - id: 659ec2d56abd01535c223484 + id: 65c2639486ce64a98769c218 external_id: '70' first_contact_reply: admin_assignee_id: team_assignee_id: - open: true - state: snoozed + open: false + state: closed read: false tags: type: tag.list @@ -5330,43 +5354,27 @@ paths: has_more: false conversation_parts: type: conversation_part.list - conversation_parts: - - type: conversation_part - id: '132' - part_type: snoozed - body: - created_at: 1704903382 - updated_at: 1704903382 - notified_at: 1704903382 - assigned_to: - author: - id: '991268555' - type: admin - name: Ciaran185 Lee - email: admin185@email.com - attachments: [] - external_id: - redacted: false - total_count: 1 + conversation_parts: [] + total_count: 0 Open a conversation: value: type: conversation - id: '716' - created_at: 1704903380 - updated_at: 1704903389 + id: '1318' + created_at: 1707238292 + updated_at: 1707238302 waiting_since: snoozed_until: source: type: conversation - id: '403918488' + id: '403918836' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991268557' - name: Ciaran186 Lee - email: admin186@email.com + id: '991271056' + name: Ciaran187 Lee + email: admin187@email.com attachments: [] url: redacted: false @@ -5374,7 +5382,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ec2d96abd01535c223489 + id: 65c2639a86ce64a98769c21d external_id: '74' first_contact_reply: admin_assignee_id: @@ -5403,18 +5411,18 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '134' + id: '289' part_type: open body: - created_at: 1704903389 - updated_at: 1704903389 - notified_at: 1704903389 + created_at: 1707238302 + updated_at: 1707238302 + notified_at: 1707238302 assigned_to: author: - id: '991268557' + id: '991271056' type: admin - name: Ciaran186 Lee - email: admin186@email.com + name: Ciaran187 Lee + email: admin187@email.com attachments: [] external_id: redacted: false @@ -5422,22 +5430,22 @@ paths: Assign a conversation: value: type: conversation - id: '720' - created_at: 1704903390 - updated_at: 1704903390 + id: '1322' + created_at: 1707238303 + updated_at: 1707238304 waiting_since: snoozed_until: source: type: conversation - id: '403918491' + id: '403918839' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991268559' - name: Ciaran187 Lee - email: admin187@email.com + id: '991271058' + name: Ciaran188 Lee + email: admin188@email.com attachments: [] url: redacted: false @@ -5445,10 +5453,10 @@ paths: type: contact.list contacts: - type: contact - id: 659ec2dd6abd01535c22348c + id: 65c2639f86ce64a98769c220 external_id: '70' first_contact_reply: - admin_assignee_id: 991268559 + admin_assignee_id: 991271058 team_assignee_id: open: true state: open @@ -5474,20 +5482,20 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '135' + id: '290' part_type: assign_and_reopen body: - created_at: 1704903390 - updated_at: 1704903390 - notified_at: 1704903390 + created_at: 1707238304 + updated_at: 1707238304 + notified_at: 1707238304 assigned_to: type: admin - id: '991268559' + id: '991271058' author: - id: '991268559' + id: '991271058' type: admin - name: Ciaran187 Lee - email: admin187@email.com + name: Ciaran188 Lee + email: admin188@email.com attachments: [] external_id: redacted: false @@ -5502,7 +5510,7 @@ paths: Not found: value: type: error.list - request_id: 05ac35dc-e9b5-46dc-82db-45537860a1e4 + request_id: 23eafb09-8ff5-40f5-9110-caca65848e99 errors: - code: not_found message: Resource Not Found @@ -5516,7 +5524,7 @@ paths: Unauthorized: value: type: error.list - request_id: 72905166-70b8-49bc-a3e3-decaddeeef67 + request_id: 6c7219ef-1c43-45f4-bc6d-02f5d5540a66 errors: - code: unauthorized message: Access Token Invalid @@ -5530,7 +5538,7 @@ paths: API plan restricted: value: type: error.list - request_id: f33ab72c-d97c-4895-8a1c-4920c190b875 + request_id: 79ec2e1d-6d37-49fd-aeeb-daafba474d17 errors: - code: api_plan_restricted message: Active subscription needed. @@ -5551,32 +5559,32 @@ paths: value: message_type: close type: admin - admin_id: 991268553 + admin_id: 991271052 body: Goodbye :) snooze_a_conversation: summary: Snooze a conversation value: message_type: snoozed - admin_id: 991268555 - snoozed_until: 1704906982 + admin_id: 991271054 + snoozed_until: 1707241893 open_a_conversation: summary: Open a conversation value: message_type: open - admin_id: 991268557 + admin_id: 991271056 assign_a_conversation: summary: Assign a conversation value: message_type: assignment type: admin - admin_id: 991268559 - assignee_id: 991268559 + admin_id: 991271058 + assignee_id: 991271058 not_found: summary: Not found value: message_type: close type: admin - admin_id: 991268561 + admin_id: 991271060 body: Goodbye :) "/conversations/{id}/run_assignment_rules": post: @@ -5607,22 +5615,22 @@ paths: Assign a conversation using assignment rules: value: type: conversation - id: '724' - created_at: 1704903395 - updated_at: 1704903396 + id: '1326' + created_at: 1707238310 + updated_at: 1707238312 waiting_since: snoozed_until: source: type: conversation - id: '403918495' + id: '403918843' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991268567' - name: Ciaran191 Lee - email: admin191@email.com + id: '991271066' + name: Ciaran192 Lee + email: admin192@email.com attachments: [] url: redacted: false @@ -5630,7 +5638,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ec2e36abd01535c223490 + id: 65c263a686ce64a98769c224 external_id: '70' first_contact_reply: admin_assignee_id: @@ -5659,20 +5667,20 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '136' + id: '291' part_type: default_assignment body: - created_at: 1704903396 - updated_at: 1704903396 - notified_at: 1704903396 + created_at: 1707238312 + updated_at: 1707238312 + notified_at: 1707238312 assigned_to: type: nobody_admin id: author: - id: '991268568' + id: '991271067' 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 +5695,7 @@ paths: Not found: value: type: error.list - request_id: d4929a69-80c2-4de7-9ee9-78f4e9020d4c + request_id: 5fee9885-9833-40aa-87be-a0849fc55cf9 errors: - code: not_found message: Resource Not Found @@ -5701,7 +5709,7 @@ paths: Unauthorized: value: type: error.list - request_id: 22b4b529-5b92-4d6d-b45d-7bb6624d7b06 + request_id: ad447601-a185-43a9-a643-ccbb8ba236c3 errors: - code: unauthorized message: Access Token Invalid @@ -5715,7 +5723,7 @@ paths: API plan restricted: value: type: error.list - request_id: a8a7afc9-9d71-4207-ad05-c5146bff1d93 + request_id: 865a8258-0ab4-4478-b636-53506d4b0b74 errors: - code: api_plan_restricted message: Active subscription needed. @@ -5754,7 +5762,7 @@ paths: value: customers: - type: user - id: 659ec2e96abd01535c223494 + id: 65c263ae86ce64a98769c228 schema: "$ref": "#/components/schemas/conversation" '404': @@ -5765,7 +5773,7 @@ paths: Not found: value: type: error.list - request_id: 488f5fb2-8782-4b73-a3cd-a215dc75a0dc + request_id: a46256d5-83eb-4d65-b11c-856665227b92 errors: - code: not_found message: Resource Not Found @@ -5779,7 +5787,7 @@ paths: Unauthorized: value: type: error.list - request_id: '03487a51-2ed5-4ada-a55a-6e4ad53a3799' + request_id: 405fcc7c-8b14-4078-8f88-6623f65f855d errors: - code: unauthorized message: Access Token Invalid @@ -5793,7 +5801,7 @@ paths: API plan restricted: value: type: error.list - request_id: 5ad02f95-40ed-4ca8-8e6d-1cbc45d0d243 + request_id: ed14605f-031e-411c-8eb9-8565f9d47da7 errors: - code: api_plan_restricted message: Active subscription needed. @@ -5808,15 +5816,15 @@ paths: attach_a_contact_to_a_conversation: summary: Attach a contact to a conversation value: - admin_id: 991268575 + admin_id: 991271074 customer: - intercom_user_id: 659ec2e96abd01535c223494 + intercom_user_id: 65c263ae86ce64a98769c228 not_found: summary: Not found value: - admin_id: 991268577 + admin_id: 991271076 customer: - intercom_user_id: 659ec2ea6abd01535c223495 + intercom_user_id: 65c263b086ce64a98769c229 "/conversations/{conversation_id}/customers/{contact_id}": delete: summary: Detach a contact from a group conversation @@ -5857,7 +5865,7 @@ paths: value: customers: - type: user - id: 659ec2f36abd01535c22349f + id: 65c263be86ce64a98769c233 schema: "$ref": "#/components/schemas/conversation" '404': @@ -5868,14 +5876,14 @@ paths: Conversation not found: value: type: error.list - request_id: 354dd098-2a14-4b3c-9f10-6805176844d3 + request_id: 42807562-731d-4d29-bfef-df14146aa798 errors: - code: not_found message: Resource Not Found Contact not found: value: type: error.list - request_id: 698996c2-32b8-4a40-944e-dba81fe767c4 + request_id: 29c36cfc-15a1-4a99-8375-1f980270b0a7 errors: - code: not_found message: User Not Found @@ -5889,7 +5897,7 @@ paths: Last customer: value: type: error.list - request_id: 1f2fbaf7-1ff7-4877-902f-9efaa69ee037 + request_id: 3a853fa4-7f1a-4f71-952c-34213dbeea49 errors: - code: parameter_invalid message: Removing the last customer is not allowed @@ -5903,7 +5911,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8a506fa2-bb68-4e26-b69c-97f79c9282e9 + request_id: bd8614bf-2229-402d-8e3e-9a5ebe7be823 errors: - code: unauthorized message: Access Token Invalid @@ -5917,7 +5925,7 @@ paths: API plan restricted: value: type: error.list - request_id: c759ac69-1891-4566-8fb3-b5f7ce6adf89 + request_id: 82ae8edb-fc61-4ef5-b942-95621aff5aca errors: - code: api_plan_restricted message: Active subscription needed. @@ -5932,27 +5940,27 @@ paths: detach_a_contact_from_a_group_conversation: summary: Detach a contact from a group conversation value: - admin_id: 991268583 + admin_id: 991271082 customer: - intercom_user_id: 659ec2ee6abd01535c223498 + intercom_user_id: 65c263b686ce64a98769c22c conversation_not_found: summary: Conversation not found value: - admin_id: 991268585 + admin_id: 991271084 customer: - intercom_user_id: 659ec2f46abd01535c2234a0 + intercom_user_id: 65c263bf86ce64a98769c234 contact_not_found: summary: Contact not found value: - admin_id: 991268587 + admin_id: 991271086 customer: - intercom_user_id: 659ec2fa6abd01535c2234a7 + intercom_user_id: 65c263c986ce64a98769c23b last_customer: summary: Last customer value: - admin_id: 991268589 + admin_id: 991271088 customer: - intercom_user_id: 659ec3016abd01535c2234ae + intercom_user_id: 65c263d186ce64a98769c242 "/conversations/redact": post: summary: Redact a conversation part @@ -5979,22 +5987,22 @@ paths: Redact a conversation part: value: type: conversation - id: '780' - created_at: 1704903444 - updated_at: 1704903446 - waiting_since: 1704903445 + id: '1382' + created_at: 1707238381 + updated_at: 1707238384 + waiting_since: 1707238383 snoozed_until: source: type: conversation - id: '403918521' + id: '403918869' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991268595' - name: Ciaran205 Lee - email: admin205@email.com + id: '991271094' + name: Ciaran206 Lee + email: admin206@email.com attachments: [] url: redacted: false @@ -6002,10 +6010,10 @@ paths: type: contact.list contacts: - type: contact - id: 659ec3146abd01535c2234c3 + id: 65c263ed86ce64a98769c257 external_id: '70' first_contact_reply: - created_at: 1704903445 + created_at: 1707238383 type: conversation url: admin_assignee_id: @@ -6034,15 +6042,15 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '144' + id: '299' part_type: open body: "

    This message was deleted

    " - created_at: 1704903445 - updated_at: 1704903446 - notified_at: 1704903445 + created_at: 1707238383 + updated_at: 1707238384 + notified_at: 1707238383 assigned_to: author: - id: 659ec3146abd01535c2234c3 + id: 65c263ed86ce64a98769c257 type: user name: Joe Bloggs email: joe@bloggs.com @@ -6060,7 +6068,7 @@ paths: Not found: value: type: error.list - request_id: b53e159b-672f-44ba-8945-bc7024d6ac44 + request_id: 75bf136f-e621-4dd8-93af-7481effff641 errors: - code: conversation_part_or_message_not_found message: Conversation part or message not found @@ -6074,7 +6082,7 @@ paths: Unauthorized: value: type: error.list - request_id: '0218e105-4bb8-4675-bbeb-d648f10c29e9' + request_id: 93ddec1a-c844-4855-9d48-5a485b8c1809 errors: - code: unauthorized message: Access Token Invalid @@ -6090,8 +6098,8 @@ paths: summary: Redact a conversation part value: type: conversation_part - conversation_id: 780 - conversation_part_id: 144 + conversation_id: 1382 + conversation_part_id: 299 not_found: summary: Not found value: @@ -6126,20 +6134,20 @@ paths: successful: value: type: ticket - id: '783' - ticket_id: '7' + id: '1385' + ticket_id: '47' ticket_attributes: {} ticket_state: submitted ticket_type: type: ticket_type - id: '72' + id: '215' 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: 1707238391 + updated_at: 1707238391 is_internal: false ticket_type_attributes: type: list @@ -6149,40 +6157,40 @@ paths: type: contact.list contacts: - type: contact - id: 659ec3196abd01535c2234c6 + id: 65c263f486ce64a98769c25a external_id: '70' admin_assignee_id: '0' team_assignee_id: '0' - created_at: 1704903449 - updated_at: 1704903452 + created_at: 1707238389 + updated_at: 1707238392 ticket_parts: type: ticket_part.list ticket_parts: - type: ticket_part - id: '146' + id: '301' part_type: comment body: "

    Comment for message

    " - created_at: 1704903449 - updated_at: 1704903449 + created_at: 1707238389 + updated_at: 1707238389 author: - id: 659ec3196abd01535c2234c6 + id: 65c263f486ce64a98769c25a type: user name: Joe Bloggs email: joe@bloggs.com attachments: [] redacted: false - type: ticket_part - id: '147' + id: '302' part_type: ticket_state_updated_by_admin ticket_state: submitted previous_ticket_state: submitted - created_at: 1704903452 - updated_at: 1704903452 + created_at: 1707238392 + updated_at: 1707238392 author: - id: '991268605' + id: '991271104' 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 +6212,7 @@ paths: Bad request: value: type: error.list - request_id: 5370f6d2-b1c2-4d09-8d6b-e43a57ed3d23 + request_id: 43bd3283-3f97-46df-a4f2-7739555ef4c5 errors: - code: parameter_invalid message: Ticket type is not a customer ticket type @@ -6219,11 +6227,11 @@ paths: successful: summary: successful value: - ticket_type_id: '72' + ticket_type_id: '215' bad_request: summary: Bad request value: - ticket_type_id: '73' + ticket_type_id: '216' "/data_attributes": get: summary: List all data attributes @@ -6393,7 +6401,7 @@ paths: custom: false archived: false model: company - - id: 113 + - id: 132 type: data_attribute name: The One Ring full_name: custom_attributes.The One Ring @@ -6405,9 +6413,9 @@ paths: ui_writable: false custom: true archived: false - admin_id: '991268613' - created_at: 1704903455 - updated_at: 1704903455 + admin_id: '991271121' + created_at: 1707238399 + updated_at: 1707238399 model: company - type: data_attribute name: id @@ -6474,7 +6482,7 @@ paths: Unauthorized: value: type: error.list - request_id: d63b7d26-e7aa-48f9-a257-ac7b96ab6927 + request_id: f2508205-8a45-4a5e-8cea-a0dd50c43c1b errors: - code: unauthorized message: Access Token Invalid @@ -6499,7 +6507,7 @@ paths: examples: Successful: value: - id: 116 + id: 135 type: data_attribute name: Mithril Shirt full_name: custom_attributes.Mithril Shirt @@ -6509,9 +6517,9 @@ paths: ui_writable: false custom: true archived: false - admin_id: '991268615' - created_at: 1704903456 - updated_at: 1704903456 + admin_id: '991271123' + created_at: 1707238400 + updated_at: 1707238400 model: company schema: "$ref": "#/components/schemas/data_attribute" @@ -6523,7 +6531,7 @@ paths: Same name already exists: value: type: error.list - request_id: ea4a8b36-6a6f-4a87-a383-dd36d10a3651 + request_id: 18207e8b-c844-4450-800d-93567f0cee9e errors: - code: parameter_invalid message: You already have 'The One Ring' in your company data. @@ -6531,7 +6539,7 @@ paths: Invalid name: value: type: error.list - request_id: dcf7c0e0-4a0a-4977-bb74-b524438bb28f + request_id: baebaf73-b31a-411c-8b37-f73fb260f2d8 errors: - code: parameter_invalid message: Your name for this attribute must only contain alphanumeric @@ -6539,7 +6547,7 @@ paths: Attribute already exists: value: type: error.list - request_id: 9bd6e2e7-724a-4661-aa6e-cf3891208d20 + request_id: b8b14058-5a63-46b9-8f32-e0175606cf8e errors: - code: parameter_invalid message: You already have 'The One Ring' in your company data. @@ -6547,14 +6555,14 @@ paths: Invalid Data Type: value: type: error.list - request_id: b01f4c9d-c020-4461-a15f-d82c65db888c + request_id: 3cb2fcb7-7b8b-43aa-bfaa-4da56f47dd2b 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: 05c80abd-f9ad-4902-8840-5c02cf63114b errors: - code: parameter_invalid message: The Data Attribute model field must be either contact @@ -6569,7 +6577,7 @@ paths: Unauthorized: value: type: error.list - request_id: 237af7d8-b4f5-4064-8c4b-30be30ed30ae + request_id: c381f3a7-07c4-4ef9-98b9-44add9ecd6c8 errors: - code: unauthorized message: Access Token Invalid @@ -6648,7 +6656,7 @@ paths: examples: Successful: value: - id: 123 + id: 142 type: data_attribute name: The One Ring full_name: custom_attributes.The One Ring @@ -6662,9 +6670,9 @@ paths: ui_writable: false custom: true archived: false - admin_id: '991268622' - created_at: 1704903459 - updated_at: 1704903459 + admin_id: '991271130' + created_at: 1707238402 + updated_at: 1707238403 model: company schema: "$ref": "#/components/schemas/data_attribute" @@ -6676,7 +6684,7 @@ paths: Too few options in list: value: type: error.list - request_id: 91c64990-dbd7-4462-a49b-cb59744ea154 + request_id: 3111fd22-8921-4947-b0f1-f9e692885ed1 errors: - code: parameter_invalid message: Options isn't an array @@ -6690,7 +6698,7 @@ paths: Attribute Not Found: value: type: error.list - request_id: 33f5de8c-3878-4797-b0ab-1d2fa373cfa5 + request_id: 7aa281e6-ce74-4128-8b82-9d194a0575f2 errors: - code: field_not_found message: We couldn't find that data attribute to update @@ -6704,7 +6712,7 @@ paths: Has Dependant Object: value: type: error.list - request_id: 50c33dc7-532c-454f-90ac-37ad802b62c8 + request_id: 16ba750c-831a-463e-bd0b-5ccc54eb9eba errors: - code: data_invalid message: The Data Attribute you are trying to archive has a @@ -6719,7 +6727,7 @@ paths: Unauthorized: value: type: error.list - request_id: f5a1a5d9-fc95-44ad-99a4-79aad8bca889 + request_id: 0d084b74-51f1-440a-8a95-76fd75eae35f errors: - code: unauthorized message: Access Token Invalid @@ -6770,63 +6778,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 +6832,7 @@ paths: Unauthorized: value: type: error.list - request_id: 723b92af-b79e-4512-a8ca-ecf5b997c8c2 + request_id: 5dc2c97d-abd9-43f9-865e-6bfd440f37b1 errors: - code: unauthorized message: Access Token Invalid @@ -6924,8 +6918,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: 65c2640686ce64a98769c260 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 schema: "$ref": "#/components/schemas/data_event_summary" @@ -6937,7 +6931,7 @@ paths: Unauthorized: value: type: error.list - request_id: 43c525b2-fa57-4593-9695-e196776a169d + request_id: 3885ac06-fa54-4040-9455-7f580d87f6e3 errors: - code: unauthorized message: Access Token Invalid @@ -6968,7 +6962,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9f5f7745-1e66-4195-bff9-eb43b8192de4 + request_id: 55677b30-79aa-47a4-90c5-0a93f1d75c03 errors: - code: unauthorized message: Access Token Invalid @@ -7012,7 +7006,7 @@ paths: examples: successful: value: - job_identifier: 86exkvb6mas0i1uv + job_identifier: xvgw8d8cpc4qfhxp status: pending download_url: '' download_expires_at: '' @@ -7027,8 +7021,8 @@ paths: successful: summary: successful value: - created_at_after: 1704885469 - created_at_before: 1704903469 + created_at_after: 1707220408 + created_at_before: 1707238408 "/export/content/data/{job_identifier}": get: summary: Show content data export @@ -7062,7 +7056,7 @@ paths: examples: successful: value: - job_identifier: tw2utjkozhhdyelq + job_identifier: zgh1z2cgbe4f64nc status: pending download_url: '' download_expires_at: '' @@ -7094,7 +7088,7 @@ paths: examples: successful: value: - job_identifier: m37o4vxn7s96zeuf + job_identifier: l5bv0t95yovcqwqw status: canceled download_url: '' download_expires_at: '' @@ -7155,32 +7149,32 @@ paths: user message created: value: type: user_message - id: '403918532' - created_at: 1704903496 + id: '403918874' + created_at: 1707238410 body: heyy message_type: inapp - conversation_id: '796' + conversation_id: '1387' lead message created: value: type: user_message - id: '403918533' - created_at: 1704903497 + id: '403918875' + created_at: 1707238411 body: heyy message_type: inapp - conversation_id: '797' + conversation_id: '1388' admin message created: value: type: admin_message - id: '40' - created_at: 1704903498 + id: '45' + created_at: 1707238412 subject: heyy body: heyy message_type: inapp owner: type: admin - id: '991268656' - name: Ciaran248 Lee - email: admin248@email.com + id: '991271153' + name: Ciaran258 Lee + email: admin258@email.com away_mode_enabled: false away_mode_reassign: false schema: @@ -7193,14 +7187,14 @@ paths: No body supplied for message: value: type: error.list - request_id: 8c8ca5b8-5b83-4f7c-8825-abac1d0f869c + request_id: 20a186e0-5a64-4eea-91f8-c7b754f39bf1 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: 3285f078-c6cb-44a5-8132-a7bc53ae9249 errors: - code: parameter_invalid message: Body is required @@ -7214,7 +7208,7 @@ paths: No subject supplied for email message: value: type: error.list - request_id: 3bb0e304-352e-46fb-994a-419880dd7ce8 + request_id: 50a831a6-35ad-40aa-85a7-2762bd7b6baa errors: - code: parameter_not_found message: No subject supplied for email message @@ -7228,7 +7222,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0f37b79c-d7f8-4b17-b900-205d57bafcbe + request_id: ab88a046-3568-46f0-b86a-9466aae0910c errors: - code: unauthorized message: Access Token Invalid @@ -7242,7 +7236,7 @@ paths: API plan restricted: value: type: error.list - request_id: d6a6d344-a4d6-4184-bbc2-99b27631b1ef + request_id: fb93e960-46cb-461a-aa1f-c842c223d73f errors: - code: api_plan_restricted message: Active subscription needed. @@ -7259,7 +7253,7 @@ paths: value: from: type: user - id: 659ec3486abd01535c223531 + id: 65c2640a86ce64a98769c265 body: heyy referer: https://twitter.com/bob lead_message_created: @@ -7267,7 +7261,7 @@ paths: value: from: type: lead - id: 659ec3496abd01535c223532 + id: 65c2640b86ce64a98769c266 body: heyy referer: https://twitter.com/bob admin_message_created: @@ -7275,10 +7269,10 @@ paths: value: from: type: admin - id: '991268656' + id: '991271153' to: type: user - id: 659ec34a6abd01535c223533 + id: 65c2640c86ce64a98769c267 message_type: conversation body: heyy no_body_supplied_for_message: @@ -7286,10 +7280,10 @@ paths: value: from: type: admin - id: '991268658' + id: '991271155' to: type: user - id: 659ec34b6abd01535c223534 + id: 65c2640d86ce64a98769c268 message_type: inapp body: subject: heyy @@ -7298,7 +7292,7 @@ paths: value: from: type: admin - id: '991268659' + id: '991271156' to: type: user user_id: '70' @@ -7309,10 +7303,10 @@ paths: value: from: type: admin - id: '991268660' + id: '991271157' to: type: user - id: 659ec34c6abd01535c223536 + id: 65c2640e86ce64a98769c26a message_type: email body: subject: heyy @@ -7343,12 +7337,12 @@ paths: total_pages: 1 type: pages data: - - id: '57' + - id: '113' 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: 991271162 state: draft labels: [] cover_image_url: @@ -7358,15 +7352,15 @@ paths: - - deliver_silently: false - created_at: 1704903502 - updated_at: 1704903502 + created_at: 1707238415 + updated_at: 1707238415 newsfeed_assignments: [] - - id: '58' + - id: '114' 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: 991271164 state: draft labels: [] cover_image_url: @@ -7376,8 +7370,8 @@ paths: - - deliver_silently: false - created_at: 1704903502 - updated_at: 1704903502 + created_at: 1707238415 + updated_at: 1707238415 newsfeed_assignments: [] total_count: 2 schema: @@ -7390,7 +7384,7 @@ paths: Unauthorized: value: type: error.list - request_id: c7a25ea3-25bd-4b56-98c9-23e4e5ef4bcc + request_id: 1f521c8c-b97c-45a4-bbbd-977ef42ab98b errors: - code: unauthorized message: Access Token Invalid @@ -7415,12 +7409,12 @@ paths: examples: successful: value: - id: '61' + id: '117' 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: 991271171 state: live labels: - New @@ -7431,10 +7425,10 @@ paths: - "\U0001F606" - "\U0001F605" deliver_silently: true - created_at: 1704903504 - updated_at: 1704903504 + created_at: 1707238417 + updated_at: 1707238417 newsfeed_assignments: - - newsfeed_id: 103 + - newsfeed_id: 203 published_at: 1664638214 schema: "$ref": "#/components/schemas/news_item" @@ -7446,7 +7440,7 @@ paths: Unauthorized: value: type: error.list - request_id: 3597b54d-8f96-43af-a3e5-00d890707de4 + request_id: b05d9868-6b91-48b5-838d-95cf43d1f537 errors: - code: unauthorized message: Access Token Invalid @@ -7467,14 +7461,14 @@ paths: - Product - Update - New - sender_id: 991268674 + sender_id: 991271171 deliver_silently: true reactions: - "\U0001F606" - "\U0001F605" state: live newsfeed_assignments: - - newsfeed_id: 103 + - newsfeed_id: 203 published_at: 1664638214 "/news/news_items/{id}": get: @@ -7503,12 +7497,12 @@ paths: examples: successful: value: - id: '62' + id: '118' 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: 991271174 state: live labels: [] cover_image_url: @@ -7518,11 +7512,11 @@ paths: - - deliver_silently: false - created_at: 1704903505 - updated_at: 1704903505 + created_at: 1707238418 + updated_at: 1707238418 newsfeed_assignments: - - newsfeed_id: 105 - published_at: 1704903505 + - newsfeed_id: 205 + published_at: 1707238418 schema: "$ref": "#/components/schemas/news_item" '404': @@ -7533,7 +7527,7 @@ paths: News Item Not Found: value: type: error.list - request_id: 92ecda54-5996-4208-9f66-2800fda20b60 + request_id: 26a76477-5aa1-46eb-899f-c58af75dc33b errors: - code: not_found message: Resource Not Found @@ -7547,7 +7541,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2b4129b8-09a4-4019-aebc-532e6eca5e98 + request_id: 64009be7-2fc3-4896-8889-7b4ecd945a45 errors: - code: unauthorized message: Access Token Invalid @@ -7578,12 +7572,12 @@ paths: examples: successful: value: - id: '65' + id: '121' 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: 991271182 state: live labels: [] cover_image_url: @@ -7591,8 +7585,8 @@ paths: - "\U0001F61D" - "\U0001F602" deliver_silently: false - created_at: 1704903506 - updated_at: 1704903506 + created_at: 1707238420 + updated_at: 1707238420 newsfeed_assignments: [] schema: "$ref": "#/components/schemas/news_item" @@ -7604,7 +7598,7 @@ paths: News Item Not Found: value: type: error.list - request_id: 6269c052-125a-4e15-b539-b58a2cfeaa70 + request_id: '082f010d-8907-4604-bcfe-8d79eece17fe' errors: - code: not_found message: Resource Not Found @@ -7618,7 +7612,7 @@ paths: Unauthorized: value: type: error.list - request_id: c772ab7f-ea30-4e24-b213-ae44020a8f88 + request_id: 1e071a0d-2893-4372-9fd0-10591e600675 errors: - code: unauthorized message: Access Token Invalid @@ -7635,7 +7629,7 @@ paths: value: title: Christmas is here! body: "

    New gifts in store for the jolly season

    " - sender_id: 991268685 + sender_id: 991271182 reactions: - "\U0001F61D" - "\U0001F602" @@ -7644,7 +7638,7 @@ paths: value: title: Christmas is here! body: "

    New gifts in store for the jolly season

    " - sender_id: 991268688 + sender_id: 991271185 reactions: - "\U0001F61D" - "\U0001F602" @@ -7674,7 +7668,7 @@ paths: examples: successful: value: - id: '68' + id: '124' object: news-item deleted: true schema: @@ -7687,7 +7681,7 @@ paths: News Item Not Found: value: type: error.list - request_id: eafc60ea-ac45-4723-9ca3-8c0ff31ab33d + request_id: e59a7a25-c32a-494b-994d-73d690047e20 errors: - code: not_found message: Resource Not Found @@ -7701,7 +7695,7 @@ paths: Unauthorized: value: type: error.list - request_id: e4826fca-7a2d-491e-b060-b9663ab2feaf + request_id: fd486ed6-c4e7-44d8-b8ea-c8fecca02f4c errors: - code: unauthorized message: Access Token Invalid @@ -7754,7 +7748,7 @@ paths: Unauthorized: value: type: error.list - request_id: 98b6a4ae-6f50-42e1-b958-c4685febd5c7 + request_id: bd97cb82-c5d0-445e-bd5f-c173cd4f21dd errors: - code: unauthorized message: Access Token Invalid @@ -7787,16 +7781,16 @@ paths: total_pages: 1 type: pages data: - - id: '118' + - id: '218' type: newsfeed name: Visitor Feed - created_at: 1704903510 - updated_at: 1704903510 - - id: '119' + created_at: 1707238425 + updated_at: 1707238425 + - id: '219' type: newsfeed name: Visitor Feed - created_at: 1704903510 - updated_at: 1704903510 + created_at: 1707238425 + updated_at: 1707238425 total_count: 2 schema: "$ref": "#/components/schemas/paginated_response" @@ -7808,7 +7802,7 @@ paths: Unauthorized: value: type: error.list - request_id: 6e613f58-5bc8-466e-87f7-f7e0eb3d0ddd + request_id: f0cc6abd-f731-4504-a07a-1ac9f999498f errors: - code: unauthorized message: Access Token Invalid @@ -7842,11 +7836,11 @@ paths: examples: successful: value: - id: '122' + id: '222' type: newsfeed name: Visitor Feed - created_at: 1704903511 - updated_at: 1704903511 + created_at: 1707238425 + updated_at: 1707238425 schema: "$ref": "#/components/schemas/newsfeed" '401': @@ -7857,7 +7851,7 @@ paths: Unauthorized: value: type: error.list - request_id: 22f7e633-2234-4686-ba76-e96aeb8f3999 + request_id: 6a7e0e1f-c54f-4a2b-a064-4ac0d48de737 errors: - code: unauthorized message: Access Token Invalid @@ -7891,16 +7885,16 @@ paths: Note found: value: type: note - id: '123' - created_at: 1704212315 + id: '135' + created_at: 1706547226 contact: type: contact - id: 659ec35b6abd01535c223541 + id: 65c2641a86ce64a98769c26d author: type: admin - id: '991268704' - name: Ciaran295 Lee - email: admin295@email.com + id: '991271201' + name: Ciaran305 Lee + email: admin305@email.com away_mode_enabled: false away_mode_reassign: false body: "

    This is a note.

    " @@ -7914,7 +7908,7 @@ paths: Note not found: value: type: error.list - request_id: f751e12d-bc72-49e0-8bba-87960265a9be + request_id: 5a039d0e-1990-452c-beb6-6929b5ec060b errors: - code: not_found message: Resource Not Found @@ -7928,7 +7922,7 @@ paths: Unauthorized: value: type: error.list - request_id: 65d57943-1d9b-413d-aa80-9a4c0a4de36e + request_id: 077fe4bc-ea0d-4bae-a18b-cacd18b975f0 errors: - code: unauthorized message: Access Token Invalid @@ -7964,16 +7958,16 @@ paths: type: segment.list segments: - type: segment - id: 659ec35e6abd01535c223548 + id: 65c2641c86ce64a98769c270 name: John segment - created_at: 1704903518 - updated_at: 1704903518 + created_at: 1707238428 + updated_at: 1707238428 person_type: user - type: segment - id: 659ec35e6abd01535c223549 + id: 65c2641c86ce64a98769c271 name: Jane segment - created_at: 1704903518 - updated_at: 1704903518 + created_at: 1707238428 + updated_at: 1707238428 person_type: user schema: "$ref": "#/components/schemas/segment_list" @@ -7985,7 +7979,7 @@ paths: Unauthorized: value: type: error.list - request_id: da37977a-befc-4010-92e6-9142965f2838 + request_id: 6dab8609-cdf5-4d92-b4ad-21a460f16e18 errors: - code: unauthorized message: Access Token Invalid @@ -8019,10 +8013,10 @@ paths: Successful response: value: type: segment - id: 659ec35f6abd01535c22354c + id: 65c2641d86ce64a98769c274 name: John segment - created_at: 1704903519 - updated_at: 1704903519 + created_at: 1707238429 + updated_at: 1707238429 person_type: user schema: "$ref": "#/components/schemas/segment" @@ -8034,7 +8028,7 @@ paths: Segment not found: value: type: error.list - request_id: ae53ca1d-47d9-47b3-a230-59ef3375544b + request_id: 35e0a999-5ed6-49c4-b311-4033ed50ec59 errors: - code: not_found message: Resource Not Found @@ -8048,7 +8042,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2db1398e-ab0a-444e-83f8-8ff5fae11bc1 + request_id: 955ea284-48dc-40a1-b410-d4cd6a4aaa52 errors: - code: unauthorized message: Access Token Invalid @@ -8078,7 +8072,7 @@ paths: type: list data: - type: subscription - id: '272' + id: '501' state: live consent_type: opt_out default_translation: @@ -8101,7 +8095,7 @@ paths: Unauthorized: value: type: error.list - request_id: f515be17-b048-4411-ac6d-836245d9c651 + request_id: 477dbccf-2f73-4c3d-8b73-b4933a092ede errors: - code: unauthorized message: Access Token Invalid @@ -8131,7 +8125,7 @@ paths: examples: successful: value: - url: http://via.intercom.io/msgr/0df6f175-fce2-4d35-989b-38b4b3896c5d + url: http://via.intercom.io/msgr/342fb18a-251c-41c5-aa97-9d8865d488b7 type: phone_call_redirect schema: "$ref": "#/components/schemas/phone_switch" @@ -8160,14 +8154,6 @@ paths: description: Unauthorized content: application/json: - examples: - Unauthorized: - value: - type: error.list - request_id: f58ce2fc-0597-40a9-b382-b56ad7136b9f - errors: - - code: unauthorized - message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: @@ -8227,7 +8213,7 @@ paths: type: list data: - type: tag - id: '233' + id: '391' name: Manual tag 1 schema: "$ref": "#/components/schemas/tag_list" @@ -8239,7 +8225,7 @@ paths: Unauthorized: value: type: error.list - request_id: c1f67f4c-dba3-4ea1-8708-948385aea56c + request_id: 98e8af5a-e3c7-4ae6-957a-199fc1e7578e errors: - code: unauthorized message: Access Token Invalid @@ -8278,7 +8264,7 @@ paths: Action successful: value: type: tag - id: '236' + id: '394' name: test schema: "$ref": "#/components/schemas/tag" @@ -8290,7 +8276,7 @@ paths: Invalid parameters: value: type: error.list - request_id: 566120e4-3faa-41e4-831d-18b15f25ab67 + request_id: 9b0d95bd-3609-4aef-9592-116e6b857494 errors: - code: parameter_invalid message: invalid tag parameters @@ -8304,14 +8290,14 @@ paths: Company not found: value: type: error.list - request_id: 4ca1e09e-2426-4afd-b28e-37aa6aecd5ae + request_id: 7eb74b1c-da84-4a0a-8441-3e8ce9ac80db 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: f3f04c39-f465-4272-b49d-0b1fe7fb2498 errors: - code: not_found message: User Not Found @@ -8325,7 +8311,7 @@ paths: Unauthorized: value: type: error.list - request_id: e7252229-2232-49d8-909c-40af2df07e33 + request_id: 1f9efeed-f3eb-4361-a8bf-81b6b7ba1761 errors: - code: unauthorized message: Access Token Invalid @@ -8391,7 +8377,7 @@ paths: Tag found: value: type: tag - id: '244' + id: '402' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -8403,7 +8389,7 @@ paths: Tag not found: value: type: error.list - request_id: 4b634d31-4872-4596-a204-7aeb4fdaceee + request_id: 24177c1c-b03e-4139-9e14-ca2f043d25fc errors: - code: not_found message: Resource Not Found @@ -8417,7 +8403,7 @@ paths: Unauthorized: value: type: error.list - request_id: 42de1ba1-7948-48ae-960a-9d08e6994bc7 + request_id: efe505df-afd9-4383-8c5d-2ab67d20aceb errors: - code: unauthorized message: Access Token Invalid @@ -8453,7 +8439,7 @@ paths: Resource not found: value: type: error.list - request_id: f2a31e6c-a632-4d32-a48f-e5201e0b559b + request_id: 88b78953-09ee-4450-9f9d-864c91ee1565 errors: - code: not_found message: Resource Not Found @@ -8467,7 +8453,7 @@ paths: Tag has dependent objects: value: type: error.list - request_id: 896c0b3b-9dab-4ba9-923a-f49185c8d089 + request_id: 41437fa8-3e9b-4935-9a69-d58fbca77901 errors: - code: tag_has_dependent_objects message: 'Unable to delete Tag with dependent objects. Segments: @@ -8482,7 +8468,7 @@ paths: Unauthorized: value: type: error.list - request_id: dc83d712-9e7d-4f68-8d43-52ff9437abbc + request_id: 2e16a6f8-9c99-49ca-98b2-5cc33ee6f162 errors: - code: unauthorized message: Access Token Invalid @@ -8520,7 +8506,7 @@ paths: Unauthorized: value: type: error.list - request_id: 69fb4a8d-5dc6-43ea-9652-b988056bd60d + request_id: 603d83c5-0925-446a-ae40-bdd98e7c626a errors: - code: unauthorized message: Access Token Invalid @@ -8555,7 +8541,7 @@ paths: successful: value: type: team - id: '991268748' + id: '991271235' name: team 1 admin_ids: [] schema: @@ -8568,7 +8554,7 @@ paths: Team not found: value: type: error.list - request_id: aced07c9-581b-4244-83e6-07a9af2df17e + request_id: ecdbd8c6-e2a1-49fe-adb7-9ed77efafdf7 errors: - code: team_not_found message: Team not found @@ -8582,7 +8568,7 @@ paths: Unauthorized: value: type: error.list - request_id: 11a434de-96ed-4d6d-97b3-6a657cceecb1 + request_id: 4b7724ac-7991-408a-98ee-05383a7ee490 errors: - code: unauthorized message: Access Token Invalid @@ -8615,23 +8601,23 @@ paths: Ticket Type Attribute created: value: type: ticket_type_attribute - id: '191' - workspace_id: this_is_an_id559_that_should_be_at_least_ + id: '632' + 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 visible_to_contacts: true default: false - ticket_type_id: 74 + ticket_type_id: 217 archived: false - created_at: 1704903538 - updated_at: 1704903538 + created_at: 1707238728 + updated_at: 1707238728 schema: "$ref": "#/components/schemas/ticket_type_attribute" '401': @@ -8642,7 +8628,7 @@ paths: Unauthorized: value: type: error.list - request_id: 6c7ebe32-755d-4e07-86df-7fa926b4a433 + request_id: b8c97d19-4f91-4c21-9c55-c9c2c9ba2e17 errors: - code: unauthorized message: Access Token Invalid @@ -8695,8 +8681,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: '637' + workspace_id: this_is_an_id580_that_should_be_at_least_ name: name description: New Attribute Description data_type: string @@ -8706,10 +8692,10 @@ paths: visible_on_create: false visible_to_contacts: false default: false - ticket_type_id: 76 + ticket_type_id: 219 archived: false - created_at: 1704903539 - updated_at: 1704903539 + created_at: 1707238729 + updated_at: 1707238729 schema: "$ref": "#/components/schemas/ticket_type_attribute" '401': @@ -8720,7 +8706,7 @@ paths: Unauthorized: value: type: error.list - request_id: bf035ced-c3d1-4b26-9e4d-190528c88d52 + request_id: cf4bb815-60a9-4802-a95d-8f4f860fc36e errors: - code: unauthorized message: Access Token Invalid @@ -8759,21 +8745,39 @@ paths: type: list data: - type: ticket_type - id: '78' + id: '221' 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: 1707238730 + updated_at: 1707238730 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: '640' + 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: 221 + archived: false + created_at: 1707238730 + updated_at: 1707238730 + - type: ticket_type_attribute + id: '642' + workspace_id: this_is_an_id584_that_should_be_at_least_ name: name description: description data_type: string @@ -8784,10 +8788,28 @@ paths: visible_on_create: false visible_to_contacts: false default: false - ticket_type_id: 78 + ticket_type_id: 221 + archived: false + created_at: 1707238730 + updated_at: 1707238730 + - type: ticket_type_attribute + id: '641' + 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: 221 archived: false - created_at: 1704903540 - updated_at: 1704903540 + created_at: 1707238730 + updated_at: 1707238730 category: Customer schema: "$ref": "#/components/schemas/ticket_type_list" @@ -8799,7 +8821,7 @@ paths: Unauthorized: value: type: error.list - request_id: 24bd46fb-8bec-4b00-9c6d-7d2d5867a4f1 + request_id: d12c4467-b994-4216-9419-c3919563b3f5 errors: - code: unauthorized message: Access Token Invalid @@ -8828,18 +8850,54 @@ paths: Ticket type created: value: type: ticket_type - id: '81' + id: '224' 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: 1707238731 + updated_at: 1707238731 is_internal: false ticket_type_attributes: type: list - data: [] + data: + - type: ticket_type_attribute + id: '649' + 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: 224 + archived: false + created_at: 1707238731 + updated_at: 1707238731 + - type: ticket_type_attribute + id: '650' + 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: 224 + archived: false + created_at: 1707238731 + updated_at: 1707238731 category: Customer schema: "$ref": "#/components/schemas/ticket_type" @@ -8851,7 +8909,7 @@ paths: Unauthorized: value: type: error.list - request_id: 972710e6-086e-4954-8a16-27c5b479c1b5 + request_id: ca6373d5-9ab7-4879-a9b7-bfa8ad8f227d errors: - code: unauthorized message: Access Token Invalid @@ -8897,21 +8955,39 @@ paths: Ticket type found: value: type: ticket_type - id: '83' + id: '226' 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: 1707238732 + updated_at: 1707238732 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: '654' + 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: 226 + archived: false + created_at: 1707238732 + updated_at: 1707238732 + - type: ticket_type_attribute + id: '656' + workspace_id: this_is_an_id592_that_should_be_at_least_ name: name description: description data_type: string @@ -8922,10 +8998,28 @@ paths: visible_on_create: false visible_to_contacts: false default: false - ticket_type_id: 83 + ticket_type_id: 226 + archived: false + created_at: 1707238732 + updated_at: 1707238732 + - type: ticket_type_attribute + id: '655' + 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: 226 archived: false - created_at: 1704903542 - updated_at: 1704903542 + created_at: 1707238732 + updated_at: 1707238732 category: Customer schema: "$ref": "#/components/schemas/ticket_type" @@ -8937,7 +9031,7 @@ paths: Unauthorized: value: type: error.list - request_id: fb11155d-673f-4724-9588-6bc63438c77c + request_id: 2f99a01a-b567-47d6-b259-ab156b8f6ae0 errors: - code: unauthorized message: Access Token Invalid @@ -8970,21 +9064,39 @@ paths: Ticket type updated: value: type: ticket_type - id: '85' + id: '228' 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: 1707238733 + updated_at: 1707238734 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: '660' + 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: 228 + archived: false + created_at: 1707238733 + updated_at: 1707238733 + - type: ticket_type_attribute + id: '662' + workspace_id: this_is_an_id596_that_should_be_at_least_ name: name description: description data_type: string @@ -8995,10 +9107,28 @@ paths: visible_on_create: false visible_to_contacts: false default: false - ticket_type_id: 85 + ticket_type_id: 228 + archived: false + created_at: 1707238734 + updated_at: 1707238734 + - type: ticket_type_attribute + id: '661' + 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: 228 archived: false - created_at: 1704903542 - updated_at: 1704903542 + created_at: 1707238734 + updated_at: 1707238734 category: Customer schema: "$ref": "#/components/schemas/ticket_type" @@ -9010,7 +9140,7 @@ paths: Unauthorized: value: type: error.list - request_id: c3cfae69-fab7-42ce-bfb0-2e96ac652c12 + request_id: 6609a9de-1149-47fa-8a0d-e4943424948f errors: - code: unauthorized message: Access Token Invalid @@ -9056,22 +9186,22 @@ paths: User reply: value: type: ticket_part - id: '150' + id: '305' part_type: comment body: "

    Thanks again :)

    " - created_at: 1704903545 - updated_at: 1704903545 + created_at: 1707238736 + updated_at: 1707238736 author: - id: 659ec3796abd01535c22357b + id: 65c2655086ce64a98769c297 type: user name: - email: user28@email.com + email: user30@email.com attachments: [] redacted: false Admin note reply: value: type: ticket_part - id: '152' + id: '307' part_type: note body: |-

    An Unordered HTML List

    @@ -9086,10 +9216,10 @@ paths:
  • Tea
  • Milk
  • - created_at: 1704903548 - updated_at: 1704903548 + created_at: 1707238739 + updated_at: 1707238739 author: - id: '991268775' + id: '991271270' type: admin name: Ciaran360 Lee email: admin360@email.com @@ -9098,12 +9228,12 @@ paths: Admin quick_reply reply: value: type: ticket_part - id: '154' + id: '309' part_type: quick_reply - created_at: 1704903550 - updated_at: 1704903550 + created_at: 1707238742 + updated_at: 1707238742 author: - id: '991268780' + id: '991271275' type: admin name: Ciaran364 Lee email: admin364@email.com @@ -9119,7 +9249,7 @@ paths: Not found: value: type: error.list - request_id: 97039432-9201-433e-a0ec-6640650377d0 + request_id: 56aaf0ff-a6c2-4a31-abb9-f46a51a4f4cc errors: - code: not_found message: Resource Not Found @@ -9133,7 +9263,7 @@ paths: Unauthorized: value: type: error.list - request_id: 55eb06a8-747b-4a3b-9454-cc9c2426d749 + request_id: e256c1eb-c02a-4ce4-8e00-66ad58993522 errors: - code: unauthorized message: Access Token Invalid @@ -9150,14 +9280,14 @@ paths: value: message_type: comment type: user - intercom_user_id: 659ec3796abd01535c22357b + intercom_user_id: 65c2655086ce64a98769c297 body: Thanks again :) admin_note_reply: summary: Admin note reply value: message_type: note type: admin - admin_id: 991268775 + admin_id: 991271270 body: "

    An Unordered HTML List

    An Ordered HTML List

    \
    1. Coffee
    2. Tea
    3. Milk
    @@ -9167,18 +9297,18 @@ paths: value: message_type: quick_reply type: admin - admin_id: 991268780 + admin_id: 991271275 reply_options: - text: 'Yes' - uuid: df4b250e-f84d-458a-b033-96a7a3461f74 + uuid: 3c92c28e-3a58-4024-8a16-a67b32684b58 - text: 'No' - uuid: 2b05e808-65d4-4160-9912-f887b176c6b5 + uuid: 6f780214-22da-4f7f-86bc-0875ed0f33c1 not_found: summary: Not found value: message_type: comment type: user - intercom_user_id: 659ec37f6abd01535c22357e + intercom_user_id: 65c2655786ce64a98769c29a body: Thanks again :) "/tickets/{ticket_id}/tags": post: @@ -9210,7 +9340,7 @@ paths: successful: value: type: tag - id: '252' + id: '410' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -9222,7 +9352,7 @@ paths: Ticket not found: value: type: error.list - request_id: fc5ae743-75df-47d9-bdce-894064b6f139 + request_id: 0f8a887c-2724-4354-9b76-b42b1e01139c errors: - code: ticket_not_found message: Ticket not found @@ -9236,7 +9366,7 @@ paths: Unauthorized: value: type: error.list - request_id: 5a7e7018-18f6-4287-b0b3-69cc375c0682 + request_id: d5b0fa03-6023-4884-983a-6f96134ff8d2 errors: - code: unauthorized message: Access Token Invalid @@ -9265,13 +9395,13 @@ paths: successful: summary: successful value: - id: 252 - admin_id: 991268790 + id: 410 + admin_id: 991271285 ticket_not_found: summary: Ticket not found value: - id: 253 - admin_id: 991268793 + id: 411 + admin_id: 991271288 "/tickets/{ticket_id}/tags/{id}": delete: summary: Remove tag from a ticket @@ -9309,7 +9439,7 @@ paths: successful: value: type: tag - id: '255' + id: '413' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -9321,14 +9451,14 @@ paths: Ticket not found: value: type: error.list - request_id: 14625274-9bef-46d9-a148-651b84e5d8ed + request_id: ad4c3272-19e6-4839-892f-cf27acc74209 errors: - code: ticket_not_found message: Ticket not found Tag not found: value: type: error.list - request_id: fe9f8dd6-29b5-4b63-9d12-1f96063e30e2 + request_id: 4c007421-90a9-4e72-a009-600c9b5c745b errors: - code: tag_not_found message: Tag not found @@ -9342,7 +9472,7 @@ paths: Unauthorized: value: type: error.list - request_id: 83cf554b-c6ba-493b-8fa7-87470e1fc30d + request_id: 00415eaf-50ff-4bb8-a881-049249483e38 errors: - code: unauthorized message: Access Token Invalid @@ -9365,15 +9495,15 @@ paths: successful: summary: successful value: - admin_id: 991268799 + admin_id: 991271294 ticket_not_found: summary: Ticket not found value: - admin_id: 991268802 + admin_id: 991271297 tag_not_found: summary: Tag not found value: - admin_id: 991268805 + admin_id: 991271300 "/tickets": post: summary: Create a ticket @@ -9395,29 +9525,29 @@ paths: Successful response: value: type: ticket - id: '809' - ticket_id: '18' + id: '1400' + ticket_id: '58' ticket_attributes: title: example description: there is a problem ticket_state: submitted ticket_type: type: ticket_type - id: '99' + id: '242' name: my-ticket-type-15 description: my ticket type description is awesome. icon: "\U0001F981" - workspace_id: this_is_an_id607_that_should_be_at_least_ + workspace_id: this_is_an_id624_that_should_be_at_least_ archived: false - created_at: 1704903564 - updated_at: 1704903564 + created_at: 1707238756 + updated_at: 1707238756 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '209' - workspace_id: this_is_an_id607_that_should_be_at_least_ + id: '674' + workspace_id: this_is_an_id624_that_should_be_at_least_ name: title description: ola data_type: string @@ -9428,13 +9558,13 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 99 + ticket_type_id: 242 archived: false - created_at: 1704903564 - updated_at: 1704903564 + created_at: 1707238756 + updated_at: 1707238756 - type: ticket_type_attribute - id: '210' - workspace_id: this_is_an_id607_that_should_be_at_least_ + id: '675' + workspace_id: this_is_an_id624_that_should_be_at_least_ name: description description: ola data_type: string @@ -9445,36 +9575,36 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 99 + ticket_type_id: 242 archived: false - created_at: 1704903564 - updated_at: 1704903564 + created_at: 1707238756 + updated_at: 1707238756 category: Back-office contacts: type: contact.list contacts: - type: contact - id: 659ec38c6abd01535c223586 + id: 65c2656486ce64a98769c2a2 external_id: '70' admin_assignee_id: '0' team_assignee_id: '0' - created_at: 1704903565 - updated_at: 1704903565 + created_at: 1707238756 + updated_at: 1707238757 ticket_parts: type: ticket_part.list ticket_parts: - type: ticket_part - id: '155' + id: '310' part_type: ticket_state_updated_by_admin ticket_state: submitted previous_ticket_state: submitted - created_at: 1704903565 - updated_at: 1704903565 + created_at: 1707238757 + updated_at: 1707238757 author: - id: '991268817' + id: '991271312' type: bot name: Operator - email: operator+this_is_an_id607_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id624_that_should_be_at_least_@intercom.io attachments: [] redacted: false total_count: 1 @@ -9496,7 +9626,7 @@ paths: Unauthorized: value: type: error.list - request_id: 865eb5ae-7f7d-4785-9b2c-f920923305f6 + request_id: 35693178-a4e0-49f9-9ef3-1c7d3d4dbf88 errors: - code: unauthorized message: Access Token Invalid @@ -9511,9 +9641,9 @@ paths: successful_response: summary: Successful response value: - ticket_type_id: 99 + ticket_type_id: 242 contacts: - - id: 659ec38c6abd01535c223586 + - id: 65c2656486ce64a98769c2a2 ticket_attributes: title: example description: there is a problem @@ -9544,29 +9674,29 @@ paths: Successful response: value: type: ticket - id: '810' - ticket_id: '19' + id: '1401' + ticket_id: '59' ticket_attributes: title: example description: there is a problem ticket_state: in_progress ticket_type: type: ticket_type - id: '101' + id: '244' name: my-ticket-type-17 description: my ticket type description is awesome. icon: "\U0001F981" - workspace_id: this_is_an_id611_that_should_be_at_least_ + workspace_id: this_is_an_id628_that_should_be_at_least_ archived: false - created_at: 1704903566 - updated_at: 1704903566 + created_at: 1707238758 + updated_at: 1707238758 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '214' - workspace_id: this_is_an_id611_that_should_be_at_least_ + id: '679' + workspace_id: this_is_an_id628_that_should_be_at_least_ name: title description: ola data_type: string @@ -9577,13 +9707,13 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 101 + ticket_type_id: 244 archived: false - created_at: 1704903566 - updated_at: 1704903566 + created_at: 1707238758 + updated_at: 1707238758 - type: ticket_type_attribute - id: '215' - workspace_id: this_is_an_id611_that_should_be_at_least_ + id: '680' + workspace_id: this_is_an_id628_that_should_be_at_least_ name: description description: ola data_type: string @@ -9594,106 +9724,106 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 101 + ticket_type_id: 244 archived: false - created_at: 1704903566 - updated_at: 1704903566 + created_at: 1707238758 + updated_at: 1707238758 category: Back-office contacts: type: contact.list contacts: - type: contact - id: 659ec38e6abd01535c223587 - external_id: 25cd6dfa-0b1f-4964-a65b-22e6fb3a5d18 - admin_assignee_id: '991268831' + id: 65c2656786ce64a98769c2a3 + external_id: a3407b5f-5bfc-45b1-ad60-133a6cb5aca4 + admin_assignee_id: '991271326' team_assignee_id: '0' - created_at: 1704903566 - updated_at: 1704903569 + created_at: 1707238759 + updated_at: 1707238761 ticket_parts: type: ticket_part.list ticket_parts: - type: ticket_part - id: '156' + id: '311' part_type: ticket_state_updated_by_admin ticket_state: submitted previous_ticket_state: submitted - created_at: 1704903567 - updated_at: 1704903567 + created_at: 1707238759 + updated_at: 1707238759 author: - id: '991268829' + id: '991271324' type: admin name: Ciaran404 Lee email: admin404@email.com attachments: [] redacted: false - type: ticket_part - id: '157' + id: '312' part_type: ticket_attribute_updated_by_admin - created_at: 1704903568 - updated_at: 1704903568 + created_at: 1707238760 + updated_at: 1707238760 author: - id: '991268830' + id: '991271325' type: bot name: Operator - email: operator+this_is_an_id611_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id628_that_should_be_at_least_@intercom.io attachments: [] redacted: false - type: ticket_part - id: '158' + id: '313' part_type: ticket_attribute_updated_by_admin - created_at: 1704903568 - updated_at: 1704903568 + created_at: 1707238760 + updated_at: 1707238760 author: - id: '991268830' + id: '991271325' type: bot name: Operator - email: operator+this_is_an_id611_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id628_that_should_be_at_least_@intercom.io attachments: [] redacted: false - type: ticket_part - id: '159' + id: '314' part_type: ticket_state_updated_by_admin ticket_state: in_progress previous_ticket_state: submitted - created_at: 1704903568 - updated_at: 1704903568 + created_at: 1707238761 + updated_at: 1707238761 author: - id: '991268830' + id: '991271325' type: bot name: Operator - email: operator+this_is_an_id611_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id628_that_should_be_at_least_@intercom.io attachments: [] redacted: false - type: ticket_part - id: '160' + id: '315' part_type: assignment - created_at: 1704903569 - updated_at: 1704903569 + created_at: 1707238761 + updated_at: 1707238761 assigned_to: type: admin - id: '991268831' + id: '991271326' author: - id: '991268829' + id: '991271324' type: admin name: Ciaran404 Lee email: admin404@email.com attachments: [] redacted: false - type: ticket_part - id: '161' + id: '316' part_type: snoozed - created_at: 1704903569 - updated_at: 1704903569 + created_at: 1707238761 + updated_at: 1707238761 author: - id: '991268830' + id: '991271325' type: bot name: Operator - email: operator+this_is_an_id611_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id628_that_should_be_at_least_@intercom.io attachments: [] redacted: false total_count: 6 open: true - snoozed_until: 1704992400 + snoozed_until: 1707325200 linked_objects: type: list data: [] @@ -9711,14 +9841,14 @@ paths: Admin not found: value: type: error.list - request_id: 299bf775-026a-40b9-bb4e-56b137122e49 + request_id: 86d28ae9-ed16-4894-a187-6aa9664b068c errors: - code: assignee_not_found message: Assignee not found Assignee not found: value: type: error.list - request_id: 3b6c3854-c285-46dc-bdb3-715d6a24c0fe + request_id: 6e896494-d76b-40a3-96e4-65bafdd706c4 errors: - code: assignee_not_found message: Assignee not found @@ -9730,7 +9860,7 @@ paths: Unauthorized: value: type: error.list - request_id: a3139c77-df96-47c0-ab4a-bfc347e65668 + request_id: b781c4b7-0bfd-43b5-98d5-ff47c126d9f4 errors: - code: unauthorized message: Access Token Invalid @@ -9750,8 +9880,8 @@ paths: description: there is a problem state: in_progress assignment: - admin_id: '991268829' - assignee_id: '991268831' + admin_id: '991271324' + assignee_id: '991271326' open: true snoozed_until: 1673609604 admin_not_found: @@ -9763,7 +9893,7 @@ paths: state: in_progress assignment: admin_id: '123' - assignee_id: '991268839' + assignee_id: '991271334' assignee_not_found: summary: Assignee not found value: @@ -9772,7 +9902,7 @@ paths: description: there is a problem state: in_progress assignment: - admin_id: '991268845' + admin_id: '991271340' assignee_id: '456' get: summary: Retrieve a ticket @@ -9800,29 +9930,29 @@ paths: Ticket found: value: type: ticket - id: '813' - ticket_id: '22' + id: '1404' + ticket_id: '62' ticket_attributes: title: attribute_value description: ticket_state: submitted ticket_type: type: ticket_type - id: '105' + id: '248' name: my-ticket-type-21 description: my ticket type description is awesome. icon: "\U0001F981" - workspace_id: this_is_an_id619_that_should_be_at_least_ + workspace_id: this_is_an_id636_that_should_be_at_least_ archived: false - created_at: 1704903575 - updated_at: 1704903575 + created_at: 1707238767 + updated_at: 1707238767 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '225' - workspace_id: this_is_an_id619_that_should_be_at_least_ + id: '690' + workspace_id: this_is_an_id636_that_should_be_at_least_ name: title description: ola data_type: string @@ -9833,13 +9963,13 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 105 + ticket_type_id: 248 archived: false - created_at: 1704903575 - updated_at: 1704903575 + created_at: 1707238767 + updated_at: 1707238767 - type: ticket_type_attribute - id: '226' - workspace_id: this_is_an_id619_that_should_be_at_least_ + id: '691' + workspace_id: this_is_an_id636_that_should_be_at_least_ name: description description: ola data_type: string @@ -9850,33 +9980,33 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 105 + ticket_type_id: 248 archived: false - created_at: 1704903575 - updated_at: 1704903575 + created_at: 1707238767 + updated_at: 1707238767 category: Back-office contacts: type: contact.list contacts: - type: contact - id: 659ec3976abd01535c22358a - external_id: 966a9711-673f-40e6-b705-7a57b0d196c2 + id: 65c2656f86ce64a98769c2a6 + external_id: 8675f53d-7796-41b8-aaab-bd795fcddfea admin_assignee_id: '0' team_assignee_id: '0' - created_at: 1704903575 - updated_at: 1704903575 + created_at: 1707238767 + updated_at: 1707238768 ticket_parts: type: ticket_part.list ticket_parts: - type: ticket_part - id: '164' + id: '319' part_type: ticket_state_updated_by_admin ticket_state: submitted previous_ticket_state: submitted - created_at: 1704903575 - updated_at: 1704903575 + created_at: 1707238768 + updated_at: 1707238768 author: - id: '991268858' + id: '991271353' type: admin name: Ciaran430 Lee email: admin430@email.com @@ -9901,7 +10031,7 @@ paths: Unauthorized: value: type: error.list - request_id: c3c357e1-1009-4036-9ce8-92eda82d6686 + request_id: c0bb8678-59ad-444a-948b-1f4508bf92cb errors: - code: unauthorized message: Access Token Invalid @@ -9966,29 +10096,29 @@ paths: total_count: 1 tickets: - type: ticket - id: '814' - ticket_id: '23' + id: '1405' + ticket_id: '63' ticket_attributes: title: attribute_value description: ticket_state: submitted ticket_type: type: ticket_type - id: '107' + id: '250' name: my-ticket-type-23 description: my ticket type description is awesome. icon: "\U0001F981" - workspace_id: this_is_an_id623_that_should_be_at_least_ + workspace_id: this_is_an_id640_that_should_be_at_least_ archived: false - created_at: 1704903577 - updated_at: 1704903577 + created_at: 1707238769 + updated_at: 1707238769 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '230' - workspace_id: this_is_an_id623_that_should_be_at_least_ + id: '695' + workspace_id: this_is_an_id640_that_should_be_at_least_ name: title description: ola data_type: string @@ -9999,13 +10129,13 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 107 + ticket_type_id: 250 archived: false - created_at: 1704903577 - updated_at: 1704903577 + created_at: 1707238769 + updated_at: 1707238769 - type: ticket_type_attribute - id: '231' - workspace_id: this_is_an_id623_that_should_be_at_least_ + id: '696' + workspace_id: this_is_an_id640_that_should_be_at_least_ name: description description: ola data_type: string @@ -10016,33 +10146,33 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 107 + ticket_type_id: 250 archived: false - created_at: 1704903577 - updated_at: 1704903577 + created_at: 1707238770 + updated_at: 1707238770 category: Back-office contacts: type: contact.list contacts: - type: contact - id: 659ec39a6abd01535c22358b - external_id: 2832a34f-3f96-4a33-80f6-aa4103a6751f + id: 65c2657286ce64a98769c2a7 + external_id: 5100250f-a9b1-4626-833e-2cd414aa36e9 admin_assignee_id: '0' team_assignee_id: '0' - created_at: 1704903578 - updated_at: 1704903578 + created_at: 1707238770 + updated_at: 1707238770 ticket_parts: type: ticket_part.list ticket_parts: - type: ticket_part - id: '165' + id: '320' part_type: ticket_state_updated_by_admin ticket_state: submitted previous_ticket_state: submitted - created_at: 1704903578 - updated_at: 1704903578 + created_at: 1707238770 + updated_at: 1707238770 author: - id: '991268871' + id: '991271366' type: admin name: Ciaran442 Lee email: admin442@email.com @@ -10073,15 +10203,15 @@ paths: value: - field: id operator: "=" - value: '814' + value: '1405' - operator: OR value: - field: id operator: "=" - value: '814' + value: '1405' - field: id operator: "=" - value: '814' + value: '1405' "/visitors": put: summary: Update a visitor @@ -10108,26 +10238,26 @@ paths: successful: value: type: visitor - id: 659ec3bd6abd01535c223678 + id: 65c2657486ce64a98769c2aa user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' phone: name: Gareth Bale - pseudonym: Charcoal Camel + pseudonym: Yellow Bottle avatar: type: avatar - image_url: https://static.intercomassets.com/app/pseudonym_avatars_2019/charcoal-camel.png - app_id: this_is_an_id627_that_should_be_at_least_ + image_url: https://static.intercomassets.com/app/pseudonym_avatars_2019/yellow-bottle.png + app_id: this_is_an_id644_that_should_be_at_least_ companies: type: company.list companies: [] location_data: {} last_request_at: - created_at: 1704903613 - remote_created_at: 1704903613 - signed_up_at: 1704903613 - updated_at: 1704903614 + created_at: 1707238772 + remote_created_at: 1707238772 + signed_up_at: 1707238772 + updated_at: 1707238772 session_count: 0 social_profiles: type: social_profile.list @@ -10160,7 +10290,7 @@ paths: visitor Not Found: value: type: error.list - request_id: a44fe8f8-69ac-4934-9c5b-bd6ff6b03e0f + request_id: 1b05720a-caa9-4a31-addd-f68460e26cf5 errors: - code: not_found message: Visitor Not Found @@ -10174,7 +10304,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2055d8a2-aeb1-48a5-867f-b71ac7cf578c + request_id: 6a0633b6-1361-4651-bece-67d1b9af542f errors: - code: unauthorized message: Access Token Invalid @@ -10189,7 +10319,7 @@ paths: successful: summary: successful value: - id: 659ec3bd6abd01535c223678 + id: 65c2657486ce64a98769c2aa name: Gareth Bale visitor_not_found: summary: visitor Not Found @@ -10222,7 +10352,7 @@ paths: successful: value: type: visitor - id: 659ec3bf6abd01535c22367e + id: 65c2657686ce64a98769c2b0 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' @@ -10232,16 +10362,16 @@ paths: avatar: type: avatar image_url: - app_id: this_is_an_id633_that_should_be_at_least_ + app_id: this_is_an_id650_that_should_be_at_least_ companies: type: company.list companies: [] location_data: {} last_request_at: - created_at: 1704903615 - remote_created_at: 1704903615 - signed_up_at: 1704903615 - updated_at: 1704903615 + created_at: 1707238774 + remote_created_at: 1707238774 + signed_up_at: 1707238774 + updated_at: 1707238774 session_count: 0 social_profiles: type: social_profile.list @@ -10274,7 +10404,7 @@ paths: Visitor not found: value: type: error.list - request_id: 29bdd211-042c-4224-bb18-b57b6c21e4bc + request_id: 3584639c-5998-4250-bc3e-0316a289b874 errors: - code: not_found message: Visitor Not Found @@ -10288,7 +10418,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8a3fea3e-a42b-45e0-81a8-0ceb7b4c554b + request_id: '096feba7-1b75-4a9b-83c4-d543b8ac7aa4' errors: - code: unauthorized message: Access Token Invalid @@ -10322,7 +10452,7 @@ paths: successful: value: type: visitor - id: 659ec3c06abd01535c223684 + id: 65c2657786ce64a98769c2b6 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' @@ -10332,16 +10462,16 @@ paths: avatar: type: avatar image_url: - app_id: this_is_an_id639_that_should_be_at_least_ + app_id: this_is_an_id656_that_should_be_at_least_ companies: type: company.list companies: [] location_data: {} last_request_at: - created_at: 1704903617 - remote_created_at: 1704903616 - signed_up_at: 1704903616 - updated_at: 1704903617 + created_at: 1707238775 + remote_created_at: 1707238775 + signed_up_at: 1707238775 + updated_at: 1707238775 session_count: 0 social_profiles: type: social_profile.list @@ -10374,7 +10504,7 @@ paths: Visitor not found: value: type: error.list - request_id: 2294ddc1-6fb3-4ec6-9d49-8bef0f507a2a + request_id: 8b2bf4af-6092-48b8-a157-4b8c0eee191b errors: - code: not_found message: Visitor Not Found @@ -10388,7 +10518,7 @@ paths: Unauthorized: value: type: error.list - request_id: 94a163c2-727c-4524-861a-70ed79684f8e + request_id: b254ac49-12da-46c2-9e10-4fc28a482cb3 errors: - code: unauthorized message: Access Token Invalid @@ -10421,7 +10551,7 @@ paths: successful: value: type: visitor - id: 659ec3c26abd01535c22368a + id: 65c2657886ce64a98769c2bc user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' @@ -10431,16 +10561,16 @@ paths: avatar: type: avatar image_url: - app_id: this_is_an_id645_that_should_be_at_least_ + app_id: this_is_an_id662_that_should_be_at_least_ companies: type: company.list companies: [] location_data: {} last_request_at: - created_at: 1704903618 - remote_created_at: 1704903618 - signed_up_at: 1704903618 - updated_at: 1704903618 + created_at: 1707238776 + remote_created_at: 1707238776 + signed_up_at: 1707238776 + updated_at: 1707238777 session_count: 0 social_profiles: type: social_profile.list @@ -10473,7 +10603,7 @@ paths: Visitor Not Found: value: type: error.list - request_id: e08e9492-df21-4b2a-ac88-81b582e3b05e + request_id: '09ba9e77-6d95-402d-9d61-c1ac508f352f' errors: - code: not_found message: User Not Found @@ -10487,7 +10617,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8f11e3b6-e2db-4995-aee7-778c67974827 + request_id: c0859624-f7a4-417f-89f6-a5ad53e08e0c errors: - code: unauthorized message: Access Token Invalid @@ -10518,8 +10648,8 @@ paths: successful: value: type: contact - id: 659ec3c36abd01535c223691 - workspace_id: this_is_an_id651_that_should_be_at_least_ + id: 65c2657a86ce64a98769c2c3 + workspace_id: this_is_an_id668_that_should_be_at_least_ external_id: role: user email: foo@bar.com @@ -10533,9 +10663,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1704903619 - updated_at: 1704903620 - signed_up_at: 1704903619 + created_at: 1707238778 + updated_at: 1707238778 + signed_up_at: 1707238778 last_seen_at: last_replied_at: last_contacted_at: @@ -10569,31 +10699,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ec3c36abd01535c223691/tags" + url: "/contacts/65c2657a86ce64a98769c2c3/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ec3c36abd01535c223691/notes" + url: "/contacts/65c2657a86ce64a98769c2c3/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ec3c36abd01535c223691/companies" + url: "/contacts/65c2657a86ce64a98769c2c3/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ec3c36abd01535c223691/subscriptions" + url: "/contacts/65c2657a86ce64a98769c2c3/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ec3c36abd01535c223691/subscriptions" + url: "/contacts/65c2657a86ce64a98769c2c3/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -10612,7 +10742,7 @@ paths: Unauthorized: value: type: error.list - request_id: '00990ff7-1294-44b2-9e44-9ac627eff447' + request_id: c1d35c9d-53a3-4cb6-b6fa-e5f57308b73e errors: - code: unauthorized message: Access Token Invalid @@ -13373,7 +13503,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 @@ -13826,30 +13957,6 @@ components: anyOf: - type: string - "$ref": "#/components/schemas/custom_object_instance" - custom_object_instance: - title: Custom Object Instance - type: object - nullable: true - description: An instance of a Custom Object Type. - properties: - id: - type: string - description: The Intercom defined id representing the custom object instance. - example: 5a7a19e9f59ae20001d1c1e6 - external_id: - type: string - description: The id you have defined for the custom object instance. - example: 0001d1c1e65a7a19e9f59ae2 - type: - type: string - description: The identifier of the custom object type that defines the structure - of the custom object instance. - example: Order - custom_attributes: - type: object - description: The custom attributes you have set on the custom object instance. - additionalProperties: - type: string customer_request: type: object nullable: true diff --git a/descriptions/2.7/api.intercom.io.yaml b/descriptions/2.7/api.intercom.io.yaml index ab9bbcd..ecf720e 100644 --- a/descriptions/2.7/api.intercom.io.yaml +++ b/descriptions/2.7/api.intercom.io.yaml @@ -37,7 +37,7 @@ paths: Successful response: value: type: admin - id: '991266804' + id: '991269303' 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: 1704902030 + created_at: 1707237162 secure: false identity_verification: false timezone: America/Los_Angeles @@ -83,7 +83,7 @@ paths: Successful response: value: type: admin - id: '991266805' + id: '991269304' 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: fd61d6f2-3866-4df3-8005-a7ebe665a132 + request_id: c0d64ca2-1725-4b12-8d7b-b1ab3c8c3655 errors: - code: admin_not_found message: Admin for admin_id not found @@ -114,7 +114,7 @@ paths: Unauthorized: value: type: error.list - request_id: c8ff73c2-4779-471c-8d99-6cf85ae4c0db + request_id: 0c7d9f33-cec5-46be-8bd0-8dc09b704891 errors: - code: unauthorized message: Access Token Invalid @@ -201,23 +201,10 @@ paths: per_page: 20 total_pages: 1 activity_logs: - - id: a867bd38-3e48-4ed0-8d21-7d054af6f0cb + - id: 3541e2ec-32ab-41f1-96b8-cf8016f7bd5d performed_by: type: admin - id: '991266809' - email: admin5@email.com - ip: 127.0.0.1 - metadata: - before: before - after: after - created_at: 1704902035 - activity_type: app_name_change - activity_description: Ciaran5 Lee changed your app name from - before to after. - - id: da958499-bed7-411e-8a34-f3b235ef18da - performed_by: - type: admin - id: '991266809' + id: '991269308' 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: 1704902035 + created_at: 1707237167 activity_type: message_state_change activity_description: Ciaran5 Lee changed your Initial message title message from Initial message title to Eventual message title. + - id: c36c0713-be2c-4844-b2fb-85c2141bbbad + performed_by: + type: admin + id: '991269308' + email: admin5@email.com + ip: 127.0.0.1 + metadata: + before: before + after: after + created_at: 1707237167 + 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: e848851c-ed7b-4cc0-836d-9048176e82e3 + request_id: cbe8a997-2357-40a7-9174-83cd52fec13e errors: - code: unauthorized message: Access Token Invalid @@ -271,7 +271,7 @@ paths: admins: - type: admin email: admin7@email.com - id: '991266812' + id: '991269310' name: Ciaran7 Lee away_mode_enabled: false away_mode_reassign: false @@ -287,7 +287,7 @@ paths: Unauthorized: value: type: error.list - request_id: 29ddb6ba-cf80-4cdc-93d2-77559bdf78c6 + request_id: e276cfde-6f27-4229-90a3-1e9e35f7fc70 errors: - code: unauthorized message: Access Token Invalid @@ -321,7 +321,7 @@ paths: Admin found: value: type: admin - id: '991266814' + id: '991269312' 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: 5999609d-9e4c-4b70-ab37-49732393201a + request_id: ed25eb8e-6ea6-4a3e-b11d-a98a029984b8 errors: - code: admin_not_found message: Admin not found @@ -352,7 +352,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9f76b065-f3d5-41ee-b636-9a00a76907f9 + request_id: 5bfb7f48-0056-4a6a-b7cd-1066bb481142 errors: - code: unauthorized message: Access Token Invalid @@ -390,20 +390,20 @@ paths: total_pages: 1 total_count: 1 data: - - id: '35' + - id: '126' type: article workspace_id: this_is_an_id22_that_should_be_at_least_4 - parent_id: 145 + parent_id: 502 parent_type: collection parent_ids: [] title: This is the article title description: '' body: '' - author_id: 991266817 + author_id: 991269315 state: published - created_at: 1704902040 - updated_at: 1704902040 - url: http://help-center.test/myapp-22/en/articles/35-this-is-the-article-title + created_at: 1707237171 + updated_at: 1707237171 + url: http://help-center.test/myapp-22/en/articles/126-this-is-the-article-title schema: "$ref": "#/components/schemas/article_list" '401': @@ -414,7 +414,7 @@ paths: Unauthorized: value: type: error.list - request_id: 78ebd356-53c8-4878-b843-60f6cdf89b2e + request_id: 2499bf3d-c64d-4b6c-832f-cce98ad04827 errors: - code: unauthorized message: Access Token Invalid @@ -439,10 +439,10 @@ paths: examples: article created: value: - id: '38' + id: '129' type: article workspace_id: this_is_an_id26_that_should_be_at_least_4 - parent_id: 147 + parent_id: 504 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: 991266822 + author_id: 991269320 state: published - created_at: 1704902043 - updated_at: 1704902043 - url: http://help-center.test/myapp-26/en/articles/38-thanks-for-everything + created_at: 1707237173 + updated_at: 1707237173 + url: http://help-center.test/myapp-26/en/articles/129-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: 2c809f1d-a543-4593-88dd-50103b0d0970 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: 88b97347-3199-4a85-bd95-f031471d29a4 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: 991269320 state: published - parent_id: 147 + parent_id: 504 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: 991269320 state: published bad_request: summary: Bad Request @@ -550,10 +550,10 @@ paths: examples: Article found: value: - id: '41' + id: '132' type: article workspace_id: this_is_an_id32_that_should_be_at_least_4 - parent_id: 150 + parent_id: 507 parent_type: collection parent_ids: [] statistics: @@ -567,11 +567,11 @@ paths: title: This is the article title description: '' body: '' - author_id: 991266827 + author_id: 991269325 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: 1707237175 + updated_at: 1707237175 + url: http://help-center.test/myapp-32/en/articles/132-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: 11db5fbf-a4fc-4053-ba2e-1654d2e55cb6 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: 5fcc6011-5f01-41e5-be1c-5e07566a9bbe errors: - code: unauthorized message: Access Token Invalid @@ -629,10 +629,10 @@ paths: examples: successful: value: - id: '44' + id: '135' type: article workspace_id: this_is_an_id38_that_should_be_at_least_4 - parent_id: 153 + parent_id: 510 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: 991269331 state: published - created_at: 1704902046 - updated_at: 1704902047 - url: http://help-center.test/myapp-38/en/articles/44-christmas-is-here + created_at: 1707237177 + updated_at: 1707237177 + url: http://help-center.test/myapp-38/en/articles/135-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: 0d1d3e7b-f75b-4479-8635-5d6be8923a5d 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: 948e508f-b893-46f9-9769-ed2120326f2e errors: - code: unauthorized message: Access Token Invalid @@ -723,7 +723,7 @@ paths: examples: successful: value: - id: '47' + id: '138' 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: 216ce2a6-97e9-46db-8e3e-fe94cf4f59c3 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: 26558c22-1429-472a-a6e7-e9e610268f0f errors: - code: unauthorized message: Access Token Invalid @@ -783,16 +783,16 @@ paths: value: type: list data: - - id: '161' + - id: '518' 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: 1707237181 + updated_at: 1707237181 description: english collection description icon: bookmark - help_center_id: 89 + help_center_id: 254 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: 23acddd7-236a-4aef-b153-5141be38ea02 errors: - code: unauthorized message: Access Token Invalid @@ -835,16 +835,16 @@ paths: examples: collection created: value: - id: '167' + id: '524' 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: 1707237182 + updated_at: 1707237182 description: '' icon: book-bookmark - help_center_id: 91 + help_center_id: 256 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: 0b9e989f-f18f-4944-ba9e-6f4bd9d5cf1e 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: fc30fa78-448e-4f7a-b341-07e1a415e8d0 errors: - code: unauthorized message: Access Token Invalid @@ -918,16 +918,16 @@ paths: examples: Collection found: value: - id: '172' + id: '529' 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: 1707237183 + updated_at: 1707237183 description: english collection description icon: bookmark - help_center_id: 94 + help_center_id: 259 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: 8205508b-8d08-4258-8107-88ecb709b8ef 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: 21442874-a985-4d9f-acd0-82f11ad8ff48 errors: - code: unauthorized message: Access Token Invalid @@ -986,16 +986,16 @@ paths: examples: successful: value: - id: '178' + id: '535' 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: 1707237184 + updated_at: 1707237185 description: english collection description icon: folder - help_center_id: 97 + help_center_id: 262 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: 58f99014-a68d-438d-bfce-b078a850bffd 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: fba9d1cd-5fee-4838-ad30-f4f8d5eba0b7 errors: - code: unauthorized message: Access Token Invalid @@ -1068,7 +1068,7 @@ paths: examples: successful: value: - id: '184' + id: '541' 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: 60e128bc-5d40-45c9-b0ef-76e00cf84826 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: fe1cf49c-3d2c-478d-b560-6a5c5e961e91 errors: - code: unauthorized message: Access Token Invalid @@ -1129,10 +1129,10 @@ paths: examples: Collection found: value: - id: '103' + id: '268' workspace_id: this_is_an_id80_that_should_be_at_least_4 - created_at: 1704902058 - updated_at: 1704902058 + created_at: 1707237187 + updated_at: 1707237187 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: 9c3fdd57-fb01-4425-a1a7-bcc4f272ceb8 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: 66a08249-2528-4bbe-b30d-c1a59899dbaf 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: cf69bcb1-8362-4e91-90c9-627bb0b06aad errors: - code: unauthorized message: Access Token Invalid @@ -1230,15 +1230,15 @@ paths: value: type: list data: - - id: '191' + - id: '548' 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: 1707237189 + updated_at: 1707237189 type: section - parent_id: 190 + parent_id: 547 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: 60c2db1a-314b-4063-bbe3-81202e3dcee8 errors: - code: unauthorized message: Access Token Invalid @@ -1280,15 +1280,15 @@ paths: examples: section created: value: - id: '196' + id: '553' 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: 1707237190 + updated_at: 1707237190 type: section - parent_id: '194' + parent_id: '551' 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: acbf9e58-f59b-4a44-9569-65b86b413728 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: 551 "/help_center/sections/{id}": get: summary: Retrieve a section @@ -1344,15 +1344,15 @@ paths: examples: Section found: value: - id: '200' + id: '557' 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: 1707237190 + updated_at: 1707237190 type: section - parent_id: 199 + parent_id: 556 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: 5a53f161-df6a-487f-bd98-29f58bfb1f7e 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: c3ba5998-762a-4f24-868d-f3196ac6e6fc errors: - code: unauthorized message: Access Token Invalid @@ -1410,15 +1410,15 @@ paths: examples: successful: value: - id: '206' + id: '563' 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: 1707237191 + updated_at: 1707237192 type: section - parent_id: '205' + parent_id: '562' 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: 5f20101b-ca33-41c7-ad3f-6d5017ee176a 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: 40c6b04f-16fd-4f70-8828-9a5af43317ae errors: - code: unauthorized message: Access Token Invalid @@ -1459,12 +1459,12 @@ paths: summary: successful value: name: Update section name - parent_id: 205 + parent_id: 562 section_not_found: summary: Section Not Found value: name: Update section name - parent_id: 207 + parent_id: 564 delete: summary: Delete a section parameters: @@ -1491,7 +1491,7 @@ paths: examples: successful: value: - id: '212' + id: '569' 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: 31e304f9-d6a5-486c-94b4-a074027eaccf 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: 54163310-d9d7-41bb-9b6c-cb0950c2429e 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: 65c25f4b86ce64a19de4a1f6 + 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: 1707237195 + updated_at: 1707237195 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: 65bb645a-e2db-4d45-9e08-113301480097 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: 65c25f4c86ce64a19de4a1fe + 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: 1707237196 + created_at: 1707237196 + updated_at: 1707237196 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: 46729687-cb64-4d49-a08b-c37f20afad1c 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: b4063bf9-d140-4d68-9f35-0bd93bdb65b6 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: 65c25f4e86ce64a19de4a209 + app_id: this_is_an_id128_that_should_be_at_least_ + name: company1 + remote_created_at: 1707237198 + created_at: 1707237198 + updated_at: 1707237198 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: a44f9110-958f-4cd7-b8cf-2edbcb7cc824 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: dce0d494-9fe4-453f-96f3-8a10ad34d6a6 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: 65c25f5086ce64a19de4a213 + app_id: this_is_an_id134_that_should_be_at_least_ + name: company2 + remote_created_at: 1707237200 + created_at: 1707237200 + updated_at: 1707237200 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: b4d39c32-580a-4a1d-a8cb-086687742914 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: c36c8355-b2fb-46fd-a3d2-05d6cba0c3a4 errors: - code: unauthorized message: Access Token Invalid @@ -1915,7 +1922,7 @@ paths: examples: Successful: value: - id: 659ebdbc6abd014d2275aada + id: 65c25f5286ce64a19de4a21d 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: 27aeac96-bf16-4043-b65f-2eb931dccbba 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: 4e96bcc0-ea65-487e-8e58-561c22f271ef 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: ebdf96d1-fa57-4f2a-8fa4-f4df57583c02 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: ab133ae1-4b54-4099-938c-c3a03c30a55f 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: f4ed3120-2bd4-4726-b5d7-63edf091c4a9 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: 97075aa7-cddf-4cb2-b5a9-5101d28a7335 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: 65c25f5886ce64a19de4a239 + 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: 1707237208 + created_at: 1707237208 + updated_at: 1707237208 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: 2daad458-6f66-43f2-9ee6-4975149360fe 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: 65c25f5986ce64a19de4a23f + 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: 1707237209 + created_at: 1707237209 + updated_at: 1707237209 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: 6b130a07-5fd1-4674-b970-78635470f3b5 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: f6e2f34f-3ffd-4ae9-a51d-87150c29d8a8 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: 65c25f5b86ce64a19de4a248 + app_id: this_is_an_id166_that_should_be_at_least_ + name: company6 + remote_created_at: 1707237211 + created_at: 1707237211 + updated_at: 1707237211 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: 5da175f4-ec20-40e1-b55c-6023562dbf81 + 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: fe492a91-0458-4f20-b4c3-0646b987df8e 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: a14110c6-cc15-451c-bee8-58d83fc0f800 errors: - code: unauthorized message: Access Token Invalid @@ -2339,11 +2360,14 @@ paths: successful: summary: Successful value: - id: 659ebdc46abd014d2275ab05 + id: 65c25f5b86ce64a19de4a248 + 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: 65c25f6086ce64a19de4a269 + app_id: this_is_an_id182_that_should_be_at_least_ + name: company12 + remote_created_at: 1707237216 + created_at: 1707237216 + updated_at: 1707237216 + last_request_at: 1707064416 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: dfe36097-e7b5-42b0-bb6e-0aab82d3eff8 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: 2e9552f4-8aa6-4c18-97fd-15f984bca670 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: 65c25f5d86ce64a19de4a258 + app_id: this_is_an_id174_that_should_be_at_least_ + name: company8 + remote_created_at: 1707237213 + created_at: 1707237213 + updated_at: 1707237214 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: 93d203e0-3030-4a21-ab99-83f3c16b4fde 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: 2c922ae8-e371-42db-ae2e-e316f9b95394 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: d88bd670-f34d-4a81-a1d1-ebda6cc6db9f errors: - code: unauthorized message: Access Token Invalid @@ -2551,44 +2575,44 @@ paths: type: list data: - type: note - id: '36' - created_at: 1704297298 + id: '88' + created_at: 1706632418 contact: type: contact - id: 659ebdd26abd014d2275ab42 + id: 65c25f6286ce64a19de4a274 author: type: admin - id: '991266914' - name: Ciaran109 Lee - email: admin109@email.com + id: '991269413' + 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: '87' + created_at: 1706546018 contact: type: contact - id: 659ebdd26abd014d2275ab42 + id: 65c25f6286ce64a19de4a274 author: type: admin - id: '991266914' - name: Ciaran109 Lee - email: admin109@email.com + id: '991269413' + 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: '86' + created_at: 1706546018 contact: type: contact - id: 659ebdd26abd014d2275ab42 + id: 65c25f6286ce64a19de4a274 author: type: admin - id: '991266914' - name: Ciaran109 Lee - email: admin109@email.com + id: '991269413' + 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: fcff990b-249f-4a67-9015-8075dd70d178 errors: - code: not_found message: User Not Found @@ -2643,16 +2667,16 @@ paths: Successful response: value: type: note - id: '41' - created_at: 1704902099 + id: '93' + created_at: 1707237219 contact: type: contact - id: 659ebdd36abd014d2275ab44 + id: 65c25f6386ce64a19de4a276 author: type: admin - id: '991266916' - name: Ciaran111 Lee - email: admin111@email.com + id: '991269415' + 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: 1b65442f-2c3b-4805-ba52-df14d876dc8c errors: - code: not_found message: Resource Not Found Contact not found: value: type: error.list - request_id: 317d1247-f1c4-4151-add5-865c9dbe093a + request_id: f734b27d-3e20-4b5b-a4a6-defdc310d6b0 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: 65c25f6386ce64a19de4a276 + admin_id: 991269415 body: Hello admin_not_found: summary: Admin not found value: - contact_id: 659ebdd36abd014d2275ab45 + contact_id: 65c25f6386ce64a19de4a277 admin_id: 123 body: Hello contact_not_found: summary: Contact not found value: contact_id: 123 - admin_id: 991266918 + admin_id: 991269417 body: Hello "/contacts/{contact_id}/segments": get: @@ -2749,10 +2773,10 @@ paths: type: list data: - type: segment - id: 659ebdd46abd014d2275ab47 + id: 65c25f6486ce64a19de4a279 name: segment - created_at: 1704902100 - updated_at: 1704902100 + created_at: 1707237220 + updated_at: 1707237220 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: b1656e3e-851d-4524-9ad5-34c11c3021a0 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: 7679b038-220a-4059-a018-0d3ab7394388 errors: - code: unauthorized message: Access Token Invalid @@ -2822,7 +2846,7 @@ paths: type: list data: - type: subscription - id: '90' + id: '319' state: live consent_type: opt_out default_translation: @@ -2836,7 +2860,7 @@ paths: content_types: - email - type: subscription - id: '92' + id: '321' 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: 0d16f8cc-b848-46b5-a75b-4cda6ee9caca 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: 3cb5a95c-36ac-426a-a1c2-119a4d8e683b errors: - code: unauthorized message: Access Token Invalid @@ -2914,7 +2938,7 @@ paths: Successful: value: type: subscription - id: '105' + id: '334' 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: 33f7eab6-4db0-48ed-9017-69c233a1d1c4 errors: - code: not_found message: User Not Found Resource not found: value: type: error.list - request_id: 58ea20fe-f3d8-4671-99e2-7918efe8c9c5 + request_id: bbbf1475-a62f-47d8-bd2e-4e49f0d1a97b 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: 2ef4de4e-fcef-45a2-864c-93358bcdecd9 errors: - code: unauthorized message: Access Token Invalid @@ -2986,12 +3010,12 @@ paths: successful: summary: Successful value: - id: 105 + id: 334 consent_type: opt_in contact_not_found: summary: Contact not found value: - id: 109 + id: 338 consent_type: opt_in resource_not_found: summary: Resource not found @@ -3037,7 +3061,7 @@ paths: Successful: value: type: subscription - id: '121' + id: '350' 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: 906854cc-f48d-4ef5-824b-447498b1b7be errors: - code: not_found message: User Not Found Resource not found: value: type: error.list - request_id: 3dfc626d-0248-49ff-a9f0-da7f99df22c4 + request_id: 3b509bbb-4d24-438b-b82d-a5b80b3da801 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: e3a1ac17-76f7-4467-9c84-f7c1c80efad4 errors: - code: unauthorized message: Access Token Invalid @@ -3119,7 +3143,7 @@ paths: type: list data: - type: tag - id: '44' + id: '246' 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: fe8c5414-6cbe-4e33-b58f-9756d503e8ac 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: 0c71e894-8749-41b3-b687-8cef2fa0e28a errors: - code: unauthorized message: Access Token Invalid @@ -3180,7 +3204,7 @@ paths: successful: value: type: tag - id: '45' + id: '247' 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: 839513de-b4e2-4c09-b00a-ff3cd3ba6feb errors: - code: not_found message: User Not Found Tag not found: value: type: error.list - request_id: 33dd2502-1527-4e6f-8ca8-d8cd19a90cc0 + request_id: a3116d89-9768-45f0-b328-8297424d446e 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: 017a5b4e-3db8-4232-88e1-859a92fdcf7d errors: - code: unauthorized message: Access Token Invalid @@ -3236,11 +3260,11 @@ paths: successful: summary: successful value: - id: 45 + id: 247 contact_not_found: summary: Contact not found value: - id: 46 + id: 248 tag_not_found: summary: Tag not found value: @@ -3282,7 +3306,7 @@ paths: successful: value: type: tag - id: '48' + id: '250' 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: 16542a19-fa7b-4c3b-9e02-3c378c44200f errors: - code: not_found message: User Not Found Tag not found: value: type: error.list - request_id: 4d9528ce-de2c-4087-8d38-535ee518ecbb + request_id: f772ea8c-8030-42ad-b67f-406cac1f27e3 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: 5e92b7c8-3b3a-4880-ab6e-e3d01785fff9 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: 65c25f6f86ce64a19de4a290 + 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: 1707237231 + updated_at: 1707237231 + signed_up_at: 1707237231 last_seen_at: last_replied_at: last_contacted_at: @@ -3400,31 +3424,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ebde16abd014d2275ab5e/tags" + url: "/contacts/65c25f6f86ce64a19de4a290/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ebde16abd014d2275ab5e/notes" + url: "/contacts/65c25f6f86ce64a19de4a290/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ebde16abd014d2275ab5e/companies" + url: "/contacts/65c25f6f86ce64a19de4a290/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ebde16abd014d2275ab5e/subscriptions" + url: "/contacts/65c25f6f86ce64a19de4a290/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ebde16abd014d2275ab5e/subscriptions" + url: "/contacts/65c25f6f86ce64a19de4a290/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: 0aa95bd8-8563-4815-92b8-802db7c1d038 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: 65c25f7086ce64a19de4a291 + 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: 1707237232 + updated_at: 1707237232 + signed_up_at: 1707237232 last_seen_at: last_replied_at: last_contacted_at: @@ -3539,31 +3563,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ebde26abd014d2275ab5f/tags" + url: "/contacts/65c25f7086ce64a19de4a291/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ebde26abd014d2275ab5f/notes" + url: "/contacts/65c25f7086ce64a19de4a291/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ebde26abd014d2275ab5f/companies" + url: "/contacts/65c25f7086ce64a19de4a291/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ebde26abd014d2275ab5f/subscriptions" + url: "/contacts/65c25f7086ce64a19de4a291/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ebde26abd014d2275ab5f/subscriptions" + url: "/contacts/65c25f7086ce64a19de4a291/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: 606c243a-cdc2-4c5a-a44d-92e4192e035d errors: - code: unauthorized message: Access Token Invalid @@ -3613,7 +3637,7 @@ paths: examples: successful: value: - id: 659ebde36abd014d2275ab60 + id: 65c25f7186ce64a19de4a292 object: contact deleted: true schema: @@ -3626,7 +3650,7 @@ paths: Unauthorized: value: type: error.list - request_id: c1fb0e55-1e5a-40e9-a0e7-ee3c8c08dd1e + request_id: 54067427-2af4-4ca1-a787-86a40c766698 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: 65c25f7286ce64a19de4a294 + 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: 1707237234 + updated_at: 1707237234 + signed_up_at: 1707237234 last_seen_at: last_replied_at: last_contacted_at: @@ -3705,31 +3729,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ebde46abd014d2275ab62/tags" + url: "/contacts/65c25f7286ce64a19de4a294/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ebde46abd014d2275ab62/notes" + url: "/contacts/65c25f7286ce64a19de4a294/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ebde46abd014d2275ab62/companies" + url: "/contacts/65c25f7286ce64a19de4a294/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ebde46abd014d2275ab62/subscriptions" + url: "/contacts/65c25f7286ce64a19de4a294/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ebde46abd014d2275ab62/subscriptions" + url: "/contacts/65c25f7286ce64a19de4a294/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: 0ad52727-d1d8-40d2-bbd4-e370c7495878 errors: - code: unauthorized message: Access Token Invalid @@ -3763,8 +3787,8 @@ paths: successful: summary: successful value: - from: 659ebde46abd014d2275ab61 - into: 659ebde46abd014d2275ab62 + from: 65c25f7286ce64a19de4a293 + into: 65c25f7286ce64a19de4a294 "/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: c02fc528-3eb4-4232-b880-b32ec118422f errors: - code: unauthorized message: Access Token Invalid @@ -3893,15 +3917,15 @@ paths: value: - field: id operator: "=" - value: 659ebde56abd014d2275ab65 + value: 65c25f7386ce64a19de4a297 - operator: OR value: - field: id operator: "=" - value: 659ebde56abd014d2275ab65 + value: 65c25f7386ce64a19de4a297 - field: id operator: "=" - value: 659ebde56abd014d2275ab65 + value: 65c25f7386ce64a19de4a297 "/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: a731833e-deb7-48b2-af0d-faa9673ca1cc 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: 65c25f7686ce64a19de4a299 + 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: 1707237238 + updated_at: 1707237238 signed_up_at: last_seen_at: last_replied_at: @@ -4017,31 +4041,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ebde76abd014d2275ab67/tags" + url: "/contacts/65c25f7686ce64a19de4a299/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ebde76abd014d2275ab67/notes" + url: "/contacts/65c25f7686ce64a19de4a299/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ebde76abd014d2275ab67/companies" + url: "/contacts/65c25f7686ce64a19de4a299/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ebde76abd014d2275ab67/subscriptions" + url: "/contacts/65c25f7686ce64a19de4a299/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ebde76abd014d2275ab67/subscriptions" + url: "/contacts/65c25f7686ce64a19de4a299/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: 7e7dbb59-3096-4533-aaa2-3487632816ed errors: - code: unauthorized message: Access Token Invalid @@ -4104,7 +4128,7 @@ paths: examples: successful: value: - id: 659ebde86abd014d2275ab68 + id: 65c25f7786ce64a19de4a29a object: contact archived: true schema: @@ -4136,7 +4160,7 @@ paths: examples: successful: value: - id: 659ebde86abd014d2275ab69 + id: 65c25f7786ce64a19de4a29b object: contact archived: false schema: @@ -4171,7 +4195,7 @@ paths: successful: value: type: tag - id: '50' + id: '252' 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: 6891463d-06f2-4c26-a9af-1f58b0866a43 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: a6251ad6-647d-4c90-9d9f-3794363c6e5e errors: - code: unauthorized message: Access Token Invalid @@ -4226,13 +4250,13 @@ paths: successful: summary: successful value: - id: 50 - admin_id: 991266949 + id: 252 + admin_id: 991269448 conversation_not_found: summary: Conversation not found value: - id: 51 - admin_id: 991266951 + id: 253 + admin_id: 991269450 "/conversations/{conversation_id}/tags/{id}": delete: summary: Remove tag from a conversation @@ -4270,7 +4294,7 @@ paths: successful: value: type: tag - id: '53' + id: '255' 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: f205c7a7-f841-41d7-9bae-e1eca17c4ec3 errors: - code: not_found message: Conversation not found Tag not found: value: type: error.list - request_id: e4cf4851-1587-4750-b163-eac34d6bf9f5 + request_id: 9489e343-a25f-4a10-a15f-53f188e2283a 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: d90a0f0b-aaa6-41a8-8706-42ba075b2b82 errors: - code: unauthorized message: Access Token Invalid @@ -4326,15 +4350,15 @@ paths: successful: summary: successful value: - admin_id: 991266953 + admin_id: 991269452 conversation_not_found: summary: Conversation not found value: - admin_id: 991266955 + admin_id: 991269454 tag_not_found: summary: Tag not found value: - admin_id: 991266956 + admin_id: 991269455 "/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: '840' + created_at: 1707237246 + updated_at: 1707237246 waiting_since: snoozed_until: source: type: conversation - id: '403918184' + id: '403918556' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991266959' - name: Ciaran151 Lee - email: admin151@email.com + id: '991269458' + 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: 65c25f7e86ce64a19de4a29f 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: 26910482-7495-49e9-a46c-bfcbe567f067 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: 9394b608-3f68-4e66-b2d9-a817117b2993 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: '403918566' + created_at: 1707237264 body: Hello there message_type: inapp - conversation_id: '230' + conversation_id: '865' 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: 04be8c12-3496-4001-88b6-b8782b4c01bc 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: 25b4fc3b-3460-4ab2-b082-32d2b40dec6b 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: 302070af-ad96-4fea-84ff-2571bd58f13f errors: - code: api_plan_restricted message: Active subscription needed. @@ -4538,7 +4562,7 @@ paths: value: from: type: user - id: 659ebe066abd014d2275ab82 + id: 65c25f8f86ce64a19de4a2b4 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: '869' + created_at: 1707237269 + updated_at: 1707237269 waiting_since: snoozed_until: source: type: conversation - id: '403918198' + id: '403918570' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991266973' - name: Ciaran158 Lee - email: admin158@email.com + id: '991269472' + 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: 65c25f9586ce64a19de4a2b8 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: aada325d-b6f1-4a17-b1da-6cdd2650ea02 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: 8611f8ff-ae92-4c9b-8550-44c4c4ec47c9 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: 6c44c871-63c3-4c50-851c-b0864d12dc9e 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: '873' + created_at: 1707237275 + updated_at: 1707237277 waiting_since: snoozed_until: source: type: conversation - id: '403918202' + id: '403918574' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991266981' - name: Ciaran162 Lee - email: admin162@email.com + id: '991269480' + 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: 65c25f9b86ce64a19de4a2bc 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: '195' part_type: conversation_attribute_updated_by_admin body: - created_at: 1704902162 - updated_at: 1704902162 - notified_at: 1704902162 + created_at: 1707237277 + updated_at: 1707237277 + notified_at: 1707237277 assigned_to: author: - id: '991266982' + id: '991269481' 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: '196' part_type: conversation_attribute_updated_by_admin body: - created_at: 1704902162 - updated_at: 1704902162 - notified_at: 1704902162 + created_at: 1707237277 + updated_at: 1707237277 + notified_at: 1707237277 assigned_to: author: - id: '991266982' + id: '991269481' 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: 16f915d2-d0c8-491b-babc-7d742fdb20e7 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: 8a6bd90e-83bb-421b-b5d1-af7bf2e6509c 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: 1e098c52-a1de-4d08-8d26-fa34330d2346 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: '880' + created_at: 1707237289 + updated_at: 1707237289 waiting_since: snoozed_until: source: type: conversation - id: '403918209' + id: '403918581' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991267011' - name: Ciaran185 Lee - email: admin185@email.com + id: '991269510' + 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: 65c25fa886ce64a19de4a2c3 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5009,15 +5033,15 @@ paths: value: - field: id operator: "=" - value: '245' + value: '880' - operator: OR value: - field: id operator: "=" - value: '245' + value: '880' - field: id operator: "=" - value: '245' + value: '880' "/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: '888' + created_at: 1707237295 + updated_at: 1707237296 + waiting_since: 1707237296 snoozed_until: source: type: conversation - id: '403918212' + id: '403918584' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991267013' - name: Ciaran186 Lee - email: admin186@email.com + id: '991269512' + 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: 65c25faf86ce64a19de4a2ca first_contact_reply: - created_at: 1704902183 + created_at: 1707237296 type: conversation url: admin_assignee_id: @@ -5104,15 +5128,15 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '39' + id: '198' part_type: open body: "

    Thanks again :)

    " - created_at: 1704902183 - updated_at: 1704902183 - notified_at: 1704902183 + created_at: 1707237296 + updated_at: 1707237296 + notified_at: 1707237296 assigned_to: author: - id: 659ebe256abd014d2275ab98 + id: 65c25faf86ce64a19de4a2ca 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: '889' + created_at: 1707237297 + updated_at: 1707237297 waiting_since: snoozed_until: source: type: conversation - id: '403918213' + id: '403918585' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991267015' - name: Ciaran187 Lee - email: admin187@email.com + id: '991269514' + 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: 65c25fb086ce64a19de4a2cb 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: '199' part_type: note body: |-

    An Unordered HTML List

    @@ -5183,15 +5207,15 @@ paths:
  • Tea
  • Milk
  • - created_at: 1704902185 - updated_at: 1704902185 - notified_at: 1704902185 + created_at: 1707237297 + updated_at: 1707237297 + notified_at: 1707237297 assigned_to: author: - id: '991267015' + id: '991269514' type: admin - name: Ciaran187 Lee - email: admin187@email.com + name: Ciaran188 Lee + email: admin188@email.com attachments: [] external_id: redacted: false @@ -5199,22 +5223,22 @@ paths: User last conversation reply: value: type: conversation - id: '256' - created_at: 1704902187 - updated_at: 1704902188 - waiting_since: 1704902188 + id: '891' + created_at: 1707237299 + updated_at: 1707237300 + waiting_since: 1707237300 snoozed_until: source: type: conversation - id: '403918215' + id: '403918587' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991267019' - name: Ciaran189 Lee - email: admin189@email.com + id: '991269518' + 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: 65c25fb386ce64a19de4a2cd first_contact_reply: - created_at: 1704902188 + created_at: 1707237300 type: conversation url: admin_assignee_id: @@ -5247,15 +5271,15 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '41' + id: '200' part_type: open body: "

    Thanks again :)

    " - created_at: 1704902188 - updated_at: 1704902188 - notified_at: 1704902188 + created_at: 1707237300 + updated_at: 1707237300 + notified_at: 1707237300 assigned_to: author: - id: 659ebe2b6abd014d2275ab9b + id: 65c25fb386ce64a19de4a2cd 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: 7d406334-787a-42ac-9011-e79d5393c95a 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: 40a7ee2b-0bf6-4c11-8744-a8428e737a2c 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: 2e199929-b796-42df-8fc9-5b8f7a49bb95 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: 65c25faf86ce64a19de4a2ca body: Thanks again :) admin_note_reply: summary: Admin note reply value: message_type: note type: admin - admin_id: 991267015 + admin_id: 991269514 body: "

    An Unordered HTML List

    An Ordered HTML List

    \
    1. Coffee
    2. Tea
    3. Milk
    @@ -5335,14 +5359,14 @@ paths: value: message_type: comment type: user - intercom_user_id: 659ebe2b6abd014d2275ab9b + intercom_user_id: 65c25fb386ce64a19de4a2cd body: Thanks again :) not_found: summary: Not found value: message_type: comment type: user - intercom_user_id: 659ebe2d6abd014d2275ab9c + intercom_user_id: 65c25fb586ce64a19de4a2ce body: Thanks again :) "/conversations/{id}/parts": post: @@ -5376,22 +5400,22 @@ paths: Close a conversation: value: type: conversation - id: '260' - created_at: 1704902195 - updated_at: 1704902196 + id: '895' + created_at: 1707237305 + updated_at: 1707237306 waiting_since: snoozed_until: source: type: conversation - id: '403918219' + id: '403918591' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991267027' - name: Ciaran193 Lee - email: admin193@email.com + id: '991269526' + 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: 65c25fb986ce64a19de4a2d1 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: '201' part_type: close body: "

    Goodbye :)

    " - created_at: 1704902196 - updated_at: 1704902196 - notified_at: 1704902196 + created_at: 1707237306 + updated_at: 1707237306 + notified_at: 1707237306 assigned_to: author: - id: '991267027' + id: '991269526' 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: '896' + created_at: 1707237307 + updated_at: 1707237307 waiting_since: - snoozed_until: 1704905797 + snoozed_until: source: type: conversation - id: '403918220' + id: '403918592' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991267029' - name: Ciaran194 Lee - email: admin194@email.com + id: '991269528' + name: Ciaran195 Lee + email: admin195@email.com attachments: [] url: redacted: false @@ -5463,12 +5487,12 @@ paths: type: contact.list contacts: - type: contact - id: 659ebe346abd014d2275aba0 + id: 65c25fbb86ce64a19de4a2d2 first_contact_reply: admin_assignee_id: team_assignee_id: - open: true - state: snoozed + open: false + state: closed read: false tags: type: tag.list @@ -5483,43 +5507,27 @@ paths: topics: {} conversation_parts: type: conversation_part.list - conversation_parts: - - type: conversation_part - id: '43' - part_type: snoozed - body: - created_at: 1704902197 - updated_at: 1704902197 - notified_at: 1704902197 - assigned_to: - author: - id: '991267029' - type: admin - name: Ciaran194 Lee - email: admin194@email.com - attachments: [] - external_id: - redacted: false - total_count: 1 + conversation_parts: [] + total_count: 0 Open a conversation: value: type: conversation - id: '266' - created_at: 1704902196 - updated_at: 1704902207 + id: '901' + created_at: 1707237306 + updated_at: 1707237315 waiting_since: snoozed_until: source: type: conversation - id: '403918221' + id: '403918593' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991267031' - name: Ciaran195 Lee - email: admin195@email.com + id: '991269530' + name: Ciaran196 Lee + email: admin196@email.com attachments: [] url: redacted: false @@ -5527,7 +5535,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ebe3a6abd014d2275aba5 + id: 65c25fbf86ce64a19de4a2d7 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5549,18 +5557,18 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '45' + id: '203' part_type: open body: - created_at: 1704902207 - updated_at: 1704902207 - notified_at: 1704902207 + created_at: 1707237315 + updated_at: 1707237315 + notified_at: 1707237315 assigned_to: author: - id: '991267031' + id: '991269530' type: admin - name: Ciaran195 Lee - email: admin195@email.com + name: Ciaran196 Lee + email: admin196@email.com attachments: [] external_id: redacted: false @@ -5568,22 +5576,22 @@ paths: Assign a conversation: value: type: conversation - id: '270' - created_at: 1704902208 - updated_at: 1704902209 + id: '905' + created_at: 1707237316 + updated_at: 1707237317 waiting_since: snoozed_until: source: type: conversation - id: '403918224' + id: '403918596' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991267033' - name: Ciaran196 Lee - email: admin196@email.com + id: '991269532' + name: Ciaran197 Lee + email: admin197@email.com attachments: [] url: redacted: false @@ -5591,9 +5599,9 @@ paths: type: contact.list contacts: - type: contact - id: 659ebe406abd014d2275aba8 + id: 65c25fc486ce64a19de4a2da first_contact_reply: - admin_assignee_id: 991267033 + admin_assignee_id: 991269532 team_assignee_id: open: true state: open @@ -5613,20 +5621,20 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '46' + id: '204' part_type: assign_and_reopen body: - created_at: 1704902209 - updated_at: 1704902209 - notified_at: 1704902209 + created_at: 1707237317 + updated_at: 1707237317 + notified_at: 1707237317 assigned_to: type: admin - id: '991267033' + id: '991269532' author: - id: '991267033' + id: '991269532' type: admin - name: Ciaran196 Lee - email: admin196@email.com + name: Ciaran197 Lee + email: admin197@email.com attachments: [] external_id: redacted: false @@ -5641,7 +5649,7 @@ paths: Not found: value: type: error.list - request_id: 51df0dd7-7e67-49f8-8a6c-dbcdd505ed91 + request_id: ce6ab8b6-90e8-4507-b727-707b6e8de132 errors: - code: not_found message: Resource Not Found @@ -5655,7 +5663,7 @@ paths: Unauthorized: value: type: error.list - request_id: 48b2b545-88ab-4dd0-9176-728c47114999 + request_id: d0c5d0b5-1fac-45fc-bd3d-7e7125685e1e errors: - code: unauthorized message: Access Token Invalid @@ -5669,7 +5677,7 @@ paths: API plan restricted: value: type: error.list - request_id: fe540041-7382-4539-a1e2-00a3146af631 + request_id: '04500798-4e12-4fa0-8940-b37e9ecdebdc' errors: - code: api_plan_restricted message: Active subscription needed. @@ -5690,32 +5698,32 @@ paths: value: message_type: close type: admin - admin_id: 991267027 + admin_id: 991269526 body: Goodbye :) snooze_a_conversation: summary: Snooze a conversation value: message_type: snoozed - admin_id: 991267029 - snoozed_until: 1704905797 + admin_id: 991269528 + snoozed_until: 1707240908 open_a_conversation: summary: Open a conversation value: message_type: open - admin_id: 991267031 + admin_id: 991269530 assign_a_conversation: summary: Assign a conversation value: message_type: assignment type: admin - admin_id: 991267033 - assignee_id: 991267033 + admin_id: 991269532 + assignee_id: 991269532 not_found: summary: Not found value: message_type: close type: admin - admin_id: 991267035 + admin_id: 991269534 body: Goodbye :) "/conversations/{id}/run_assignment_rules": post: @@ -5746,22 +5754,22 @@ paths: Assign a conversation using assignment rules: value: type: conversation - id: '274' - created_at: 1704902215 - updated_at: 1704902216 + id: '909' + created_at: 1707237323 + updated_at: 1707237325 waiting_since: snoozed_until: source: type: conversation - id: '403918228' + id: '403918600' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991267041' - name: Ciaran200 Lee - email: admin200@email.com + id: '991269540' + name: Ciaran201 Lee + email: admin201@email.com attachments: [] url: redacted: false @@ -5769,7 +5777,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ebe476abd014d2275abac + id: 65c25fcb86ce64a19de4a2de first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5791,20 +5799,20 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '47' + id: '205' part_type: default_assignment body: - created_at: 1704902216 - updated_at: 1704902216 - notified_at: 1704902216 + created_at: 1707237325 + updated_at: 1707237325 + notified_at: 1707237325 assigned_to: type: nobody_admin id: author: - id: '991267042' + id: '991269541' 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 +5827,7 @@ paths: Not found: value: type: error.list - request_id: 8eb4fba0-6fe6-4d61-b1b6-3fd17808f0f2 + request_id: 7927434f-7239-41f6-980d-c439bda1d0e2 errors: - code: not_found message: Resource Not Found @@ -5833,7 +5841,7 @@ paths: Unauthorized: value: type: error.list - request_id: 10bb192b-9490-40a3-a435-39a61d97ae26 + request_id: 6db6ce76-3068-47d8-b5d9-d610cfc8b40d errors: - code: unauthorized message: Access Token Invalid @@ -5847,7 +5855,7 @@ paths: API plan restricted: value: type: error.list - request_id: 485b0484-0d2b-4ffd-9b47-4e403f285606 + request_id: c1beeef7-23cf-4f4c-bd27-ed4d8095b6ae errors: - code: api_plan_restricted message: Active subscription needed. @@ -5886,7 +5894,7 @@ paths: value: customers: - type: user - id: 659ebe4d6abd014d2275abb0 + id: 65c25fd286ce64a19de4a2e2 schema: "$ref": "#/components/schemas/conversation" '404': @@ -5897,7 +5905,7 @@ paths: Not found: value: type: error.list - request_id: ca0ec060-8ca2-402e-9567-dd5bedded1e3 + request_id: 73e38948-5594-49fe-b9eb-539145f75f5a errors: - code: not_found message: Resource Not Found @@ -5911,7 +5919,7 @@ paths: Unauthorized: value: type: error.list - request_id: aa796a88-e9a5-4f4e-bc20-4df4435b585a + request_id: dbc317a7-3a07-460f-bedf-9bfc3d8d26f7 errors: - code: unauthorized message: Access Token Invalid @@ -5925,7 +5933,7 @@ paths: API plan restricted: value: type: error.list - request_id: 6d01231a-9e5e-41d5-b1c2-34ceddf76992 + request_id: a0243474-919f-4427-89a0-3c1d2d03ba92 errors: - code: api_plan_restricted message: Active subscription needed. @@ -5940,15 +5948,15 @@ paths: attach_a_contact_to_a_conversation: summary: Attach a contact to a conversation value: - admin_id: 991267049 + admin_id: 991269548 customer: - intercom_user_id: 659ebe4d6abd014d2275abb0 + intercom_user_id: 65c25fd286ce64a19de4a2e2 not_found: summary: Not found value: - admin_id: 991267051 + admin_id: 991269550 customer: - intercom_user_id: 659ebe4f6abd014d2275abb1 + intercom_user_id: 65c25fd486ce64a19de4a2e3 "/conversations/{conversation_id}/customers/{contact_id}": delete: summary: Detach a contact from a group conversation @@ -5989,7 +5997,7 @@ paths: value: customers: - type: user - id: 659ebe5d6abd014d2275abbb + id: 65c25fdf86ce64a19de4a2ed schema: "$ref": "#/components/schemas/conversation" '404': @@ -6000,14 +6008,14 @@ paths: Conversation not found: value: type: error.list - request_id: 840d17c5-b0c9-4440-9a72-86c6df3c7e9a + request_id: 47291bfe-64a4-4bbc-a2b5-7418b39ba52b errors: - code: not_found message: Resource Not Found Contact not found: value: type: error.list - request_id: '01963e78-781b-442a-91df-84d0865312b7' + request_id: f3bc9f4f-fdfa-4964-89d0-1146e267eecc errors: - code: not_found message: User Not Found @@ -6021,7 +6029,7 @@ paths: Last customer: value: type: error.list - request_id: b30d8c10-a21d-4fc8-bcdb-8bdfc64f0d6b + request_id: ad62886e-ffc1-4375-8f67-00cad4037d1c errors: - code: parameter_invalid message: Removing the last customer is not allowed @@ -6035,7 +6043,7 @@ paths: Unauthorized: value: type: error.list - request_id: 49e36e56-8e0c-401c-9bad-9abd319a4791 + request_id: e5a12bca-bc8e-4485-b3ae-2cb6a759fc1e errors: - code: unauthorized message: Access Token Invalid @@ -6049,7 +6057,7 @@ paths: API plan restricted: value: type: error.list - request_id: bc05bcff-2601-4817-8b3e-1edeb1ca6cb6 + request_id: c8d745ed-c387-4ce8-9e83-e82b2f830f91 errors: - code: api_plan_restricted message: Active subscription needed. @@ -6064,27 +6072,27 @@ paths: detach_a_contact_from_a_group_conversation: summary: Detach a contact from a group conversation value: - admin_id: 991267057 + admin_id: 991269556 customer: - intercom_user_id: 659ebe546abd014d2275abb4 + intercom_user_id: 65c25fd986ce64a19de4a2e6 conversation_not_found: summary: Conversation not found value: - admin_id: 991267059 + admin_id: 991269558 customer: - intercom_user_id: 659ebe5e6abd014d2275abbc + intercom_user_id: 65c25fe186ce64a19de4a2ee contact_not_found: summary: Contact not found value: - admin_id: 991267061 + admin_id: 991269560 customer: - intercom_user_id: 659ebe676abd014d2275abc3 + intercom_user_id: 65c25fe786ce64a19de4a2f5 last_customer: summary: Last customer value: - admin_id: 991267063 + admin_id: 991269562 customer: - intercom_user_id: 659ebe6f6abd014d2275abca + intercom_user_id: 65c25ff086ce64a19de4a2fc "/conversations/redact": post: summary: Redact a conversation part @@ -6111,22 +6119,22 @@ paths: Redact a conversation part: value: type: conversation - id: '330' - created_at: 1704902277 - updated_at: 1704902278 - waiting_since: 1704902277 + id: '965' + created_at: 1707237383 + updated_at: 1707237385 + waiting_since: 1707237383 snoozed_until: source: type: conversation - id: '403918254' + id: '403918626' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991267069' - name: Ciaran214 Lee - email: admin214@email.com + id: '991269568' + name: Ciaran215 Lee + email: admin215@email.com attachments: [] url: redacted: false @@ -6134,9 +6142,9 @@ paths: type: contact.list contacts: - type: contact - id: 659ebe856abd014d2275abdf + id: 65c2600686ce64a19de4a311 first_contact_reply: - created_at: 1704902277 + created_at: 1707237383 type: conversation url: admin_assignee_id: @@ -6159,15 +6167,15 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '55' + id: '213' part_type: open body: "

    This message was deleted

    " - created_at: 1704902277 - updated_at: 1704902278 - notified_at: 1704902277 + created_at: 1707237383 + updated_at: 1707237384 + notified_at: 1707237383 assigned_to: author: - id: 659ebe856abd014d2275abdf + id: 65c2600686ce64a19de4a311 type: user name: Joe Bloggs email: joe@bloggs.com @@ -6185,7 +6193,7 @@ paths: Not found: value: type: error.list - request_id: 1d0015d0-25f2-43e4-adff-f014f6499cae + request_id: a4e8859f-2954-4eed-b371-aaa9783d907d errors: - code: conversation_part_or_message_not_found message: Conversation part or message not found @@ -6199,7 +6207,7 @@ paths: Unauthorized: value: type: error.list - request_id: ce0fb3c4-4b09-424c-b6ba-88261dc36247 + request_id: f1f9a4e0-7dd0-4a39-a62f-7318656dcf19 errors: - code: unauthorized message: Access Token Invalid @@ -6215,8 +6223,8 @@ paths: summary: Redact a conversation part value: type: conversation_part - conversation_id: 330 - conversation_part_id: 55 + conversation_id: 965 + conversation_part_id: 213 not_found: summary: Not found value: @@ -6392,7 +6400,7 @@ paths: custom: false archived: false model: company - - id: 38 + - id: 84 type: data_attribute name: The One Ring full_name: custom_attributes.The One Ring @@ -6404,9 +6412,9 @@ paths: ui_writable: false custom: true archived: false - admin_id: '991267085' - created_at: 1704902286 - updated_at: 1704902286 + admin_id: '991269593' + created_at: 1707237397 + updated_at: 1707237397 model: company - type: data_attribute name: id @@ -6473,7 +6481,7 @@ paths: Unauthorized: value: type: error.list - request_id: 5064dad4-eef1-4c6e-8758-e650fbfa1b6b + request_id: c1a3033f-eee7-427f-8e41-fe44d0827a14 errors: - code: unauthorized message: Access Token Invalid @@ -6498,7 +6506,7 @@ paths: examples: Successful: value: - id: 41 + id: 87 type: data_attribute name: Mithril Shirt full_name: custom_attributes.Mithril Shirt @@ -6508,9 +6516,9 @@ paths: ui_writable: false custom: true archived: false - admin_id: '991267087' - created_at: 1704902287 - updated_at: 1704902287 + admin_id: '991269595' + created_at: 1707237398 + updated_at: 1707237398 model: company schema: "$ref": "#/components/schemas/data_attribute" @@ -6522,7 +6530,7 @@ paths: Same name already exists: value: type: error.list - request_id: b860f3f9-4e50-47f4-a0c3-706185cbd0d9 + request_id: c4332c2d-f6e5-4e86-8698-9ba6f5fb1ddf errors: - code: parameter_invalid message: You already have 'The One Ring' in your company data. @@ -6530,7 +6538,7 @@ paths: Invalid name: value: type: error.list - request_id: 390a0c95-1429-47bc-9b80-c7226d3bcc4d + request_id: 9e29653f-dcc1-414b-bcea-04367a81f6ae errors: - code: parameter_invalid message: Your name for this attribute must only contain alphanumeric @@ -6538,7 +6546,7 @@ paths: Attribute already exists: value: type: error.list - request_id: f90f7a7b-3543-471b-ac9e-11ef393774f0 + request_id: ac3b1517-d598-4fa4-b084-5eadf8af337f errors: - code: parameter_invalid message: You already have 'The One Ring' in your company data. @@ -6546,14 +6554,14 @@ paths: Invalid Data Type: value: type: error.list - request_id: fd5530d5-0406-4ca8-8b36-43ee0bf3ed97 + request_id: 3024e9f6-7c68-4a65-a67f-35dbd2f54f9e 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: a31b0c60-6935-4791-baae-adbb0e467935 errors: - code: parameter_invalid message: The Data Attribute model field must be either contact @@ -6568,7 +6576,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0b542575-15f3-48d2-b3e6-37df7dba4217 + request_id: be16ce06-d59f-4532-ba7b-73618060a807 errors: - code: unauthorized message: Access Token Invalid @@ -6647,7 +6655,7 @@ paths: examples: Successful: value: - id: 48 + id: 94 type: data_attribute name: The One Ring full_name: custom_attributes.The One Ring @@ -6661,9 +6669,9 @@ paths: ui_writable: false custom: true archived: false - admin_id: '991267094' - created_at: 1704902290 - updated_at: 1704902290 + admin_id: '991269602' + created_at: 1707237400 + updated_at: 1707237401 model: company schema: "$ref": "#/components/schemas/data_attribute" @@ -6675,7 +6683,7 @@ paths: Too few options in list: value: type: error.list - request_id: e9b5e2a7-2d4e-4cd6-ad8e-5704dd81572b + request_id: 7dc21368-13ff-4fc5-8ed2-c6f141ac25f7 errors: - code: parameter_invalid message: Options isn't an array @@ -6689,7 +6697,7 @@ paths: Attribute Not Found: value: type: error.list - request_id: 15bef0cf-be70-4ffd-b387-90e6a1a9c5c8 + request_id: 2c3962d7-5616-40ac-9dab-2103ba95315f errors: - code: field_not_found message: We couldn't find that data attribute to update @@ -6703,7 +6711,7 @@ paths: Has Dependant Object: value: type: error.list - request_id: 5ea8d29f-3110-4d01-825d-4e05ff9e3593 + request_id: a86ea141-977a-4259-87e8-1f30f5983119 errors: - code: data_invalid message: The Data Attribute you are trying to archive has a @@ -6718,7 +6726,7 @@ paths: Unauthorized: value: type: error.list - request_id: 05d97f93-8a02-4e49-9faf-b868eed2ae54 + request_id: 99dd2b59-7734-420b-b8e7-e51ff0902504 errors: - code: unauthorized message: Access Token Invalid @@ -6769,63 +6777,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 +6831,7 @@ paths: Unauthorized: value: type: error.list - request_id: e8a31b61-8a17-463f-9d26-89702e3e2947 + request_id: 760791f4-b9a1-4c6b-ad7a-98007899c233 errors: - code: unauthorized message: Access Token Invalid @@ -6923,8 +6917,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: 65c2601d86ce64a19de4a31a user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 schema: "$ref": "#/components/schemas/data_event_summary" @@ -6936,7 +6930,7 @@ paths: Unauthorized: value: type: error.list - request_id: 563a3fae-c399-45c6-a6ae-8c9242d0fca0 + request_id: 404b6604-1741-4002-9488-44c8fae7d93e errors: - code: unauthorized message: Access Token Invalid @@ -6967,7 +6961,7 @@ paths: Unauthorized: value: type: error.list - request_id: 7bed7383-946e-4bb4-af48-94a6eb56027b + request_id: 1cd52b4c-dbbc-4b65-966a-120fcb8e037f errors: - code: unauthorized message: Access Token Invalid @@ -7011,7 +7005,7 @@ paths: examples: successful: value: - job_identifier: azt9r3sad8hy30oz + job_identifier: qf9c31lob088eg4r status: pending download_url: '' download_expires_at: '' @@ -7026,8 +7020,8 @@ paths: successful: summary: successful value: - created_at_after: 1704884300 - created_at_before: 1704902300 + created_at_after: 1707219407 + created_at_before: 1707237407 "/export/content/data/{job_identifier}": get: summary: Show content data export @@ -7061,7 +7055,7 @@ paths: examples: successful: value: - job_identifier: 58tm0u6qqudiw1wg + job_identifier: 86wf0clyrdd3hnph status: pending download_url: '' download_expires_at: '' @@ -7093,7 +7087,7 @@ paths: examples: successful: value: - job_identifier: 265qguretsv4rw80 + job_identifier: xz0qdnf216ekc819 status: canceled download_url: '' download_expires_at: '' @@ -7154,32 +7148,32 @@ paths: user message created: value: type: user_message - id: '403918265' - created_at: 1704902327 + id: '403918631' + created_at: 1707237409 body: heyy message_type: inapp - conversation_id: '346' + conversation_id: '970' lead message created: value: type: user_message - id: '403918266' - created_at: 1704902328 + id: '403918632' + created_at: 1707237409 body: heyy message_type: inapp - conversation_id: '347' + conversation_id: '971' admin message created: value: type: admin_message - id: '16' - created_at: 1704902329 + id: '30' + created_at: 1707237411 subject: heyy body: heyy message_type: inapp owner: type: admin - id: '991267128' - name: Ciaran255 Lee - email: admin255@email.com + id: '991269625' + name: Ciaran265 Lee + email: admin265@email.com away_mode_enabled: false away_mode_reassign: false schema: @@ -7192,14 +7186,14 @@ paths: No body supplied for message: value: type: error.list - request_id: 83111350-c2cd-4745-a4d4-aa17a5fa1cbe + request_id: 6e7da247-783f-46b2-bbb0-34d7dda4bafe 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: d40b7c20-6abf-4a58-9760-cfa0bbd8fb58 errors: - code: parameter_invalid message: Body is required @@ -7213,7 +7207,7 @@ paths: No subject supplied for email message: value: type: error.list - request_id: 964a512e-6458-4a49-ad30-e86e9750382d + request_id: 3dc6ee75-68b5-4a5a-bf35-ada8e78cc117 errors: - code: parameter_not_found message: No subject supplied for email message @@ -7227,7 +7221,7 @@ paths: Unauthorized: value: type: error.list - request_id: 5e552874-2b5c-4571-b7ba-20c0e65832fc + request_id: 7f231873-c18d-4e08-810c-983bed5f67d0 errors: - code: unauthorized message: Access Token Invalid @@ -7241,7 +7235,7 @@ paths: API plan restricted: value: type: error.list - request_id: f8c94e3f-b089-4a66-8b53-0e968b44f289 + request_id: 6d0c3ea7-9e7e-4687-818f-bd2bc5766798 errors: - code: api_plan_restricted message: Active subscription needed. @@ -7258,7 +7252,7 @@ paths: value: from: type: user - id: 659ebeb76abd014d2275ac4d + id: 65c2602086ce64a19de4a31f body: heyy referer: https://twitter.com/bob lead_message_created: @@ -7266,7 +7260,7 @@ paths: value: from: type: lead - id: 659ebeb86abd014d2275ac4e + id: 65c2602186ce64a19de4a320 body: heyy referer: https://twitter.com/bob admin_message_created: @@ -7274,10 +7268,10 @@ paths: value: from: type: admin - id: '991267128' + id: '991269625' to: type: user - id: 659ebeb96abd014d2275ac4f + id: 65c2602286ce64a19de4a321 message_type: conversation body: heyy no_body_supplied_for_message: @@ -7285,10 +7279,10 @@ paths: value: from: type: admin - id: '991267130' + id: '991269627' to: type: user - id: 659ebeba6abd014d2275ac50 + id: 65c2602386ce64a19de4a322 message_type: inapp body: subject: heyy @@ -7297,7 +7291,7 @@ paths: value: from: type: admin - id: '991267131' + id: '991269628' to: type: user user_id: '70' @@ -7308,10 +7302,10 @@ paths: value: from: type: admin - id: '991267132' + id: '991269629' to: type: user - id: 659ebebb6abd014d2275ac52 + id: 65c2602486ce64a19de4a324 message_type: email body: subject: heyy @@ -7342,12 +7336,12 @@ paths: total_pages: 1 type: pages data: - - id: '15' + - id: '71' 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: 991269634 state: draft labels: [] cover_image_url: @@ -7357,15 +7351,15 @@ paths: - - deliver_silently: false - created_at: 1704902333 - updated_at: 1704902333 + created_at: 1707237413 + updated_at: 1707237413 newsfeed_assignments: [] - - id: '16' + - id: '72' 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: 991269636 state: draft labels: [] cover_image_url: @@ -7375,8 +7369,8 @@ paths: - - deliver_silently: false - created_at: 1704902333 - updated_at: 1704902333 + created_at: 1707237413 + updated_at: 1707237413 newsfeed_assignments: [] total_count: 2 schema: @@ -7389,7 +7383,7 @@ paths: Unauthorized: value: type: error.list - request_id: d10360b2-369e-43d5-acb8-ae02f85e5311 + request_id: 229104c5-a892-48c0-8612-812b604b74dd errors: - code: unauthorized message: Access Token Invalid @@ -7414,12 +7408,12 @@ paths: examples: successful: value: - id: '19' + id: '75' 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: 991269643 state: live labels: - New @@ -7430,10 +7424,10 @@ paths: - "\U0001F606" - "\U0001F605" deliver_silently: true - created_at: 1704902335 - updated_at: 1704902335 + created_at: 1707237415 + updated_at: 1707237415 newsfeed_assignments: - - newsfeed_id: 28 + - newsfeed_id: 128 published_at: 1664638214 schema: "$ref": "#/components/schemas/news_item" @@ -7445,7 +7439,7 @@ paths: Unauthorized: value: type: error.list - request_id: 4e6f92c6-bcef-4faf-9337-8df194bd9a08 + request_id: 4a308663-c496-4bb2-958a-71b028dd4f68 errors: - code: unauthorized message: Access Token Invalid @@ -7466,14 +7460,14 @@ paths: - Product - Update - New - sender_id: 991267146 + sender_id: 991269643 deliver_silently: true reactions: - "\U0001F606" - "\U0001F605" state: live newsfeed_assignments: - - newsfeed_id: 28 + - newsfeed_id: 128 published_at: 1664638214 "/news/news_items/{id}": get: @@ -7502,12 +7496,12 @@ paths: examples: successful: value: - id: '20' + id: '76' 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: 991269646 state: live labels: [] cover_image_url: @@ -7517,11 +7511,11 @@ paths: - - deliver_silently: false - created_at: 1704902336 - updated_at: 1704902336 + created_at: 1707237416 + updated_at: 1707237416 newsfeed_assignments: - - newsfeed_id: 30 - published_at: 1704902336 + - newsfeed_id: 130 + published_at: 1707237417 schema: "$ref": "#/components/schemas/news_item" '404': @@ -7532,7 +7526,7 @@ paths: News Item Not Found: value: type: error.list - request_id: 537cc56f-444c-49ba-8faf-399e25b5b6ab + request_id: 1385f146-7ac3-46b4-a8ab-57dd02295b0b errors: - code: not_found message: Resource Not Found @@ -7546,7 +7540,7 @@ paths: Unauthorized: value: type: error.list - request_id: 83f95f28-b352-405b-9910-38ef2c951cb6 + request_id: a74cc71c-42b5-4e79-a4cb-4b193352553b errors: - code: unauthorized message: Access Token Invalid @@ -7577,12 +7571,12 @@ paths: examples: successful: value: - id: '23' + id: '79' 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: 991269654 state: live labels: [] cover_image_url: @@ -7590,8 +7584,8 @@ paths: - "\U0001F61D" - "\U0001F602" deliver_silently: false - created_at: 1704902337 - updated_at: 1704902338 + created_at: 1707237418 + updated_at: 1707237418 newsfeed_assignments: [] schema: "$ref": "#/components/schemas/news_item" @@ -7603,7 +7597,7 @@ paths: News Item Not Found: value: type: error.list - request_id: 64210c76-336f-4082-89bf-1adef968afd6 + request_id: 9fc958b8-7555-4aa7-a0c2-786d9ae05939 errors: - code: not_found message: Resource Not Found @@ -7617,7 +7611,7 @@ paths: Unauthorized: value: type: error.list - request_id: 5b5f4993-dbad-435a-a276-cc7e47359e1a + request_id: 2719043c-0814-4002-ab4f-f43f5c3eeb94 errors: - code: unauthorized message: Access Token Invalid @@ -7634,7 +7628,7 @@ paths: value: title: Christmas is here! body: "

    New gifts in store for the jolly season

    " - sender_id: 991267157 + sender_id: 991269654 reactions: - "\U0001F61D" - "\U0001F602" @@ -7643,7 +7637,7 @@ paths: value: title: Christmas is here! body: "

    New gifts in store for the jolly season

    " - sender_id: 991267160 + sender_id: 991269657 reactions: - "\U0001F61D" - "\U0001F602" @@ -7673,7 +7667,7 @@ paths: examples: successful: value: - id: '26' + id: '82' object: news-item deleted: true schema: @@ -7686,7 +7680,7 @@ paths: News Item Not Found: value: type: error.list - request_id: dc4e11b7-5b10-45d8-b252-0be98ccc79c9 + request_id: fd29e4b9-8a90-482c-9183-6ba7d40c0e48 errors: - code: not_found message: Resource Not Found @@ -7700,7 +7694,7 @@ paths: Unauthorized: value: type: error.list - request_id: 7570b2de-e25a-4d83-b644-98c182bf3e00 + request_id: 87bd3674-11cd-49cb-9e89-8ee9c1fb589e errors: - code: unauthorized message: Access Token Invalid @@ -7753,7 +7747,7 @@ paths: Unauthorized: value: type: error.list - request_id: b6d7eab4-d558-41db-a461-b18d9fd339d6 + request_id: 399796cc-5b30-4260-a729-00c653a52d8d errors: - code: unauthorized message: Access Token Invalid @@ -7786,16 +7780,16 @@ paths: total_pages: 1 type: pages data: - - id: '43' + - id: '143' type: newsfeed name: Visitor Feed - created_at: 1704902342 - updated_at: 1704902342 - - id: '44' + created_at: 1707237422 + updated_at: 1707237422 + - id: '144' type: newsfeed name: Visitor Feed - created_at: 1704902342 - updated_at: 1704902342 + created_at: 1707237422 + updated_at: 1707237422 total_count: 2 schema: "$ref": "#/components/schemas/paginated_response" @@ -7807,7 +7801,7 @@ paths: Unauthorized: value: type: error.list - request_id: df3f0af8-4f76-4699-85fd-ce08b25c9d74 + request_id: 2884b75f-691f-4397-ada5-23bb6a533b2d errors: - code: unauthorized message: Access Token Invalid @@ -7841,11 +7835,11 @@ paths: examples: successful: value: - id: '47' + id: '147' type: newsfeed name: Visitor Feed - created_at: 1704902343 - updated_at: 1704902343 + created_at: 1707237423 + updated_at: 1707237423 schema: "$ref": "#/components/schemas/newsfeed" '401': @@ -7856,7 +7850,7 @@ paths: Unauthorized: value: type: error.list - request_id: 54838234-2c28-4101-8abe-52e52ed7c204 + request_id: 30e72db5-dfa6-47e8-aa13-131bbf879ada errors: - code: unauthorized message: Access Token Invalid @@ -7890,16 +7884,16 @@ paths: Note found: value: type: note - id: '54' - created_at: 1704211146 + id: '96' + created_at: 1706546223 contact: type: contact - id: 659ebeca6abd014d2275ac5d + id: 65c2603086ce64a19de4a327 author: type: admin - id: '991267176' - name: Ciaran302 Lee - email: admin302@email.com + id: '991269673' + name: Ciaran312 Lee + email: admin312@email.com away_mode_enabled: false away_mode_reassign: false body: "

    This is a note.

    " @@ -7913,7 +7907,7 @@ paths: Note not found: value: type: error.list - request_id: 2444c7ec-53e8-4958-b6ad-5b859b005805 + request_id: 7c004818-fd4d-481b-b017-83774581e4aa errors: - code: not_found message: Resource Not Found @@ -7927,7 +7921,7 @@ paths: Unauthorized: value: type: error.list - request_id: 7fa3ad29-771d-4375-b7fc-4624cae48ce9 + request_id: 97462efe-7a01-453a-afef-c6741b2a1206 errors: - code: unauthorized message: Access Token Invalid @@ -7963,16 +7957,16 @@ paths: type: segment.list segments: - type: segment - id: 659ebece6abd014d2275ac64 + id: 65c2603186ce64a19de4a32a name: John segment - created_at: 1704902350 - updated_at: 1704902350 + created_at: 1707237425 + updated_at: 1707237425 person_type: user - type: segment - id: 659ebece6abd014d2275ac65 + id: 65c2603186ce64a19de4a32b name: Jane segment - created_at: 1704902350 - updated_at: 1704902350 + created_at: 1707237425 + updated_at: 1707237425 person_type: user schema: "$ref": "#/components/schemas/segment_list" @@ -7984,7 +7978,7 @@ paths: Unauthorized: value: type: error.list - request_id: 58b716c6-0fa3-4936-9f81-6a3837ef22da + request_id: 834dea4b-9657-456a-b838-a255a1f9e9c7 errors: - code: unauthorized message: Access Token Invalid @@ -8018,10 +8012,10 @@ paths: Successful response: value: type: segment - id: 659ebecf6abd014d2275ac68 + id: 65c2603286ce64a19de4a32e name: John segment - created_at: 1704902351 - updated_at: 1704902351 + created_at: 1707237426 + updated_at: 1707237426 person_type: user schema: "$ref": "#/components/schemas/segment" @@ -8033,7 +8027,7 @@ paths: Segment not found: value: type: error.list - request_id: c70f69ba-04af-4397-aad6-d2499d039cf5 + request_id: e8e2d460-a71a-43fe-a063-9d487505db2b errors: - code: not_found message: Resource Not Found @@ -8047,7 +8041,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9bbc3cfd-186d-4261-b8db-3e0e78ebf529 + request_id: 2a46a8ee-1d7d-4743-8ed7-52e1c8d9eb61 errors: - code: unauthorized message: Access Token Invalid @@ -8077,7 +8071,7 @@ paths: type: list data: - type: subscription - id: '134' + id: '363' state: live consent_type: opt_out default_translation: @@ -8100,7 +8094,7 @@ paths: Unauthorized: value: type: error.list - request_id: ca5068dd-322b-4b4a-82e5-3a51f3eb72e5 + request_id: d32a01d2-51a3-4e92-8feb-141a59744b0f errors: - code: unauthorized message: Access Token Invalid @@ -8130,7 +8124,7 @@ paths: examples: successful: value: - url: http://via.intercom.io/msgr/36c5c4a5-5179-4939-bb60-617772a72baa + url: http://via.intercom.io/msgr/0d64c425-8deb-4de4-843d-a5f0bd3f1241 type: phone_call_redirect schema: "$ref": "#/components/schemas/phone_switch" @@ -8163,7 +8157,7 @@ paths: Unauthorized: value: type: error.list - request_id: f3d24edb-d37d-47c9-b31c-e077bdcc337a + request_id: 78a6fd80-f9e8-47b6-830d-ff3b9400bc4f errors: - code: unauthorized message: Access Token Invalid @@ -8226,7 +8220,7 @@ paths: type: list data: - type: tag - id: '74' + id: '268' name: Manual tag 1 schema: "$ref": "#/components/schemas/tag_list" @@ -8238,7 +8232,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9dff0d23-f00d-484a-afbf-84217a6e534b + request_id: 49230ee3-ce6b-4d57-8626-9f81420ad0b5 errors: - code: unauthorized message: Access Token Invalid @@ -8277,7 +8271,7 @@ paths: Action successful: value: type: tag - id: '77' + id: '271' name: test schema: "$ref": "#/components/schemas/tag" @@ -8289,7 +8283,7 @@ paths: Invalid parameters: value: type: error.list - request_id: de91a882-bcdf-4091-aee7-4a0d194a4bba + request_id: eb428b7b-749c-4535-9439-8e1afb32c2da errors: - code: parameter_invalid message: invalid tag parameters @@ -8303,14 +8297,14 @@ paths: Company not found: value: type: error.list - request_id: 5537dcaf-f960-453a-9095-8d7e7ac06ee7 + request_id: 279ad052-f53a-4c08-bcb3-53863863198b 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: 359386a2-3c35-4308-bd46-2d82ed0eae05 errors: - code: not_found message: User Not Found @@ -8324,7 +8318,7 @@ paths: Unauthorized: value: type: error.list - request_id: 6f06b092-0ab0-4f0a-b90f-516e4f973376 + request_id: fa0055b1-196d-456e-90cf-d35f3a4e45ed errors: - code: unauthorized message: Access Token Invalid @@ -8390,7 +8384,7 @@ paths: Tag found: value: type: tag - id: '85' + id: '279' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -8402,7 +8396,7 @@ paths: Tag not found: value: type: error.list - request_id: bddd7bea-e5b3-4dd8-ade1-027e1677b8f0 + request_id: 7effd499-71b8-45f3-8199-8889bf3de892 errors: - code: not_found message: Resource Not Found @@ -8416,7 +8410,7 @@ paths: Unauthorized: value: type: error.list - request_id: 192bff70-9676-432c-b61d-fd2a86e741f1 + request_id: ca4e9138-b033-41b1-83a5-7304596be23d errors: - code: unauthorized message: Access Token Invalid @@ -8452,7 +8446,7 @@ paths: Resource not found: value: type: error.list - request_id: adfccecf-2769-47cb-8ba3-ac32d39d7f5c + request_id: f03b20be-82a2-4ced-83be-8c5b40e356c8 errors: - code: not_found message: Resource Not Found @@ -8466,7 +8460,7 @@ paths: Tag has dependent objects: value: type: error.list - request_id: 734a14d9-de2a-46f2-822b-db996bccbdaa + request_id: 2be6397b-be70-4316-a9db-b893a2ea06da errors: - code: tag_has_dependent_objects message: 'Unable to delete Tag with dependent objects. Segments: @@ -8481,7 +8475,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2da05771-3e0d-45f2-97e4-a279658694cc + request_id: 3c8dd47b-b2a5-4a91-9f80-2f9ad42cbff6 errors: - code: unauthorized message: Access Token Invalid @@ -8519,7 +8513,7 @@ paths: Unauthorized: value: type: error.list - request_id: eae07671-81a6-41a2-a48d-a44c8eea16cf + request_id: caa8ee0e-cde0-4a2e-963e-41edf0ec4fd9 errors: - code: unauthorized message: Access Token Invalid @@ -8554,7 +8548,7 @@ paths: successful: value: type: team - id: '991267220' + id: '991269711' name: team 1 admin_ids: [] schema: @@ -8567,7 +8561,7 @@ paths: Team not found: value: type: error.list - request_id: 9d49b19c-8339-4edc-8b8e-eb49038035d2 + request_id: eda035c7-239d-4233-8acd-b535b2861f0b errors: - code: team_not_found message: Team not found @@ -8581,7 +8575,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2179a27b-9a20-4928-b700-b6484f5c38ab + request_id: 50d45197-ec39-45c1-82e7-e8d12952c099 errors: - code: unauthorized message: Access Token Invalid @@ -8613,26 +8607,26 @@ paths: successful: value: type: visitor - id: 659ebf116abd014d2275ad82 + id: 65c2604b86ce64a19de4a352 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' phone: name: Gareth Bale - pseudonym: Lime Cat + pseudonym: Lime Crown 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/lime-crown.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: 1707237451 + remote_created_at: 1707237451 + signed_up_at: 1707237451 + updated_at: 1707237452 session_count: 0 social_profiles: type: social_profile.list @@ -8665,7 +8659,7 @@ paths: visitor Not Found: value: type: error.list - request_id: 85aaf8aa-46fa-4dcc-95ad-fbb97b9b5e7f + request_id: cf88af91-c463-4045-921e-05b16ffdd5df errors: - code: not_found message: Visitor Not Found @@ -8679,7 +8673,7 @@ paths: Unauthorized: value: type: error.list - request_id: 81777aa9-9cdf-4033-9bb4-8657aeb849b1 + request_id: 0c5f65bc-b70d-4b05-8f1d-a8da71b4e62e errors: - code: unauthorized message: Access Token Invalid @@ -8694,7 +8688,7 @@ paths: successful: summary: successful value: - id: 659ebf116abd014d2275ad82 + id: 65c2604b86ce64a19de4a352 name: Gareth Bale visitor_not_found: summary: visitor Not Found @@ -8727,7 +8721,7 @@ paths: successful: value: type: visitor - id: 659ebf136abd014d2275ad88 + id: 65c2604c86ce64a19de4a358 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' @@ -8737,16 +8731,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: 1707237453 + remote_created_at: 1707237452 + signed_up_at: 1707237452 + updated_at: 1707237453 session_count: 0 social_profiles: type: social_profile.list @@ -8779,7 +8773,7 @@ paths: Visitor not found: value: type: error.list - request_id: e55e6ab1-204e-495b-b6f2-3ad50e00aa1c + request_id: db4b423a-9f5b-40e5-8edb-d2abcc22baf5 errors: - code: not_found message: Visitor Not Found @@ -8793,7 +8787,7 @@ paths: Unauthorized: value: type: error.list - request_id: 7b040ea5-ff0f-441b-8a83-119f6cac5cd9 + request_id: abfe57de-1981-40d5-8d00-f1c2740418bc errors: - code: unauthorized message: Access Token Invalid @@ -8827,7 +8821,7 @@ paths: successful: value: type: visitor - id: 659ebf146abd014d2275ad8e + id: 65c2604e86ce64a19de4a35e user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' @@ -8837,16 +8831,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: 1707237454 + remote_created_at: 1707237454 + signed_up_at: 1707237454 + updated_at: 1707237454 session_count: 0 social_profiles: type: social_profile.list @@ -8879,7 +8873,7 @@ paths: Visitor not found: value: type: error.list - request_id: a060e92d-bf93-440e-aa95-ce24bd1bd19e + request_id: 0fd70891-24d5-471c-baf6-3aebc58b357a errors: - code: not_found message: Visitor Not Found @@ -8893,7 +8887,7 @@ paths: Unauthorized: value: type: error.list - request_id: 7970295d-b57f-43f9-b4a7-b62e99d17bec + request_id: 483b67f4-fb23-494e-a91b-060cf68dec29 errors: - code: unauthorized message: Access Token Invalid @@ -8926,7 +8920,7 @@ paths: successful: value: type: visitor - id: 659ebf166abd014d2275ad94 + id: 65c2604f86ce64a19de4a364 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' @@ -8936,16 +8930,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: 1707237455 + remote_created_at: 1707237455 + signed_up_at: 1707237455 + updated_at: 1707237455 session_count: 0 social_profiles: type: social_profile.list @@ -8978,7 +8972,7 @@ paths: Visitor Not Found: value: type: error.list - request_id: 2cd4d57b-25d7-4caa-adee-53babcf27438 + request_id: 4d65d58e-9fa2-4631-9279-ee2df09eabb2 errors: - code: not_found message: User Not Found @@ -8992,7 +8986,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8bb1ea72-3aa0-4542-bd0c-a67d626d00b5 + request_id: bb9c9e30-8606-4e73-a6e8-ff7548780cc7 errors: - code: unauthorized message: Access Token Invalid @@ -9023,8 +9017,8 @@ paths: successful: value: type: contact - id: 659ebf176abd014d2275ad9b - workspace_id: this_is_an_id616_that_should_be_at_least_ + id: 65c2605186ce64a19de4a36b + workspace_id: this_is_an_id633_that_should_be_at_least_ external_id: role: user email: foo@bar.com @@ -9038,9 +9032,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: 1707237457 + updated_at: 1707237457 + signed_up_at: 1707237457 last_seen_at: last_replied_at: last_contacted_at: @@ -9074,31 +9068,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ebf176abd014d2275ad9b/tags" + url: "/contacts/65c2605186ce64a19de4a36b/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ebf176abd014d2275ad9b/notes" + url: "/contacts/65c2605186ce64a19de4a36b/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ebf176abd014d2275ad9b/companies" + url: "/contacts/65c2605186ce64a19de4a36b/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ebf176abd014d2275ad9b/subscriptions" + url: "/contacts/65c2605186ce64a19de4a36b/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ebf176abd014d2275ad9b/subscriptions" + url: "/contacts/65c2605186ce64a19de4a36b/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -9117,7 +9111,7 @@ paths: Unauthorized: value: type: error.list - request_id: 3f2d3e00-b163-4326-aebe-df6dae6814c5 + request_id: 97a63b28-e17b-4671-854d-6edcccbf1b80 errors: - code: unauthorized message: Access Token Invalid @@ -11683,7 +11677,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 @@ -11996,30 +11991,6 @@ components: anyOf: - type: string - "$ref": "#/components/schemas/custom_object_instance" - custom_object_instance: - title: Custom Object Instance - type: object - nullable: true - description: An instance of a Custom Object Type. - properties: - id: - type: string - description: The Intercom defined id representing the custom object instance. - example: 5a7a19e9f59ae20001d1c1e6 - external_id: - type: string - description: The id you have defined for the custom object instance. - example: 0001d1c1e65a7a19e9f59ae2 - type: - type: string - description: The identifier of the custom object type that defines the structure - of the custom object instance. - example: Order - custom_attributes: - type: object - description: The custom attributes you have set on the custom object instance. - additionalProperties: - type: string customer_request: type: object nullable: true diff --git a/descriptions/2.8/api.intercom.io.yaml b/descriptions/2.8/api.intercom.io.yaml index fca43e6..c21ebb0 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: '991269805' 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: 1707237468 secure: false identity_verification: false timezone: America/Los_Angeles @@ -83,7 +83,7 @@ paths: Successful response: value: type: admin - id: '991267307' + id: '991269806' 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: e8190cf7-fe99-4d0f-b6ac-3e522b08a9b2 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: 86b2991d-825b-459e-824b-d1d73e96c0ad 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: 0bfa8fab-e401-45f5-845c-82d52bd5ee4f 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: '991269810' 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: 1707237474 activity_type: message_state_change activity_description: Ciaran5 Lee changed your Initial message title message from Initial message title to Eventual message title. + - id: 139055aa-1822-4160-9bd2-d0aa1e5f7ae5 + performed_by: + type: admin + id: '991269810' + email: admin5@email.com + ip: 127.0.0.1 + metadata: + before: before + after: after + created_at: 1707237474 + 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: 72677734-4a6d-4fa3-b675-d588080b6798 errors: - code: unauthorized message: Access Token Invalid @@ -271,7 +271,7 @@ paths: admins: - type: admin email: admin7@email.com - id: '991267314' + id: '991269812' 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: 25d24f22-44a2-474f-b9b4-ab65e3476a1a errors: - code: unauthorized message: Access Token Invalid @@ -321,7 +321,7 @@ paths: Admin found: value: type: admin - id: '991267316' + id: '991269814' 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: b6584d84-0426-46b7-832e-356c44efc767 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: 35cbf8a2-4282-4720-9361-86fc729b6f7c errors: - code: unauthorized message: Access Token Invalid @@ -390,20 +390,20 @@ paths: total_pages: 1 total_count: 1 data: - - id: '52' + - id: '143' type: article workspace_id: this_is_an_id22_that_should_be_at_least_4 - parent_id: 217 + parent_id: 574 parent_type: collection parent_ids: [] title: This is the article title description: '' body: '' - author_id: 991267319 + author_id: 991269817 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: 1707237478 + updated_at: 1707237478 + url: http://help-center.test/myapp-22/en/articles/143-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: a21e08b6-ca51-4254-b856-b21c9a792909 errors: - code: unauthorized message: Access Token Invalid @@ -439,10 +439,10 @@ paths: examples: article created: value: - id: '55' + id: '146' type: article workspace_id: this_is_an_id26_that_should_be_at_least_4 - parent_id: 219 + parent_id: 576 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: 991269822 state: published - created_at: 1704902450 - updated_at: 1704902450 - url: http://help-center.test/myapp-26/en/articles/55-thanks-for-everything + created_at: 1707237479 + updated_at: 1707237479 + url: http://help-center.test/myapp-26/en/articles/146-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: 9c3333a4-d2a2-4d57-a8d9-ea6466507dfc 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: cb56b647-55f8-4b21-91d0-a51cee8acc60 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: 991269822 state: published - parent_id: 219 + parent_id: 576 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: 991269822 state: published bad_request: summary: Bad Request @@ -550,10 +550,10 @@ paths: examples: Article found: value: - id: '58' + id: '149' type: article workspace_id: this_is_an_id32_that_should_be_at_least_4 - parent_id: 222 + parent_id: 579 parent_type: collection parent_ids: [] statistics: @@ -567,11 +567,11 @@ paths: title: This is the article title description: '' body: '' - author_id: 991267329 + author_id: 991269827 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: 1707237481 + updated_at: 1707237481 + url: http://help-center.test/myapp-32/en/articles/149-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: d1284c68-47a3-4c59-8493-2e2ae17b4a95 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: 3877ae98-d109-4606-99e7-eba2f961e234 errors: - code: unauthorized message: Access Token Invalid @@ -629,10 +629,10 @@ paths: examples: successful: value: - id: '61' + id: '152' type: article workspace_id: this_is_an_id38_that_should_be_at_least_4 - parent_id: 225 + parent_id: 582 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: 991269833 state: published - created_at: 1704902453 - updated_at: 1704902454 - url: http://help-center.test/myapp-38/en/articles/61-christmas-is-here + created_at: 1707237483 + updated_at: 1707237483 + url: http://help-center.test/myapp-38/en/articles/152-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: f6d87c3d-6724-420a-a447-880bb8a084dd 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: e6e71f9c-f59a-490e-8476-9c3c7337fe0c errors: - code: unauthorized message: Access Token Invalid @@ -723,7 +723,7 @@ paths: examples: successful: value: - id: '64' + id: '155' 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: ad0ef8d8-41d5-4fce-89d7-9428496bdf15 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: 0453442f-e669-4c7e-abba-86e780c2be2e errors: - code: unauthorized message: Access Token Invalid @@ -783,16 +783,16 @@ paths: value: type: list data: - - id: '233' + - id: '590' 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: 1707237487 + updated_at: 1707237487 description: english collection description icon: bookmark - help_center_id: 125 + help_center_id: 290 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: 9cdb4382-2e96-47c1-a30c-c3ec519a1326 errors: - code: unauthorized message: Access Token Invalid @@ -835,16 +835,16 @@ paths: examples: collection created: value: - id: '239' + id: '596' 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: 1707237488 + updated_at: 1707237488 description: '' icon: book-bookmark - help_center_id: 127 + help_center_id: 292 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: b375108e-b1d6-4456-8935-1ebe0e2e39b4 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: 2f433156-4739-43c4-95c9-8c3a93ff668c errors: - code: unauthorized message: Access Token Invalid @@ -918,16 +918,16 @@ paths: examples: Collection found: value: - id: '244' + id: '601' 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: 1707237489 + updated_at: 1707237489 description: english collection description icon: bookmark - help_center_id: 130 + help_center_id: 295 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: b3ed561e-21e2-4bd3-a22a-8c50d5b3e853 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: '08f8ae09-bb2c-4270-8634-7b4582f3be71' errors: - code: unauthorized message: Access Token Invalid @@ -986,16 +986,16 @@ paths: examples: successful: value: - id: '250' + id: '607' 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: 1707237490 + updated_at: 1707237491 description: english collection description icon: folder - help_center_id: 133 + help_center_id: 298 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: 6da5a2b7-4772-4292-83dd-18a5f6cc31dc 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: d4c33577-99d7-4623-84cb-40ba197dedc7 errors: - code: unauthorized message: Access Token Invalid @@ -1068,7 +1068,7 @@ paths: examples: successful: value: - id: '256' + id: '613' 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: ba5fda69-79af-438f-bf1e-7a400f9c12b2 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: e75c321b-912d-4b2b-8651-99b12f4868d1 errors: - code: unauthorized message: Access Token Invalid @@ -1129,10 +1129,10 @@ paths: examples: Collection found: value: - id: '139' + id: '304' workspace_id: this_is_an_id80_that_should_be_at_least_4 - created_at: 1704902465 - updated_at: 1704902465 + created_at: 1707237493 + updated_at: 1707237493 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: 477d09bc-58c3-499d-bfbd-865d2b27cf08 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: e57ac8a1-ecc5-4a36-91f7-dfbd4be8e08e 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: 2470f7bd-bd6d-48a9-a556-72fc71a31e41 errors: - code: unauthorized message: Access Token Invalid @@ -1230,15 +1230,15 @@ paths: value: type: list data: - - id: '263' + - id: '620' 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: 1707237495 + updated_at: 1707237495 type: section - parent_id: 262 + parent_id: 619 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: f743a423-1c8a-44cc-a56f-27ee75d8be8f errors: - code: unauthorized message: Access Token Invalid @@ -1280,15 +1280,15 @@ paths: examples: section created: value: - id: '268' + id: '625' 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: 1707237496 + updated_at: 1707237496 type: section - parent_id: '266' + parent_id: '623' 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: 7cb4bc3e-e45b-4d78-a2d5-d1aaea9237dc 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: 623 "/help_center/sections/{id}": get: summary: Retrieve a section @@ -1344,15 +1344,15 @@ paths: examples: Section found: value: - id: '272' + id: '629' 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: 1707237496 + updated_at: 1707237496 type: section - parent_id: 271 + parent_id: 628 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: 5e4294c4-4d77-40a7-ba03-b784f820be82 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: 35f7e242-7897-4cd6-8e36-dfc14c8d24d4 errors: - code: unauthorized message: Access Token Invalid @@ -1410,15 +1410,15 @@ paths: examples: successful: value: - id: '278' + id: '635' 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: 1707237498 + updated_at: 1707237498 type: section - parent_id: '277' + parent_id: '634' 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: ed87a856-5335-429d-8510-fb4910b8c0f9 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: c72dce99-2a2a-442a-9e70-fe4bc3922856 errors: - code: unauthorized message: Access Token Invalid @@ -1459,12 +1459,12 @@ paths: summary: successful value: name: Update section name - parent_id: 277 + parent_id: 634 section_not_found: summary: Section Not Found value: name: Update section name - parent_id: 279 + parent_id: 636 delete: summary: Delete a section parameters: @@ -1491,7 +1491,7 @@ paths: examples: successful: value: - id: '284' + id: '641' 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: fccdf1a0-b88b-4193-903b-fe72d85924b3 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: 11c6d8cc-0fbd-4f1c-9522-5d3b86a9d67c 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: 65c2607c86ce64a5b786d7ab + 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: 1707237500 + updated_at: 1707237500 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: f6e78b76-75ba-4f6e-b702-5ecf7c4ac0ea 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: 65c2607e86ce64a5b786d7b3 + 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: 1707237502 + created_at: 1707237502 + updated_at: 1707237502 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: a4cecaff-fe85-4f86-bbfc-bc4d6e7b0400 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: 7eb4315a-abdc-4270-8ae7-07ba36ae2e73 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: 65c2608086ce64a5b786d7be + app_id: this_is_an_id128_that_should_be_at_least_ + name: company1 + remote_created_at: 1707237504 + created_at: 1707237504 + updated_at: 1707237504 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: d94591f6-b33f-4679-9719-1d516fa376c8 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: 40fe000a-d8aa-4720-975f-3be4c322062f 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: 65c2608386ce64a5b786d7c8 + app_id: this_is_an_id134_that_should_be_at_least_ + name: company2 + remote_created_at: 1707237507 + created_at: 1707237507 + updated_at: 1707237507 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: 17873fad-0ef3-401e-9b08-7f4f70f5b2b8 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: 6643a397-e773-40a7-9e26-7b816ba8837f errors: - code: unauthorized message: Access Token Invalid @@ -1915,7 +1922,7 @@ paths: examples: Successful: value: - id: 659ebf526abd014ef26e4c34 + id: 65c2608486ce64a5b786d7d2 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: fb3158d7-3efd-407e-a369-52a5cf8d1188 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: 74b10169-835d-4650-8001-8c19ffba417a 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: 04e88382-0cfa-46ff-aeda-85a6491ecd1b 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: 85bfad66-faa8-40f4-8ce2-34a21c4393b5 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: b4398b80-13e3-43fc-bf1e-cc4a28f68139 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: b4d75c48-5813-4532-a6a0-4e62f44898da 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: 65c2608a86ce64a5b786d7ee + 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: 1707237514 + created_at: 1707237514 + updated_at: 1707237514 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: 241f0b38-68d0-447f-8f44-d16ca8c2fce9 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: 65c2608b86ce64a5b786d7f4 + 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: 1707237515 + created_at: 1707237515 + updated_at: 1707237515 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: d2fc7d54-ba94-46e3-be2d-be0596940374 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: 35b99619-9741-4843-8781-e75f28389a86 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: 65c2608d86ce64a5b786d7fd + app_id: this_is_an_id166_that_should_be_at_least_ + name: company6 + remote_created_at: 1707237517 + created_at: 1707237517 + updated_at: 1707237517 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: d8065993-e444-4393-bedc-9718779836d5 + 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: 5b975762-1db4-44e8-9fef-ac471532aa61 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: e4fcd60f-bf3b-4225-b02c-b866d982e57d errors: - code: unauthorized message: Access Token Invalid @@ -2339,11 +2360,14 @@ paths: successful: summary: Successful value: - id: 659ebf5a6abd014ef26e4c5f + id: 65c2608d86ce64a5b786d7fd + 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: 65c2609286ce64a5b786d81e + app_id: this_is_an_id182_that_should_be_at_least_ + name: company12 + remote_created_at: 1707237522 + created_at: 1707237522 + updated_at: 1707237522 + last_request_at: 1707064722 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: a82e96d6-645a-46dc-ad40-73aa1586962f 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: 975630a4-a746-4262-a6ac-44afffdc59aa 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: 65c2609086ce64a5b786d80d + app_id: this_is_an_id174_that_should_be_at_least_ + name: company8 + remote_created_at: 1707237520 + created_at: 1707237520 + updated_at: 1707237520 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: b1e4bf33-6123-47f0-bcde-1c436a80c0e7 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: 696c32cc-26dd-4195-96e1-996efa495d15 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: ac8f8af3-2f10-410f-b13e-5351d9abca00 errors: - code: unauthorized message: Access Token Invalid @@ -2551,44 +2575,44 @@ paths: type: list data: - type: note - id: '59' - created_at: 1704297703 + id: '101' + created_at: 1706632725 contact: type: contact - id: 659ebf676abd014ef26e4c9c + id: 65c2609486ce64a5b786d829 author: type: admin - id: '991267416' - name: Ciaran109 Lee - email: admin109@email.com + id: '991269915' + 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: '100' + created_at: 1706546325 contact: type: contact - id: 659ebf676abd014ef26e4c9c + id: 65c2609486ce64a5b786d829 author: type: admin - id: '991267416' - name: Ciaran109 Lee - email: admin109@email.com + id: '991269915' + 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: '99' + created_at: 1706546324 contact: type: contact - id: 659ebf676abd014ef26e4c9c + id: 65c2609486ce64a5b786d829 author: type: admin - id: '991267416' - name: Ciaran109 Lee - email: admin109@email.com + id: '991269915' + 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: a6a006c2-11aa-45b9-abd0-c99c55a4486f errors: - code: not_found message: User Not Found @@ -2643,16 +2667,16 @@ paths: Successful response: value: type: note - id: '64' - created_at: 1704902504 + id: '106' + created_at: 1707237526 contact: type: contact - id: 659ebf686abd014ef26e4c9e + id: 65c2609586ce64a5b786d82b author: type: admin - id: '991267418' - name: Ciaran111 Lee - email: admin111@email.com + id: '991269917' + 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: 9be4b345-66ad-4c12-a811-f6d05cdaca24 errors: - code: not_found message: Resource Not Found Contact not found: value: type: error.list - request_id: 37b8884d-cc01-40f7-8612-5455df4efa96 + request_id: 1df1a501-cd2b-4821-ae70-26fa01eb2276 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: 65c2609586ce64a5b786d82b + admin_id: 991269917 body: Hello admin_not_found: summary: Admin not found value: - contact_id: 659ebf686abd014ef26e4c9f + contact_id: 65c2609686ce64a5b786d82c admin_id: 123 body: Hello contact_not_found: summary: Contact not found value: contact_id: 123 - admin_id: 991267420 + admin_id: 991269919 body: Hello "/contacts/{contact_id}/segments": get: @@ -2749,10 +2773,10 @@ paths: type: list data: - type: segment - id: 659ebf696abd014ef26e4ca1 + id: 65c2609786ce64a5b786d82e name: segment - created_at: 1704902505 - updated_at: 1704902505 + created_at: 1707237527 + updated_at: 1707237527 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: 01b10512-1abe-458d-bbda-a5aa60e4c694 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: ccddc854-599c-4404-9b8e-5faab7198857 errors: - code: unauthorized message: Access Token Invalid @@ -2822,7 +2846,7 @@ paths: type: list data: - type: subscription - id: '136' + id: '365' state: live consent_type: opt_out default_translation: @@ -2836,7 +2860,7 @@ paths: content_types: - email - type: subscription - id: '138' + id: '367' 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: 0011e8e6-5617-485b-acf0-5dea9e23f625 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: c57ebdde-8353-4dc5-89d7-cabac94a9902 errors: - code: unauthorized message: Access Token Invalid @@ -2914,7 +2938,7 @@ paths: Successful: value: type: subscription - id: '151' + id: '380' 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: aef7620c-6294-45cf-8164-8d898eebda5a errors: - code: not_found message: User Not Found Resource not found: value: type: error.list - request_id: 14a73ae4-0902-4e2d-98f4-de43dffe4766 + request_id: eae38a19-2bfc-494a-8a21-256f571ff676 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: bd5a8f17-aeae-4688-a2a5-bafd728d2656 errors: - code: unauthorized message: Access Token Invalid @@ -2986,12 +3010,12 @@ paths: successful: summary: Successful value: - id: 151 + id: 380 consent_type: opt_in contact_not_found: summary: Contact not found value: - id: 155 + id: 384 consent_type: opt_in resource_not_found: summary: Resource not found @@ -3037,7 +3061,7 @@ paths: Successful: value: type: subscription - id: '167' + id: '396' 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: 9b246451-4366-4256-851e-84f954a4e8d8 errors: - code: not_found message: User Not Found Resource not found: value: type: error.list - request_id: 02ad6b19-9c4e-4ca8-b128-a117b2f863a3 + request_id: 0cdce40f-c558-4d0c-881d-65773764a408 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: 955b636f-6906-418c-b421-786a3e829d39 errors: - code: unauthorized message: Access Token Invalid @@ -3119,7 +3143,7 @@ paths: type: list data: - type: tag - id: '97' + id: '287' 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: dfa32ac0-eae3-4f68-865e-418ce6dde05a 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: 535e1ee4-378f-46c2-bea8-4bb812c1fcb8 errors: - code: unauthorized message: Access Token Invalid @@ -3180,7 +3204,7 @@ paths: successful: value: type: tag - id: '98' + id: '288' 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: 502e6fbb-9486-46b8-8c5d-b468cfc40cef errors: - code: not_found message: User Not Found Tag not found: value: type: error.list - request_id: 2d7ca1b0-d3fe-45ce-aa8c-a61e8960edd7 + request_id: 9f89e4c1-944c-494b-92a1-298eae4c619f 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: c2e63a65-4e61-4b80-b589-cea544e83df7 errors: - code: unauthorized message: Access Token Invalid @@ -3236,11 +3260,11 @@ paths: successful: summary: successful value: - id: 98 + id: 288 contact_not_found: summary: Contact not found value: - id: 99 + id: 289 tag_not_found: summary: Tag not found value: @@ -3282,7 +3306,7 @@ paths: successful: value: type: tag - id: '101' + id: '291' 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: 293b3a0e-6c92-4d28-bd5e-55569d7cd24a errors: - code: not_found message: User Not Found Tag not found: value: type: error.list - request_id: 70c17887-69a7-4c26-8995-6acffb381d5d + request_id: 9a23e848-0eba-44c2-9954-73896503b17a 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: d240425e-c9ce-4a40-91c9-a6f1c552ce05 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: 65c260a286ce64a5b786d845 + 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: 1707237538 + updated_at: 1707237538 + signed_up_at: 1707237538 last_seen_at: last_replied_at: last_contacted_at: @@ -3400,31 +3424,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ebf756abd014ef26e4cb8/tags" + url: "/contacts/65c260a286ce64a5b786d845/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ebf756abd014ef26e4cb8/notes" + url: "/contacts/65c260a286ce64a5b786d845/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ebf756abd014ef26e4cb8/companies" + url: "/contacts/65c260a286ce64a5b786d845/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ebf756abd014ef26e4cb8/subscriptions" + url: "/contacts/65c260a286ce64a5b786d845/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ebf756abd014ef26e4cb8/subscriptions" + url: "/contacts/65c260a286ce64a5b786d845/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: a0dbda84-52bd-461a-8aed-e2c8ade2bdb3 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: 65c260a386ce64a5b786d846 + 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: 1707237539 + updated_at: 1707237539 + signed_up_at: 1707237539 last_seen_at: last_replied_at: last_contacted_at: @@ -3539,31 +3563,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ebf766abd014ef26e4cb9/tags" + url: "/contacts/65c260a386ce64a5b786d846/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ebf766abd014ef26e4cb9/notes" + url: "/contacts/65c260a386ce64a5b786d846/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ebf766abd014ef26e4cb9/companies" + url: "/contacts/65c260a386ce64a5b786d846/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ebf766abd014ef26e4cb9/subscriptions" + url: "/contacts/65c260a386ce64a5b786d846/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ebf766abd014ef26e4cb9/subscriptions" + url: "/contacts/65c260a386ce64a5b786d846/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: af40635c-c1ea-4381-8cbf-3445419404fe errors: - code: unauthorized message: Access Token Invalid @@ -3613,7 +3637,7 @@ paths: examples: successful: value: - id: 659ebf776abd014ef26e4cba + id: 65c260a486ce64a5b786d847 object: contact deleted: true schema: @@ -3626,7 +3650,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2c317d00-e7b3-464d-8d4b-2b75d767432b + request_id: dae37135-d520-4c8b-b4ef-de5d2008919b 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: 65c260a586ce64a5b786d849 + 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: 1707237541 + updated_at: 1707237542 + signed_up_at: 1707237541 last_seen_at: last_replied_at: last_contacted_at: @@ -3705,31 +3729,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ebf786abd014ef26e4cbc/tags" + url: "/contacts/65c260a586ce64a5b786d849/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ebf786abd014ef26e4cbc/notes" + url: "/contacts/65c260a586ce64a5b786d849/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ebf786abd014ef26e4cbc/companies" + url: "/contacts/65c260a586ce64a5b786d849/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ebf786abd014ef26e4cbc/subscriptions" + url: "/contacts/65c260a586ce64a5b786d849/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ebf786abd014ef26e4cbc/subscriptions" + url: "/contacts/65c260a586ce64a5b786d849/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: d43c512c-6446-40d5-a883-7f6d0bb31d9f errors: - code: unauthorized message: Access Token Invalid @@ -3763,8 +3787,8 @@ paths: successful: summary: successful value: - from: 659ebf786abd014ef26e4cbb - into: 659ebf786abd014ef26e4cbc + from: 65c260a586ce64a5b786d848 + into: 65c260a586ce64a5b786d849 "/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: 18f3c3ed-ca1f-4de4-a530-c2477512fa52 errors: - code: unauthorized message: Access Token Invalid @@ -3893,15 +3917,15 @@ paths: value: - field: id operator: "=" - value: 659ebf796abd014ef26e4cbf + value: 65c260a786ce64a5b786d84c - operator: OR value: - field: id operator: "=" - value: 659ebf796abd014ef26e4cbf + value: 65c260a786ce64a5b786d84c - field: id operator: "=" - value: 659ebf796abd014ef26e4cbf + value: 65c260a786ce64a5b786d84c "/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: 24ff7cc8-4228-48dd-a5db-adb7b7e73a6a 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: 65c260a986ce64a5b786d84e + 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: 1707237545 + updated_at: 1707237545 signed_up_at: last_seen_at: last_replied_at: @@ -4017,31 +4041,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ebf7b6abd014ef26e4cc1/tags" + url: "/contacts/65c260a986ce64a5b786d84e/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ebf7b6abd014ef26e4cc1/notes" + url: "/contacts/65c260a986ce64a5b786d84e/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ebf7b6abd014ef26e4cc1/companies" + url: "/contacts/65c260a986ce64a5b786d84e/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ebf7b6abd014ef26e4cc1/subscriptions" + url: "/contacts/65c260a986ce64a5b786d84e/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ebf7b6abd014ef26e4cc1/subscriptions" + url: "/contacts/65c260a986ce64a5b786d84e/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: 1be3112a-a95f-42bc-8d4b-c2eb4d1d4c97 errors: - code: unauthorized message: Access Token Invalid @@ -4104,7 +4128,7 @@ paths: examples: successful: value: - id: 659ebf7c6abd014ef26e4cc2 + id: 65c260aa86ce64a5b786d84f object: contact archived: true schema: @@ -4136,7 +4160,7 @@ paths: examples: successful: value: - id: 659ebf7d6abd014ef26e4cc3 + id: 65c260aa86ce64a5b786d850 object: contact archived: false schema: @@ -4171,7 +4195,7 @@ paths: successful: value: type: tag - id: '103' + id: '293' 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: 0375f025-b8aa-4974-848d-010dd8667fe7 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: 036ede8a-ea35-4c52-9ebe-abf1019e6f0b errors: - code: unauthorized message: Access Token Invalid @@ -4226,13 +4250,13 @@ paths: successful: summary: successful value: - id: 103 - admin_id: 991267451 + id: 293 + admin_id: 991269950 conversation_not_found: summary: Conversation not found value: - id: 104 - admin_id: 991267453 + id: 294 + admin_id: 991269952 "/conversations/{conversation_id}/tags/{id}": delete: summary: Remove tag from a conversation @@ -4270,7 +4294,7 @@ paths: successful: value: type: tag - id: '106' + id: '296' 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: 6ce64163-fa2e-4a5f-9c7d-33ebf6ce05ae errors: - code: not_found message: Conversation not found Tag not found: value: type: error.list - request_id: 20371fef-3307-4ce9-84b6-39d0d13c1ed0 + request_id: '08d7b95f-1bc3-48b9-bf3e-f5b7eb97acea' 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: 040c0435-6443-4815-9edf-ab4d9bce91fc errors: - code: unauthorized message: Access Token Invalid @@ -4326,15 +4350,15 @@ paths: successful: summary: successful value: - admin_id: 991267455 + admin_id: 991269954 conversation_not_found: summary: Conversation not found value: - admin_id: 991267457 + admin_id: 991269956 tag_not_found: summary: Tag not found value: - admin_id: 991267458 + admin_id: 991269957 "/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: '977' + created_at: 1707237554 + updated_at: 1707237554 waiting_since: snoozed_until: source: type: conversation - id: '403918273' + id: '403918637' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991267461' - name: Ciaran151 Lee - email: admin151@email.com + id: '991269960' + 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: 65c260b286ce64a5b786d854 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: 53d70402-0013-49c9-a355-eb76cff7bfa4 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: 4bd684b7-240b-4fe8-a242-fee7b3b1916a 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: '403918647' + created_at: 1707237578 body: Hello there message_type: inapp - conversation_id: '378' + conversation_id: '1002' 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: b7247129-0963-4983-a32d-812da8ca2650 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: 23db9da4-7934-48a4-9357-0be96914f273 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: 7405bb67-8a79-4fc5-a718-00e944ab1d65 errors: - code: api_plan_restricted message: Active subscription needed. @@ -4538,7 +4562,7 @@ paths: value: from: type: user - id: 659ebf996abd014ef26e4cdc + id: 65c260c986ce64a5b786d869 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: '1006' + created_at: 1707237585 + updated_at: 1707237585 waiting_since: snoozed_until: source: type: conversation - id: '403918287' + id: '403918651' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991267475' - name: Ciaran158 Lee - email: admin158@email.com + id: '991269974' + 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: 65c260d186ce64a5b786d86d 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: ea3bb98d-bbf8-4603-a522-01c0eac7efe3 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: 0ed57ca7-94a0-480b-8d9c-a294061d916c 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: baab1070-8bd7-4127-b0a2-c98d9bc9b7d6 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: '1010' + created_at: 1707237591 + updated_at: 1707237592 waiting_since: snoozed_until: source: type: conversation - id: '403918291' + id: '403918655' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991267483' - name: Ciaran162 Lee - email: admin162@email.com + id: '991269982' + 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: 65c260d686ce64a5b786d871 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: '220' part_type: conversation_attribute_updated_by_admin body: - created_at: 1704902565 - updated_at: 1704902565 - notified_at: 1704902565 + created_at: 1707237592 + updated_at: 1707237592 + notified_at: 1707237592 assigned_to: author: - id: '991267484' + id: '991269983' 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: '221' part_type: conversation_attribute_updated_by_admin body: - created_at: 1704902565 - updated_at: 1704902565 - notified_at: 1704902565 + created_at: 1707237592 + updated_at: 1707237592 + notified_at: 1707237592 assigned_to: author: - id: '991267484' + id: '991269983' 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: edc0a797-3367-4bc0-98d5-af78f228bf14 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: 85e02aa0-cf1a-4adc-acdc-83195522f70f 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: adc4621d-0bc1-4fba-9e6b-435e4d457142 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: '1017' + created_at: 1707237600 + updated_at: 1707237600 waiting_since: snoozed_until: source: type: conversation - id: '403918298' + id: '403918662' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991267513' - name: Ciaran185 Lee - email: admin185@email.com + id: '991270012' + 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: 65c260e086ce64a5b786d878 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5009,15 +5033,15 @@ paths: value: - field: id operator: "=" - value: '393' + value: '1017' - operator: OR value: - field: id operator: "=" - value: '393' + value: '1017' - field: id operator: "=" - value: '393' + value: '1017' "/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: '1025' + created_at: 1707237606 + updated_at: 1707237607 + waiting_since: 1707237607 snoozed_until: source: type: conversation - id: '403918301' + id: '403918665' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991267515' - name: Ciaran186 Lee - email: admin186@email.com + id: '991270014' + 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: 65c260e686ce64a5b786d87f first_contact_reply: - created_at: 1704902582 + created_at: 1707237607 type: conversation url: admin_assignee_id: @@ -5104,15 +5128,15 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '65' + id: '223' part_type: open body: "

    Thanks again :)

    " - created_at: 1704902582 - updated_at: 1704902582 - notified_at: 1704902582 + created_at: 1707237607 + updated_at: 1707237607 + notified_at: 1707237607 assigned_to: author: - id: 659ebfb56abd014ef26e4cf2 + id: 65c260e686ce64a5b786d87f 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: '1026' + created_at: 1707237608 + updated_at: 1707237609 waiting_since: snoozed_until: source: type: conversation - id: '403918302' + id: '403918666' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991267517' - name: Ciaran187 Lee - email: admin187@email.com + id: '991270016' + 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: 65c260e886ce64a5b786d880 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: '224' part_type: note body: |-

    An Unordered HTML List

    @@ -5183,15 +5207,15 @@ paths:
  • Tea
  • Milk
  • - created_at: 1704902584 - updated_at: 1704902584 - notified_at: 1704902584 + created_at: 1707237609 + updated_at: 1707237609 + notified_at: 1707237609 assigned_to: author: - id: '991267517' + id: '991270016' type: admin - name: Ciaran187 Lee - email: admin187@email.com + name: Ciaran188 Lee + email: admin188@email.com attachments: [] external_id: redacted: false @@ -5199,22 +5223,22 @@ paths: User last conversation reply: value: type: conversation - id: '404' - created_at: 1704902586 - updated_at: 1704902587 - waiting_since: 1704902587 + id: '1028' + created_at: 1707237612 + updated_at: 1707237613 + waiting_since: 1707237613 snoozed_until: source: type: conversation - id: '403918304' + id: '403918668' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991267521' - name: Ciaran189 Lee - email: admin189@email.com + id: '991270020' + 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: 65c260ec86ce64a5b786d882 first_contact_reply: - created_at: 1704902587 + created_at: 1707237613 type: conversation url: admin_assignee_id: @@ -5247,15 +5271,15 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '67' + id: '225' part_type: open body: "

    Thanks again :)

    " - created_at: 1704902587 - updated_at: 1704902587 - notified_at: 1704902587 + created_at: 1707237613 + updated_at: 1707237613 + notified_at: 1707237613 assigned_to: author: - id: 659ebfba6abd014ef26e4cf5 + id: 65c260ec86ce64a5b786d882 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: 22e553d5-a3ba-419c-b884-a79bf3ed72fa 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: c59cefa2-275c-4e57-af02-c3f2e2cac79e 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: c5c37494-b955-4292-b547-6595e32d4901 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: 65c260e686ce64a5b786d87f body: Thanks again :) admin_note_reply: summary: Admin note reply value: message_type: note type: admin - admin_id: 991267517 + admin_id: 991270016 body: "

    An Unordered HTML List

    An Ordered HTML List

    \
    1. Coffee
    2. Tea
    3. Milk
    @@ -5335,14 +5359,14 @@ paths: value: message_type: comment type: user - intercom_user_id: 659ebfba6abd014ef26e4cf5 + intercom_user_id: 65c260ec86ce64a5b786d882 body: Thanks again :) not_found: summary: Not found value: message_type: comment type: user - intercom_user_id: 659ebfbc6abd014ef26e4cf6 + intercom_user_id: 65c260ed86ce64a5b786d883 body: Thanks again :) "/conversations/{id}/parts": post: @@ -5376,22 +5400,22 @@ paths: Close a conversation: value: type: conversation - id: '408' - created_at: 1704902593 - updated_at: 1704902593 + id: '1032' + created_at: 1707237618 + updated_at: 1707237619 waiting_since: snoozed_until: source: type: conversation - id: '403918308' + id: '403918672' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991267529' - name: Ciaran193 Lee - email: admin193@email.com + id: '991270028' + 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: 65c260f286ce64a5b786d886 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: '226' part_type: close body: "

    Goodbye :)

    " - created_at: 1704902593 - updated_at: 1704902593 - notified_at: 1704902593 + created_at: 1707237619 + updated_at: 1707237619 + notified_at: 1707237619 assigned_to: author: - id: '991267529' + id: '991270028' 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: '1033' + created_at: 1707237620 + updated_at: 1707237620 waiting_since: - snoozed_until: 1704906195 + snoozed_until: source: type: conversation - id: '403918309' + id: '403918673' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991267531' - name: Ciaran194 Lee - email: admin194@email.com + id: '991270030' + name: Ciaran195 Lee + email: admin195@email.com attachments: [] url: redacted: false @@ -5463,12 +5487,12 @@ paths: type: contact.list contacts: - type: contact - id: 659ebfc26abd014ef26e4cfa + id: 65c260f486ce64a5b786d887 first_contact_reply: admin_assignee_id: team_assignee_id: - open: true - state: snoozed + open: false + state: closed read: false tags: type: tag.list @@ -5483,43 +5507,27 @@ paths: topics: {} conversation_parts: type: conversation_part.list - conversation_parts: - - type: conversation_part - id: '69' - part_type: snoozed - body: - created_at: 1704902595 - updated_at: 1704902595 - notified_at: 1704902595 - assigned_to: - author: - id: '991267531' - type: admin - name: Ciaran194 Lee - email: admin194@email.com - attachments: [] - external_id: - redacted: false - total_count: 1 + conversation_parts: [] + total_count: 0 Open a conversation: value: type: conversation - id: '414' - created_at: 1704902594 - updated_at: 1704902603 + id: '1038' + created_at: 1707237620 + updated_at: 1707237629 waiting_since: snoozed_until: source: type: conversation - id: '403918310' + id: '403918674' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991267533' - name: Ciaran195 Lee - email: admin195@email.com + id: '991270032' + name: Ciaran196 Lee + email: admin196@email.com attachments: [] url: redacted: false @@ -5527,7 +5535,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ebfc66abd014ef26e4cff + id: 65c260f986ce64a5b786d88c first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5549,18 +5557,18 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '71' + id: '228' part_type: open body: - created_at: 1704902603 - updated_at: 1704902603 - notified_at: 1704902603 + created_at: 1707237629 + updated_at: 1707237629 + notified_at: 1707237629 assigned_to: author: - id: '991267533' + id: '991270032' type: admin - name: Ciaran195 Lee - email: admin195@email.com + name: Ciaran196 Lee + email: admin196@email.com attachments: [] external_id: redacted: false @@ -5568,22 +5576,22 @@ paths: Assign a conversation: value: type: conversation - id: '418' - created_at: 1704902604 - updated_at: 1704902604 + id: '1042' + created_at: 1707237630 + updated_at: 1707237631 waiting_since: snoozed_until: source: type: conversation - id: '403918313' + id: '403918677' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991267535' - name: Ciaran196 Lee - email: admin196@email.com + id: '991270034' + name: Ciaran197 Lee + email: admin197@email.com attachments: [] url: redacted: false @@ -5591,9 +5599,9 @@ paths: type: contact.list contacts: - type: contact - id: 659ebfcc6abd014ef26e4d02 + id: 65c260fe86ce64a5b786d88f first_contact_reply: - admin_assignee_id: 991267535 + admin_assignee_id: 991270034 team_assignee_id: open: true state: open @@ -5613,20 +5621,20 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '72' + id: '229' part_type: assign_and_reopen body: - created_at: 1704902605 - updated_at: 1704902605 - notified_at: 1704902605 + created_at: 1707237631 + updated_at: 1707237631 + notified_at: 1707237631 assigned_to: type: admin - id: '991267535' + id: '991270034' author: - id: '991267535' + id: '991270034' type: admin - name: Ciaran196 Lee - email: admin196@email.com + name: Ciaran197 Lee + email: admin197@email.com attachments: [] external_id: redacted: false @@ -5641,7 +5649,7 @@ paths: Not found: value: type: error.list - request_id: 564ec2be-da91-4d28-a747-b646d0e4e4cf + request_id: fba3a973-99d7-47e9-bc29-49f7924d8019 errors: - code: not_found message: Resource Not Found @@ -5655,7 +5663,7 @@ paths: Unauthorized: value: type: error.list - request_id: e436af9b-6afa-4236-b014-027af7395d29 + request_id: af860e47-d5a6-4c54-bbec-f27b3b720905 errors: - code: unauthorized message: Access Token Invalid @@ -5669,7 +5677,7 @@ paths: API plan restricted: value: type: error.list - request_id: 55a49023-06d7-4583-86d9-4e1b76bcabe4 + request_id: d6ce10fc-1b17-4477-ab02-de881a8dcccb errors: - code: api_plan_restricted message: Active subscription needed. @@ -5690,32 +5698,32 @@ paths: value: message_type: close type: admin - admin_id: 991267529 + admin_id: 991270028 body: Goodbye :) snooze_a_conversation: summary: Snooze a conversation value: message_type: snoozed - admin_id: 991267531 - snoozed_until: 1704906195 + admin_id: 991270030 + snoozed_until: 1707241221 open_a_conversation: summary: Open a conversation value: message_type: open - admin_id: 991267533 + admin_id: 991270032 assign_a_conversation: summary: Assign a conversation value: message_type: assignment type: admin - admin_id: 991267535 - assignee_id: 991267535 + admin_id: 991270034 + assignee_id: 991270034 not_found: summary: Not found value: message_type: close type: admin - admin_id: 991267537 + admin_id: 991270036 body: Goodbye :) "/conversations/{id}/run_assignment_rules": post: @@ -5746,22 +5754,22 @@ paths: Assign a conversation using assignment rules: value: type: conversation - id: '422' - created_at: 1704902609 - updated_at: 1704902610 + id: '1046' + created_at: 1707237636 + updated_at: 1707237637 waiting_since: snoozed_until: source: type: conversation - id: '403918317' + id: '403918681' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991267543' - name: Ciaran200 Lee - email: admin200@email.com + id: '991270042' + name: Ciaran201 Lee + email: admin201@email.com attachments: [] url: redacted: false @@ -5769,7 +5777,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ebfd16abd014ef26e4d06 + id: 65c2610486ce64a5b786d893 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5791,20 +5799,20 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '73' + id: '230' part_type: default_assignment body: - created_at: 1704902610 - updated_at: 1704902610 - notified_at: 1704902610 + created_at: 1707237637 + updated_at: 1707237637 + notified_at: 1707237637 assigned_to: type: nobody_admin id: author: - id: '991267544' + id: '991270043' 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 +5827,7 @@ paths: Not found: value: type: error.list - request_id: 79d74ccd-b6c7-4ba2-8877-c95f71ab318a + request_id: a3606249-5b56-4fd2-9e1c-238353e943c9 errors: - code: not_found message: Resource Not Found @@ -5833,7 +5841,7 @@ paths: Unauthorized: value: type: error.list - request_id: 265be2ae-d75f-4b52-a46d-e15ec3ca0e42 + request_id: 5998d662-dad8-4297-9f30-d4d6c90dfbae errors: - code: unauthorized message: Access Token Invalid @@ -5847,7 +5855,7 @@ paths: API plan restricted: value: type: error.list - request_id: 912829e2-d65f-4a98-8d6f-f6abf1e1a2cd + request_id: 28d3f766-2d5f-41c0-b0e3-67fcb58561cb errors: - code: api_plan_restricted message: Active subscription needed. @@ -5886,7 +5894,7 @@ paths: value: customers: - type: user - id: 659ebfd76abd014ef26e4d0a + id: 65c2610b86ce64a5b786d897 schema: "$ref": "#/components/schemas/conversation" '404': @@ -5897,7 +5905,7 @@ paths: Not found: value: type: error.list - request_id: 142e7af6-85ae-4d52-8eca-46018f87df78 + request_id: 93a968d1-916d-44aa-b881-f4fea8262b58 errors: - code: not_found message: Resource Not Found @@ -5911,7 +5919,7 @@ paths: Unauthorized: value: type: error.list - request_id: 22a7bd4b-3712-48a3-8c0b-34f18cb67d9d + request_id: de0608b6-8a20-4697-a973-265f6649dffe errors: - code: unauthorized message: Access Token Invalid @@ -5925,7 +5933,7 @@ paths: API plan restricted: value: type: error.list - request_id: '0926496b-bdb6-4aa5-b1dc-f5197304484f' + request_id: f8a4ec3f-a44d-4c9c-8d11-bd4333214873 errors: - code: api_plan_restricted message: Active subscription needed. @@ -5940,15 +5948,15 @@ paths: attach_a_contact_to_a_conversation: summary: Attach a contact to a conversation value: - admin_id: 991267551 + admin_id: 991270050 customer: - intercom_user_id: 659ebfd76abd014ef26e4d0a + intercom_user_id: 65c2610b86ce64a5b786d897 not_found: summary: Not found value: - admin_id: 991267553 + admin_id: 991270052 customer: - intercom_user_id: 659ebfd86abd014ef26e4d0b + intercom_user_id: 65c2610d86ce64a5b786d898 "/conversations/{conversation_id}/customers/{contact_id}": delete: summary: Detach a contact from a group conversation @@ -5989,7 +5997,7 @@ paths: value: customers: - type: user - id: 659ebfe36abd014ef26e4d15 + id: 65c2611a86ce64a5b786d8a2 schema: "$ref": "#/components/schemas/conversation" '404': @@ -6000,14 +6008,14 @@ paths: Conversation not found: value: type: error.list - request_id: 3a217d83-3e50-451c-bcf4-e78479843f97 + request_id: 487893c2-7c12-4b0b-8c41-6f27e51279d7 errors: - code: not_found message: Resource Not Found Contact not found: value: type: error.list - request_id: 5096be26-9d59-45fc-bc85-588251e45247 + request_id: 0c3e022d-1cd4-469c-a720-7232dc56d9ed errors: - code: not_found message: User Not Found @@ -6021,7 +6029,7 @@ paths: Last customer: value: type: error.list - request_id: 35576150-ceab-4b06-ac07-694accdecd02 + request_id: a6805af3-ecb6-4932-8750-cb08e45ff1be errors: - code: parameter_invalid message: Removing the last customer is not allowed @@ -6035,7 +6043,7 @@ paths: Unauthorized: value: type: error.list - request_id: 4d6365e5-92b3-422a-a9cb-3a695165df16 + request_id: 4fc8fba1-a74f-4db5-98d0-a2b4ea71b2d7 errors: - code: unauthorized message: Access Token Invalid @@ -6049,7 +6057,7 @@ paths: API plan restricted: value: type: error.list - request_id: 454fc060-e915-4e60-84de-b7946b76b4c9 + request_id: 614a2fb7-43ea-49fb-8b0a-e386c0980558 errors: - code: api_plan_restricted message: Active subscription needed. @@ -6064,27 +6072,27 @@ paths: detach_a_contact_from_a_group_conversation: summary: Detach a contact from a group conversation value: - admin_id: 991267559 + admin_id: 991270058 customer: - intercom_user_id: 659ebfdd6abd014ef26e4d0e + intercom_user_id: 65c2611186ce64a5b786d89b conversation_not_found: summary: Conversation not found value: - admin_id: 991267561 + admin_id: 991270060 customer: - intercom_user_id: 659ebfe46abd014ef26e4d16 + intercom_user_id: 65c2611b86ce64a5b786d8a3 contact_not_found: summary: Contact not found value: - admin_id: 991267563 + admin_id: 991270062 customer: - intercom_user_id: 659ebfeb6abd014ef26e4d1d + intercom_user_id: 65c2612386ce64a5b786d8aa last_customer: summary: Last customer value: - admin_id: 991267565 + admin_id: 991270064 customer: - intercom_user_id: 659ebff36abd014ef26e4d24 + intercom_user_id: 65c2612b86ce64a5b786d8b1 "/conversations/redact": post: summary: Redact a conversation part @@ -6111,22 +6119,22 @@ paths: Redact a conversation part: value: type: conversation - id: '478' - created_at: 1704902666 - updated_at: 1704902667 - waiting_since: 1704902666 + id: '1102' + created_at: 1707237698 + updated_at: 1707237700 + waiting_since: 1707237698 snoozed_until: source: type: conversation - id: '403918343' + id: '403918707' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991267571' - name: Ciaran214 Lee - email: admin214@email.com + id: '991270070' + name: Ciaran215 Lee + email: admin215@email.com attachments: [] url: redacted: false @@ -6134,9 +6142,9 @@ paths: type: contact.list contacts: - type: contact - id: 659ec0096abd014ef26e4d39 + id: 65c2614186ce64a5b786d8c6 first_contact_reply: - created_at: 1704902666 + created_at: 1707237698 type: conversation url: admin_assignee_id: @@ -6159,15 +6167,15 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '81' + id: '238' part_type: open body: "

    This message was deleted

    " - created_at: 1704902666 - updated_at: 1704902667 - notified_at: 1704902666 + created_at: 1707237698 + updated_at: 1707237700 + notified_at: 1707237698 assigned_to: author: - id: 659ec0096abd014ef26e4d39 + id: 65c2614186ce64a5b786d8c6 type: user name: Joe Bloggs email: joe@bloggs.com @@ -6185,7 +6193,7 @@ paths: Not found: value: type: error.list - request_id: c9c28803-cb75-4ef4-a84a-e91bf0e67d99 + request_id: 59c0ec04-0f15-4acc-9fe5-d953a3a7af0c errors: - code: conversation_part_or_message_not_found message: Conversation part or message not found @@ -6199,7 +6207,7 @@ paths: Unauthorized: value: type: error.list - request_id: '099f6c33-4434-4b7a-9fb2-35cc57fc895e' + request_id: 53163787-241c-4ed5-b99a-40e9e3eee9f0 errors: - code: unauthorized message: Access Token Invalid @@ -6215,8 +6223,8 @@ paths: summary: Redact a conversation part value: type: conversation_part - conversation_id: 478 - conversation_part_id: 81 + conversation_id: 1102 + conversation_part_id: 238 not_found: summary: Not found value: @@ -6392,7 +6400,7 @@ paths: custom: false archived: false model: company - - id: 63 + - id: 100 type: data_attribute name: The One Ring full_name: custom_attributes.The One Ring @@ -6404,9 +6412,9 @@ paths: ui_writable: false custom: true archived: false - admin_id: '991267587' - created_at: 1704902676 - updated_at: 1704902676 + admin_id: '991270095' + created_at: 1707237711 + updated_at: 1707237711 model: company - type: data_attribute name: id @@ -6473,7 +6481,7 @@ paths: Unauthorized: value: type: error.list - request_id: b8bb4508-7fae-47a9-b909-cc250e54431e + request_id: 26ae4f31-169d-4931-a707-7c01de4b447d errors: - code: unauthorized message: Access Token Invalid @@ -6498,7 +6506,7 @@ paths: examples: Successful: value: - id: 66 + id: 103 type: data_attribute name: Mithril Shirt full_name: custom_attributes.Mithril Shirt @@ -6508,9 +6516,9 @@ paths: ui_writable: false custom: true archived: false - admin_id: '991267589' - created_at: 1704902677 - updated_at: 1704902677 + admin_id: '991270097' + created_at: 1707237713 + updated_at: 1707237713 model: company schema: "$ref": "#/components/schemas/data_attribute" @@ -6522,7 +6530,7 @@ paths: Same name already exists: value: type: error.list - request_id: 0dbe56e9-dab9-44cb-aabc-cdc5f856af06 + request_id: eca84296-63f2-4f66-9ebd-67a7f8e63572 errors: - code: parameter_invalid message: You already have 'The One Ring' in your company data. @@ -6530,7 +6538,7 @@ paths: Invalid name: value: type: error.list - request_id: '080cc651-3c92-4f63-b7aa-154f07a8cacd' + request_id: 75efb33b-562a-481b-aac4-59b9fd9cca5d errors: - code: parameter_invalid message: Your name for this attribute must only contain alphanumeric @@ -6538,7 +6546,7 @@ paths: Attribute already exists: value: type: error.list - request_id: 0b26293c-c1f2-4c61-bf9c-103858dc4553 + request_id: eb519af6-c3df-4c86-abaf-2f2cf9cab205 errors: - code: parameter_invalid message: You already have 'The One Ring' in your company data. @@ -6546,14 +6554,14 @@ paths: Invalid Data Type: value: type: error.list - request_id: 2beb79ba-072b-4d3a-9ef7-be7e6125b71d + request_id: dc165f3b-b38f-4fd0-9ef4-5929b9567f96 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: 2cc739c4-eb00-4348-91ad-cfbb8927a685 errors: - code: parameter_invalid message: The Data Attribute model field must be either contact @@ -6568,7 +6576,7 @@ paths: Unauthorized: value: type: error.list - request_id: b48c89a3-1b5c-4547-86e3-7ae58324d785 + request_id: c597499e-9481-4687-9520-285d79deafd5 errors: - code: unauthorized message: Access Token Invalid @@ -6647,7 +6655,7 @@ paths: examples: Successful: value: - id: 73 + id: 110 type: data_attribute name: The One Ring full_name: custom_attributes.The One Ring @@ -6661,9 +6669,9 @@ paths: ui_writable: false custom: true archived: false - admin_id: '991267596' - created_at: 1704902679 - updated_at: 1704902680 + admin_id: '991270104' + created_at: 1707237715 + updated_at: 1707237715 model: company schema: "$ref": "#/components/schemas/data_attribute" @@ -6675,7 +6683,7 @@ paths: Too few options in list: value: type: error.list - request_id: 4f96facb-cf5a-4e05-a674-63ce507dc814 + request_id: 5d5520c6-eb75-4b55-98fc-54200813f617 errors: - code: parameter_invalid message: Options isn't an array @@ -6689,7 +6697,7 @@ paths: Attribute Not Found: value: type: error.list - request_id: 6a119cf9-02dc-4dc2-a8f3-e00aabb5ebbf + request_id: 5a27b227-5d73-4bfe-9918-318902504241 errors: - code: field_not_found message: We couldn't find that data attribute to update @@ -6703,7 +6711,7 @@ paths: Has Dependant Object: value: type: error.list - request_id: e3295d23-0d29-4855-b750-87814df76277 + request_id: ad62347d-35de-4563-a3df-a4168ac6e107 errors: - code: data_invalid message: The Data Attribute you are trying to archive has a @@ -6718,7 +6726,7 @@ paths: Unauthorized: value: type: error.list - request_id: 35f17d52-d07b-4004-9239-4ad467644e5d + request_id: ff0f6193-ef8d-4cd0-9a32-748fdb208b0c errors: - code: unauthorized message: Access Token Invalid @@ -6769,63 +6777,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 +6831,7 @@ paths: Unauthorized: value: type: error.list - request_id: e7adf1b8-b34e-48db-9949-7802ca36ad0a + request_id: b219b619-0328-4a74-94ce-8344818eb6e2 errors: - code: unauthorized message: Access Token Invalid @@ -6923,8 +6917,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: 65c2615786ce64a5b786d8cf user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 schema: "$ref": "#/components/schemas/data_event_summary" @@ -6936,7 +6930,7 @@ paths: Unauthorized: value: type: error.list - request_id: f011b7bc-07be-4447-b161-afc4410d92bd + request_id: 0a6e93e1-bf15-4ba0-a0bc-60232b5f5764 errors: - code: unauthorized message: Access Token Invalid @@ -6967,7 +6961,7 @@ paths: Unauthorized: value: type: error.list - request_id: d3955770-d5ee-4cd9-bc97-75ca8526b5eb + request_id: 6a623786-5817-4a0d-8899-166fbab59878 errors: - code: unauthorized message: Access Token Invalid @@ -7011,7 +7005,7 @@ paths: examples: successful: value: - job_identifier: qdwplfnqgdjb4wna + job_identifier: fkycc0lwzevv49yl status: pending download_url: '' download_expires_at: '' @@ -7026,8 +7020,8 @@ paths: successful: summary: successful value: - created_at_after: 1704884690 - created_at_before: 1704902690 + created_at_after: 1707219721 + created_at_before: 1707237721 "/export/content/data/{job_identifier}": get: summary: Show content data export @@ -7061,7 +7055,7 @@ paths: examples: successful: value: - job_identifier: t99ds5pna2o4fgjb + job_identifier: 33yq33vyh02fscx9 status: pending download_url: '' download_expires_at: '' @@ -7093,7 +7087,7 @@ paths: examples: successful: value: - job_identifier: ho49jvgjht3objmp + job_identifier: t5zl6vskf3yo3ipl status: canceled download_url: '' download_expires_at: '' @@ -7154,32 +7148,32 @@ paths: user message created: value: type: user_message - id: '403918354' - created_at: 1704902716 + id: '403918712' + created_at: 1707237723 body: heyy message_type: inapp - conversation_id: '494' + conversation_id: '1107' lead message created: value: type: user_message - id: '403918355' - created_at: 1704902717 + id: '403918713' + created_at: 1707237724 body: heyy message_type: inapp - conversation_id: '495' + conversation_id: '1108' admin message created: value: type: admin_message - id: '24' - created_at: 1704902718 + id: '35' + created_at: 1707237725 subject: heyy body: heyy message_type: inapp owner: type: admin - id: '991267630' - name: Ciaran255 Lee - email: admin255@email.com + id: '991270127' + name: Ciaran265 Lee + email: admin265@email.com away_mode_enabled: false away_mode_reassign: false schema: @@ -7192,14 +7186,14 @@ paths: No body supplied for message: value: type: error.list - request_id: fcf08b01-bce3-4349-a989-39081c76d61b + request_id: 3fbea8c3-9858-405c-82df-e3ad8d9ef817 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: 7a462333-974f-4bd7-8afb-fc190ebe0104 errors: - code: parameter_invalid message: Body is required @@ -7213,7 +7207,7 @@ paths: No subject supplied for email message: value: type: error.list - request_id: dd4f061f-86ee-4601-a548-bc072da25b4a + request_id: b1470e35-c1a5-4ab0-875e-d131a177141a errors: - code: parameter_not_found message: No subject supplied for email message @@ -7227,7 +7221,7 @@ paths: Unauthorized: value: type: error.list - request_id: f05d7fdf-69da-4058-8f90-8cb1664a7e9b + request_id: 31be31b0-7187-437a-ab7d-773cda61e7bc errors: - code: unauthorized message: Access Token Invalid @@ -7241,7 +7235,7 @@ paths: API plan restricted: value: type: error.list - request_id: bc15225f-94fc-4215-a83a-45f9ac12fa6a + request_id: fac2f8bd-92c3-44a5-a0f2-b39c30116f5c errors: - code: api_plan_restricted message: Active subscription needed. @@ -7258,7 +7252,7 @@ paths: value: from: type: user - id: 659ec03c6abd014ef26e4da7 + id: 65c2615b86ce64a5b786d8d4 body: heyy referer: https://twitter.com/bob lead_message_created: @@ -7266,7 +7260,7 @@ paths: value: from: type: lead - id: 659ec03d6abd014ef26e4da8 + id: 65c2615c86ce64a5b786d8d5 body: heyy referer: https://twitter.com/bob admin_message_created: @@ -7274,10 +7268,10 @@ paths: value: from: type: admin - id: '991267630' + id: '991270127' to: type: user - id: 659ec03e6abd014ef26e4da9 + id: 65c2615d86ce64a5b786d8d6 message_type: conversation body: heyy no_body_supplied_for_message: @@ -7285,10 +7279,10 @@ paths: value: from: type: admin - id: '991267632' + id: '991270129' to: type: user - id: 659ec03f6abd014ef26e4daa + id: 65c2615e86ce64a5b786d8d7 message_type: inapp body: subject: heyy @@ -7297,7 +7291,7 @@ paths: value: from: type: admin - id: '991267633' + id: '991270130' to: type: user user_id: '70' @@ -7308,10 +7302,10 @@ paths: value: from: type: admin - id: '991267634' + id: '991270131' to: type: user - id: 659ec0406abd014ef26e4dac + id: 65c2615f86ce64a5b786d8d9 message_type: email body: subject: heyy @@ -7342,12 +7336,12 @@ paths: total_pages: 1 type: pages data: - - id: '30' + - id: '85' 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: 991270136 state: draft labels: [] cover_image_url: @@ -7357,15 +7351,15 @@ paths: - - deliver_silently: false - created_at: 1704902722 - updated_at: 1704902722 + created_at: 1707237728 + updated_at: 1707237728 newsfeed_assignments: [] - - id: '29' + - id: '86' 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: 991270138 state: draft labels: [] cover_image_url: @@ -7375,8 +7369,8 @@ paths: - - deliver_silently: false - created_at: 1704902721 - updated_at: 1704902721 + created_at: 1707237728 + updated_at: 1707237728 newsfeed_assignments: [] total_count: 2 schema: @@ -7389,7 +7383,7 @@ paths: Unauthorized: value: type: error.list - request_id: 45c0d233-aeb5-4b8f-b652-9893dcef6544 + request_id: 57d958c2-0823-4574-91e8-692ea6c085da errors: - code: unauthorized message: Access Token Invalid @@ -7414,12 +7408,12 @@ paths: examples: successful: value: - id: '33' + id: '89' 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: 991270145 state: live labels: - New @@ -7430,10 +7424,10 @@ paths: - "\U0001F606" - "\U0001F605" deliver_silently: true - created_at: 1704902723 - updated_at: 1704902723 + created_at: 1707237730 + updated_at: 1707237730 newsfeed_assignments: - - newsfeed_id: 53 + - newsfeed_id: 153 published_at: 1664638214 schema: "$ref": "#/components/schemas/news_item" @@ -7445,7 +7439,7 @@ paths: Unauthorized: value: type: error.list - request_id: e698bf6c-3069-47cb-9380-ac57fe87ca5b + request_id: '018a12c5-d3fe-45ca-a036-fd4095ebefd9' errors: - code: unauthorized message: Access Token Invalid @@ -7466,14 +7460,14 @@ paths: - Product - Update - New - sender_id: 991267648 + sender_id: 991270145 deliver_silently: true reactions: - "\U0001F606" - "\U0001F605" state: live newsfeed_assignments: - - newsfeed_id: 53 + - newsfeed_id: 153 published_at: 1664638214 "/news/news_items/{id}": get: @@ -7502,12 +7496,12 @@ paths: examples: successful: value: - id: '34' + id: '90' 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: 991270148 state: live labels: [] cover_image_url: @@ -7517,11 +7511,11 @@ paths: - - deliver_silently: false - created_at: 1704902724 - updated_at: 1704902724 + created_at: 1707237731 + updated_at: 1707237731 newsfeed_assignments: - - newsfeed_id: 55 - published_at: 1704902724 + - newsfeed_id: 155 + published_at: 1707237731 schema: "$ref": "#/components/schemas/news_item" '404': @@ -7532,7 +7526,7 @@ paths: News Item Not Found: value: type: error.list - request_id: decf1905-c5d6-48e7-bbf5-23424635271e + request_id: 78d4f45c-e21a-4411-a86b-a6f552b2249a errors: - code: not_found message: Resource Not Found @@ -7546,7 +7540,7 @@ paths: Unauthorized: value: type: error.list - request_id: a73ebf48-8a96-4b5b-9551-3e70c0fda634 + request_id: a76fb454-3347-473d-b3b3-1014efaa326c errors: - code: unauthorized message: Access Token Invalid @@ -7577,12 +7571,12 @@ paths: examples: successful: value: - id: '37' + id: '93' 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: 991270156 state: live labels: [] cover_image_url: @@ -7590,8 +7584,8 @@ paths: - "\U0001F61D" - "\U0001F602" deliver_silently: false - created_at: 1704902726 - updated_at: 1704902726 + created_at: 1707237733 + updated_at: 1707237733 newsfeed_assignments: [] schema: "$ref": "#/components/schemas/news_item" @@ -7603,7 +7597,7 @@ paths: News Item Not Found: value: type: error.list - request_id: 8d269c67-ec53-486d-895e-809ba2b2fac6 + request_id: dcf59ae2-3798-4263-93cf-3ba58c6f1840 errors: - code: not_found message: Resource Not Found @@ -7617,7 +7611,7 @@ paths: Unauthorized: value: type: error.list - request_id: 778c29f5-915e-40f7-98c8-be902cbf2e31 + request_id: 68d285f2-562c-495e-a90b-d16cd74d02f8 errors: - code: unauthorized message: Access Token Invalid @@ -7634,7 +7628,7 @@ paths: value: title: Christmas is here! body: "

    New gifts in store for the jolly season

    " - sender_id: 991267659 + sender_id: 991270156 reactions: - "\U0001F61D" - "\U0001F602" @@ -7643,7 +7637,7 @@ paths: value: title: Christmas is here! body: "

    New gifts in store for the jolly season

    " - sender_id: 991267662 + sender_id: 991270159 reactions: - "\U0001F61D" - "\U0001F602" @@ -7673,7 +7667,7 @@ paths: examples: successful: value: - id: '40' + id: '96' object: news-item deleted: true schema: @@ -7686,7 +7680,7 @@ paths: News Item Not Found: value: type: error.list - request_id: 2dc811cd-76fa-43e8-92fe-7c83b5f7001d + request_id: ac210b19-0549-4dfd-b270-3d1c67b8720b errors: - code: not_found message: Resource Not Found @@ -7700,7 +7694,7 @@ paths: Unauthorized: value: type: error.list - request_id: a02a14d3-5cb9-439f-b05c-31b45064c37a + request_id: 02efd300-e5ca-4c2e-b8c6-cb2a9ab75c6c errors: - code: unauthorized message: Access Token Invalid @@ -7753,7 +7747,7 @@ paths: Unauthorized: value: type: error.list - request_id: 5ea01b2b-06c1-4ed1-9942-06890247fe3f + request_id: 15e80f6e-92b9-46ec-a99e-a0c5a3be6835 errors: - code: unauthorized message: Access Token Invalid @@ -7786,16 +7780,16 @@ paths: total_pages: 1 type: pages data: - - id: '68' + - id: '168' type: newsfeed name: Visitor Feed - created_at: 1704902730 - updated_at: 1704902730 - - id: '69' + created_at: 1707237737 + updated_at: 1707237737 + - id: '169' type: newsfeed name: Visitor Feed - created_at: 1704902730 - updated_at: 1704902730 + created_at: 1707237737 + updated_at: 1707237737 total_count: 2 schema: "$ref": "#/components/schemas/paginated_response" @@ -7807,7 +7801,7 @@ paths: Unauthorized: value: type: error.list - request_id: b7b8e4fc-5843-4559-9e3e-5f10c39f140a + request_id: 7a273bce-808a-47ae-9d5c-1242706d8bed errors: - code: unauthorized message: Access Token Invalid @@ -7841,11 +7835,11 @@ paths: examples: successful: value: - id: '72' + id: '172' type: newsfeed name: Visitor Feed - created_at: 1704902731 - updated_at: 1704902731 + created_at: 1707237738 + updated_at: 1707237738 schema: "$ref": "#/components/schemas/newsfeed" '401': @@ -7856,7 +7850,7 @@ paths: Unauthorized: value: type: error.list - request_id: 7bec245e-1d80-44a8-b04c-40728aa34c66 + request_id: d79a1cb1-7228-4fcb-9cd6-012e3a2dc0fa errors: - code: unauthorized message: Access Token Invalid @@ -7890,16 +7884,16 @@ paths: Note found: value: type: note - id: '77' - created_at: 1704211534 + id: '109' + created_at: 1706546539 contact: type: contact - id: 659ec04e6abd014ef26e4db7 + id: 65c2616b86ce64a5b786d8dc author: type: admin - id: '991267678' - name: Ciaran302 Lee - email: admin302@email.com + id: '991270175' + name: Ciaran312 Lee + email: admin312@email.com away_mode_enabled: false away_mode_reassign: false body: "

    This is a note.

    " @@ -7913,7 +7907,7 @@ paths: Note not found: value: type: error.list - request_id: 0614fee6-9d4f-423a-a053-4cfaa47482e2 + request_id: f1e5524b-0d85-4e09-8051-28f6a0245747 errors: - code: not_found message: Resource Not Found @@ -7927,7 +7921,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8893816d-d388-4bf5-9cc6-5ca6d10dfe72 + request_id: fccbca69-d026-4f65-ae93-99b6283f9472 errors: - code: unauthorized message: Access Token Invalid @@ -7963,16 +7957,16 @@ paths: type: segment.list segments: - type: segment - id: 659ec0516abd014ef26e4dbe + id: 65c2616c86ce64a5b786d8df name: John segment - created_at: 1704902737 - updated_at: 1704902737 + created_at: 1707237740 + updated_at: 1707237740 person_type: user - type: segment - id: 659ec0516abd014ef26e4dbf + id: 65c2616c86ce64a5b786d8e0 name: Jane segment - created_at: 1704902737 - updated_at: 1704902737 + created_at: 1707237740 + updated_at: 1707237740 person_type: user schema: "$ref": "#/components/schemas/segment_list" @@ -7984,7 +7978,7 @@ paths: Unauthorized: value: type: error.list - request_id: 1f177e7c-8572-4af2-8dbf-790d3b4a5283 + request_id: af7ddd9b-62dc-4837-87c1-3a3f31e61f85 errors: - code: unauthorized message: Access Token Invalid @@ -8018,10 +8012,10 @@ paths: Successful response: value: type: segment - id: 659ec0526abd014ef26e4dc2 + id: 65c2616d86ce64a5b786d8e3 name: John segment - created_at: 1704902738 - updated_at: 1704902738 + created_at: 1707237741 + updated_at: 1707237741 person_type: user schema: "$ref": "#/components/schemas/segment" @@ -8033,7 +8027,7 @@ paths: Segment not found: value: type: error.list - request_id: a61365a1-4bf7-46f6-8523-2485249f69fc + request_id: 61d0d03b-8abd-43ff-9698-2f19a245ade0 errors: - code: not_found message: Resource Not Found @@ -8047,7 +8041,7 @@ paths: Unauthorized: value: type: error.list - request_id: bf02f0ae-2ee8-4e95-a19f-2339d3966de9 + request_id: 5985c029-260e-4d7b-bc66-c928dd2eb583 errors: - code: unauthorized message: Access Token Invalid @@ -8077,7 +8071,7 @@ paths: type: list data: - type: subscription - id: '180' + id: '409' state: live consent_type: opt_out default_translation: @@ -8100,7 +8094,7 @@ paths: Unauthorized: value: type: error.list - request_id: ac3ec790-eb33-4273-bb15-94e3922ba9a1 + request_id: fb5404c2-223d-442b-bf24-cbd1665c0a95 errors: - code: unauthorized message: Access Token Invalid @@ -8130,7 +8124,7 @@ paths: examples: successful: value: - url: http://via.intercom.io/msgr/d5e813fc-a1e6-4feb-83c7-a5e3d7323f72 + url: http://via.intercom.io/msgr/9d347702-5158-4ea1-b174-3196a71dca40 type: phone_call_redirect schema: "$ref": "#/components/schemas/phone_switch" @@ -8163,7 +8157,7 @@ paths: Unauthorized: value: type: error.list - request_id: b508c27d-2c21-4f6f-836c-cc83840765d5 + request_id: ee50605a-189f-46f3-acd6-96403f4e9ad5 errors: - code: unauthorized message: Access Token Invalid @@ -8226,7 +8220,7 @@ paths: type: list data: - type: tag - id: '127' + id: '309' name: Manual tag 1 schema: "$ref": "#/components/schemas/tag_list" @@ -8238,7 +8232,7 @@ paths: Unauthorized: value: type: error.list - request_id: 41eb6776-5f03-4fee-85ce-d1132e4e6399 + request_id: 050a1b65-cd9f-47d2-9577-51dc2cc69071 errors: - code: unauthorized message: Access Token Invalid @@ -8277,7 +8271,7 @@ paths: Action successful: value: type: tag - id: '130' + id: '312' name: test schema: "$ref": "#/components/schemas/tag" @@ -8289,7 +8283,7 @@ paths: Invalid parameters: value: type: error.list - request_id: 4c7feb9b-1e4b-4c13-8611-a345d2c70be5 + request_id: c1ddf89e-2750-446c-8934-58c378f761a6 errors: - code: parameter_invalid message: invalid tag parameters @@ -8303,14 +8297,14 @@ paths: Company not found: value: type: error.list - request_id: ba6b73de-a50e-469a-bd24-3414e3eb8cd8 + request_id: 78fee756-dbb4-4588-a3cf-82e1f1602400 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: 0a539a4a-6c21-4a53-b0ba-c64c0d4c3638 errors: - code: not_found message: User Not Found @@ -8324,7 +8318,7 @@ paths: Unauthorized: value: type: error.list - request_id: 4b28d7de-40b0-4695-8d29-4a448c7fe5d2 + request_id: e3bf2c56-14d9-4157-945e-8a16d6611ad5 errors: - code: unauthorized message: Access Token Invalid @@ -8390,7 +8384,7 @@ paths: Tag found: value: type: tag - id: '138' + id: '320' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -8402,7 +8396,7 @@ paths: Tag not found: value: type: error.list - request_id: 2a267451-14c8-4580-8f33-2d44cc2537a8 + request_id: 7ae10091-80b8-4c93-b810-913f7155702d errors: - code: not_found message: Resource Not Found @@ -8416,7 +8410,7 @@ paths: Unauthorized: value: type: error.list - request_id: 45fa6074-62e3-4731-b7c8-387c89dfe7d7 + request_id: ef3958f3-d14f-44fe-b6e5-b83f182693dd errors: - code: unauthorized message: Access Token Invalid @@ -8452,7 +8446,7 @@ paths: Resource not found: value: type: error.list - request_id: 9a46fce0-7752-44af-806f-6d14aa0a1098 + request_id: 32a907c8-4469-4257-ba2f-4d82bc974257 errors: - code: not_found message: Resource Not Found @@ -8466,7 +8460,7 @@ paths: Tag has dependent objects: value: type: error.list - request_id: 29e0257b-8ba4-40d8-a00b-c18642866d0a + request_id: 6523b520-a258-4ad0-babb-a1af4c5c63b0 errors: - code: tag_has_dependent_objects message: 'Unable to delete Tag with dependent objects. Segments: @@ -8481,7 +8475,7 @@ paths: Unauthorized: value: type: error.list - request_id: 63bc2fce-112a-451c-b56f-2a8bd568394b + request_id: bb185d75-b360-4bd0-9195-1c0fb7897a4b errors: - code: unauthorized message: Access Token Invalid @@ -8519,7 +8513,7 @@ paths: Unauthorized: value: type: error.list - request_id: 56e196f9-7766-4e91-9aae-7ed2098d13e5 + request_id: 49e04f71-19c5-4c21-9e5f-f063892e150a errors: - code: unauthorized message: Access Token Invalid @@ -8554,7 +8548,7 @@ paths: successful: value: type: team - id: '991267722' + id: '991270213' name: team 1 admin_ids: [] schema: @@ -8567,7 +8561,7 @@ paths: Team not found: value: type: error.list - request_id: e0d87a7d-a6be-432d-82d8-54ad1ded4bff + request_id: caa69c59-8c48-4ffd-bd23-fae457cc4e75 errors: - code: team_not_found message: Team not found @@ -8581,7 +8575,7 @@ paths: Unauthorized: value: type: error.list - request_id: a7642b24-48cb-4640-9bcd-b92051657c54 + request_id: e03d4408-56d3-4c89-a03d-f6e86c62187e errors: - code: unauthorized message: Access Token Invalid @@ -8613,26 +8607,26 @@ paths: successful: value: type: visitor - id: 659ec0926abd014ef26e4edc + id: 65c2618786ce64a5b786d907 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' phone: name: Gareth Bale - pseudonym: Violet Deer + pseudonym: Pink Anchor 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/pink-anchor.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: 1707237767 + remote_created_at: 1707237767 + signed_up_at: 1707237767 + updated_at: 1707237768 session_count: 0 social_profiles: type: social_profile.list @@ -8665,7 +8659,7 @@ paths: visitor Not Found: value: type: error.list - request_id: d505b76a-c372-4f4d-a133-44c024682903 + request_id: 626b24ae-6e48-427c-b7b7-611f25806032 errors: - code: not_found message: Visitor Not Found @@ -8679,7 +8673,7 @@ paths: Unauthorized: value: type: error.list - request_id: 6c9a138a-36e9-4c4a-accc-924eafa4cee8 + request_id: beddc16a-4e90-4c68-89f4-b3889f798ad0 errors: - code: unauthorized message: Access Token Invalid @@ -8694,7 +8688,7 @@ paths: successful: summary: successful value: - id: 659ec0926abd014ef26e4edc + id: 65c2618786ce64a5b786d907 name: Gareth Bale visitor_not_found: summary: visitor Not Found @@ -8727,7 +8721,7 @@ paths: successful: value: type: visitor - id: 659ec0936abd014ef26e4ee2 + id: 65c2618886ce64a5b786d90d user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' @@ -8737,16 +8731,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: 1707237768 + remote_created_at: 1707237768 + signed_up_at: 1707237768 + updated_at: 1707237768 session_count: 0 social_profiles: type: social_profile.list @@ -8779,7 +8773,7 @@ paths: Visitor not found: value: type: error.list - request_id: aa48054b-62ff-4c7b-abc4-3e8f6c2a1633 + request_id: ee84c942-3184-42c3-aed2-f2a9befddf05 errors: - code: not_found message: Visitor Not Found @@ -8793,7 +8787,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0d3ed27a-0248-47ea-95bf-3a206885761d + request_id: 7f027308-b7d7-4b56-ae76-aca15cb57f97 errors: - code: unauthorized message: Access Token Invalid @@ -8827,7 +8821,7 @@ paths: successful: value: type: visitor - id: 659ec0956abd014ef26e4ee8 + id: 65c2618a86ce64a5b786d913 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' @@ -8837,16 +8831,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: 1707237770 + remote_created_at: 1707237770 + signed_up_at: 1707237770 + updated_at: 1707237770 session_count: 0 social_profiles: type: social_profile.list @@ -8879,7 +8873,7 @@ paths: Visitor not found: value: type: error.list - request_id: 335184da-c6fe-4020-b1ff-48993f7594cf + request_id: 67eee36e-d199-4d63-b703-149b33a15da1 errors: - code: not_found message: Visitor Not Found @@ -8893,7 +8887,7 @@ paths: Unauthorized: value: type: error.list - request_id: 613b17be-6510-4373-bfa7-a1ec831e529e + request_id: 9b6058dd-26fe-4b64-8946-7fbff4016d71 errors: - code: unauthorized message: Access Token Invalid @@ -8926,7 +8920,7 @@ paths: successful: value: type: visitor - id: 659ec0966abd014ef26e4eee + id: 65c2618b86ce64a5b786d919 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' @@ -8936,16 +8930,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: 1707237771 + remote_created_at: 1707237771 + signed_up_at: 1707237771 + updated_at: 1707237772 session_count: 0 social_profiles: type: social_profile.list @@ -8978,7 +8972,7 @@ paths: Visitor Not Found: value: type: error.list - request_id: fb746054-43c0-49c9-acf7-1a88914445a9 + request_id: d11df064-e6b3-41de-b2c9-77fa255049d9 errors: - code: not_found message: User Not Found @@ -8992,7 +8986,7 @@ paths: Unauthorized: value: type: error.list - request_id: dc30cce0-e7f5-452a-ae94-5a3887df8e8b + request_id: e767f5c7-4cd3-4b7d-b886-34a2ce077e42 errors: - code: unauthorized message: Access Token Invalid @@ -9023,8 +9017,8 @@ paths: successful: value: type: contact - id: 659ec0986abd014ef26e4ef5 - workspace_id: this_is_an_id616_that_should_be_at_least_ + id: 65c2618d86ce64a5b786d920 + workspace_id: this_is_an_id633_that_should_be_at_least_ external_id: role: user email: foo@bar.com @@ -9038,9 +9032,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: 1707237773 + updated_at: 1707237774 + signed_up_at: 1707237773 last_seen_at: last_replied_at: last_contacted_at: @@ -9074,31 +9068,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ec0986abd014ef26e4ef5/tags" + url: "/contacts/65c2618d86ce64a5b786d920/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ec0986abd014ef26e4ef5/notes" + url: "/contacts/65c2618d86ce64a5b786d920/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ec0986abd014ef26e4ef5/companies" + url: "/contacts/65c2618d86ce64a5b786d920/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ec0986abd014ef26e4ef5/subscriptions" + url: "/contacts/65c2618d86ce64a5b786d920/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ec0986abd014ef26e4ef5/subscriptions" + url: "/contacts/65c2618d86ce64a5b786d920/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -9117,7 +9111,7 @@ paths: Unauthorized: value: type: error.list - request_id: f3917e09-b7f7-466b-a03f-5c39af75ff09 + request_id: 8c7b38f6-26cb-49c1-9fc2-b1312ee8be16 errors: - code: unauthorized message: Access Token Invalid @@ -11707,7 +11701,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 @@ -12020,30 +12015,6 @@ components: anyOf: - type: string - "$ref": "#/components/schemas/custom_object_instance" - custom_object_instance: - title: Custom Object Instance - type: object - nullable: true - description: An instance of a Custom Object Type. - properties: - id: - type: string - description: The Intercom defined id representing the custom object instance. - example: 5a7a19e9f59ae20001d1c1e6 - external_id: - type: string - description: The id you have defined for the custom object instance. - example: 0001d1c1e65a7a19e9f59ae2 - type: - type: string - description: The identifier of the custom object type that defines the structure - of the custom object instance. - example: Order - custom_attributes: - type: object - description: The custom attributes you have set on the custom object instance. - additionalProperties: - type: string customer_request: type: object nullable: true diff --git a/descriptions/2.9/api.intercom.io.yaml b/descriptions/2.9/api.intercom.io.yaml index e254724..7a221a8 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: '991270307' 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: 1707237787 secure: false identity_verification: false timezone: America/Los_Angeles @@ -83,7 +83,7 @@ paths: Successful response: value: type: admin - id: '991267809' + id: '991270308' 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: e6715a94-f31f-4738-9300-3d4b0b07b818 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: 8cbf174b-3ed4-4a7f-b5eb-fe77b8e643dd 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: e2a119c5-d7ea-4189-8034-f26234da698f 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: '991270312' 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: 1707237793 activity_type: message_state_change activity_description: Ciaran5 Lee changed your Initial message title message from Initial message title to Eventual message title. + - id: 024f3247-f1ff-4c42-a12f-dd0038cbe0a1 + performed_by: + type: admin + id: '991270312' + email: admin5@email.com + ip: 127.0.0.1 + metadata: + before: before + after: after + created_at: 1707237793 + 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: 04756a71-6a1d-40da-ac2b-31821c2bf9a2 errors: - code: unauthorized message: Access Token Invalid @@ -271,7 +271,7 @@ paths: admins: - type: admin email: admin7@email.com - id: '991267816' + id: '991270314' 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: 13fcfaf8-bbb2-4f95-a54e-f5cbc5b9793d errors: - code: unauthorized message: Access Token Invalid @@ -321,7 +321,7 @@ paths: Admin found: value: type: admin - id: '991267818' + id: '991270316' 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: 7c8e2460-2b96-4754-8432-f0cf64d58c83 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: 9eb956ef-c05c-4138-af6a-19a0ccf82128 errors: - code: unauthorized message: Access Token Invalid @@ -390,20 +390,20 @@ paths: total_pages: 1 total_count: 1 data: - - id: '69' + - id: '160' type: article workspace_id: this_is_an_id22_that_should_be_at_least_4 - parent_id: 289 + parent_id: 646 parent_type: collection parent_ids: [] title: This is the article title description: '' body: '' - author_id: 991267821 + author_id: 991270319 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: 1707237797 + updated_at: 1707237797 + url: http://help-center.test/myapp-22/en/articles/160-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: 571af2ca-e95e-474a-b4be-6a6ba8bd85bb errors: - code: unauthorized message: Access Token Invalid @@ -439,10 +439,10 @@ paths: examples: article created: value: - id: '72' + id: '163' type: article workspace_id: this_is_an_id26_that_should_be_at_least_4 - parent_id: 291 + parent_id: 648 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: 991270324 state: published - created_at: 1704902834 - updated_at: 1704902834 - url: http://help-center.test/myapp-26/en/articles/72-thanks-for-everything + created_at: 1707237799 + updated_at: 1707237799 + url: http://help-center.test/myapp-26/en/articles/163-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: 2643146f-6d13-4758-b1f1-fb974f6e7df6 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: fca9406b-84e0-491d-822d-a29ae0a9d0de 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: 991270324 state: published - parent_id: 291 + parent_id: 648 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: 991270324 state: published bad_request: summary: Bad Request @@ -550,10 +550,10 @@ paths: examples: Article found: value: - id: '75' + id: '166' type: article workspace_id: this_is_an_id32_that_should_be_at_least_4 - parent_id: 294 + parent_id: 651 parent_type: collection parent_ids: [] statistics: @@ -567,11 +567,11 @@ paths: title: This is the article title description: '' body: '' - author_id: 991267831 + author_id: 991270329 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: 1707237800 + updated_at: 1707237800 + url: http://help-center.test/myapp-32/en/articles/166-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: 69113ec0-2044-496e-85f5-3c1df6602bfb 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: 8c0ff027-ffc3-493e-a9f1-29ff86c51443 errors: - code: unauthorized message: Access Token Invalid @@ -629,10 +629,10 @@ paths: examples: successful: value: - id: '78' + id: '169' type: article workspace_id: this_is_an_id38_that_should_be_at_least_4 - parent_id: 297 + parent_id: 654 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: 991270335 state: published - created_at: 1704902838 - updated_at: 1704902839 - url: http://help-center.test/myapp-38/en/articles/78-christmas-is-here + created_at: 1707237802 + updated_at: 1707237802 + url: http://help-center.test/myapp-38/en/articles/169-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: 7a88a571-da1d-4d92-8729-2cd50d5bea6f 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: bc94458e-d53f-4506-b223-dc8dec8e8b32 errors: - code: unauthorized message: Access Token Invalid @@ -723,7 +723,7 @@ paths: examples: successful: value: - id: '81' + id: '172' 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: ee248e5f-5c88-4dbe-8d1e-3a67c445a019 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: 0714d077-2daa-4cf2-a0ca-77ae30ef6e99 errors: - code: unauthorized message: Access Token Invalid @@ -783,16 +783,16 @@ paths: value: type: list data: - - id: '305' + - id: '662' 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: 1707237806 + updated_at: 1707237806 description: english collection description icon: bookmark - help_center_id: 161 + help_center_id: 326 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: 156caafb-ff58-44ee-a135-2d589bb20386 errors: - code: unauthorized message: Access Token Invalid @@ -835,16 +835,16 @@ paths: examples: collection created: value: - id: '311' + id: '668' 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: 1707237807 + updated_at: 1707237807 description: '' icon: book-bookmark - help_center_id: 163 + help_center_id: 328 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: 32b16626-2ebe-4c81-bb36-0037872c91ad 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: bcac15ef-0c36-4b9f-b05e-1e1fb9296a64 errors: - code: unauthorized message: Access Token Invalid @@ -918,16 +918,16 @@ paths: examples: Collection found: value: - id: '316' + id: '673' 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: 1707237808 + updated_at: 1707237808 description: english collection description icon: bookmark - help_center_id: 166 + help_center_id: 331 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: c2c314c1-845b-41a8-94f0-e5d7a02f1b87 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: f4de6676-4df0-46a6-b4b3-37baf51162e6 errors: - code: unauthorized message: Access Token Invalid @@ -986,16 +986,16 @@ paths: examples: successful: value: - id: '322' + id: '679' 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: 1707237809 + updated_at: 1707237810 description: english collection description icon: folder - help_center_id: 169 + help_center_id: 334 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: 7e3be0ba-c985-4f80-8f5e-2b6dfdea31f0 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: 787e29c6-17fb-4227-8ed0-4491d012bebc errors: - code: unauthorized message: Access Token Invalid @@ -1068,7 +1068,7 @@ paths: examples: successful: value: - id: '328' + id: '685' 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: 5018a670-7bb0-474b-b9c6-1ed7ec6565c0 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: 2401170f-fac0-4685-80b8-31ba23b89ff5 errors: - code: unauthorized message: Access Token Invalid @@ -1129,10 +1129,10 @@ paths: examples: Collection found: value: - id: '175' + id: '340' workspace_id: this_is_an_id80_that_should_be_at_least_4 - created_at: 1704902849 - updated_at: 1704902849 + created_at: 1707237812 + updated_at: 1707237812 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: 8edac453-d4b4-4651-8b23-c0783c503981 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: 4832a258-01c8-404d-816f-61c3b920bbd4 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: 158b259f-1cb6-4a1a-80f0-eab3d7b5e11f errors: - code: unauthorized message: Access Token Invalid @@ -1230,15 +1230,15 @@ paths: value: type: list data: - - id: '335' + - id: '692' 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: 1707237814 + updated_at: 1707237814 type: section - parent_id: 334 + parent_id: 691 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: 6cd0104c-b2cb-499a-b8ce-a7b956c57042 errors: - code: unauthorized message: Access Token Invalid @@ -1280,15 +1280,15 @@ paths: examples: section created: value: - id: '340' + id: '697' 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: 1707237815 + updated_at: 1707237815 type: section - parent_id: '338' + parent_id: '695' 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: 04a9c490-3dfc-41e7-a3ee-5205c5cbc435 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: 695 "/help_center/sections/{id}": get: summary: Retrieve a section @@ -1344,15 +1344,15 @@ paths: examples: Section found: value: - id: '344' + id: '701' 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: 1707237815 + updated_at: 1707237815 type: section - parent_id: 343 + parent_id: 700 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: 1cb500a6-9b07-4e9e-a99a-6551880ffc95 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: 1eb7d118-da5b-4af2-8350-a6d32d0ba0ef errors: - code: unauthorized message: Access Token Invalid @@ -1410,15 +1410,15 @@ paths: examples: successful: value: - id: '350' + id: '707' 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: 1707237817 + updated_at: 1707237817 type: section - parent_id: '349' + parent_id: '706' 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: faedd8c5-7ce3-4654-be71-1d730c47ebe4 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: 28ccdf21-ef03-445d-a8b2-4a51f6964b0e errors: - code: unauthorized message: Access Token Invalid @@ -1459,12 +1459,12 @@ paths: summary: successful value: name: Update section name - parent_id: 349 + parent_id: 706 section_not_found: summary: Section Not Found value: name: Update section name - parent_id: 351 + parent_id: 708 delete: summary: Delete a section parameters: @@ -1491,7 +1491,7 @@ paths: examples: successful: value: - id: '356' + id: '713' 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: bd159905-526a-41c2-a84b-dbc0b2dc775f 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: 112d655c-8594-4158-acbd-0fd096bdbca9 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: 65c261bb86ce64a79327e875 + 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: 1707237819 + updated_at: 1707237819 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: ccd7a65c-59a6-4ff0-bee5-3d2e8c5faa95 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: 65c261bd86ce64a79327e87d + 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: 1707237821 + created_at: 1707237821 + updated_at: 1707237821 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: 30d57a41-4c74-4d41-88f1-233b5916c30c 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: d919ed98-51aa-4f63-89b8-053e19038e31 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: 65c261bf86ce64a79327e888 + app_id: this_is_an_id128_that_should_be_at_least_ + name: company1 + remote_created_at: 1707237823 + created_at: 1707237823 + updated_at: 1707237823 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: 23f034f5-030e-4032-906a-e4df7449515c 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: 7bb7748f-e727-4129-ac20-330e90cc364d 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: 65c261c186ce64a79327e892 + app_id: this_is_an_id134_that_should_be_at_least_ + name: company2 + remote_created_at: 1707237825 + created_at: 1707237825 + updated_at: 1707237825 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: 477958bb-12e1-4d58-884b-eeaf0a268616 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: 589f21bb-b597-462f-9511-1786030698e4 errors: - code: unauthorized message: Access Token Invalid @@ -1915,7 +1922,7 @@ paths: examples: Successful: value: - id: 659ec0d26abd0150e7d4a1dc + id: 65c261c386ce64a79327e89c 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: 3dcff35b-93e0-4f0c-8583-7f8e2f59dc7f 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: 6f0ac1bf-df0e-442e-b498-82a85cf05d8a 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: e45f4de1-6a28-4d1c-88d3-0eeed706789b 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: 96b52e90-38ee-444b-afa4-6486b92a66db 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: 2a323579-b9dc-4d5e-bb73-602d3369d5eb 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: 92a6b7be-34fe-44f9-92d9-cdeef85d302d 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: 65c261c986ce64a79327e8b8 + 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: 1707237833 + created_at: 1707237833 + updated_at: 1707237833 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: 9b039d08-5972-435d-aab6-af58105a9a06 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: 65c261ca86ce64a79327e8be + 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: 1707237834 + created_at: 1707237834 + updated_at: 1707237834 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: 3ece1507-9cf4-4359-b815-6a9257fde4b5 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: 447760fe-765c-4fc8-9c8b-6772dbf5e2fa 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: 65c261cc86ce64a79327e8c7 + app_id: this_is_an_id166_that_should_be_at_least_ + name: company6 + remote_created_at: 1707237836 + created_at: 1707237836 + updated_at: 1707237836 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: a590d547-1bc3-470a-9456-770dd80b48f9 + 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: 6d797b09-e179-4e0d-ad6e-7bfa0dae0b62 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: a9ebbea3-9e65-4fd7-a40f-e27efe1b362f errors: - code: unauthorized message: Access Token Invalid @@ -2339,11 +2360,14 @@ paths: successful: summary: Successful value: - id: 659ec0da6abd0150e7d4a207 + id: 65c261cc86ce64a79327e8c7 + 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: 65c261d286ce64a79327e8e8 + app_id: this_is_an_id182_that_should_be_at_least_ + name: company12 + remote_created_at: 1707237842 + created_at: 1707237842 + updated_at: 1707237842 + last_request_at: 1707065042 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: de19b539-edd7-43cd-93a7-180dfd4a725d 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: fed0a63d-8a36-466e-94fc-6dff676b4840 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: 65c261cf86ce64a79327e8d7 + app_id: this_is_an_id174_that_should_be_at_least_ + name: company8 + remote_created_at: 1707237839 + created_at: 1707237839 + updated_at: 1707237839 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: 2aadf1b7-b573-450d-86e8-a0c9e9384ad8 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: 47d14813-b2d5-437a-a474-a046557fdd6d 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: 5555bc17-e089-4ef6-b121-8774ee6b645f errors: - code: unauthorized message: Access Token Invalid @@ -2551,44 +2575,44 @@ paths: type: list data: - type: note - id: '82' - created_at: 1704298087 + id: '114' + created_at: 1706633044 contact: type: contact - id: 659ec0e76abd0150e7d4a244 + id: 65c261d486ce64a79327e8f3 author: type: admin - id: '991267918' - name: Ciaran109 Lee - email: admin109@email.com + id: '991270417' + 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: '113' + created_at: 1706546644 contact: type: contact - id: 659ec0e76abd0150e7d4a244 + id: 65c261d486ce64a79327e8f3 author: type: admin - id: '991267918' - name: Ciaran109 Lee - email: admin109@email.com + id: '991270417' + 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: '112' + created_at: 1706546644 contact: type: contact - id: 659ec0e76abd0150e7d4a244 + id: 65c261d486ce64a79327e8f3 author: type: admin - id: '991267918' - name: Ciaran109 Lee - email: admin109@email.com + id: '991270417' + 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: 7b988d45-44a4-4d37-80da-db889db3fc24 errors: - code: not_found message: User Not Found @@ -2643,16 +2667,16 @@ paths: Successful response: value: type: note - id: '87' - created_at: 1704902888 + id: '119' + created_at: 1707237845 contact: type: contact - id: 659ec0e86abd0150e7d4a246 + id: 65c261d586ce64a79327e8f5 author: type: admin - id: '991267920' - name: Ciaran111 Lee - email: admin111@email.com + id: '991270419' + 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: f45e9cce-397b-4bf6-92cb-b4e7fe036bc2 errors: - code: not_found message: Resource Not Found Contact not found: value: type: error.list - request_id: c7d979e7-23c9-4251-a0a6-38363f21d3b9 + request_id: cf5a3cd3-83a4-4cbc-8d39-f284b895395e 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: 65c261d586ce64a79327e8f5 + admin_id: 991270419 body: Hello admin_not_found: summary: Admin not found value: - contact_id: 659ec0e96abd0150e7d4a247 + contact_id: 65c261d586ce64a79327e8f6 admin_id: 123 body: Hello contact_not_found: summary: Contact not found value: contact_id: 123 - admin_id: 991267922 + admin_id: 991270421 body: Hello "/contacts/{contact_id}/segments": get: @@ -2749,10 +2773,10 @@ paths: type: list data: - type: segment - id: 659ec0ea6abd0150e7d4a249 + id: 65c261d786ce64a79327e8f8 name: segment - created_at: 1704902890 - updated_at: 1704902890 + created_at: 1707237847 + updated_at: 1707237847 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: 5d42347a-c4bc-4a0d-87a1-dd1d9de77a3b 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: 4d5ce518-779d-4cb1-88c4-bb80390308b3 errors: - code: unauthorized message: Access Token Invalid @@ -2822,7 +2846,7 @@ paths: type: list data: - type: subscription - id: '182' + id: '411' state: live consent_type: opt_out default_translation: @@ -2836,7 +2860,7 @@ paths: content_types: - email - type: subscription - id: '184' + id: '413' 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: ca7a4d1b-341d-4694-9ca5-88073fb7be26 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: eb95196c-0a52-4298-a457-3c7f8ecf7b46 errors: - code: unauthorized message: Access Token Invalid @@ -2914,7 +2938,7 @@ paths: Successful: value: type: subscription - id: '197' + id: '426' 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: 0af4a664-8667-49b4-af18-6ec20038df67 errors: - code: not_found message: User Not Found Resource not found: value: type: error.list - request_id: cbb2d192-f32c-4359-96ef-afa56734e463 + request_id: 2b536658-6cee-441c-afbf-88327439e187 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: 76e4506f-ce6f-4b71-ab2f-d5e5c55756b9 errors: - code: unauthorized message: Access Token Invalid @@ -2986,12 +3010,12 @@ paths: successful: summary: Successful value: - id: 197 + id: 426 consent_type: opt_in contact_not_found: summary: Contact not found value: - id: 201 + id: 430 consent_type: opt_in resource_not_found: summary: Resource not found @@ -3037,7 +3061,7 @@ paths: Successful: value: type: subscription - id: '213' + id: '442' 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: 8f883c72-d21d-4014-a445-17733259ada9 errors: - code: not_found message: User Not Found Resource not found: value: type: error.list - request_id: ab578239-97fe-4526-a1e4-ee775f50fa18 + request_id: 2dde38da-6525-494a-b2a0-38fdfde744fc 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: 6f48e3ed-a454-48c6-a8a9-b20906e86c3a errors: - code: unauthorized message: Access Token Invalid @@ -3119,7 +3143,7 @@ paths: type: list data: - type: tag - id: '150' + id: '328' 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: b6ca28ca-c22d-40b2-917d-2ffb176552c8 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: a00aa7b6-6553-48c4-bced-c649958651e0 errors: - code: unauthorized message: Access Token Invalid @@ -3180,7 +3204,7 @@ paths: successful: value: type: tag - id: '151' + id: '329' 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: e96f2fd5-231a-401a-bdb8-ef18bd3182d3 errors: - code: not_found message: User Not Found Tag not found: value: type: error.list - request_id: 267fb369-85c0-4219-9407-18f9df64e68d + request_id: b3931ccb-82b2-4073-9ccf-2f26577163d4 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: d94713b3-77f2-4feb-b78a-10e74e52771e errors: - code: unauthorized message: Access Token Invalid @@ -3236,11 +3260,11 @@ paths: successful: summary: successful value: - id: 151 + id: 329 contact_not_found: summary: Contact not found value: - id: 152 + id: 330 tag_not_found: summary: Tag not found value: @@ -3282,7 +3306,7 @@ paths: successful: value: type: tag - id: '154' + id: '332' 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: 6c7f423d-8e18-4763-a5e1-f4cac749c5c9 errors: - code: not_found message: User Not Found Tag not found: value: type: error.list - request_id: 9a57aa58-8bf3-47ef-8c36-782dc7ca8eb1 + request_id: eb79c338-5588-4063-aee5-1598aaaed20c 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: bdb9d76c-3bc6-44eb-a7fd-edd499963ac6 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: 65c261e286ce64a79327e90f + 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: 1707237858 + updated_at: 1707237858 + signed_up_at: 1707237858 last_seen_at: last_replied_at: last_contacted_at: @@ -3400,31 +3424,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ec0f56abd0150e7d4a260/tags" + url: "/contacts/65c261e286ce64a79327e90f/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ec0f56abd0150e7d4a260/notes" + url: "/contacts/65c261e286ce64a79327e90f/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ec0f56abd0150e7d4a260/companies" + url: "/contacts/65c261e286ce64a79327e90f/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ec0f56abd0150e7d4a260/subscriptions" + url: "/contacts/65c261e286ce64a79327e90f/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ec0f56abd0150e7d4a260/subscriptions" + url: "/contacts/65c261e286ce64a79327e90f/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: 9eae501a-95b2-4fc5-ba79-b08755f1d2fc 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: 65c261e386ce64a79327e910 + 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: 1707237859 + updated_at: 1707237859 + signed_up_at: 1707237859 last_seen_at: last_replied_at: last_contacted_at: @@ -3539,31 +3563,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ec0f66abd0150e7d4a261/tags" + url: "/contacts/65c261e386ce64a79327e910/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ec0f66abd0150e7d4a261/notes" + url: "/contacts/65c261e386ce64a79327e910/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ec0f66abd0150e7d4a261/companies" + url: "/contacts/65c261e386ce64a79327e910/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ec0f66abd0150e7d4a261/subscriptions" + url: "/contacts/65c261e386ce64a79327e910/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ec0f66abd0150e7d4a261/subscriptions" + url: "/contacts/65c261e386ce64a79327e910/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: b744dd61-3b00-4257-8870-6c789986162a errors: - code: unauthorized message: Access Token Invalid @@ -3613,7 +3637,7 @@ paths: examples: successful: value: - id: 659ec0f76abd0150e7d4a262 + id: 65c261e486ce64a79327e911 object: contact deleted: true schema: @@ -3626,7 +3650,7 @@ paths: Unauthorized: value: type: error.list - request_id: 975d0473-04a5-4050-bf13-4660177336ac + request_id: d7036aca-fc9f-4d55-b1c1-41f0cd10167f 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: 65c261e586ce64a79327e913 + 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: 1707237861 + updated_at: 1707237861 + signed_up_at: 1707237861 last_seen_at: last_replied_at: last_contacted_at: @@ -3705,31 +3729,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ec0f86abd0150e7d4a264/tags" + url: "/contacts/65c261e586ce64a79327e913/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ec0f86abd0150e7d4a264/notes" + url: "/contacts/65c261e586ce64a79327e913/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ec0f86abd0150e7d4a264/companies" + url: "/contacts/65c261e586ce64a79327e913/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ec0f86abd0150e7d4a264/subscriptions" + url: "/contacts/65c261e586ce64a79327e913/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ec0f86abd0150e7d4a264/subscriptions" + url: "/contacts/65c261e586ce64a79327e913/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: 8c072240-57a1-486b-b2b0-169ae8bb2f7b errors: - code: unauthorized message: Access Token Invalid @@ -3763,8 +3787,8 @@ paths: successful: summary: successful value: - from: 659ec0f86abd0150e7d4a263 - into: 659ec0f86abd0150e7d4a264 + from: 65c261e586ce64a79327e912 + into: 65c261e586ce64a79327e913 "/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: 269f8fd6-840c-40c8-99da-b682b9116392 errors: - code: unauthorized message: Access Token Invalid @@ -3893,15 +3917,15 @@ paths: value: - field: id operator: "=" - value: 659ec0fa6abd0150e7d4a267 + value: 65c261e686ce64a79327e916 - operator: OR value: - field: id operator: "=" - value: 659ec0fa6abd0150e7d4a267 + value: 65c261e686ce64a79327e916 - field: id operator: "=" - value: 659ec0fa6abd0150e7d4a267 + value: 65c261e686ce64a79327e916 "/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: 1f2d88e0-9520-4606-bc3d-c8233a6ec9cc 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: 65c261e886ce64a79327e918 + 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: 1707237865 + updated_at: 1707237865 signed_up_at: last_seen_at: last_replied_at: @@ -4017,31 +4041,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ec0fc6abd0150e7d4a269/tags" + url: "/contacts/65c261e886ce64a79327e918/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ec0fc6abd0150e7d4a269/notes" + url: "/contacts/65c261e886ce64a79327e918/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ec0fc6abd0150e7d4a269/companies" + url: "/contacts/65c261e886ce64a79327e918/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ec0fc6abd0150e7d4a269/subscriptions" + url: "/contacts/65c261e886ce64a79327e918/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ec0fc6abd0150e7d4a269/subscriptions" + url: "/contacts/65c261e886ce64a79327e918/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: 6882fb44-3ddf-4493-a36f-8cb276fb5b63 errors: - code: unauthorized message: Access Token Invalid @@ -4104,7 +4128,7 @@ paths: examples: successful: value: - id: 659ec0fd6abd0150e7d4a26a + id: 65c261e986ce64a79327e919 object: contact archived: true schema: @@ -4136,7 +4160,7 @@ paths: examples: successful: value: - id: 659ec0fd6abd0150e7d4a26b + id: 65c261ea86ce64a79327e91a object: contact archived: false schema: @@ -4171,7 +4195,7 @@ paths: successful: value: type: tag - id: '156' + id: '334' 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: a25bc4c8-f43a-4e73-9087-d31696216da9 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: 43316a92-e995-45df-b94d-ae1276beeae2 errors: - code: unauthorized message: Access Token Invalid @@ -4226,13 +4250,13 @@ paths: successful: summary: successful value: - id: 156 - admin_id: 991267953 + id: 334 + admin_id: 991270452 conversation_not_found: summary: Conversation not found value: - id: 157 - admin_id: 991267955 + id: 335 + admin_id: 991270454 "/conversations/{conversation_id}/tags/{id}": delete: summary: Remove tag from a conversation @@ -4270,7 +4294,7 @@ paths: successful: value: type: tag - id: '159' + id: '337' 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: ceb30f48-f5e3-488e-b71f-e8c682f4f40d errors: - code: not_found message: Conversation not found Tag not found: value: type: error.list - request_id: 8f109750-c9b8-4328-b623-e808834cf1d8 + request_id: db4efc4b-d5e6-43bb-b4fc-4c072cb9c5f8 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: 7d52c406-f6da-4ce3-9d6e-c43df034dbbc errors: - code: unauthorized message: Access Token Invalid @@ -4326,15 +4350,15 @@ paths: successful: summary: successful value: - admin_id: 991267957 + admin_id: 991270456 conversation_not_found: summary: Conversation not found value: - admin_id: 991267959 + admin_id: 991270458 tag_not_found: summary: Tag not found value: - admin_id: 991267960 + admin_id: 991270459 "/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: '1114' + created_at: 1707237873 + updated_at: 1707237873 waiting_since: snoozed_until: source: type: conversation - id: '403918362' + id: '403918718' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991267963' - name: Ciaran151 Lee - email: admin151@email.com + id: '991270462' + 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: 65c261f186ce64a79327e91e 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: 65f24075-cbf4-4f2b-b3f1-fe47bf3fc5a6 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: a7928047-7788-4770-9429-198407ac1d6f 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: '403918728' + created_at: 1707237899 body: Hello there message_type: inapp - conversation_id: '526' + conversation_id: '1139' 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: ed4e0802-334e-42bc-a8b4-979a3f6d1775 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: ab0cc8fb-01d4-466f-8584-b840d4a318d6 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: 54beff66-147c-4a5b-b3c5-3876e61b938c errors: - code: api_plan_restricted message: Active subscription needed. @@ -4539,7 +4563,7 @@ paths: value: from: type: user - id: 659ec1206abd0150e7d4a284 + id: 65c2620a86ce64a79327e933 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: '1143' + created_at: 1707237906 + updated_at: 1707237906 waiting_since: snoozed_until: source: type: conversation - id: '403918376' + id: '403918732' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991267977' - name: Ciaran158 Lee - email: admin158@email.com + id: '991270476' + 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: 65c2621286ce64a79327e937 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: bdbc1340-86a8-49fd-97da-e356c00d438f 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: f4635a12-ef16-4ed8-a1ae-e58540f73235 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: e4bb54d4-3371-44a2-9727-8c06a6e9e356 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: '1147' + created_at: 1707237912 + updated_at: 1707237913 waiting_since: snoozed_until: source: type: conversation - id: '403918380' + id: '403918736' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991267985' - name: Ciaran162 Lee - email: admin162@email.com + id: '991270484' + 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: 65c2621886ce64a79327e93b 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: '245' part_type: conversation_attribute_updated_by_admin body: - created_at: 1704902959 - updated_at: 1704902959 - notified_at: 1704902959 + created_at: 1707237913 + updated_at: 1707237913 + notified_at: 1707237913 assigned_to: author: - id: '991267986' + id: '991270485' 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: '246' part_type: conversation_attribute_updated_by_admin body: - created_at: 1704902959 - updated_at: 1704902959 - notified_at: 1704902959 + created_at: 1707237913 + updated_at: 1707237913 + notified_at: 1707237913 assigned_to: author: - id: '991267986' + id: '991270485' 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: 1b331dfa-6785-4e71-b649-0f1dceb085dd 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: 2e5c21e2-1db6-402d-8bef-a07112677d15 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: 1981960e-6582-4617-aff5-c24e74e0e2a4 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: '1154' + created_at: 1707237924 + updated_at: 1707237924 waiting_since: snoozed_until: source: type: conversation - id: '403918387' + id: '403918743' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991268015' - name: Ciaran185 Lee - email: admin185@email.com + id: '991270514' + 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: 65c2622486ce64a79327e942 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5013,15 +5037,15 @@ paths: value: - field: id operator: "=" - value: '541' + value: '1154' - operator: OR value: - field: id operator: "=" - value: '541' + value: '1154' - field: id operator: "=" - value: '541' + value: '1154' "/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: '1162' + created_at: 1707237931 + updated_at: 1707237933 + waiting_since: 1707237933 snoozed_until: source: type: conversation - id: '403918390' + id: '403918746' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991268017' - name: Ciaran186 Lee - email: admin186@email.com + id: '991270516' + 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: 65c2622b86ce64a79327e949 first_contact_reply: - created_at: 1704902980 + created_at: 1707237933 type: conversation url: admin_assignee_id: @@ -5109,15 +5133,15 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '91' + id: '248' part_type: open body: "

    Thanks again :)

    " - created_at: 1704902980 - updated_at: 1704902980 - notified_at: 1704902980 + created_at: 1707237933 + updated_at: 1707237933 + notified_at: 1707237933 assigned_to: author: - id: 659ec1426abd0150e7d4a29a + id: 65c2622b86ce64a79327e949 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: '1163' + created_at: 1707237934 + updated_at: 1707237935 waiting_since: snoozed_until: source: type: conversation - id: '403918391' + id: '403918747' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991268019' - name: Ciaran187 Lee - email: admin187@email.com + id: '991270518' + 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: 65c2622e86ce64a79327e94a 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: '249' part_type: note body: |-

    An Unordered HTML List

    @@ -5189,15 +5213,15 @@ paths:
  • Tea
  • Milk
  • - created_at: 1704902983 - updated_at: 1704902983 - notified_at: 1704902983 + created_at: 1707237935 + updated_at: 1707237935 + notified_at: 1707237935 assigned_to: author: - id: '991268019' + id: '991270518' type: admin - name: Ciaran187 Lee - email: admin187@email.com + name: Ciaran188 Lee + email: admin188@email.com attachments: [] external_id: redacted: false @@ -5205,22 +5229,22 @@ paths: User last conversation reply: value: type: conversation - id: '552' - created_at: 1704902984 - updated_at: 1704902985 - waiting_since: 1704902985 + id: '1165' + created_at: 1707237938 + updated_at: 1707237939 + waiting_since: 1707237939 snoozed_until: source: type: conversation - id: '403918393' + id: '403918749' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991268023' - name: Ciaran189 Lee - email: admin189@email.com + id: '991270522' + 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: 65c2623186ce64a79327e94c first_contact_reply: - created_at: 1704902985 + created_at: 1707237939 type: conversation url: admin_assignee_id: @@ -5254,15 +5278,15 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '93' + id: '250' part_type: open body: "

    Thanks again :)

    " - created_at: 1704902985 - updated_at: 1704902985 - notified_at: 1704902985 + created_at: 1707237939 + updated_at: 1707237939 + notified_at: 1707237939 assigned_to: author: - id: 659ec1486abd0150e7d4a29d + id: 65c2623186ce64a79327e94c 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: bcea3ca9-08b3-48f2-9382-cb410c0bfbec 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: 84984b45-0d20-4522-80a2-86abc92bc3c0 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: 84921ca4-d4eb-442d-9d01-31d932bd0a02 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: 65c2622b86ce64a79327e949 body: Thanks again :) admin_note_reply: summary: Admin note reply value: message_type: note type: admin - admin_id: 991268019 + admin_id: 991270518 body: "

    An Unordered HTML List

    An Ordered HTML List

    \
    1. Coffee
    2. Tea
    3. Milk
    @@ -5342,14 +5366,14 @@ paths: value: message_type: comment type: user - intercom_user_id: 659ec1486abd0150e7d4a29d + intercom_user_id: 65c2623186ce64a79327e94c body: Thanks again :) not_found: summary: Not found value: message_type: comment type: user - intercom_user_id: 659ec14a6abd0150e7d4a29e + intercom_user_id: 65c2623386ce64a79327e94d body: Thanks again :) "/conversations/{id}/parts": post: @@ -5383,22 +5407,22 @@ paths: Close a conversation: value: type: conversation - id: '556' - created_at: 1704902992 - updated_at: 1704902992 + id: '1169' + created_at: 1707237946 + updated_at: 1707237947 waiting_since: snoozed_until: source: type: conversation - id: '403918397' + id: '403918753' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991268031' - name: Ciaran193 Lee - email: admin193@email.com + id: '991270530' + 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: 65c2623986ce64a79327e950 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: '251' part_type: close body: "

    Goodbye :)

    " - created_at: 1704902992 - updated_at: 1704902992 - notified_at: 1704902992 + created_at: 1707237947 + updated_at: 1707237947 + notified_at: 1707237947 assigned_to: author: - id: '991268031' + id: '991270530' 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: '1170' + created_at: 1707237948 + updated_at: 1707237948 waiting_since: - snoozed_until: 1704906594 + snoozed_until: source: type: conversation - id: '403918398' + id: '403918754' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991268033' - name: Ciaran194 Lee - email: admin194@email.com + id: '991270532' + name: Ciaran195 Lee + email: admin195@email.com attachments: [] url: redacted: false @@ -5471,12 +5495,12 @@ paths: type: contact.list contacts: - type: contact - id: 659ec1516abd0150e7d4a2a2 + id: 65c2623c86ce64a79327e951 first_contact_reply: admin_assignee_id: team_assignee_id: - open: true - state: snoozed + open: false + state: closed read: false tags: type: tag.list @@ -5492,43 +5516,27 @@ paths: ticket: conversation_parts: type: conversation_part.list - conversation_parts: - - type: conversation_part - id: '95' - part_type: snoozed - body: - created_at: 1704902994 - updated_at: 1704902994 - notified_at: 1704902994 - assigned_to: - author: - id: '991268033' - type: admin - name: Ciaran194 Lee - email: admin194@email.com - attachments: [] - external_id: - redacted: false - total_count: 1 + conversation_parts: [] + total_count: 0 Open a conversation: value: type: conversation - id: '562' - created_at: 1704902992 - updated_at: 1704903001 + id: '1175' + created_at: 1707237947 + updated_at: 1707237957 waiting_since: snoozed_until: source: type: conversation - id: '403918399' + id: '403918755' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991268035' - name: Ciaran195 Lee - email: admin195@email.com + id: '991270534' + name: Ciaran196 Lee + email: admin196@email.com attachments: [] url: redacted: false @@ -5536,7 +5544,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ec1556abd0150e7d4a2a7 + id: 65c2624186ce64a79327e956 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5559,18 +5567,18 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '97' + id: '253' part_type: open body: - created_at: 1704903001 - updated_at: 1704903001 - notified_at: 1704903001 + created_at: 1707237957 + updated_at: 1707237957 + notified_at: 1707237957 assigned_to: author: - id: '991268035' + id: '991270534' type: admin - name: Ciaran195 Lee - email: admin195@email.com + name: Ciaran196 Lee + email: admin196@email.com attachments: [] external_id: redacted: false @@ -5578,22 +5586,22 @@ paths: Assign a conversation: value: type: conversation - id: '566' - created_at: 1704903002 - updated_at: 1704903003 + id: '1179' + created_at: 1707237958 + updated_at: 1707237959 waiting_since: snoozed_until: source: type: conversation - id: '403918402' + id: '403918758' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991268037' - name: Ciaran196 Lee - email: admin196@email.com + id: '991270536' + name: Ciaran197 Lee + email: admin197@email.com attachments: [] url: redacted: false @@ -5601,9 +5609,9 @@ paths: type: contact.list contacts: - type: contact - id: 659ec15a6abd0150e7d4a2aa + id: 65c2624686ce64a79327e959 first_contact_reply: - admin_assignee_id: 991268037 + admin_assignee_id: 991270536 team_assignee_id: open: true state: open @@ -5624,20 +5632,20 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '98' + id: '254' part_type: assign_and_reopen body: - created_at: 1704903003 - updated_at: 1704903003 - notified_at: 1704903003 + created_at: 1707237959 + updated_at: 1707237959 + notified_at: 1707237959 assigned_to: type: admin - id: '991268037' + id: '991270536' author: - id: '991268037' + id: '991270536' type: admin - name: Ciaran196 Lee - email: admin196@email.com + name: Ciaran197 Lee + email: admin197@email.com attachments: [] external_id: redacted: false @@ -5652,7 +5660,7 @@ paths: Not found: value: type: error.list - request_id: c48014f3-9a25-4205-a073-a07f24a43a02 + request_id: b9bf8305-327a-44a9-ac58-fa2eb3b43bdf errors: - code: not_found message: Resource Not Found @@ -5666,7 +5674,7 @@ paths: Unauthorized: value: type: error.list - request_id: 14c5ae3e-7f3a-4127-988d-74a2e4195df2 + request_id: fdb071eb-b3da-47ab-8662-27c5d1e09452 errors: - code: unauthorized message: Access Token Invalid @@ -5680,7 +5688,7 @@ paths: API plan restricted: value: type: error.list - request_id: 2187d8df-523a-4710-9e30-b050799b1faa + request_id: 80b00889-0c29-4fb5-ac66-edad84402833 errors: - code: api_plan_restricted message: Active subscription needed. @@ -5701,32 +5709,32 @@ paths: value: message_type: close type: admin - admin_id: 991268031 + admin_id: 991270530 body: Goodbye :) snooze_a_conversation: summary: Snooze a conversation value: message_type: snoozed - admin_id: 991268033 - snoozed_until: 1704906594 + admin_id: 991270532 + snoozed_until: 1707241549 open_a_conversation: summary: Open a conversation value: message_type: open - admin_id: 991268035 + admin_id: 991270534 assign_a_conversation: summary: Assign a conversation value: message_type: assignment type: admin - admin_id: 991268037 - assignee_id: 991268037 + admin_id: 991270536 + assignee_id: 991270536 not_found: summary: Not found value: message_type: close type: admin - admin_id: 991268039 + admin_id: 991270538 body: Goodbye :) "/conversations/{id}/run_assignment_rules": post: @@ -5757,22 +5765,22 @@ paths: Assign a conversation using assignment rules: value: type: conversation - id: '570' - created_at: 1704903007 - updated_at: 1704903007 + id: '1183' + created_at: 1707237966 + updated_at: 1707237967 waiting_since: snoozed_until: source: type: conversation - id: '403918406' + id: '403918762' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991268045' - name: Ciaran200 Lee - email: admin200@email.com + id: '991270544' + name: Ciaran201 Lee + email: admin201@email.com attachments: [] url: redacted: false @@ -5780,7 +5788,7 @@ paths: type: contact.list contacts: - type: contact - id: 659ec15f6abd0150e7d4a2ae + id: 65c2624e86ce64a79327e95d first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5803,20 +5811,20 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '99' + id: '255' part_type: default_assignment body: - created_at: 1704903007 - updated_at: 1704903007 - notified_at: 1704903007 + created_at: 1707237967 + updated_at: 1707237967 + notified_at: 1707237967 assigned_to: type: nobody_admin id: author: - id: '991268046' + id: '991270545' 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 +5839,7 @@ paths: Not found: value: type: error.list - request_id: ac56d974-d053-4f54-91d3-b99f5a82c593 + request_id: cb3e5f90-224f-4244-9a38-ef1b1f80d0a1 errors: - code: not_found message: Resource Not Found @@ -5845,7 +5853,7 @@ paths: Unauthorized: value: type: error.list - request_id: e9a3ba92-94cf-414a-adfb-cbcc66f6c8f5 + request_id: 7fd7dd6d-299b-47e1-b53b-99f82c3f2577 errors: - code: unauthorized message: Access Token Invalid @@ -5859,7 +5867,7 @@ paths: API plan restricted: value: type: error.list - request_id: 750b2a5d-1efd-4e25-9d47-52ecf1afc481 + request_id: 458587c4-f6a6-40f6-8908-e03fa8f0cad8 errors: - code: api_plan_restricted message: Active subscription needed. @@ -5898,7 +5906,7 @@ paths: value: customers: - type: user - id: 659ec1646abd0150e7d4a2b2 + id: 65c2625486ce64a79327e961 schema: "$ref": "#/components/schemas/conversation" '404': @@ -5909,7 +5917,7 @@ paths: Not found: value: type: error.list - request_id: 07c8070a-e2a3-4b68-a516-b4afa3baec7f + request_id: 526eda45-36ab-41b9-a145-be797191b95a errors: - code: not_found message: Resource Not Found @@ -5923,7 +5931,7 @@ paths: Unauthorized: value: type: error.list - request_id: 67962eff-aac0-431a-b413-da1eb2a0b3bb + request_id: de9d334b-e7ec-44a7-b7e1-7b42b9392dfc errors: - code: unauthorized message: Access Token Invalid @@ -5937,7 +5945,7 @@ paths: API plan restricted: value: type: error.list - request_id: 8ae1fda0-308c-43f4-83f1-ed2e65221558 + request_id: '011084e9-21d3-4343-9ee7-1633c0e403a2' errors: - code: api_plan_restricted message: Active subscription needed. @@ -5952,15 +5960,15 @@ paths: attach_a_contact_to_a_conversation: summary: Attach a contact to a conversation value: - admin_id: 991268053 + admin_id: 991270552 customer: - intercom_user_id: 659ec1646abd0150e7d4a2b2 + intercom_user_id: 65c2625486ce64a79327e961 not_found: summary: Not found value: - admin_id: 991268055 + admin_id: 991270554 customer: - intercom_user_id: 659ec1656abd0150e7d4a2b3 + intercom_user_id: 65c2625586ce64a79327e962 "/conversations/{conversation_id}/customers/{contact_id}": delete: summary: Detach a contact from a group conversation @@ -6001,7 +6009,7 @@ paths: value: customers: - type: user - id: 659ec16e6abd0150e7d4a2bd + id: 65c2626186ce64a79327e96c schema: "$ref": "#/components/schemas/conversation" '404': @@ -6012,14 +6020,14 @@ paths: Conversation not found: value: type: error.list - request_id: 44889af5-e733-45ff-95bc-c079767afac3 + request_id: b263bfe6-a576-444a-946a-5d572383e904 errors: - code: not_found message: Resource Not Found Contact not found: value: type: error.list - request_id: 15ff32db-31f4-4ce5-b28b-298b07a388b0 + request_id: 3b8e52bc-25fa-4176-b3a4-0f0663cdd1fd errors: - code: not_found message: User Not Found @@ -6033,7 +6041,7 @@ paths: Last customer: value: type: error.list - request_id: 709095b4-b462-48bf-b186-978c4bdbf96e + request_id: 6d02ca93-2c2c-4688-9054-30b203604652 errors: - code: parameter_invalid message: Removing the last customer is not allowed @@ -6047,7 +6055,7 @@ paths: Unauthorized: value: type: error.list - request_id: b5c691eb-4e01-4e43-bf10-822ed6c33629 + request_id: 021b69fc-966c-49f1-ae09-f4454323c2e7 errors: - code: unauthorized message: Access Token Invalid @@ -6061,7 +6069,7 @@ paths: API plan restricted: value: type: error.list - request_id: 0a93505d-5e4f-4efd-a964-7f83d349939c + request_id: 453eeee0-2351-4e2d-b060-472637ca9f81 errors: - code: api_plan_restricted message: Active subscription needed. @@ -6076,27 +6084,27 @@ paths: detach_a_contact_from_a_group_conversation: summary: Detach a contact from a group conversation value: - admin_id: 991268061 + admin_id: 991270560 customer: - intercom_user_id: 659ec1686abd0150e7d4a2b6 + intercom_user_id: 65c2625a86ce64a79327e965 conversation_not_found: summary: Conversation not found value: - admin_id: 991268063 + admin_id: 991270562 customer: - intercom_user_id: 659ec16f6abd0150e7d4a2be + intercom_user_id: 65c2626386ce64a79327e96d contact_not_found: summary: Contact not found value: - admin_id: 991268065 + admin_id: 991270564 customer: - intercom_user_id: 659ec1756abd0150e7d4a2c5 + intercom_user_id: 65c2626a86ce64a79327e974 last_customer: summary: Last customer value: - admin_id: 991268067 + admin_id: 991270566 customer: - intercom_user_id: 659ec17c6abd0150e7d4a2cc + intercom_user_id: 65c2627286ce64a79327e97b "/conversations/redact": post: summary: Redact a conversation part @@ -6123,22 +6131,22 @@ paths: Redact a conversation part: value: type: conversation - id: '626' - created_at: 1704903056 - updated_at: 1704903058 - waiting_since: 1704903057 + id: '1239' + created_at: 1707238027 + updated_at: 1707238029 + waiting_since: 1707238027 snoozed_until: source: type: conversation - id: '403918432' + id: '403918788' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991268073' - name: Ciaran214 Lee - email: admin214@email.com + id: '991270572' + name: Ciaran215 Lee + email: admin215@email.com attachments: [] url: redacted: false @@ -6146,9 +6154,9 @@ paths: type: contact.list contacts: - type: contact - id: 659ec1906abd0150e7d4a2e1 + id: 65c2628a86ce64a79327e990 first_contact_reply: - created_at: 1704903057 + created_at: 1707238027 type: conversation url: admin_assignee_id: @@ -6172,15 +6180,15 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '107' + id: '263' part_type: open body: "

    This message was deleted

    " - created_at: 1704903057 - updated_at: 1704903058 - notified_at: 1704903057 + created_at: 1707238027 + updated_at: 1707238028 + notified_at: 1707238027 assigned_to: author: - id: 659ec1906abd0150e7d4a2e1 + id: 65c2628a86ce64a79327e990 type: user name: Joe Bloggs email: joe@bloggs.com @@ -6198,7 +6206,7 @@ paths: Not found: value: type: error.list - request_id: f132f527-b220-4d2c-b8e1-3032b7bf624a + request_id: 89798f87-224e-4ea5-9252-c60cc6cf458e errors: - code: conversation_part_or_message_not_found message: Conversation part or message not found @@ -6212,7 +6220,7 @@ paths: Unauthorized: value: type: error.list - request_id: 83bdf77e-e8fa-41e6-b804-48e89b3b5d79 + request_id: 741db2c9-b301-4db5-967a-437342428bcf errors: - code: unauthorized message: Access Token Invalid @@ -6228,8 +6236,8 @@ paths: summary: Redact a conversation part value: type: conversation_part - conversation_id: 626 - conversation_part_id: 107 + conversation_id: 1239 + conversation_part_id: 263 not_found: summary: Not found value: @@ -6405,7 +6413,7 @@ paths: custom: false archived: false model: company - - id: 88 + - id: 116 type: data_attribute name: The One Ring full_name: custom_attributes.The One Ring @@ -6417,9 +6425,9 @@ paths: ui_writable: false custom: true archived: false - admin_id: '991268089' - created_at: 1704903065 - updated_at: 1704903065 + admin_id: '991270597' + created_at: 1707238041 + updated_at: 1707238041 model: company - type: data_attribute name: id @@ -6486,7 +6494,7 @@ paths: Unauthorized: value: type: error.list - request_id: 134f4f6a-16e2-4b53-834b-1f7b3b834969 + request_id: 6e63ab94-6c2b-4521-9abf-975dda4fc518 errors: - code: unauthorized message: Access Token Invalid @@ -6511,7 +6519,7 @@ paths: examples: Successful: value: - id: 91 + id: 119 type: data_attribute name: Mithril Shirt full_name: custom_attributes.Mithril Shirt @@ -6521,9 +6529,9 @@ paths: ui_writable: false custom: true archived: false - admin_id: '991268091' - created_at: 1704903067 - updated_at: 1704903067 + admin_id: '991270599' + created_at: 1707238043 + updated_at: 1707238043 model: company schema: "$ref": "#/components/schemas/data_attribute" @@ -6535,7 +6543,7 @@ paths: Same name already exists: value: type: error.list - request_id: 719c9de8-ecd7-42cd-a817-52e8abd7d012 + request_id: e10445ce-d2e3-4a1d-b873-009b433c95c4 errors: - code: parameter_invalid message: You already have 'The One Ring' in your company data. @@ -6543,7 +6551,7 @@ paths: Invalid name: value: type: error.list - request_id: 72dd093e-76ff-41dd-898f-caddcc1f1bec + request_id: 26b8019c-1312-45b0-bd9b-325ecfaa36e5 errors: - code: parameter_invalid message: Your name for this attribute must only contain alphanumeric @@ -6551,7 +6559,7 @@ paths: Attribute already exists: value: type: error.list - request_id: 0ac95dec-fdea-4f21-95a0-0faac4111ef7 + request_id: a53dcd13-2985-4c02-bb94-4f02b92446f6 errors: - code: parameter_invalid message: You already have 'The One Ring' in your company data. @@ -6559,14 +6567,14 @@ paths: Invalid Data Type: value: type: error.list - request_id: adae7702-c350-467c-ae77-e359b005d2e4 + request_id: 315fe6f1-71b9-4ccc-bf0c-4175d3106d9b 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: 9f92be17-9ab0-4c8a-b5a6-8e9b0edc2c95 errors: - code: parameter_invalid message: The Data Attribute model field must be either contact @@ -6581,7 +6589,7 @@ paths: Unauthorized: value: type: error.list - request_id: add275ad-5ef1-4663-b626-1209ab51885c + request_id: 5322854b-4465-4c0c-bb88-14f2696d8ebb errors: - code: unauthorized message: Access Token Invalid @@ -6660,7 +6668,7 @@ paths: examples: Successful: value: - id: 98 + id: 126 type: data_attribute name: The One Ring full_name: custom_attributes.The One Ring @@ -6674,9 +6682,9 @@ paths: ui_writable: false custom: true archived: false - admin_id: '991268098' - created_at: 1704903069 - updated_at: 1704903070 + admin_id: '991270606' + created_at: 1707238045 + updated_at: 1707238046 model: company schema: "$ref": "#/components/schemas/data_attribute" @@ -6688,7 +6696,7 @@ paths: Too few options in list: value: type: error.list - request_id: e38502e7-7292-4914-8054-24762ad484dd + request_id: 6dae2668-c365-4087-8eb6-ef368096c7b5 errors: - code: parameter_invalid message: Options isn't an array @@ -6702,7 +6710,7 @@ paths: Attribute Not Found: value: type: error.list - request_id: 6ab1582d-89ae-472e-a671-2dbb3f5a0737 + request_id: 34ac5ccc-c505-48b5-8a3d-cfce62f3cf10 errors: - code: field_not_found message: We couldn't find that data attribute to update @@ -6716,7 +6724,7 @@ paths: Has Dependant Object: value: type: error.list - request_id: 290b7892-5dbf-441b-b405-20c404963954 + request_id: 560654a4-3a6f-4b7a-992c-74c8dde81962 errors: - code: data_invalid message: The Data Attribute you are trying to archive has a @@ -6731,7 +6739,7 @@ paths: Unauthorized: value: type: error.list - request_id: 7664bf52-aaa1-430a-bf9a-ba21f9e5abe0 + request_id: 8946711a-f628-4998-b0af-541f772c346f errors: - code: unauthorized message: Access Token Invalid @@ -6782,63 +6790,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 +6844,7 @@ paths: Unauthorized: value: type: error.list - request_id: e8a11750-b5c0-4d2b-8ea2-ff7c56ca74bd + request_id: 8900124b-7b6a-49d1-bd21-0e5403f69b45 errors: - code: unauthorized message: Access Token Invalid @@ -6936,8 +6930,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: 65c262a186ce64a79327e999 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 schema: "$ref": "#/components/schemas/data_event_summary" @@ -6949,7 +6943,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0e835f49-86fa-49cb-8fb0-4858a0e3808d + request_id: adc08b22-0964-4e20-9b92-64cbf220e884 errors: - code: unauthorized message: Access Token Invalid @@ -6980,7 +6974,7 @@ paths: Unauthorized: value: type: error.list - request_id: ddc7294c-f22b-48d7-b013-effacea5dab6 + request_id: 3df1c26f-51b2-4709-8306-16e1f0ce0478 errors: - code: unauthorized message: Access Token Invalid @@ -7024,7 +7018,7 @@ paths: examples: successful: value: - job_identifier: mnw179sm6z9l88o9 + job_identifier: ucb4wfvw571yd7mj status: pending download_url: '' download_expires_at: '' @@ -7039,8 +7033,8 @@ paths: successful: summary: successful value: - created_at_after: 1704885080 - created_at_before: 1704903080 + created_at_after: 1707220051 + created_at_before: 1707238051 "/export/content/data/{job_identifier}": get: summary: Show content data export @@ -7074,7 +7068,7 @@ paths: examples: successful: value: - job_identifier: uks44tbfv0z065ut + job_identifier: 4ivqrqgj19iuhssm status: pending download_url: '' download_expires_at: '' @@ -7106,7 +7100,7 @@ paths: examples: successful: value: - job_identifier: xj0yyljha1e0mnby + job_identifier: sidz84go8n5y0g3x status: canceled download_url: '' download_expires_at: '' @@ -7167,32 +7161,32 @@ paths: user message created: value: type: user_message - id: '403918443' - created_at: 1704903108 + id: '403918793' + created_at: 1707238053 body: heyy message_type: inapp - conversation_id: '642' + conversation_id: '1244' lead message created: value: type: user_message - id: '403918444' - created_at: 1704903109 + id: '403918794' + created_at: 1707238054 body: heyy message_type: inapp - conversation_id: '643' + conversation_id: '1245' admin message created: value: type: admin_message - id: '32' - created_at: 1704903110 + id: '40' + created_at: 1707238055 subject: heyy body: heyy message_type: inapp owner: type: admin - id: '991268132' - name: Ciaran255 Lee - email: admin255@email.com + id: '991270629' + name: Ciaran265 Lee + email: admin265@email.com away_mode_enabled: false away_mode_reassign: false schema: @@ -7205,14 +7199,14 @@ paths: No body supplied for message: value: type: error.list - request_id: 3558f87a-c1b1-4fad-8db3-40cfe0ac29d7 + request_id: f7a02154-8f56-4f84-b10e-d56913ca6f75 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: 8d30ef29-d6c5-47be-a484-a5b47366fa49 errors: - code: parameter_invalid message: Body is required @@ -7226,7 +7220,7 @@ paths: No subject supplied for email message: value: type: error.list - request_id: 44b4664b-3912-42e4-b8c2-54dd543c6af1 + request_id: dfc8b209-d8dd-444f-85c2-eec2d0915bd8 errors: - code: parameter_not_found message: No subject supplied for email message @@ -7240,7 +7234,7 @@ paths: Unauthorized: value: type: error.list - request_id: a282bd59-45d0-443a-a44d-05c5ba498b3c + request_id: 426a4331-b99a-46ee-8892-992b306cd88e errors: - code: unauthorized message: Access Token Invalid @@ -7254,7 +7248,7 @@ paths: API plan restricted: value: type: error.list - request_id: debd62af-7fbe-4821-9896-e76564f8b32d + request_id: eec00d36-fe26-4960-a44a-5219be392dc5 errors: - code: api_plan_restricted message: Active subscription needed. @@ -7271,7 +7265,7 @@ paths: value: from: type: user - id: 659ec1c36abd0150e7d4a34f + id: 65c262a486ce64a79327e99e body: heyy referer: https://twitter.com/bob lead_message_created: @@ -7279,7 +7273,7 @@ paths: value: from: type: lead - id: 659ec1c46abd0150e7d4a350 + id: 65c262a586ce64a79327e99f body: heyy referer: https://twitter.com/bob admin_message_created: @@ -7287,10 +7281,10 @@ paths: value: from: type: admin - id: '991268132' + id: '991270629' to: type: user - id: 659ec1c66abd0150e7d4a351 + id: 65c262a786ce64a79327e9a0 message_type: conversation body: heyy no_body_supplied_for_message: @@ -7298,10 +7292,10 @@ paths: value: from: type: admin - id: '991268134' + id: '991270631' to: type: user - id: 659ec1c76abd0150e7d4a352 + id: 65c262a786ce64a79327e9a1 message_type: inapp body: subject: heyy @@ -7310,7 +7304,7 @@ paths: value: from: type: admin - id: '991268135' + id: '991270632' to: type: user user_id: '70' @@ -7321,10 +7315,10 @@ paths: value: from: type: admin - id: '991268136' + id: '991270633' to: type: user - id: 659ec1c86abd0150e7d4a354 + id: 65c262a886ce64a79327e9a3 message_type: email body: subject: heyy @@ -7355,12 +7349,12 @@ paths: total_pages: 1 type: pages data: - - id: '43' + - id: '99' 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: 991270638 state: draft labels: [] cover_image_url: @@ -7370,15 +7364,15 @@ paths: - - deliver_silently: false - created_at: 1704903113 - updated_at: 1704903113 + created_at: 1707238058 + updated_at: 1707238058 newsfeed_assignments: [] - - id: '44' + - id: '100' 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: 991270640 state: draft labels: [] cover_image_url: @@ -7388,8 +7382,8 @@ paths: - - deliver_silently: false - created_at: 1704903113 - updated_at: 1704903113 + created_at: 1707238058 + updated_at: 1707238058 newsfeed_assignments: [] total_count: 2 schema: @@ -7402,7 +7396,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0602da35-fcea-44cd-85d0-7827acc88f61 + request_id: b220812a-41ad-488f-a877-630e0a44df8a errors: - code: unauthorized message: Access Token Invalid @@ -7427,12 +7421,12 @@ paths: examples: successful: value: - id: '47' + id: '103' 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: 991270647 state: live labels: - New @@ -7443,10 +7437,10 @@ paths: - "\U0001F606" - "\U0001F605" deliver_silently: true - created_at: 1704903115 - updated_at: 1704903115 + created_at: 1707238059 + updated_at: 1707238059 newsfeed_assignments: - - newsfeed_id: 78 + - newsfeed_id: 178 published_at: 1664638214 schema: "$ref": "#/components/schemas/news_item" @@ -7458,7 +7452,7 @@ paths: Unauthorized: value: type: error.list - request_id: b00f2529-64e4-4a6b-837d-02a403b88061 + request_id: d4e76315-954c-42bc-9f48-b41be305f109 errors: - code: unauthorized message: Access Token Invalid @@ -7479,14 +7473,14 @@ paths: - Product - Update - New - sender_id: 991268150 + sender_id: 991270647 deliver_silently: true reactions: - "\U0001F606" - "\U0001F605" state: live newsfeed_assignments: - - newsfeed_id: 78 + - newsfeed_id: 178 published_at: 1664638214 "/news/news_items/{id}": get: @@ -7515,12 +7509,12 @@ paths: examples: successful: value: - id: '48' + id: '104' 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: 991270650 state: live labels: [] cover_image_url: @@ -7530,11 +7524,11 @@ paths: - - deliver_silently: false - created_at: 1704903116 - updated_at: 1704903116 + created_at: 1707238060 + updated_at: 1707238060 newsfeed_assignments: - - newsfeed_id: 80 - published_at: 1704903116 + - newsfeed_id: 180 + published_at: 1707238060 schema: "$ref": "#/components/schemas/news_item" '404': @@ -7545,7 +7539,7 @@ paths: News Item Not Found: value: type: error.list - request_id: b8eb8670-4862-471f-b437-ba15d77194a7 + request_id: ebb62e23-ca49-496a-9651-f00a4c77f244 errors: - code: not_found message: Resource Not Found @@ -7559,7 +7553,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8732dfef-e019-4325-b51d-45a18d4c7500 + request_id: 92746c51-ec46-42e9-a0db-80c4664b7e0d errors: - code: unauthorized message: Access Token Invalid @@ -7590,12 +7584,12 @@ paths: examples: successful: value: - id: '51' + id: '107' 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: 991270658 state: live labels: [] cover_image_url: @@ -7603,8 +7597,8 @@ paths: - "\U0001F61D" - "\U0001F602" deliver_silently: false - created_at: 1704903117 - updated_at: 1704903118 + created_at: 1707238062 + updated_at: 1707238062 newsfeed_assignments: [] schema: "$ref": "#/components/schemas/news_item" @@ -7616,7 +7610,7 @@ paths: News Item Not Found: value: type: error.list - request_id: 8d07d3ac-39cc-41b4-9772-50bb72e9da96 + request_id: ca440576-5006-42b8-9e76-36e5e713f976 errors: - code: not_found message: Resource Not Found @@ -7630,7 +7624,7 @@ paths: Unauthorized: value: type: error.list - request_id: d6709299-6441-4b1f-b1de-26335bf68fc9 + request_id: 9127a7da-a3fc-4597-8e6b-4af826c4789d errors: - code: unauthorized message: Access Token Invalid @@ -7647,7 +7641,7 @@ paths: value: title: Christmas is here! body: "

    New gifts in store for the jolly season

    " - sender_id: 991268161 + sender_id: 991270658 reactions: - "\U0001F61D" - "\U0001F602" @@ -7656,7 +7650,7 @@ paths: value: title: Christmas is here! body: "

    New gifts in store for the jolly season

    " - sender_id: 991268164 + sender_id: 991270661 reactions: - "\U0001F61D" - "\U0001F602" @@ -7686,7 +7680,7 @@ paths: examples: successful: value: - id: '54' + id: '110' object: news-item deleted: true schema: @@ -7699,7 +7693,7 @@ paths: News Item Not Found: value: type: error.list - request_id: fa76bc54-44ef-45f7-985b-5ee154db7eae + request_id: 5e5c4544-6336-46e9-af7b-1ac6d3f1af24 errors: - code: not_found message: Resource Not Found @@ -7713,7 +7707,7 @@ paths: Unauthorized: value: type: error.list - request_id: 72a31612-a382-48bc-a278-1104ada2e19c + request_id: f55b4e98-4108-441a-abc3-532508eacffc errors: - code: unauthorized message: Access Token Invalid @@ -7766,7 +7760,7 @@ paths: Unauthorized: value: type: error.list - request_id: 7923cb95-d32d-4c76-97b9-16c6b27a33df + request_id: fdd3bc38-4423-4f0f-b816-91f74888ed6f errors: - code: unauthorized message: Access Token Invalid @@ -7799,16 +7793,16 @@ paths: total_pages: 1 type: pages data: - - id: '93' + - id: '193' type: newsfeed name: Visitor Feed - created_at: 1704903122 - updated_at: 1704903122 - - id: '94' + created_at: 1707238066 + updated_at: 1707238066 + - id: '194' type: newsfeed name: Visitor Feed - created_at: 1704903122 - updated_at: 1704903122 + created_at: 1707238066 + updated_at: 1707238066 total_count: 2 schema: "$ref": "#/components/schemas/paginated_response" @@ -7820,7 +7814,7 @@ paths: Unauthorized: value: type: error.list - request_id: aae2be8a-f910-4e0c-80af-48e00ebe2fcb + request_id: 27727fa1-e343-4321-9125-6ab26a1e7729 errors: - code: unauthorized message: Access Token Invalid @@ -7854,11 +7848,11 @@ paths: examples: successful: value: - id: '97' + id: '197' type: newsfeed name: Visitor Feed - created_at: 1704903123 - updated_at: 1704903123 + created_at: 1707238067 + updated_at: 1707238067 schema: "$ref": "#/components/schemas/newsfeed" '401': @@ -7869,7 +7863,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8b46d741-29a7-40b3-947a-4829480e4096 + request_id: 937479a0-11da-47d0-ad30-b5646e10bf23 errors: - code: unauthorized message: Access Token Invalid @@ -7903,16 +7897,16 @@ paths: Note found: value: type: note - id: '100' - created_at: 1704211926 + id: '122' + created_at: 1706546868 contact: type: contact - id: 659ec1d66abd0150e7d4a35f + id: 65c262b486ce64a79327e9a6 author: type: admin - id: '991268180' - name: Ciaran302 Lee - email: admin302@email.com + id: '991270677' + name: Ciaran312 Lee + email: admin312@email.com away_mode_enabled: false away_mode_reassign: false body: "

    This is a note.

    " @@ -7925,11 +7919,20 @@ paths: examples: Note not found: value: - type: error.list - request_id: acebba53-e776-4383-94e3-3f167030f7b5 - errors: - - code: not_found - message: Resource Not Found + type: note + id: '123' + created_at: 1706546868 + contact: + type: contact + id: 65c262b586ce64a79327e9a7 + author: + type: admin + id: '991270678' + name: Ciaran313 Lee + email: admin313@email.com + away_mode_enabled: false + away_mode_reassign: false + body: "

    This is a note.

    " schema: "$ref": "#/components/schemas/error" '401': @@ -7940,7 +7943,7 @@ paths: Unauthorized: value: type: error.list - request_id: 223f3c98-a084-4699-9d50-9773c99e07ac + request_id: 28618d56-7c84-43f5-8541-044b996ecc49 errors: - code: unauthorized message: Access Token Invalid @@ -7976,16 +7979,16 @@ paths: type: segment.list segments: - type: segment - id: 659ec1da6abd0150e7d4a366 + id: 65c262b586ce64a79327e9a9 name: John segment - created_at: 1704903130 - updated_at: 1704903130 + created_at: 1707238069 + updated_at: 1707238069 person_type: user - type: segment - id: 659ec1da6abd0150e7d4a367 + id: 65c262b586ce64a79327e9aa name: Jane segment - created_at: 1704903130 - updated_at: 1704903130 + created_at: 1707238069 + updated_at: 1707238069 person_type: user schema: "$ref": "#/components/schemas/segment_list" @@ -7997,7 +8000,7 @@ paths: Unauthorized: value: type: error.list - request_id: 87545ed9-4400-4b25-8bcd-3bde3675c989 + request_id: 55ddf37c-da9f-4fea-b376-7a0bd691618f errors: - code: unauthorized message: Access Token Invalid @@ -8031,10 +8034,10 @@ paths: Successful response: value: type: segment - id: 659ec1da6abd0150e7d4a36a + id: 65c262b686ce64a79327e9ad name: John segment - created_at: 1704903130 - updated_at: 1704903130 + created_at: 1707238070 + updated_at: 1707238070 person_type: user schema: "$ref": "#/components/schemas/segment" @@ -8046,7 +8049,7 @@ paths: Segment not found: value: type: error.list - request_id: 18b3d0ef-97cf-484d-a64e-ba40e8c8d467 + request_id: dd5bb3eb-9209-43f7-bd1a-822991ecdf4b errors: - code: not_found message: Resource Not Found @@ -8060,7 +8063,7 @@ paths: Unauthorized: value: type: error.list - request_id: 95e9f393-edb1-4865-80b0-23105345f8bf + request_id: 6291870c-72e0-4d6f-8058-2bf591991a3e errors: - code: unauthorized message: Access Token Invalid @@ -8090,7 +8093,7 @@ paths: type: list data: - type: subscription - id: '226' + id: '455' state: live consent_type: opt_out default_translation: @@ -8113,7 +8116,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0c3d1d38-8525-4a81-af3d-8a973d8ac42c + request_id: 3e2893fe-10b6-4e53-af26-f2c776231026 errors: - code: unauthorized message: Access Token Invalid @@ -8143,7 +8146,7 @@ paths: examples: successful: value: - url: http://via.intercom.io/msgr/0cae109c-4b59-4cfe-b6fe-0c39911713ba + url: http://via.intercom.io/msgr/f02771bd-e56e-4e62-893d-3b0ed555bafa type: phone_call_redirect schema: "$ref": "#/components/schemas/phone_switch" @@ -8176,7 +8179,7 @@ paths: Unauthorized: value: type: error.list - request_id: 62c5624a-8b19-4365-b4fd-5fc1a577f273 + request_id: 258d3cff-715c-40c9-a2a8-dd5f336a34b3 errors: - code: unauthorized message: Access Token Invalid @@ -8239,7 +8242,7 @@ paths: type: list data: - type: tag - id: '180' + id: '350' name: Manual tag 1 schema: "$ref": "#/components/schemas/tag_list" @@ -8251,7 +8254,7 @@ paths: Unauthorized: value: type: error.list - request_id: 04e59143-670c-4733-87b0-4da28100a832 + request_id: 13b27a81-8451-46fe-8b5b-0a68b43b257d errors: - code: unauthorized message: Access Token Invalid @@ -8290,7 +8293,7 @@ paths: Action successful: value: type: tag - id: '183' + id: '353' name: test schema: "$ref": "#/components/schemas/tag" @@ -8302,7 +8305,7 @@ paths: Invalid parameters: value: type: error.list - request_id: f337d11c-a9a0-4843-8b46-4fd811b81551 + request_id: 8f7c0e55-6286-4ec2-937e-3ab37bea0bcb errors: - code: parameter_invalid message: invalid tag parameters @@ -8316,14 +8319,14 @@ paths: Company not found: value: type: error.list - request_id: 9e5945a8-5c02-40e7-b7d1-c6d222ab1f03 + request_id: 378cdf4c-0145-4562-8f8f-2dd8daab04d0 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: 33361ce5-6461-4ac4-9326-fb10bdd04567 errors: - code: not_found message: User Not Found @@ -8337,7 +8340,7 @@ paths: Unauthorized: value: type: error.list - request_id: fdc1f68d-117d-479f-b28e-ae11e226da61 + request_id: b62f409a-bedf-4f36-b393-55708be9a840 errors: - code: unauthorized message: Access Token Invalid @@ -8403,7 +8406,7 @@ paths: Tag found: value: type: tag - id: '191' + id: '361' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -8415,7 +8418,7 @@ paths: Tag not found: value: type: error.list - request_id: 95e9daad-d1c9-4c3e-b12f-dffbe5137c0b + request_id: db93691f-7c96-401b-bb11-61164eaf5fcb errors: - code: not_found message: Resource Not Found @@ -8429,7 +8432,7 @@ paths: Unauthorized: value: type: error.list - request_id: '075884f3-5a26-4046-943c-e26915324cdd' + request_id: 78f973b1-7694-48a1-ae3d-2f14a8b1b8a8 errors: - code: unauthorized message: Access Token Invalid @@ -8465,7 +8468,7 @@ paths: Resource not found: value: type: error.list - request_id: 9a632310-0fa2-4b6c-a132-6150c33c6caa + request_id: e88119f8-2989-4733-88e4-cd6416b48f9b errors: - code: not_found message: Resource Not Found @@ -8479,7 +8482,7 @@ paths: Tag has dependent objects: value: type: error.list - request_id: 69f92b81-62f7-4809-aef6-f7ac7522fd57 + request_id: 74d5be5e-eb6e-4709-818e-88ea9816a305 errors: - code: tag_has_dependent_objects message: 'Unable to delete Tag with dependent objects. Segments: @@ -8494,7 +8497,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9930d1fa-1006-4fe4-84d9-72b025b4a9b0 + request_id: 686ef223-4f4a-4f8c-9485-6c35e2ed2ed8 errors: - code: unauthorized message: Access Token Invalid @@ -8532,7 +8535,7 @@ paths: Unauthorized: value: type: error.list - request_id: c12903f7-cb1b-48da-b4f6-28a34e1ba091 + request_id: 72293796-f841-4123-99c0-c63412f36c72 errors: - code: unauthorized message: Access Token Invalid @@ -8567,7 +8570,7 @@ paths: successful: value: type: team - id: '991268224' + id: '991270715' name: team 1 admin_ids: [] schema: @@ -8580,7 +8583,7 @@ paths: Team not found: value: type: error.list - request_id: 9f6bb07a-6aa1-4f82-976a-6c832e3be6ca + request_id: 65af862a-c6e8-4fd1-a329-d8af0253899e errors: - code: team_not_found message: Team not found @@ -8594,7 +8597,7 @@ paths: Unauthorized: value: type: error.list - request_id: f1223500-e010-4943-873a-1f9190146fb2 + request_id: fdd64d30-9142-4896-ab7c-130b9f1683d0 errors: - code: unauthorized message: Access Token Invalid @@ -8627,23 +8630,23 @@ paths: Ticket Type Attribute created: value: type: ticket_type_attribute - id: '133' - workspace_id: this_is_an_id568_that_should_be_at_least_ + id: '550' + 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 visible_to_contacts: true default: false - ticket_type_id: 45 + ticket_type_id: 188 archived: false - created_at: 1704903150 - updated_at: 1704903150 + created_at: 1707238086 + updated_at: 1707238086 schema: "$ref": "#/components/schemas/ticket_type_attribute" '401': @@ -8654,7 +8657,7 @@ paths: Unauthorized: value: type: error.list - request_id: eb17fd71-1ec6-4372-a14f-9f3043b827dd + request_id: 9b58bd11-94f7-4f0e-974e-e7eddd2ab59b errors: - code: unauthorized message: Access Token Invalid @@ -8707,8 +8710,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: '555' + workspace_id: this_is_an_id589_that_should_be_at_least_ name: name description: New Attribute Description data_type: string @@ -8718,10 +8721,10 @@ paths: visible_on_create: false visible_to_contacts: false default: false - ticket_type_id: 47 + ticket_type_id: 190 archived: false - created_at: 1704903151 - updated_at: 1704903151 + created_at: 1707238087 + updated_at: 1707238087 schema: "$ref": "#/components/schemas/ticket_type_attribute" '401': @@ -8732,7 +8735,7 @@ paths: Unauthorized: value: type: error.list - request_id: 22285163-10e7-40be-89d1-2ad6b9c040e2 + request_id: 5fd7cb3b-38d3-4631-b2e0-a96e12afff24 errors: - code: unauthorized message: Access Token Invalid @@ -8771,21 +8774,39 @@ paths: type: list data: - type: ticket_type - id: '49' + id: '192' 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: 1707238088 + updated_at: 1707238088 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: '558' + 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: 192 + archived: false + created_at: 1707238088 + updated_at: 1707238088 + - type: ticket_type_attribute + id: '560' + workspace_id: this_is_an_id593_that_should_be_at_least_ name: name description: description data_type: string @@ -8796,10 +8817,28 @@ paths: visible_on_create: false visible_to_contacts: false default: false - ticket_type_id: 49 + ticket_type_id: 192 + archived: false + created_at: 1707238088 + updated_at: 1707238088 + - type: ticket_type_attribute + id: '559' + 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: 192 archived: false - created_at: 1704903152 - updated_at: 1704903152 + created_at: 1707238088 + updated_at: 1707238088 schema: "$ref": "#/components/schemas/ticket_type_list" '401': @@ -8810,7 +8849,7 @@ paths: Unauthorized: value: type: error.list - request_id: 6aaeb527-407d-489e-ae95-c418e54f0285 + request_id: c0b99207-a930-4ba9-b447-b2df3989eb46 errors: - code: unauthorized message: Access Token Invalid @@ -8839,18 +8878,54 @@ paths: Ticket type created: value: type: ticket_type - id: '52' + id: '195' 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: 1707238089 + updated_at: 1707238089 is_internal: false ticket_type_attributes: type: list - data: [] + data: + - type: ticket_type_attribute + id: '567' + 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: 195 + archived: false + created_at: 1707238089 + updated_at: 1707238089 + - type: ticket_type_attribute + id: '568' + 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: 195 + archived: false + created_at: 1707238089 + updated_at: 1707238089 schema: "$ref": "#/components/schemas/ticket_type" '401': @@ -8861,7 +8936,7 @@ paths: Unauthorized: value: type: error.list - request_id: dd48c269-fbe9-43cb-937f-9ca5605126a6 + request_id: 980dd10c-50d2-4c15-a4c9-12845e125782 errors: - code: unauthorized message: Access Token Invalid @@ -8906,21 +8981,39 @@ paths: Ticket type found: value: type: ticket_type - id: '54' + id: '197' 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: 1707238090 + updated_at: 1707238090 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: '572' + 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: 197 + archived: false + created_at: 1707238090 + updated_at: 1707238090 + - type: ticket_type_attribute + id: '574' + workspace_id: this_is_an_id601_that_should_be_at_least_ name: name description: description data_type: string @@ -8931,10 +9024,28 @@ paths: visible_on_create: false visible_to_contacts: false default: false - ticket_type_id: 54 + ticket_type_id: 197 + archived: false + created_at: 1707238090 + updated_at: 1707238090 + - type: ticket_type_attribute + id: '573' + 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: 197 archived: false - created_at: 1704903154 - updated_at: 1704903154 + created_at: 1707238090 + updated_at: 1707238090 schema: "$ref": "#/components/schemas/ticket_type" '401': @@ -8945,7 +9056,7 @@ paths: Unauthorized: value: type: error.list - request_id: d4e669eb-a7a2-4cf7-a4d7-edcb6273b2a0 + request_id: e18f1f32-52cf-40b0-bdb2-3414f470c408 errors: - code: unauthorized message: Access Token Invalid @@ -8978,21 +9089,39 @@ paths: Ticket type updated: value: type: ticket_type - id: '56' + id: '199' 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: 1707238091 + updated_at: 1707238091 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: '578' + 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: 199 + archived: false + created_at: 1707238091 + updated_at: 1707238091 + - type: ticket_type_attribute + id: '580' + workspace_id: this_is_an_id605_that_should_be_at_least_ name: name description: description data_type: string @@ -9003,10 +9132,28 @@ paths: visible_on_create: false visible_to_contacts: false default: false - ticket_type_id: 56 + ticket_type_id: 199 + archived: false + created_at: 1707238091 + updated_at: 1707238091 + - type: ticket_type_attribute + id: '579' + 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: 199 archived: false - created_at: 1704903155 - updated_at: 1704903155 + created_at: 1707238091 + updated_at: 1707238091 schema: "$ref": "#/components/schemas/ticket_type" '401': @@ -9017,7 +9164,7 @@ paths: Unauthorized: value: type: error.list - request_id: 88c8603e-c424-484d-b33e-383ce0f6167f + request_id: 54b501da-658c-4e7a-9161-d5b35331cf35 errors: - code: unauthorized message: Access Token Invalid @@ -9062,7 +9209,7 @@ paths: Admin note reply: value: type: ticket_part - id: '112' + id: '268' part_type: note body: |-

    An Unordered HTML List

    @@ -9077,13 +9224,13 @@ paths:
  • Tea
  • Milk
  • - created_at: 1704903158 - updated_at: 1704903158 + created_at: 1707238094 + updated_at: 1707238094 author: - id: '991268250' + id: '991270749' type: admin - name: Ciaran367 Lee - email: admin367@email.com + name: Ciaran371 Lee + email: admin371@email.com attachments: [] redacted: false schema: @@ -9096,7 +9243,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0e766865-1004-415e-9b84-dbadb5832369 + request_id: eb919508-9616-4141-84bf-ab898b7d5219 errors: - code: unauthorized message: Access Token Invalid @@ -9113,7 +9260,7 @@ paths: value: message_type: note type: admin - admin_id: 991268250 + admin_id: 991270749 body: "

    An Unordered HTML List

    An Ordered HTML List

    \
    1. Coffee
    2. Tea
    3. Milk
    @@ -9139,28 +9286,28 @@ paths: Successful response: value: type: ticket - id: '646' + id: '1248' ticket_attributes: title: example description: there is a problem ticket_state: submitted ticket_type: type: ticket_type - id: '63' + id: '206' name: my-ticket-type-6 description: my ticket type description is awesome. icon: "\U0001F981" - workspace_id: this_is_an_id602_that_should_be_at_least_ + workspace_id: this_is_an_id619_that_should_be_at_least_ archived: false - created_at: 1704903161 - updated_at: 1704903161 + created_at: 1707238097 + updated_at: 1707238097 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '149' - workspace_id: this_is_an_id602_that_should_be_at_least_ + id: '590' + workspace_id: this_is_an_id619_that_should_be_at_least_ name: title description: ola data_type: string @@ -9171,13 +9318,13 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 63 + ticket_type_id: 206 archived: false - created_at: 1704903161 - updated_at: 1704903161 + created_at: 1707238097 + updated_at: 1707238097 - type: ticket_type_attribute - id: '150' - workspace_id: this_is_an_id602_that_should_be_at_least_ + id: '591' + workspace_id: this_is_an_id619_that_should_be_at_least_ name: description description: ola data_type: string @@ -9188,34 +9335,34 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 63 + ticket_type_id: 206 archived: false - created_at: 1704903161 - updated_at: 1704903161 + created_at: 1707238097 + updated_at: 1707238097 contacts: type: contact.list contacts: - - id: 659ec1f96abd0150e7d4a399 + - id: 65c262d186ce64a79327e9d0 role: user admin_assignee_id: '0' team_assignee_id: '0' - created_at: 1704903162 - updated_at: 1704903162 + created_at: 1707238098 + updated_at: 1707238098 ticket_parts: type: ticket_part.list ticket_parts: - type: ticket_part - id: '113' + id: '269' part_type: ticket_state_updated_by_admin ticket_state: submitted previous_ticket_state: submitted - created_at: 1704903162 - updated_at: 1704903162 + created_at: 1707238098 + updated_at: 1707238098 author: - id: '991268270' + id: '991270769' type: bot name: Operator - email: operator+this_is_an_id602_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id619_that_should_be_at_least_@intercom.io attachments: [] redacted: false total_count: 1 @@ -9229,7 +9376,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0726de3e-f176-4fe2-9368-400f6dda5fa2 + request_id: f632b953-3a98-421e-816e-a04d9ad6bf88 errors: - code: unauthorized message: Access Token Invalid @@ -9244,9 +9391,9 @@ paths: successful_response: summary: Successful response value: - ticket_type_id: 63 + ticket_type_id: 206 contacts: - - id: 659ec1f96abd0150e7d4a399 + - id: 65c262d186ce64a79327e9d0 ticket_attributes: title: example description: there is a problem @@ -9277,28 +9424,28 @@ paths: Successful response: value: type: ticket - id: '647' + id: '1249' ticket_attributes: title: example description: there is a problem ticket_state: in_progress ticket_type: type: ticket_type - id: '65' + id: '208' name: my-ticket-type-8 description: my ticket type description is awesome. icon: "\U0001F981" - workspace_id: this_is_an_id606_that_should_be_at_least_ + workspace_id: this_is_an_id623_that_should_be_at_least_ archived: false - created_at: 1704903163 - updated_at: 1704903163 + created_at: 1707238099 + updated_at: 1707238099 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '154' - workspace_id: this_is_an_id606_that_should_be_at_least_ + id: '595' + workspace_id: this_is_an_id623_that_should_be_at_least_ name: title description: ola data_type: string @@ -9309,13 +9456,13 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 65 + ticket_type_id: 208 archived: false - created_at: 1704903163 - updated_at: 1704903163 + created_at: 1707238099 + updated_at: 1707238099 - type: ticket_type_attribute - id: '155' - workspace_id: this_is_an_id606_that_should_be_at_least_ + id: '596' + workspace_id: this_is_an_id623_that_should_be_at_least_ name: description description: ola data_type: string @@ -9326,87 +9473,87 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 65 + ticket_type_id: 208 archived: false - created_at: 1704903164 - updated_at: 1704903164 + created_at: 1707238100 + updated_at: 1707238100 contacts: type: contact.list contacts: - - id: 659ec1fc6abd0150e7d4a39a + - id: 65c262d486ce64a79327e9d1 role: lead - admin_assignee_id: '991268284' + admin_assignee_id: '991270783' team_assignee_id: '0' - created_at: 1704903164 - updated_at: 1704903166 + created_at: 1707238100 + updated_at: 1707238102 ticket_parts: type: ticket_part.list ticket_parts: - type: ticket_part - id: '114' + id: '270' part_type: ticket_state_updated_by_admin ticket_state: submitted previous_ticket_state: submitted - created_at: 1704903164 - updated_at: 1704903164 + created_at: 1707238101 + updated_at: 1707238101 author: - id: '991268282' + id: '991270781' type: admin - name: Ciaran397 Lee - email: admin397@email.com + name: Ciaran401 Lee + email: admin401@email.com attachments: [] redacted: false - type: ticket_part - id: '115' + id: '271' part_type: ticket_attribute_updated_by_admin - created_at: 1704903165 - updated_at: 1704903165 + created_at: 1707238102 + updated_at: 1707238102 author: - id: '991268283' + id: '991270782' type: bot name: Operator - email: operator+this_is_an_id606_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id623_that_should_be_at_least_@intercom.io attachments: [] redacted: false - type: ticket_part - id: '116' + id: '272' part_type: ticket_attribute_updated_by_admin - created_at: 1704903165 - updated_at: 1704903165 + created_at: 1707238102 + updated_at: 1707238102 author: - id: '991268283' + id: '991270782' type: bot name: Operator - email: operator+this_is_an_id606_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id623_that_should_be_at_least_@intercom.io attachments: [] redacted: false - type: ticket_part - id: '117' + id: '273' part_type: ticket_state_updated_by_admin ticket_state: in_progress previous_ticket_state: submitted - created_at: 1704903165 - updated_at: 1704903165 + created_at: 1707238102 + updated_at: 1707238102 author: - id: '991268283' + id: '991270782' type: bot name: Operator - email: operator+this_is_an_id606_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id623_that_should_be_at_least_@intercom.io attachments: [] redacted: false - type: ticket_part - id: '118' + id: '274' part_type: assignment - created_at: 1704903166 - updated_at: 1704903166 + created_at: 1707238102 + updated_at: 1707238102 assigned_to: type: admin - id: '991268284' + id: '991270783' author: - id: '991268282' + id: '991270781' type: admin - name: Ciaran397 Lee - email: admin397@email.com + name: Ciaran401 Lee + email: admin401@email.com attachments: [] redacted: false total_count: 5 @@ -9420,14 +9567,14 @@ paths: Admin not found: value: type: error.list - request_id: 7cedc463-e2bf-4d95-bca7-8eefd6c2bf61 + request_id: 40d46a79-0997-472a-bad1-9bcc57d17c33 errors: - code: assignee_not_found message: Assignee not found Assignee not found: value: type: error.list - request_id: 50c1dfb0-c334-4616-b3f6-f7a5247418a0 + request_id: 027efa69-746a-4740-8f6a-152cad3c7fbe errors: - code: assignee_not_found message: Assignee not found @@ -9439,7 +9586,7 @@ paths: Unauthorized: value: type: error.list - request_id: d09c3433-f842-4bfd-9ae6-ca991a4d71ef + request_id: 2f60110b-c8c6-47cd-8c83-b559e6da5394 errors: - code: unauthorized message: Access Token Invalid @@ -9459,8 +9606,8 @@ paths: description: there is a problem state: in_progress assignment: - admin_id: '991268282' - assignee_id: '991268284' + admin_id: '991270781' + assignee_id: '991270783' open: true snoozed_until: 1673609604 admin_not_found: @@ -9472,7 +9619,7 @@ paths: state: in_progress assignment: admin_id: '123' - assignee_id: '991268292' + assignee_id: '991270791' assignee_not_found: summary: Assignee not found value: @@ -9481,7 +9628,7 @@ paths: description: there is a problem state: in_progress assignment: - admin_id: '991268298' + admin_id: '991270797' assignee_id: '456' get: summary: Retrieve a ticket @@ -9509,28 +9656,28 @@ paths: Ticket found: value: type: ticket - id: '650' + id: '1252' ticket_attributes: title: attribute_value description: ticket_state: submitted ticket_type: type: ticket_type - id: '69' + id: '212' name: my-ticket-type-12 description: my ticket type description is awesome. icon: "\U0001F981" - workspace_id: this_is_an_id614_that_should_be_at_least_ + workspace_id: this_is_an_id631_that_should_be_at_least_ archived: false - created_at: 1704903171 - updated_at: 1704903171 + created_at: 1707238108 + updated_at: 1707238108 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '165' - workspace_id: this_is_an_id614_that_should_be_at_least_ + id: '606' + workspace_id: this_is_an_id631_that_should_be_at_least_ name: title description: ola data_type: string @@ -9541,13 +9688,13 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 69 + ticket_type_id: 212 archived: false - created_at: 1704903171 - updated_at: 1704903171 + created_at: 1707238108 + updated_at: 1707238108 - type: ticket_type_attribute - id: '166' - workspace_id: this_is_an_id614_that_should_be_at_least_ + id: '607' + workspace_id: this_is_an_id631_that_should_be_at_least_ name: description description: ola data_type: string @@ -9558,34 +9705,34 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 69 + ticket_type_id: 212 archived: false - created_at: 1704903172 - updated_at: 1704903172 + created_at: 1707238108 + updated_at: 1707238108 contacts: type: contact.list contacts: - - id: 659ec2046abd0150e7d4a39d + - id: 65c262dd86ce64a79327e9d4 role: lead admin_assignee_id: '0' team_assignee_id: '0' - created_at: 1704903172 - updated_at: 1704903172 + created_at: 1707238109 + updated_at: 1707238109 ticket_parts: type: ticket_part.list ticket_parts: - type: ticket_part - id: '121' + id: '277' part_type: ticket_state_updated_by_admin ticket_state: submitted previous_ticket_state: submitted - created_at: 1704903172 - updated_at: 1704903172 + created_at: 1707238109 + updated_at: 1707238109 author: - id: '991268311' + id: '991270810' type: admin - name: Ciaran423 Lee - email: admin423@email.com + name: Ciaran427 Lee + email: admin427@email.com attachments: [] redacted: false total_count: 1 @@ -9599,7 +9746,7 @@ paths: Unauthorized: value: type: error.list - request_id: 97ea65cd-1af7-48ca-913c-fbad2abf35ca + request_id: 302e3278-d977-4302-bafe-c07651ce6690 errors: - code: unauthorized message: Access Token Invalid @@ -9631,26 +9778,26 @@ paths: successful: value: type: visitor - id: 659ec22a6abd0150e7d4a48a + id: 65c262e086ce64a79327e9d7 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' phone: name: Gareth Bale - pseudonym: Purple Glass + pseudonym: Amber Taxi avatar: type: avatar - image_url: https://static.intercomassets.com/app/pseudonym_avatars_2019/purple-glass.png - app_id: this_is_an_id621_that_should_be_at_least_ + image_url: https://static.intercomassets.com/app/pseudonym_avatars_2019/amber-taxi.png + app_id: this_is_an_id638_that_should_be_at_least_ companies: type: company.list companies: [] location_data: {} last_request_at: - created_at: 1704903210 - remote_created_at: 1704903210 - signed_up_at: 1704903210 - updated_at: 1704903210 + created_at: 1707238112 + remote_created_at: 1707238112 + signed_up_at: 1707238112 + updated_at: 1707238112 session_count: 0 social_profiles: type: social_profile.list @@ -9683,7 +9830,7 @@ paths: visitor Not Found: value: type: error.list - request_id: 1b4d3a59-b458-4c52-805a-bc3f4f3662f5 + request_id: 4c360f75-ad6d-495e-b091-7114c2fe6af4 errors: - code: not_found message: Visitor Not Found @@ -9697,7 +9844,7 @@ paths: Unauthorized: value: type: error.list - request_id: c26882e6-1edd-41aa-81f2-c0f26aba210e + request_id: f87730d6-cd1a-403d-9d91-2e21a4487b2a errors: - code: unauthorized message: Access Token Invalid @@ -9712,7 +9859,7 @@ paths: successful: summary: successful value: - id: 659ec22a6abd0150e7d4a48a + id: 65c262e086ce64a79327e9d7 name: Gareth Bale visitor_not_found: summary: visitor Not Found @@ -9745,7 +9892,7 @@ paths: successful: value: type: visitor - id: 659ec22c6abd0150e7d4a490 + id: 65c262e186ce64a79327e9dd user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' @@ -9755,16 +9902,16 @@ paths: avatar: type: avatar image_url: - app_id: this_is_an_id627_that_should_be_at_least_ + app_id: this_is_an_id644_that_should_be_at_least_ companies: type: company.list companies: [] location_data: {} last_request_at: - created_at: 1704903212 - remote_created_at: 1704903212 - signed_up_at: 1704903212 - updated_at: 1704903212 + created_at: 1707238113 + remote_created_at: 1707238113 + signed_up_at: 1707238113 + updated_at: 1707238113 session_count: 0 social_profiles: type: social_profile.list @@ -9797,7 +9944,7 @@ paths: Visitor not found: value: type: error.list - request_id: 2dc62d18-cd91-4c71-9f27-7d7a4a049f1f + request_id: 3dc5856c-5647-4881-81a5-2f52682f1eed errors: - code: not_found message: Visitor Not Found @@ -9811,7 +9958,7 @@ paths: Unauthorized: value: type: error.list - request_id: b04092a8-8860-4161-b5e5-affce5cc8df7 + request_id: acb65b09-a35f-442f-ba81-b93443241a71 errors: - code: unauthorized message: Access Token Invalid @@ -9845,7 +9992,7 @@ paths: successful: value: type: visitor - id: 659ec22d6abd0150e7d4a496 + id: 65c262e386ce64a79327e9e3 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' @@ -9855,16 +10002,16 @@ paths: avatar: type: avatar image_url: - app_id: this_is_an_id633_that_should_be_at_least_ + app_id: this_is_an_id650_that_should_be_at_least_ companies: type: company.list companies: [] location_data: {} last_request_at: - created_at: 1704903213 - remote_created_at: 1704903213 - signed_up_at: 1704903213 - updated_at: 1704903213 + created_at: 1707238115 + remote_created_at: 1707238115 + signed_up_at: 1707238115 + updated_at: 1707238115 session_count: 0 social_profiles: type: social_profile.list @@ -9897,7 +10044,7 @@ paths: Visitor not found: value: type: error.list - request_id: d3013261-2481-46ec-a0fe-1714c9dd16f6 + request_id: c4056c7d-5ec1-44a4-8425-57346a9bb23c errors: - code: not_found message: Visitor Not Found @@ -9911,7 +10058,7 @@ paths: Unauthorized: value: type: error.list - request_id: f76f6669-a89b-4ef1-9a65-d5d149294065 + request_id: a4569aed-76fb-4948-8421-7016e43a7f7c errors: - code: unauthorized message: Access Token Invalid @@ -9944,7 +10091,7 @@ paths: successful: value: type: visitor - id: 659ec22f6abd0150e7d4a49c + id: 65c262e486ce64a79327e9e9 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' @@ -9954,16 +10101,16 @@ paths: avatar: type: avatar image_url: - app_id: this_is_an_id639_that_should_be_at_least_ + app_id: this_is_an_id656_that_should_be_at_least_ companies: type: company.list companies: [] location_data: {} last_request_at: - created_at: 1704903215 - remote_created_at: 1704903215 - signed_up_at: 1704903215 - updated_at: 1704903215 + created_at: 1707238116 + remote_created_at: 1707238116 + signed_up_at: 1707238116 + updated_at: 1707238116 session_count: 0 social_profiles: type: social_profile.list @@ -9996,7 +10143,7 @@ paths: Visitor Not Found: value: type: error.list - request_id: 625e56cc-5d1c-4722-874a-f348384fed15 + request_id: d732d3d3-c780-46e6-a58d-4f4a842f551c errors: - code: not_found message: User Not Found @@ -10010,7 +10157,7 @@ paths: Unauthorized: value: type: error.list - request_id: 60f702dc-b524-480c-b9bf-ead0c06d229d + request_id: 9e271731-25d5-4a7c-bcdb-d7713ac1b2d5 errors: - code: unauthorized message: Access Token Invalid @@ -10041,8 +10188,8 @@ paths: successful: value: type: contact - id: 659ec2306abd0150e7d4a4a3 - workspace_id: this_is_an_id645_that_should_be_at_least_ + id: 65c262e586ce64a79327e9f0 + workspace_id: this_is_an_id662_that_should_be_at_least_ external_id: role: user email: foo@bar.com @@ -10056,9 +10203,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1704903216 - updated_at: 1704903216 - signed_up_at: 1704903216 + created_at: 1707238117 + updated_at: 1707238118 + signed_up_at: 1707238117 last_seen_at: last_replied_at: last_contacted_at: @@ -10092,31 +10239,31 @@ paths: tags: type: list data: [] - url: "/contacts/659ec2306abd0150e7d4a4a3/tags" + url: "/contacts/65c262e586ce64a79327e9f0/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/659ec2306abd0150e7d4a4a3/notes" + url: "/contacts/65c262e586ce64a79327e9f0/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/659ec2306abd0150e7d4a4a3/companies" + url: "/contacts/65c262e586ce64a79327e9f0/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/659ec2306abd0150e7d4a4a3/subscriptions" + url: "/contacts/65c262e586ce64a79327e9f0/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/659ec2306abd0150e7d4a4a3/subscriptions" + url: "/contacts/65c262e586ce64a79327e9f0/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -10135,7 +10282,7 @@ paths: Unauthorized: value: type: error.list - request_id: 993dfc21-1873-4056-9f38-00ab0c0f805e + request_id: '0429e7a1-3202-4f2c-952b-67aec7d77840' errors: - code: unauthorized message: Access Token Invalid @@ -12725,7 +12872,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 @@ -13205,30 +13353,6 @@ components: anyOf: - type: string - "$ref": "#/components/schemas/custom_object_instance" - custom_object_instance: - title: Custom Object Instance - type: object - nullable: true - description: An instance of a Custom Object Type. - properties: - id: - type: string - description: The Intercom defined id representing the custom object instance. - example: 5a7a19e9f59ae20001d1c1e6 - external_id: - type: string - description: The id you have defined for the custom object instance. - example: 0001d1c1e65a7a19e9f59ae2 - type: - type: string - description: The identifier of the custom object type that defines the structure - of the custom object instance. - example: Order - custom_attributes: - type: object - description: The custom attributes you have set on the custom object instance. - additionalProperties: - type: string customer_request: type: object nullable: true