diff --git a/descriptions/0/api.intercom.io.yaml b/descriptions/0/api.intercom.io.yaml index bddd09f..5f70d8a 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: '991266214' + id: '991272020' 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: 1713520645 + created_at: 1715078081 secure: false identity_verification: false timezone: America/Los_Angeles @@ -83,7 +83,7 @@ paths: Successful response: value: type: admin - id: '991266215' + id: '991272021' 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: 024ff1fe-33e7-441f-b9ce-929704b55327 + request_id: 54b48504-ea6c-4e00-a7a8-1cc396c89913 errors: - code: admin_not_found message: Admin for admin_id not found @@ -114,7 +114,7 @@ paths: Unauthorized: value: type: error.list - request_id: 00c413ba-b6ac-4346-b797-48a66d2c649f + request_id: 7b11b972-f757-47d6-a77d-af329afae527 errors: - code: unauthorized message: Access Token Invalid @@ -201,10 +201,10 @@ paths: per_page: 20 total_pages: 1 activity_logs: - - id: 3dfee8c1-81d5-489c-826a-ecb95c3457e0 + - id: 4f6647ce-fa22-4e50-bf28-8eab1a86fd76 performed_by: type: admin - id: '991266219' + id: '991272025' email: admin5@email.com ip: 127.0.0.1 metadata: @@ -213,21 +213,21 @@ paths: title: Initial message title before: Initial message title after: Eventual message title - created_at: 1713520650 + created_at: 1715078086 activity_type: message_state_change activity_description: Ciaran5 Lee changed your Initial message title message from Initial message title to Eventual message title. - - id: 70bc247f-af2e-4f0b-a6b1-3591ae620140 + - id: a90d6c22-2839-4e5b-bd37-1cb0df6b5146 performed_by: type: admin - id: '991266219' + id: '991272025' email: admin5@email.com ip: 127.0.0.1 metadata: before: before after: after - created_at: 1713520650 + created_at: 1715078086 activity_type: app_name_change activity_description: Ciaran5 Lee changed your app name from before to after. @@ -241,7 +241,7 @@ paths: Unauthorized: value: type: error.list - request_id: bca3cea8-6e22-40e7-99b3-29619f83f87e + request_id: eff215af-2d15-4f81-bc59-d0652c320dc2 errors: - code: unauthorized message: Access Token Invalid @@ -271,7 +271,7 @@ paths: admins: - type: admin email: admin7@email.com - id: '991266221' + id: '991272027' name: Ciaran7 Lee away_mode_enabled: false away_mode_reassign: false @@ -287,7 +287,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2126c6e9-0e0e-4ec0-a3a9-f4485bdc1332 + request_id: 411934df-aba4-472f-930e-f0d37aad3ad1 errors: - code: unauthorized message: Access Token Invalid @@ -321,7 +321,7 @@ paths: Admin found: value: type: admin - id: '991266223' + id: '991272029' 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: 052cf18e-73bb-4c29-95e4-a12d72787ea6 + request_id: f5674cd5-3f14-452b-901e-44384da2551f errors: - code: admin_not_found message: Admin not found @@ -352,7 +352,7 @@ paths: Unauthorized: value: type: error.list - request_id: 55c3b3a6-7ab7-4775-9d0f-c5d2673c3bb3 + request_id: 34189db0-5762-4e96-bf5d-13017a9def6e errors: - code: unauthorized message: Access Token Invalid @@ -379,30 +379,30 @@ paths: successful: value: data: - - id: 1 + - id: 17 type: content_import_source - last_synced_at: 1713520653 + last_synced_at: 1715078089 status: active url: https://support.example.com/us/1 sync_behavior: automatic - created_at: 1713520653 - updated_at: 1713520653 - - id: 2 + created_at: 1715078089 + updated_at: 1715078089 + - id: 18 type: content_import_source - last_synced_at: 1713520653 + last_synced_at: 1715078089 status: active url: https://support.example.com/us/2 sync_behavior: automatic - created_at: 1713520653 - updated_at: 1713520653 - - id: 3 + created_at: 1715078089 + updated_at: 1715078089 + - id: 19 type: content_import_source - last_synced_at: 1713520653 + last_synced_at: 1715078089 status: active url: https://support.example.com/us/3 sync_behavior: automatic - created_at: 1713520653 - updated_at: 1713520653 + created_at: 1715078089 + updated_at: 1715078089 pages: type: pages page: 1 @@ -420,7 +420,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9751b5c3-3dcf-4d32-86a8-6c040ae67144 + request_id: 83bc7b78-5b0e-48ff-b561-530aee67ca44 errors: - code: unauthorized message: Access Token Invalid @@ -446,14 +446,14 @@ paths: examples: successful: value: - id: 4 + id: 20 type: content_import_source - last_synced_at: 1713520654 + last_synced_at: 1715078090 status: active url: https://www.example.com sync_behavior: api - created_at: 1713520654 - updated_at: 1713520654 + created_at: 1715078090 + updated_at: 1715078090 schema: "$ref": "#/components/schemas/content_import_source" '401': @@ -464,7 +464,7 @@ paths: Unauthorized: value: type: error.list - request_id: 113448f7-94ec-4221-83bc-c657e98a2e8b + request_id: ea7467a3-b118-402d-b9fc-a6cc751a58bf errors: - code: unauthorized message: Access Token Invalid @@ -514,7 +514,7 @@ paths: Unauthorized: value: type: error.list - request_id: 04dc8d59-25c8-45d1-80b6-9e23e1686300 + request_id: 23460f01-937f-4a3b-9f99-0bac68b370ca errors: - code: unauthorized message: Access Token Invalid @@ -538,14 +538,14 @@ paths: examples: successful: value: - id: 6 + id: 22 type: content_import_source - last_synced_at: 1713520656 + last_synced_at: 1715078092 status: active url: https://support.example.com/us/5 sync_behavior: api - created_at: 1713520656 - updated_at: 1713520656 + created_at: 1715078092 + updated_at: 1715078092 schema: "$ref": "#/components/schemas/content_import_source" '401': @@ -556,7 +556,7 @@ paths: Unauthorized: value: type: error.list - request_id: 28bd1826-7018-4855-bb92-106bc9c06132 + request_id: 5a13430f-8bdf-4e7f-84b9-3c3ba2d6effd errors: - code: unauthorized message: Access Token Invalid @@ -581,14 +581,14 @@ paths: examples: successful: value: - id: 7 + id: 23 type: content_import_source - last_synced_at: 1713520657 + last_synced_at: 1715078093 status: active url: https://www.example.com sync_behavior: api - created_at: 1713520657 - updated_at: 1713520657 + created_at: 1715078093 + updated_at: 1715078093 schema: "$ref": "#/components/schemas/content_import_source" '401': @@ -599,7 +599,7 @@ paths: Unauthorized: value: type: error.list - request_id: 94517560-63f7-4ede-bcb4-d3606ab8f7ea + request_id: f180e870-b4be-4b9b-8b1a-efb1cecc1792 errors: - code: unauthorized message: Access Token Invalid @@ -637,42 +637,42 @@ paths: successful: value: data: - - id: '3' + - id: '11' 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: 26 external_id: '3' - created_at: 1713520658 - updated_at: 1713520658 - last_ingested_at: 1713520658 - - id: '2' + created_at: 1715078094 + updated_at: 1715078094 + last_ingested_at: 1715078094 + - id: '10' 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: 25 external_id: '2' - created_at: 1713520658 - updated_at: 1713520658 - last_ingested_at: 1713520658 - - id: '1' + created_at: 1715078094 + updated_at: 1715078094 + last_ingested_at: 1715078094 + - id: '9' 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: 24 external_id: '1' - created_at: 1713520658 - updated_at: 1713520658 - last_ingested_at: 1713520658 + created_at: 1715078094 + updated_at: 1715078094 + last_ingested_at: 1715078094 pages: type: pages page: 1 @@ -690,7 +690,7 @@ paths: Unauthorized: value: type: error.list - request_id: d58b9539-ed5b-4b63-a2e5-8b3763b6fabd + request_id: 4ecc0376-879c-4b3f-8bff-d06c8c480e35 errors: - code: unauthorized message: Access Token Invalid @@ -717,18 +717,18 @@ paths: examples: successful: value: - id: '5' + id: '13' type: external_page title: Test html: "

Test

" url: https://www.example.com fin_availability: true locale: en - source_id: 12 + source_id: 28 external_id: abc1234 - created_at: 1713520660 - updated_at: 1713520660 - last_ingested_at: 1713520660 + created_at: 1715078095 + updated_at: 1715078096 + last_ingested_at: 1715078096 schema: "$ref": "#/components/schemas/external_page" '401': @@ -739,7 +739,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8be40910-6d5b-4585-8cc7-75a8ee72f958 + request_id: 6e4f75f3-a9d9-42f7-9c8e-b8b688be06cb errors: - code: unauthorized message: Access Token Invalid @@ -757,7 +757,7 @@ paths: external_id: abc1234 html: "

Test

" locale: en - source_id: 12 + source_id: 28 title: Test url: https://www.example.com "/ai/external_pages/{id}": @@ -788,18 +788,18 @@ paths: examples: successful: value: - id: '6' + id: '14' 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: 29 external_id: '4' - created_at: 1713520661 - updated_at: 1713520661 - last_ingested_at: 1713520661 + created_at: 1715078097 + updated_at: 1715078097 + last_ingested_at: 1715078097 schema: "$ref": "#/components/schemas/external_page" '401': @@ -810,7 +810,7 @@ paths: Unauthorized: value: type: error.list - request_id: 39c61eb5-eeb4-458f-a510-42b11d772276 + request_id: e8295874-3865-473f-915e-6ef91d44473a errors: - code: unauthorized message: Access Token Invalid @@ -835,18 +835,18 @@ paths: examples: successful: value: - id: '7' + id: '15' 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: 30 external_id: '5' - created_at: 1713520662 - updated_at: 1713520662 - last_ingested_at: 1713520662 + created_at: 1715078098 + updated_at: 1715078098 + last_ingested_at: 1715078098 schema: "$ref": "#/components/schemas/external_page" '401': @@ -857,7 +857,7 @@ paths: Unauthorized: value: type: error.list - request_id: 7d725093-338b-48cd-b271-c82644a79923 + request_id: 3c2245b3-70ef-430b-b17e-35ccce7edb35 errors: - code: unauthorized message: Access Token Invalid @@ -883,18 +883,18 @@ paths: examples: successful: value: - id: '8' + id: '16' type: external_page title: Test html: "

Test

" url: https://www.example.com fin_availability: true locale: en - source_id: 15 + source_id: 31 external_id: '5678' - created_at: 1713520663 - updated_at: 1713520663 - last_ingested_at: 1713520663 + created_at: 1715078099 + updated_at: 1715078099 + last_ingested_at: 1715078099 schema: "$ref": "#/components/schemas/external_page" '401': @@ -905,7 +905,7 @@ paths: Unauthorized: value: type: error.list - request_id: 89954894-c9d1-40df-ae0c-e88392b349f4 + request_id: c523b56a-578e-424d-80c4-f0cb14522a04 errors: - code: unauthorized message: Access Token Invalid @@ -923,7 +923,7 @@ paths: external_id: '5678' html: "

Test

" locale: en - source_id: 15 + source_id: 31 title: Test url: https://www.example.com "/articles": @@ -958,20 +958,20 @@ paths: total_pages: 1 total_count: 1 data: - - id: '1' + - id: '198' type: article workspace_id: this_is_an_id64_that_should_be_at_least_4 - parent_id: 1 + parent_id: 788 parent_type: collection parent_ids: [] title: This is the article title description: '' body: '' - author_id: 991266247 + author_id: 991272053 state: published - created_at: 1713520664 - updated_at: 1713520664 - url: http://help-center.test/myapp-64/en/articles/1-this-is-the-article-title + created_at: 1715078100 + updated_at: 1715078100 + url: http://help-center.test/myapp-64/en/articles/198-this-is-the-article-title schema: "$ref": "#/components/schemas/article_list" '401': @@ -982,7 +982,7 @@ paths: Unauthorized: value: type: error.list - request_id: b9222a1f-264d-405f-9e5d-05885bd14be3 + request_id: 847dd3ca-748b-4315-b3a6-f7699b3e8dac errors: - code: unauthorized message: Access Token Invalid @@ -1007,10 +1007,10 @@ paths: examples: article created: value: - id: '4' + id: '201' type: article workspace_id: this_is_an_id68_that_should_be_at_least_4 - parent_id: 3 + parent_id: 790 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: 991266252 + author_id: 991272058 state: published - created_at: 1713520666 - updated_at: 1713520666 - url: http://help-center.test/myapp-68/en/articles/4-thanks-for-everything + created_at: 1715078101 + updated_at: 1715078101 + url: http://help-center.test/myapp-68/en/articles/201-thanks-for-everything schema: "$ref": "#/components/schemas/article" '400': @@ -1039,7 +1039,7 @@ paths: Bad Request: value: type: error.list - request_id: 35267d30-e939-4f28-b5af-3e3e909fec0a + request_id: 246fd7b6-2719-4691-b2b7-88b5afe2b8d3 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: 05e77f6d-c0c2-4e49-bb44-5ce0b811187c + request_id: 7341cb56-ca50-4473-a5d7-6268708d4184 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: 991266252 + author_id: 991272058 state: published - parent_id: 3 + parent_id: 790 parent_type: collection translated_content: fr: title: Merci pour tout description: Description de l'article body: Corps de l'article - author_id: 991266252 + author_id: 991272058 state: published bad_request: summary: Bad Request @@ -1118,10 +1118,10 @@ paths: examples: Article found: value: - id: '7' + id: '204' type: article workspace_id: this_is_an_id74_that_should_be_at_least_4 - parent_id: 6 + parent_id: 793 parent_type: collection parent_ids: [] statistics: @@ -1135,11 +1135,11 @@ paths: title: This is the article title description: '' body: '' - author_id: 991266257 + author_id: 991272063 state: published - created_at: 1713520667 - updated_at: 1713520667 - url: http://help-center.test/myapp-74/en/articles/7-this-is-the-article-title + created_at: 1715078103 + updated_at: 1715078103 + url: http://help-center.test/myapp-74/en/articles/204-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: 9a441f6f-f1c0-4eec-9f95-91943ee3e5cb + request_id: b7689af5-f7d5-45c9-81ac-23eedc7919ee errors: - code: not_found message: Resource Not Found @@ -1164,7 +1164,7 @@ paths: Unauthorized: value: type: error.list - request_id: 342bfc79-8bc2-401d-98a5-28b992f04d4f + request_id: abd6755d-d5d0-4320-be30-2221dbc809fe errors: - code: unauthorized message: Access Token Invalid @@ -1197,10 +1197,10 @@ paths: examples: successful: value: - id: '10' + id: '207' type: article workspace_id: this_is_an_id80_that_should_be_at_least_4 - parent_id: 9 + parent_id: 796 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: 991266263 + author_id: 991272069 state: published - created_at: 1713520669 - updated_at: 1713520670 - url: http://help-center.test/myapp-80/en/articles/10-christmas-is-here + created_at: 1715078105 + updated_at: 1715078106 + url: http://help-center.test/myapp-80/en/articles/207-christmas-is-here schema: "$ref": "#/components/schemas/article" '404': @@ -1229,7 +1229,7 @@ paths: Article Not Found: value: type: error.list - request_id: 9ecbfb32-e3fc-43e6-b986-72ff9729e242 + request_id: b9d99cd2-d95d-457c-bb5a-0e73e000aba6 errors: - code: not_found message: Resource Not Found @@ -1243,7 +1243,7 @@ paths: Unauthorized: value: type: error.list - request_id: c5f188a2-f411-40f5-b60f-9f313d384554 + request_id: 92aedde2-4acb-4cf0-a4af-16e0407e492d errors: - code: unauthorized message: Access Token Invalid @@ -1291,7 +1291,7 @@ paths: examples: successful: value: - id: '13' + id: '210' object: article deleted: true schema: @@ -1304,7 +1304,7 @@ paths: Article Not Found: value: type: error.list - request_id: 0a0ddf40-8317-4efa-b6bd-75ae7a4b98e4 + request_id: f4d2320d-e56d-4b5a-a822-5524cf4a4665 errors: - code: not_found message: Resource Not Found @@ -1318,7 +1318,7 @@ paths: Unauthorized: value: type: error.list - request_id: 4e8e0cea-43c4-4941-b9a8-c0afcefe232f + request_id: 5e241a6e-0e7a-45c2-8240-3ea149cf69be errors: - code: unauthorized message: Access Token Invalid @@ -1378,7 +1378,7 @@ paths: total_count: 1 data: articles: - - id: '17' + - id: '214' 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: 991266276 + author_id: 991272082 state: draft - created_at: 1713520674 - updated_at: 1713520674 + created_at: 1715078110 + updated_at: 1715078110 url: highlights: [] pages: @@ -1408,7 +1408,7 @@ paths: Unauthorized: value: type: error.list - request_id: e88c286d-c1e9-4060-82e1-7b8bc17d39e5 + request_id: fab15a80-e7e7-4a84-a72b-43c27f6458cf errors: - code: unauthorized message: Access Token Invalid @@ -1439,27 +1439,27 @@ paths: value: type: list data: - - id: '17' + - id: '804' 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: 1713520675 - updated_at: 1713520675 + created_at: 1715078111 + updated_at: 1715078111 description: english collection description icon: bookmark parent_id: - help_center_id: 17 - - id: '18' + help_center_id: 388 + - id: '805' 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: 1713520675 - updated_at: 1713520675 + created_at: 1715078111 + updated_at: 1715078111 description: icon: bookmark - parent_id: '17' + parent_id: '804' help_center_id: total_count: 2 pages: @@ -1477,7 +1477,7 @@ paths: Unauthorized: value: type: error.list - request_id: 564e9900-717b-4169-ae3c-fb395a8f743b + request_id: d0b1415c-3634-49cd-8ddc-8164f2108d3b errors: - code: unauthorized message: Access Token Invalid @@ -1502,17 +1502,17 @@ paths: examples: collection created: value: - id: '23' + id: '810' 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: 1713520676 - updated_at: 1713520676 + created_at: 1715078112 + updated_at: 1715078112 description: '' icon: book-bookmark parent_id: - help_center_id: 19 + help_center_id: 390 schema: "$ref": "#/components/schemas/collection" '400': @@ -1523,7 +1523,7 @@ paths: Bad Request: value: type: error.list - request_id: 885928d1-3649-4e0a-b729-5b53cfcfc609 + request_id: 56d7800a-543f-424f-bff5-98aa38470ffe errors: - code: parameter_not_found message: Name is a required parameter. @@ -1537,7 +1537,7 @@ paths: Unauthorized: value: type: error.list - request_id: e2d97487-d6b0-4014-a712-761917b2c3bf + request_id: 3580cb3d-9a23-416c-b377-40b5757b53ff errors: - code: unauthorized message: Access Token Invalid @@ -1585,17 +1585,17 @@ paths: examples: Collection found: value: - id: '28' + id: '815' 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: 1713520677 - updated_at: 1713520677 + created_at: 1715078114 + updated_at: 1715078114 description: english collection description icon: bookmark parent_id: - help_center_id: 22 + help_center_id: 393 schema: "$ref": "#/components/schemas/collection" '404': @@ -1606,7 +1606,7 @@ paths: Collection not found: value: type: error.list - request_id: d9cb865a-d260-4b9f-b8eb-66ec7e07bb6a + request_id: ebd2edc0-d22f-41db-af3c-b33deb31d208 errors: - code: not_found message: Resource Not Found @@ -1620,7 +1620,7 @@ paths: Unauthorized: value: type: error.list - request_id: 619c7516-7686-46cf-9736-d536b8e2805e + request_id: 20e9e743-fbe4-4590-9e7d-c598b70c2055 errors: - code: unauthorized message: Access Token Invalid @@ -1653,17 +1653,17 @@ paths: examples: successful: value: - id: '34' + id: '821' 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: 1713520679 - updated_at: 1713520679 + created_at: 1715078115 + updated_at: 1715078115 description: english collection description icon: folder parent_id: - help_center_id: 25 + help_center_id: 396 schema: "$ref": "#/components/schemas/collection" '404': @@ -1674,7 +1674,7 @@ paths: Collection Not Found: value: type: error.list - request_id: cb1295b6-0a42-42d2-9d37-baa51252024f + request_id: 7a0adc70-ac62-4b43-9d57-f343ddfad8b0 errors: - code: not_found message: Resource Not Found @@ -1688,7 +1688,7 @@ paths: Unauthorized: value: type: error.list - request_id: cd1eb716-63eb-4214-b1f0-8a4254e4bdc1 + request_id: d83b5890-ba94-4133-88dc-ababca32e953 errors: - code: unauthorized message: Access Token Invalid @@ -1735,7 +1735,7 @@ paths: examples: successful: value: - id: '40' + id: '827' object: collection deleted: true schema: @@ -1748,7 +1748,7 @@ paths: collection Not Found: value: type: error.list - request_id: 2b2dec1b-b980-4f5b-932e-49df4ce43257 + request_id: a58d38bd-6b2e-4876-956d-d51c69905956 errors: - code: not_found message: Resource Not Found @@ -1762,7 +1762,7 @@ paths: Unauthorized: value: type: error.list - request_id: 59046e83-d97c-4d8f-9122-6b8eef26ef3d + request_id: 31913c55-e87b-4239-bf14-4a87c88fc136 errors: - code: unauthorized message: Access Token Invalid @@ -1796,10 +1796,10 @@ paths: examples: Collection found: value: - id: '31' + id: '402' workspace_id: this_is_an_id124_that_should_be_at_least_ - created_at: 1713520682 - updated_at: 1713520682 + created_at: 1715078118 + updated_at: 1715078118 identifier: help-center-1 website_turned_on: false display_name: Intercom Help Center @@ -1813,7 +1813,7 @@ paths: Collection not found: value: type: error.list - request_id: fb60ea37-3f60-40ff-8ade-bd6d544225a1 + request_id: 320ca45f-102d-4284-adb2-65de87c3088c errors: - code: not_found message: Resource Not Found @@ -1827,7 +1827,7 @@ paths: Unauthorized: value: type: error.list - request_id: a68bcb63-8c3d-4cfd-b89a-e1791a1e8f91 + request_id: d2766d31-c23a-488f-aa28-75ec0e470bd1 errors: - code: unauthorized message: Access Token Invalid @@ -1865,12 +1865,42 @@ paths: Unauthorized: value: type: error.list - request_id: bbf72fb7-690b-4a14-80e0-6e7d675b5be1 + request_id: 53febc29-50d0-4189-b53e-1f2e02a8ebda errors: - code: unauthorized message: Access Token Invalid schema: "$ref": "#/components/schemas/error" + "/calls": + get: + summary: List all calls + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Calls + operationId: ListCalls + description: You can fetch a list of all calls. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + data: [] + total_count: 0 + pages: + type: pages + page: 1 + per_page: 25 + total_pages: 0 + schema: + "$ref": "#/components/schemas/call_list" "/companies": post: summary: Create or Update a company @@ -1902,12 +1932,12 @@ paths: value: type: company company_id: company_remote_id - id: 6622402f8a6818704e8a6bb8 - app_id: this_is_an_id147_that_should_be_at_least_ + id: 663a03eb6ef5d45c04c86a53 + app_id: this_is_an_id149_that_should_be_at_least_ name: my company remote_created_at: 1374138000 - created_at: 1713520687 - updated_at: 1713520687 + created_at: 1715078123 + updated_at: 1715078123 monthly_spend: 0 session_count: 0 user_count: 0 @@ -1944,7 +1974,7 @@ paths: Unauthorized: value: type: error.list - request_id: f1420470-6868-4996-af2c-2835fe40016c + request_id: 99ae584f-8128-4109-8fa4-fa5a7e75ef3e errors: - code: unauthorized message: Access Token Invalid @@ -2042,12 +2072,12 @@ paths: data: - type: company company_id: remote_companies_scroll_2 - id: 662240308a6818704e8a6bc0 - app_id: this_is_an_id153_that_should_be_at_least_ + id: 663a03ed6ef5d45c04c86a5b + app_id: this_is_an_id155_that_should_be_at_least_ name: IntercomQATest1 - remote_created_at: 1713520688 - created_at: 1713520688 - updated_at: 1713520688 + remote_created_at: 1715078125 + created_at: 1715078125 + updated_at: 1715078125 monthly_spend: 0 session_count: 0 user_count: 4 @@ -2076,7 +2106,7 @@ paths: Company Not Found: value: type: error.list - request_id: e797faee-d384-4665-8626-97558496a864 + request_id: b6334488-6c0e-4a1a-b46e-19b764134c73 errors: - code: company_not_found message: Company Not Found @@ -2090,7 +2120,7 @@ paths: Unauthorized: value: type: error.list - request_id: 12d5672f-8238-4e85-b38d-1e8d593857a6 + request_id: f4206cb1-2757-40bf-b9ea-8c84b27f9dc9 errors: - code: unauthorized message: Access Token Invalid @@ -2125,12 +2155,12 @@ paths: value: type: company company_id: '1' - id: 662240338a6818704e8a6bcb - app_id: this_is_an_id159_that_should_be_at_least_ + id: 663a03ef6ef5d45c04c86a66 + app_id: this_is_an_id161_that_should_be_at_least_ name: company1 - remote_created_at: 1713520691 - created_at: 1713520691 - updated_at: 1713520691 + remote_created_at: 1715078127 + created_at: 1715078127 + updated_at: 1715078127 monthly_spend: 0 session_count: 0 user_count: 1 @@ -2152,7 +2182,7 @@ paths: Company Not Found: value: type: error.list - request_id: e6cef6af-fd84-430e-8825-21354c9efb00 + request_id: 66579c32-cc80-4ddd-854a-9efff405ea93 errors: - code: company_not_found message: Company Not Found @@ -2166,7 +2196,7 @@ paths: Unauthorized: value: type: error.list - request_id: d194c928-6af3-4cae-9486-2e05c4e2b350 + request_id: f44cfe02-3998-4a1e-add7-a1c8dd212fe1 errors: - code: unauthorized message: Access Token Invalid @@ -2205,12 +2235,12 @@ paths: value: type: company company_id: '1' - id: 662240358a6818704e8a6bd5 - app_id: this_is_an_id165_that_should_be_at_least_ + id: 663a03f16ef5d45c04c86a70 + app_id: this_is_an_id167_that_should_be_at_least_ name: company2 - remote_created_at: 1713520693 - created_at: 1713520693 - updated_at: 1713520693 + remote_created_at: 1715078129 + created_at: 1715078129 + updated_at: 1715078129 monthly_spend: 0 session_count: 0 user_count: 1 @@ -2232,7 +2262,7 @@ paths: Company Not Found: value: type: error.list - request_id: 91ca3fc9-fdc0-40d8-ae42-a3455f41b248 + request_id: c97aaa11-cbe4-4d11-a551-f8af0f1000a1 errors: - code: company_not_found message: Company Not Found @@ -2246,7 +2276,7 @@ paths: Unauthorized: value: type: error.list - request_id: b75720f0-70d8-454b-9d59-577e042476d3 + request_id: a1467b0d-d901-4e47-b210-6cd06ab0bfc4 errors: - code: unauthorized message: Access Token Invalid @@ -2278,7 +2308,7 @@ paths: examples: Successful: value: - id: 662240378a6818704e8a6bdf + id: 663a03f36ef5d45c04c86a7a object: company deleted: true schema: @@ -2291,7 +2321,7 @@ paths: Company Not Found: value: type: error.list - request_id: 0dfedb24-6ebf-4593-82a6-f0a1780901f9 + request_id: b94f6624-3915-4f66-81ad-7afb4829702c errors: - code: company_not_found message: Company Not Found @@ -2305,7 +2335,7 @@ paths: Unauthorized: value: type: error.list - request_id: '08be8048-f25a-4034-a55b-897da3bfd778' + request_id: 6726e6ec-8c47-4bc9-ae2c-b578c2551714 errors: - code: unauthorized message: Access Token Invalid @@ -2357,7 +2387,7 @@ paths: Company Not Found: value: type: error.list - request_id: 99c76f87-86e1-4d24-9c17-2f78dddb6e57 + request_id: 2113ac81-7ff0-4da8-a460-04a5191a127d errors: - code: company_not_found message: Company Not Found @@ -2371,7 +2401,7 @@ paths: Unauthorized: value: type: error.list - request_id: bc3b48f7-7a51-46a0-92c1-8d6118b0f499 + request_id: 44619b94-7331-4a15-bd95-3db71d051dcb errors: - code: unauthorized message: Access Token Invalid @@ -2416,7 +2446,7 @@ paths: Company Not Found: value: type: error.list - request_id: f998d1cb-d4f9-444b-90ac-bda4a9259a8c + request_id: 751b1ebd-2f8b-4138-8430-295fccaaf9f6 errors: - code: company_not_found message: Company Not Found @@ -2430,7 +2460,7 @@ paths: Unauthorized: value: type: error.list - request_id: 80bf61ff-c3da-4a36-b4ed-6cf026c96577 + request_id: ba600ead-ab9c-4fe6-a6df-f5d0d6f70222 errors: - code: unauthorized message: Access Token Invalid @@ -2447,14 +2477,14 @@ paths: - name: page in: query required: false - description: what page of results to fetch. Defaults to first page + description: The page of results to fetch. Defaults to first page example: 1 schema: type: integer - name: per_page in: query required: false - description: how many results per page. Defaults to 15 + description: How many results to return per page. Defaults to 15 example: 15 schema: type: integer @@ -2475,6 +2505,10 @@ paths: Note that the API does not include companies who have no associated users in list responses. When using the Companies endpoint and the pages object to iterate through the returned companies, there is a limit of 10,000 Companies that can be returned. If you need to list or iterate on more than 10,000 Companies, please use the [Scroll API](https://developers.intercom.com/reference#iterating-over-all-companies). + {% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `20` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. + {% /admonition %} responses: '200': description: Successful @@ -2487,12 +2521,12 @@ paths: data: - type: company company_id: remote_companies_scroll_2 - id: 6622403c8a6818704e8a6bfb - app_id: this_is_an_id189_that_should_be_at_least_ + id: 663a03f96ef5d45c04c86a96 + app_id: this_is_an_id191_that_should_be_at_least_ name: IntercomQATest1 - remote_created_at: 1713520700 - created_at: 1713520700 - updated_at: 1713520700 + remote_created_at: 1715078137 + created_at: 1715078137 + updated_at: 1715078137 monthly_spend: 0 session_count: 0 user_count: 4 @@ -2521,7 +2555,7 @@ paths: Unauthorized: value: type: error.list - request_id: 4d80cf70-8266-4be3-a5e6-13dba2de2e92 + request_id: b1d5d2c8-4a8f-417c-9753-fe8754a82ed4 errors: - code: unauthorized message: Access Token Invalid @@ -2544,23 +2578,22 @@ paths: tags: - Companies operationId: scrollOverAllCompanies - description: " The `list all companies` functionality does not work well - for huge datasets, and can result in errors and performance problems when - paging deeply. The Scroll API provides an efficient mechanism for iterating - over all companies in a dataset.\n\n- Each app can only have 1 scroll open - at a time. You'll get an error message if you try to have more than one open - per app.\n- If the scroll isn't used for 1 minute, it expires and calls with - that scroll param will fail\n- If the end of the scroll is reached, \"companies\" - will be empty and the scroll parameter will expire\n\n> \U0001F4D8 Scroll - Parameter\n>\n> You can get the first page of companies by simply sending - a GET request to the scroll endpoint. For subsequent requests you will need - to use the scroll parameter from the response.\n\n> ❗️ Scroll network timeouts\n>\n> - Since scroll is often used on large datasets network errors such as timeouts - can be encountered. When this occurs you will need to restart your scroll - query as it is not possible to continue from a specific point when using scroll.\n>\n> - When this occurs you will see a HTTP 500 error with the following message:\n> - \"Request failed due to an internal network error. Please restart the scroll - operation.\"\n" + description: |2 + The `list all companies` functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. The Scroll API provides an efficient mechanism for iterating over all companies in a dataset. + + - Each app can only have 1 scroll open at a time. You'll get an error message if you try to have more than one open per app. + - If the scroll isn't used for 1 minute, it expires and calls with that scroll param will fail + - If the end of the scroll is reached, "companies" will be empty and the scroll parameter will expire + + {% admonition type="info" name="Scroll Parameter" %} + You can get the first page of companies by simply sending a GET request to the scroll endpoint. + For subsequent requests you will need to use the scroll parameter from the response. + {% /admonition %} + {% admonition type="danger" name="Scroll network timeouts" %} + Since scroll is often used on large datasets network errors such as timeouts can be encountered. When this occurs you will see a HTTP 500 error with the following message: + "Request failed due to an internal network error. Please restart the scroll operation." + If this happens, you will need to restart your scroll query: It is not possible to continue from a specific point when using scroll. + {% /admonition %} responses: '200': description: Successful @@ -2573,12 +2606,12 @@ paths: data: - type: company company_id: remote_companies_scroll_2 - id: 6622403e8a6818704e8a6c01 - app_id: this_is_an_id193_that_should_be_at_least_ + id: 663a03fb6ef5d45c04c86a9c + app_id: this_is_an_id195_that_should_be_at_least_ name: IntercomQATest1 - remote_created_at: 1713520702 - created_at: 1713520702 - updated_at: 1713520702 + remote_created_at: 1715078139 + created_at: 1715078139 + updated_at: 1715078139 monthly_spend: 0 session_count: 0 user_count: 4 @@ -2592,7 +2625,7 @@ paths: custom_attributes: {} pages: total_count: - scroll_param: dda4fdbe-1562-4651-8483-1a70d56b0159 + scroll_param: c3405a4a-ba63-4db4-9cf2-a2574faa1b7e schema: "$ref": "#/components/schemas/company_scroll" '401': @@ -2603,7 +2636,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2953fe24-7ffe-4725-add0-c0d1b9a260c2 + request_id: 37e8ee06-d999-49eb-8e24-3514929ea22c errors: - code: unauthorized message: Access Token Invalid @@ -2638,12 +2671,12 @@ paths: value: type: company company_id: '1' - id: 662240408a6818704e8a6c0a - app_id: this_is_an_id197_that_should_be_at_least_ + id: 663a03fc6ef5d45c04c86aa5 + app_id: this_is_an_id199_that_should_be_at_least_ name: company6 - remote_created_at: 1713520704 - created_at: 1713520704 - updated_at: 1713520704 + remote_created_at: 1715078140 + created_at: 1715078140 + updated_at: 1715078140 monthly_spend: 0 session_count: 0 user_count: 1 @@ -2665,7 +2698,7 @@ paths: Bad Request: value: type: error.list - request_id: 699aae4b-7fd8-46a8-9a89-d2a5d79a3074 + request_id: 6844d5a8-8404-42af-863c-a71fc8c5139e errors: - code: parameter_not_found message: company not specified @@ -2679,7 +2712,7 @@ paths: Company Not Found: value: type: error.list - request_id: 27f5059b-c2ff-41f8-beeb-3c0a3a38c859 + request_id: b3fac6ee-6dad-4272-a17f-5177b790572a errors: - code: company_not_found message: Company Not Found @@ -2693,7 +2726,7 @@ paths: Unauthorized: value: type: error.list - request_id: 6758cbd0-04e0-449f-89b8-fd88f720e98d + request_id: 2a7aad4f-5b12-48db-9000-c326d1259841 errors: - code: unauthorized message: Access Token Invalid @@ -2716,7 +2749,7 @@ paths: successful: summary: Successful value: - id: 662240408a6818704e8a6c0a + id: 663a03fc6ef5d45c04c86aa5 bad_request: summary: Bad Request value: @@ -2755,13 +2788,13 @@ paths: data: - type: company company_id: '1' - id: 662240458a6818704e8a6c2b - app_id: this_is_an_id213_that_should_be_at_least_ + id: 663a04026ef5d45c04c86ac6 + app_id: this_is_an_id215_that_should_be_at_least_ name: company12 - remote_created_at: 1713520709 - created_at: 1713520709 - updated_at: 1713520709 - last_request_at: 1713347909 + remote_created_at: 1715078146 + created_at: 1715078146 + updated_at: 1715078146 + last_request_at: 1714905346 monthly_spend: 0 session_count: 0 user_count: 1 @@ -2790,7 +2823,7 @@ paths: Contact not found: value: type: error.list - request_id: 3c1eb803-d58e-420d-9307-869a5de7ef2b + request_id: 99f90547-ef18-44e8-b5d2-87fb436194ed errors: - code: not_found message: User Not Found @@ -2804,7 +2837,7 @@ paths: Unauthorized: value: type: error.list - request_id: e729ef59-f6cf-4e2f-938e-a12b6d2798ff + request_id: aaae7d0a-7dff-4012-92fc-29829d7cf5e5 errors: - code: unauthorized message: Access Token Invalid @@ -2847,12 +2880,12 @@ paths: value: type: company company_id: '1' - id: 662240428a6818704e8a6c1a - app_id: this_is_an_id205_that_should_be_at_least_ + id: 663a03ff6ef5d45c04c86ab5 + app_id: this_is_an_id207_that_should_be_at_least_ name: company8 - remote_created_at: 1713520706 - created_at: 1713520706 - updated_at: 1713520707 + remote_created_at: 1715078143 + created_at: 1715078143 + updated_at: 1715078143 monthly_spend: 0 session_count: 0 user_count: 0 @@ -2874,14 +2907,14 @@ paths: Company Not Found: value: type: error.list - request_id: 8d04c8e8-586d-4f9c-93cc-5fbcb3bbc69b + request_id: 4cb89abb-d9c7-4c13-9cff-306605da35f2 errors: - code: company_not_found message: Company Not Found Contact Not Found: value: type: error.list - request_id: 6bca6d15-c84b-4f56-8fab-25e875e61ed8 + request_id: 55f497b4-ae97-4998-9a1a-816e886d6d3b errors: - code: not_found message: User Not Found @@ -2895,7 +2928,7 @@ paths: Unauthorized: value: type: error.list - request_id: df9544bd-9911-4521-a99e-3633bebb9734 + request_id: d588affb-8ae9-4a26-9b71-554f4eae6044 errors: - code: unauthorized message: Access Token Invalid @@ -2931,44 +2964,44 @@ paths: type: list data: - type: note - id: '3' - created_at: 1712915911 + id: '146' + created_at: 1714473348 contact: type: contact - id: 662240478a6818704e8a6c36 + id: 663a04046ef5d45c04c86ad1 author: type: admin - id: '991266336' - name: Ciaran122 Lee - email: admin122@email.com + id: '991272143' + name: Ciaran123 Lee + email: admin123@email.com away_mode_enabled: false away_mode_reassign: false body: "

This is a note.

" - type: note - id: '2' - created_at: 1712829511 + id: '145' + created_at: 1714386948 contact: type: contact - id: 662240478a6818704e8a6c36 + id: 663a04046ef5d45c04c86ad1 author: type: admin - id: '991266336' - name: Ciaran122 Lee - email: admin122@email.com + id: '991272143' + name: Ciaran123 Lee + email: admin123@email.com away_mode_enabled: false away_mode_reassign: false body: "

This is a note.

" - type: note - id: '1' - created_at: 1712829511 + id: '144' + created_at: 1714386948 contact: type: contact - id: 662240478a6818704e8a6c36 + id: 663a04046ef5d45c04c86ad1 author: type: admin - id: '991266336' - name: Ciaran122 Lee - email: admin122@email.com + id: '991272143' + name: Ciaran123 Lee + email: admin123@email.com away_mode_enabled: false away_mode_reassign: false body: "

This is a note.

" @@ -2989,7 +3022,7 @@ paths: Contact not found: value: type: error.list - request_id: aa43cb28-b1a1-4970-bf1b-876b724db296 + request_id: 8882e4d8-ac63-4498-abf1-a7bab9b78698 errors: - code: not_found message: User Not Found @@ -3023,16 +3056,16 @@ paths: Successful response: value: type: note - id: '8' - created_at: 1713520713 + id: '151' + created_at: 1715078149 contact: type: contact - id: 662240488a6818704e8a6c38 + id: 663a04056ef5d45c04c86ad3 author: type: admin - id: '991266338' - name: Ciaran124 Lee - email: admin124@email.com + id: '991272145' + name: Ciaran125 Lee + email: admin125@email.com away_mode_enabled: false away_mode_reassign: false body: "

Hello

" @@ -3046,14 +3079,14 @@ paths: Admin not found: value: type: error.list - request_id: 6ae4dabe-f0be-45d4-9171-ef9e01290e2c + request_id: 186fb89a-a870-44a4-8f38-2c7b239e95e9 errors: - code: not_found message: Resource Not Found Contact not found: value: type: error.list - request_id: db1dea94-fece-4a7b-bce0-0841a6f9eb78 + request_id: 6419c59c-1317-4900-8816-c72f6b17502e errors: - code: not_found message: User Not Found @@ -3083,20 +3116,20 @@ paths: successful_response: summary: Successful response value: - contact_id: 662240488a6818704e8a6c38 - admin_id: 991266338 + contact_id: 663a04056ef5d45c04c86ad3 + admin_id: 991272145 body: Hello admin_not_found: summary: Admin not found value: - contact_id: 662240498a6818704e8a6c39 + contact_id: 663a04066ef5d45c04c86ad4 admin_id: 123 body: Hello contact_not_found: summary: Contact not found value: contact_id: 123 - admin_id: 991266340 + admin_id: 991272147 body: Hello "/contacts/{contact_id}/segments": get: @@ -3129,10 +3162,10 @@ paths: type: list data: - type: segment - id: 6622404a8a6818704e8a6c3b + id: 663a04076ef5d45c04c86ad6 name: segment - created_at: 1713520714 - updated_at: 1713520714 + created_at: 1715078151 + updated_at: 1715078151 person_type: user schema: "$ref": "#/components/schemas/contact_segments" @@ -3144,7 +3177,7 @@ paths: Contact not found: value: type: error.list - request_id: 64b844b5-5a1d-4bcc-8034-93b581b03357 + request_id: 254360a9-047c-4754-bbf1-4f14604a678f errors: - code: not_found message: User Not Found @@ -3158,7 +3191,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2b2a8567-a459-4409-9ecf-088e52a96748 + request_id: a62db5f9-2def-4107-b940-33673b7c22df errors: - code: unauthorized message: Access Token Invalid @@ -3202,7 +3235,7 @@ paths: type: list data: - type: subscription - id: '1' + id: '507' state: live consent_type: opt_out default_translation: @@ -3216,7 +3249,7 @@ paths: content_types: - email - type: subscription - id: '3' + id: '509' state: live consent_type: opt_in default_translation: @@ -3239,7 +3272,7 @@ paths: Contact not found: value: type: error.list - request_id: afdc9206-187a-46e9-bd49-d8fa29b9e1a4 + request_id: 6fe37b36-196c-497d-ba36-ce480d2ce38f errors: - code: not_found message: User Not Found @@ -3253,7 +3286,7 @@ paths: Unauthorized: value: type: error.list - request_id: a7825005-f04c-4f99-a63d-2a976909bb9e + request_id: b27cad94-17e9-4ee0-9265-1585b171e9b2 errors: - code: unauthorized message: Access Token Invalid @@ -3294,7 +3327,7 @@ paths: Successful: value: type: subscription - id: '16' + id: '522' state: live consent_type: opt_in default_translation: @@ -3317,14 +3350,14 @@ paths: Contact not found: value: type: error.list - request_id: 2052d15d-c705-4f21-9ec9-9db6f332428f + request_id: 6c44a3b7-fe81-44c9-881c-cb0565424a26 errors: - code: not_found message: User Not Found Resource not found: value: type: error.list - request_id: fc1b73e1-4189-499b-a425-57f587bc00b4 + request_id: 7dbfaa04-55e8-4ec3-b43d-c428991ecf9b errors: - code: not_found message: Resource Not Found @@ -3338,7 +3371,7 @@ paths: Unauthorized: value: type: error.list - request_id: 6fa3f3a3-39cd-4dd4-b230-b7a0b36cc0ec + request_id: 4b43b59c-2402-4175-83e7-1c13d44c3214 errors: - code: unauthorized message: Access Token Invalid @@ -3366,12 +3399,12 @@ paths: successful: summary: Successful value: - id: 16 + id: 522 consent_type: opt_in contact_not_found: summary: Contact not found value: - id: 20 + id: 526 consent_type: opt_in resource_not_found: summary: Resource not found @@ -3417,7 +3450,7 @@ paths: Successful: value: type: subscription - id: '32' + id: '538' state: live consent_type: opt_in default_translation: @@ -3440,14 +3473,14 @@ paths: Contact not found: value: type: error.list - request_id: 3eb6f289-fdca-426a-bc48-1f91c73bf0dc + request_id: f25cae79-0ce1-423b-bee1-ac46c34af9b2 errors: - code: not_found message: User Not Found Resource not found: value: type: error.list - request_id: ecebd0f2-2588-4b19-9b99-5353ced47b15 + request_id: f49c1e09-aade-43a6-a14b-2315b37c4801 errors: - code: not_found message: Resource Not Found @@ -3461,7 +3494,7 @@ paths: Unauthorized: value: type: error.list - request_id: f477a357-2c9b-49eb-856f-f6ef2aba6cd2 + request_id: 2f9dfb24-06b6-4c40-ae8c-1fedfc266d45 errors: - code: unauthorized message: Access Token Invalid @@ -3499,7 +3532,7 @@ paths: type: list data: - type: tag - id: '1' + id: '477' name: Manual tag schema: "$ref": "#/components/schemas/tag_list" @@ -3511,7 +3544,7 @@ paths: Contact not found: value: type: error.list - request_id: 9cd34f6d-9d33-405d-b744-0ee3952183d0 + request_id: b85a7a66-8a2f-469c-8f11-3a1ae48ef433 errors: - code: not_found message: User Not Found @@ -3525,7 +3558,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8ce2e35f-5082-4a49-b5e6-899bcc3a2220 + request_id: d9e469c3-10a5-47ed-85d2-8a96e09c617d errors: - code: unauthorized message: Access Token Invalid @@ -3560,7 +3593,7 @@ paths: successful: value: type: tag - id: '2' + id: '478' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -3572,14 +3605,14 @@ paths: Contact not found: value: type: error.list - request_id: 10b30200-762e-49a9-9ceb-976fae5341db + request_id: e903b60a-1898-4d5c-85f9-200a77910f6c errors: - code: not_found message: User Not Found Tag not found: value: type: error.list - request_id: df4cadb3-8b29-42b3-b5ce-76494e89ed1b + request_id: 9c35e4f6-3791-462f-8a11-2dac1487dd8e errors: - code: not_found message: Resource Not Found @@ -3593,7 +3626,7 @@ paths: Unauthorized: value: type: error.list - request_id: c31e20e9-0061-48dd-8dbf-88fe301273bd + request_id: 60002ce4-860b-4f9b-937f-db076bd239b1 errors: - code: unauthorized message: Access Token Invalid @@ -3616,11 +3649,11 @@ paths: successful: summary: successful value: - id: 2 + id: 478 contact_not_found: summary: Contact not found value: - id: 3 + id: 479 tag_not_found: summary: Tag not found value: @@ -3662,7 +3695,7 @@ paths: successful: value: type: tag - id: '5' + id: '481' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -3674,14 +3707,14 @@ paths: Contact not found: value: type: error.list - request_id: 3f1f7fc3-033b-4283-96c0-a267fc582f36 + request_id: de14ac32-6184-4af3-8fe9-27f213d412c8 errors: - code: not_found message: User Not Found Tag not found: value: type: error.list - request_id: c42977df-82da-4e29-a9c6-bb13b9c95ff2 + request_id: 9ee365aa-46e9-4be1-8795-8ba29cfcdefb errors: - code: not_found message: Resource Not Found @@ -3695,7 +3728,7 @@ paths: Unauthorized: value: type: error.list - request_id: 5a0ba777-db88-4903-9b5e-2e8e4ca119bd + request_id: ae6a35b5-e74c-449c-9f21-5533eb647b9e errors: - code: unauthorized message: Access Token Invalid @@ -3729,8 +3762,8 @@ paths: successful: value: type: contact - id: 662240588a6818704e8a6c52 - workspace_id: this_is_an_id279_that_should_be_at_least_ + id: 663a04146ef5d45c04c86aed + workspace_id: this_is_an_id281_that_should_be_at_least_ external_id: '70' role: user email: joebloggs@intercom.io @@ -3745,9 +3778,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1713520728 - updated_at: 1713520728 - signed_up_at: 1713520728 + created_at: 1715078164 + updated_at: 1715078164 + signed_up_at: 1715078164 last_seen_at: last_replied_at: last_contacted_at: @@ -3781,31 +3814,31 @@ paths: tags: type: list data: [] - url: "/contacts/662240588a6818704e8a6c52/tags" + url: "/contacts/663a04146ef5d45c04c86aed/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/662240588a6818704e8a6c52/notes" + url: "/contacts/663a04146ef5d45c04c86aed/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/662240588a6818704e8a6c52/companies" + url: "/contacts/663a04146ef5d45c04c86aed/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/662240588a6818704e8a6c52/subscriptions" + url: "/contacts/663a04146ef5d45c04c86aed/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/662240588a6818704e8a6c52/subscriptions" + url: "/contacts/663a04146ef5d45c04c86aed/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3824,7 +3857,7 @@ paths: Unauthorized: value: type: error.list - request_id: fa463763-2fb1-4e1d-be0f-a5f93654b316 + request_id: 6df2dcb0-7975-40a0-b6ee-585b6da8388d errors: - code: unauthorized message: Access Token Invalid @@ -3869,8 +3902,8 @@ paths: successful: value: type: contact - id: 662240598a6818704e8a6c53 - workspace_id: this_is_an_id283_that_should_be_at_least_ + id: 663a04166ef5d45c04c86aee + workspace_id: this_is_an_id285_that_should_be_at_least_ external_id: '70' role: user email: joe@bloggs.com @@ -3885,9 +3918,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1713520729 - updated_at: 1713520729 - signed_up_at: 1713520729 + created_at: 1715078166 + updated_at: 1715078166 + signed_up_at: 1715078166 last_seen_at: last_replied_at: last_contacted_at: @@ -3921,31 +3954,31 @@ paths: tags: type: list data: [] - url: "/contacts/662240598a6818704e8a6c53/tags" + url: "/contacts/663a04166ef5d45c04c86aee/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/662240598a6818704e8a6c53/notes" + url: "/contacts/663a04166ef5d45c04c86aee/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/662240598a6818704e8a6c53/companies" + url: "/contacts/663a04166ef5d45c04c86aee/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/662240598a6818704e8a6c53/subscriptions" + url: "/contacts/663a04166ef5d45c04c86aee/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/662240598a6818704e8a6c53/subscriptions" + url: "/contacts/663a04166ef5d45c04c86aee/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3964,7 +3997,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8062ee8e-5979-4966-b38c-de3a9a0632cd + request_id: 1f14b617-6e4c-4a58-95b8-8d34a6dd4175 errors: - code: unauthorized message: Access Token Invalid @@ -3995,7 +4028,7 @@ paths: examples: successful: value: - id: 6622405b8a6818704e8a6c54 + id: 663a04176ef5d45c04c86aef external_id: '70' type: contact deleted: true @@ -4009,7 +4042,7 @@ paths: Unauthorized: value: type: error.list - request_id: 14ce5796-0b61-4352-b82e-566f64540045 + request_id: af1decc2-fa1c-4bbd-a101-2adae5df0046 errors: - code: unauthorized message: Access Token Invalid @@ -4037,8 +4070,8 @@ paths: successful: value: type: contact - id: 6622405c8a6818704e8a6c56 - workspace_id: this_is_an_id291_that_should_be_at_least_ + id: 663a04186ef5d45c04c86af1 + workspace_id: this_is_an_id293_that_should_be_at_least_ external_id: '70' role: user email: joe@bloggs.com @@ -4053,9 +4086,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1713520732 - updated_at: 1713520732 - signed_up_at: 1713520732 + created_at: 1715078168 + updated_at: 1715078168 + signed_up_at: 1715078168 last_seen_at: last_replied_at: last_contacted_at: @@ -4089,31 +4122,31 @@ paths: tags: type: list data: [] - url: "/contacts/6622405c8a6818704e8a6c56/tags" + url: "/contacts/663a04186ef5d45c04c86af1/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/6622405c8a6818704e8a6c56/notes" + url: "/contacts/663a04186ef5d45c04c86af1/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/6622405c8a6818704e8a6c56/companies" + url: "/contacts/663a04186ef5d45c04c86af1/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/6622405c8a6818704e8a6c56/subscriptions" + url: "/contacts/663a04186ef5d45c04c86af1/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/6622405c8a6818704e8a6c56/subscriptions" + url: "/contacts/663a04186ef5d45c04c86af1/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -4132,7 +4165,7 @@ paths: Unauthorized: value: type: error.list - request_id: 1b3bc8b1-a32a-4f10-995a-60cb2e7c72d3 + request_id: '0487dace-51f4-49df-a5c1-48284c881599' errors: - code: unauthorized message: Access Token Invalid @@ -4147,8 +4180,8 @@ paths: successful: summary: successful value: - from: 6622405c8a6818704e8a6c55 - into: 6622405c8a6818704e8a6c56 + from: 663a04186ef5d45c04c86af0 + into: 663a04186ef5d45c04c86af1 "/contacts/search": post: summary: Search contacts @@ -4167,6 +4200,12 @@ paths: This will accept a query object in the body which will define your filters in order to search for contacts. + {% admonition type="warning" name="Optimizing search queries" %} + Search queries can be complex, so optimizing them can help the performance of your search. + Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize + pagination to limit the number of results returned. The default is `50` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param. + {% /admonition %} ### Contact Creation Delay If a contact has recently been created, there is a possibility that it will not yet be available when searching. This means that it may not appear in the response. This delay can take a few minutes. If you need to be instantly notified it is recommended to use webhooks and iterate to see if they match your search filters. @@ -4281,7 +4320,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9c92426c-2583-4a30-905f-6a85cec1c578 + request_id: ecfed177-e5f7-4184-97b9-b5b14f75242f errors: - code: unauthorized message: Access Token Invalid @@ -4301,15 +4340,15 @@ paths: value: - field: id operator: "=" - value: 6622405d8a6818704e8a6c59 + value: 663a041a6ef5d45c04c86af4 - operator: OR value: - field: id operator: "=" - value: 6622405d8a6818704e8a6c59 + value: 663a041a6ef5d45c04c86af4 - field: id operator: "=" - value: 6622405d8a6818704e8a6c59 + value: 663a041a6ef5d45c04c86af4 "/contacts": get: summary: List all contacts @@ -4321,7 +4360,12 @@ paths: tags: - Contacts operationId: ListContacts - description: You can fetch a list of all contacts. + description: | + You can fetch a list of all contacts (ie. users or leads) in your workspace. + {% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `50` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. + {% /admonition %} responses: '200': description: successful @@ -4348,7 +4392,7 @@ paths: Unauthorized: value: type: error.list - request_id: de24a788-6ad4-4d8d-aa6d-8f8f0280703a + request_id: d109e99d-423d-4179-b7b0-fb5a23f79228 errors: - code: unauthorized message: Access Token Invalid @@ -4374,8 +4418,8 @@ paths: successful: value: type: contact - id: 662240608a6818704e8a6c5b - workspace_id: this_is_an_id303_that_should_be_at_least_ + id: 663a041c6ef5d45c04c86af6 + workspace_id: this_is_an_id305_that_should_be_at_least_ external_id: role: user email: joebloggs@intercom.io @@ -4390,8 +4434,8 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1713520736 - updated_at: 1713520736 + created_at: 1715078173 + updated_at: 1715078173 signed_up_at: last_seen_at: last_replied_at: @@ -4426,31 +4470,31 @@ paths: tags: type: list data: [] - url: "/contacts/662240608a6818704e8a6c5b/tags" + url: "/contacts/663a041c6ef5d45c04c86af6/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/662240608a6818704e8a6c5b/notes" + url: "/contacts/663a041c6ef5d45c04c86af6/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/662240608a6818704e8a6c5b/companies" + url: "/contacts/663a041c6ef5d45c04c86af6/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/662240608a6818704e8a6c5b/subscriptions" + url: "/contacts/663a041c6ef5d45c04c86af6/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/662240608a6818704e8a6c5b/subscriptions" + url: "/contacts/663a041c6ef5d45c04c86af6/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -4469,7 +4513,7 @@ paths: Unauthorized: value: type: error.list - request_id: b1f4780d-6f8b-4ffd-b1b1-5e1655d1ed58 + request_id: fb44a5c4-5d8c-4caa-9a80-0e5f06f285b1 errors: - code: unauthorized message: Access Token Invalid @@ -4515,8 +4559,8 @@ paths: successful: value: type: contact - id: 662240618a6818704e8a6c5c - workspace_id: this_is_an_id307_that_should_be_at_least_ + id: 663a041e6ef5d45c04c86af7 + workspace_id: this_is_an_id309_that_should_be_at_least_ external_id: '70' role: user email: joe@bloggs.com @@ -4531,9 +4575,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1713520737 - updated_at: 1713520737 - signed_up_at: 1713520737 + created_at: 1715078174 + updated_at: 1715078174 + signed_up_at: 1715078174 last_seen_at: last_replied_at: last_contacted_at: @@ -4567,31 +4611,31 @@ paths: tags: type: list data: [] - url: "/contacts/662240618a6818704e8a6c5c/tags" + url: "/contacts/663a041e6ef5d45c04c86af7/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/662240618a6818704e8a6c5c/notes" + url: "/contacts/663a041e6ef5d45c04c86af7/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/662240618a6818704e8a6c5c/companies" + url: "/contacts/663a041e6ef5d45c04c86af7/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/662240618a6818704e8a6c5c/subscriptions" + url: "/contacts/663a041e6ef5d45c04c86af7/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/662240618a6818704e8a6c5c/subscriptions" + url: "/contacts/663a041e6ef5d45c04c86af7/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -4610,7 +4654,7 @@ paths: Unauthorized: value: type: error.list - request_id: 7284480a-5407-418d-b30a-2e1ff3350151 + request_id: e2ce3415-11f6-49f7-896f-315160efd08d errors: - code: unauthorized message: Access Token Invalid @@ -4643,7 +4687,7 @@ paths: examples: successful: value: - id: 662240638a6818704e8a6c5e + id: 663a041f6ef5d45c04c86af9 external_id: '70' type: contact archived: true @@ -4676,7 +4720,7 @@ paths: examples: successful: value: - id: 662240638a6818704e8a6c5f + id: 663a041f6ef5d45c04c86afa external_id: '70' type: contact archived: false @@ -4712,7 +4756,7 @@ paths: successful: value: type: tag - id: '7' + id: '483' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -4724,7 +4768,7 @@ paths: Conversation not found: value: type: error.list - request_id: 4549e55f-ef70-41ca-a102-e5a2890413e4 + request_id: 427c5ea2-aeb4-4fb3-be71-43d4a7fbf994 errors: - code: not_found message: Conversation not found @@ -4738,7 +4782,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8b499480-a397-45f2-9b28-7a2021af1570 + request_id: 86abf6e7-a6fd-4c50-acc3-9582c1128923 errors: - code: unauthorized message: Access Token Invalid @@ -4767,13 +4811,13 @@ paths: successful: summary: successful value: - id: 7 - admin_id: 991266373 + id: 483 + admin_id: 991272180 conversation_not_found: summary: Conversation not found value: - id: 8 - admin_id: 991266375 + id: 484 + admin_id: 991272182 "/conversations/{conversation_id}/tags/{id}": delete: summary: Remove tag from a conversation @@ -4811,7 +4855,7 @@ paths: successful: value: type: tag - id: '10' + id: '486' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -4823,14 +4867,14 @@ paths: Conversation not found: value: type: error.list - request_id: 7ce5b9a3-d38c-4fdd-91ec-66dab3770753 + request_id: 5ffb2d84-ecc5-45c2-aeed-01e3fa5ab82c errors: - code: not_found message: Conversation not found Tag not found: value: type: error.list - request_id: f9dc33d7-1b7b-41d0-8df8-0d071fb755cb + request_id: 3ec55fcd-63d9-4b02-a3e6-e0c9c6e412c7 errors: - code: tag_not_found message: Tag not found @@ -4844,7 +4888,7 @@ paths: Unauthorized: value: type: error.list - request_id: 52563b75-cf13-48e2-9e68-8550424c3de3 + request_id: f325a130-fa66-45b2-9e41-1f5bae3c179a errors: - code: unauthorized message: Access Token Invalid @@ -4867,15 +4911,15 @@ paths: successful: summary: successful value: - admin_id: 991266377 + admin_id: 991272184 conversation_not_found: summary: Conversation not found value: - admin_id: 991266379 + admin_id: 991272186 tag_not_found: summary: Tag not found value: - admin_id: 991266380 + admin_id: 991272187 "/conversations": get: summary: List all conversations @@ -4904,7 +4948,11 @@ paths: description: | You can fetch a list of all conversations. - You can optionally request the result page size and the cursor to start after to fetch the result + You can optionally request the result page size and the cursor to start after to fetch the result. + {% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `20` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. + {% /admonition %} responses: '200': description: successful @@ -4922,22 +4970,22 @@ paths: total_count: 1 conversations: - type: conversation - id: '5' - created_at: 1713520747 - updated_at: 1713520747 + id: '1725' + created_at: 1715078183 + updated_at: 1715078183 waiting_since: snoozed_until: source: type: conversation - id: '403918065' + id: '403918991' delivered_as: admin_initiated subject: '' body: "

this is the message body

" author: type: admin - id: '991266383' - name: Ciaran166 Lee - email: admin166@email.com + id: '991272190' + name: Ciaran167 Lee + email: admin167@email.com attachments: [] url: redacted: false @@ -4945,7 +4993,7 @@ paths: type: contact.list contacts: - type: contact - id: 6622406b8a6818704e8a6c63 + id: 663a04276ef5d45c04c86afe external_id: '70' first_contact_reply: admin_assignee_id: @@ -4982,7 +5030,7 @@ paths: Unauthorized: value: type: error.list - request_id: b35d1a48-e94f-460a-8e2c-0aa59e0079d7 + request_id: bbd7425c-8147-4ebb-8966-c95b208ddca9 errors: - code: unauthorized message: Access Token Invalid @@ -4996,7 +5044,7 @@ paths: API plan restricted: value: type: error.list - request_id: ee33dc60-0e5a-4be7-9d27-849dba8f489c + request_id: 2543cc39-31e0-445a-b5ca-3836f8c8c0ff errors: - code: api_plan_restricted message: Active subscription needed. @@ -5032,11 +5080,11 @@ paths: conversation created: value: type: user_message - id: '403918075' - created_at: 1713520766 + id: '403919001' + created_at: 1715078202 body: Hello there message_type: inapp - conversation_id: '33' + conversation_id: '1753' schema: "$ref": "#/components/schemas/message" '404': @@ -5047,7 +5095,7 @@ paths: Contact Not Found: value: type: error.list - request_id: 9e96ca53-e3f3-4fc1-8811-5fdcc02aed38 + request_id: c3a689c9-38f8-4905-a535-28da6b3a07ac errors: - code: not_found message: User Not Found @@ -5061,7 +5109,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8faaa8bd-91ff-4657-9b95-439f55a64e25 + request_id: 677e2559-b2e8-461c-af0f-c9468f667f4d errors: - code: unauthorized message: Access Token Invalid @@ -5075,7 +5123,7 @@ paths: API plan restricted: value: type: error.list - request_id: 2e8ed0c1-137a-4b4a-bb25-d694cc2ef589 + request_id: 36074dd5-ad2c-4466-b203-2316e02b3e3e errors: - code: api_plan_restricted message: Active subscription needed. @@ -5092,7 +5140,7 @@ paths: value: from: type: user - id: 6622407e8a6818704e8a6c7b + id: 663a043a6ef5d45c04c86b16 body: Hello there contact_not_found: summary: Contact Not Found @@ -5146,22 +5194,22 @@ paths: conversation found: value: type: conversation - id: '37' - created_at: 1713520771 - updated_at: 1713520771 + id: '1757' + created_at: 1715078207 + updated_at: 1715078207 waiting_since: snoozed_until: source: type: conversation - id: '403918079' + id: '403919005' delivered_as: admin_initiated subject: '' body: "

this is the message body

" author: type: admin - id: '991266400' - name: Ciaran176 Lee - email: admin176@email.com + id: '991272207' + name: Ciaran177 Lee + email: admin177@email.com attachments: [] url: redacted: false @@ -5169,7 +5217,7 @@ paths: type: contact.list contacts: - type: contact - id: 662240838a6818704e8a6c7f + id: 663a043f6ef5d45c04c86b1a external_id: '70' first_contact_reply: admin_assignee_id: @@ -5194,12 +5242,12 @@ paths: data: [] total_count: 0 has_more: false + ai_agent: + ai_agent_participated: false conversation_parts: type: conversation_part.list conversation_parts: [] total_count: 0 - ai_agent: - ai_agent_participated: false schema: "$ref": "#/components/schemas/conversation" '404': @@ -5210,7 +5258,7 @@ paths: Not found: value: type: error.list - request_id: dab87719-b7d2-4b4e-8054-3b9b3d96c34d + request_id: 879ac1fc-0bc1-4a10-b862-d26e5486def4 errors: - code: not_found message: Resource Not Found @@ -5224,7 +5272,7 @@ paths: Unauthorized: value: type: error.list - request_id: 15cbfd39-e9c9-4451-991e-8f0c34ed1c55 + request_id: eae5c9c0-d6ad-4690-8f5f-4bac5da0b9c1 errors: - code: unauthorized message: Access Token Invalid @@ -5238,7 +5286,7 @@ paths: API plan restricted: value: type: error.list - request_id: 9188a2f8-26c3-4627-8e53-7b6a71e8fe47 + request_id: 476d5756-d30f-49ac-a273-423085027bb4 errors: - code: api_plan_restricted message: Active subscription needed. @@ -5285,22 +5333,22 @@ paths: conversation found: value: type: conversation - id: '41' - created_at: 1713520775 - updated_at: 1713520777 + id: '1761' + created_at: 1715078211 + updated_at: 1715078212 waiting_since: snoozed_until: source: type: conversation - id: '403918083' + id: '403919009' delivered_as: admin_initiated subject: '' body: "

this is the message body

" author: type: admin - id: '991266408' - name: Ciaran180 Lee - email: admin180@email.com + id: '991272215' + name: Ciaran181 Lee + email: admin181@email.com attachments: [] url: redacted: false @@ -5308,7 +5356,7 @@ paths: type: contact.list contacts: - type: contact - id: 662240878a6818704e8a6c83 + id: 663a04436ef5d45c04c86b1e external_id: '70' first_contact_reply: admin_assignee_id: @@ -5335,46 +5383,46 @@ paths: data: [] total_count: 0 has_more: false + ai_agent: + ai_agent_participated: false conversation_parts: type: conversation_part.list conversation_parts: - type: conversation_part - id: '4' + id: '403' part_type: conversation_attribute_updated_by_admin body: - created_at: 1713520776 - updated_at: 1713520776 - notified_at: 1713520776 + created_at: 1715078212 + updated_at: 1715078212 + notified_at: 1715078212 assigned_to: author: - id: '991266409' + id: '991272216' type: bot name: Operator - email: operator+this_is_an_id354_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id356_that_should_be_at_least_@intercom.io attachments: [] external_id: redacted: false metadata: {} - type: conversation_part - id: '5' + id: '404' part_type: conversation_attribute_updated_by_admin body: - created_at: 1713520777 - updated_at: 1713520777 - notified_at: 1713520777 + created_at: 1715078212 + updated_at: 1715078212 + notified_at: 1715078212 assigned_to: author: - id: '991266409' + id: '991272216' type: bot name: Operator - email: operator+this_is_an_id354_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id356_that_should_be_at_least_@intercom.io attachments: [] external_id: redacted: false metadata: {} total_count: 2 - ai_agent: - ai_agent_participated: false schema: "$ref": "#/components/schemas/conversation" '404': @@ -5385,7 +5433,7 @@ paths: Not found: value: type: error.list - request_id: '080ffc26-f66a-407a-802d-f439fd17ccf0' + request_id: f7ff4aee-5198-448a-82e7-a106042af59d errors: - code: not_found message: Resource Not Found @@ -5399,7 +5447,7 @@ paths: Unauthorized: value: type: error.list - request_id: 4d3aec6f-3953-48b1-a80f-5dc697688916 + request_id: 830acb55-0e68-43d7-94e1-e96465489f72 errors: - code: unauthorized message: Access Token Invalid @@ -5413,7 +5461,7 @@ paths: API plan restricted: value: type: error.list - request_id: 41aeb783-2e14-4714-8dfe-989f11df0153 + request_id: 8e92b933-328d-46f8-906b-fffe117a4308 errors: - code: api_plan_restricted message: Active subscription needed. @@ -5464,7 +5512,7 @@ paths: examples: successful: value: - id: '45' + id: '1765' object: conversation deleted: true schema: @@ -5477,7 +5525,7 @@ paths: Unauthorized: value: type: error.list - request_id: 1c266175-e6ba-49d6-8f08-1aafbdc46ea4 + request_id: 14162ce1-a351-4b1c-8c2a-27bf01168290 errors: - code: unauthorized message: Access Token Invalid @@ -5491,7 +5539,7 @@ paths: API plan restricted: value: type: error.list - request_id: bcb5b21a-1ebb-4293-97c7-ebd37189ead7 + request_id: f0419a60-2cd0-43af-9ce7-54cfb53a2af2 errors: - code: api_plan_restricted message: Active subscription needed. @@ -5514,6 +5562,12 @@ paths: To search for conversations, you need to send a `POST` request to `https://api.intercom.io/conversations/search`. This will accept a query object in the body which will define your filters in order to search for conversations. + {% admonition type="warning" name="Optimizing search queries" %} + Search queries can be complex, so optimizing them can help the performance of your search. + Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize + pagination to limit the number of results returned. The default is `20` results per page and maximum is `150`. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param. + {% /admonition %} ### Nesting & Limitations @@ -5618,22 +5672,22 @@ paths: total_count: 1 conversations: - type: conversation - id: '48' - created_at: 1713520785 - updated_at: 1713520785 + id: '1768' + created_at: 1715078221 + updated_at: 1715078221 waiting_since: snoozed_until: source: type: conversation - id: '403918090' + id: '403919016' delivered_as: admin_initiated subject: '' body: "

this is the message body

" author: type: admin - id: '991266438' - name: Ciaran203 Lee - email: admin203@email.com + id: '991272245' + name: Ciaran204 Lee + email: admin204@email.com attachments: [] url: redacted: false @@ -5641,7 +5695,7 @@ paths: type: contact.list contacts: - type: contact - id: 662240918a6818704e8a6c8a + id: 663a044d6ef5d45c04c86b25 external_id: '70' first_contact_reply: admin_assignee_id: @@ -5684,15 +5738,15 @@ paths: value: - field: id operator: "=" - value: '48' + value: '1768' - operator: OR value: - field: id operator: "=" - value: '48' + value: '1768' - field: id operator: "=" - value: '48' + value: '1768' "/conversations/{id}/reply": post: summary: Reply to a conversation @@ -5723,22 +5777,22 @@ paths: User reply: value: type: conversation - id: '57' - created_at: 1713520792 - updated_at: 1713520793 - waiting_since: 1713520793 + id: '1777' + created_at: 1715078227 + updated_at: 1715078228 + waiting_since: 1715078228 snoozed_until: source: type: conversation - id: '403918093' + id: '403919019' delivered_as: admin_initiated subject: '' body: "

this is the message body

" author: type: admin - id: '991266441' - name: Ciaran205 Lee - email: admin205@email.com + id: '991272248' + name: Ciaran206 Lee + email: admin206@email.com attachments: [] url: redacted: false @@ -5746,10 +5800,10 @@ paths: type: contact.list contacts: - type: contact - id: 662240978a6818704e8a6c92 + id: 663a04536ef5d45c04c86b2d external_id: '70' first_contact_reply: - created_at: 1713520793 + created_at: 1715078228 type: conversation url: admin_assignee_id: @@ -5774,19 +5828,21 @@ paths: data: [] total_count: 0 has_more: false + ai_agent: + ai_agent_participated: false conversation_parts: type: conversation_part.list conversation_parts: - type: conversation_part - id: '7' + id: '406' part_type: open body: "

Thanks again :)

" - created_at: 1713520793 - updated_at: 1713520793 - notified_at: 1713520793 + created_at: 1715078228 + updated_at: 1715078228 + notified_at: 1715078228 assigned_to: author: - id: 662240978a6818704e8a6c92 + id: 663a04536ef5d45c04c86b2d type: user name: Joe Bloggs email: joe@bloggs.com @@ -5795,27 +5851,25 @@ paths: redacted: false metadata: {} total_count: 1 - ai_agent: - ai_agent_participated: false Admin note reply: value: type: conversation - id: '58' - created_at: 1713520794 - updated_at: 1713520794 + id: '1778' + created_at: 1715078229 + updated_at: 1715078230 waiting_since: snoozed_until: source: type: conversation - id: '403918094' + id: '403919020' delivered_as: admin_initiated subject: '' body: "

this is the message body

" author: type: admin - id: '991266443' - name: Ciaran206 Lee - email: admin206@email.com + id: '991272250' + name: Ciaran207 Lee + email: admin207@email.com attachments: [] url: redacted: false @@ -5823,7 +5877,7 @@ paths: type: contact.list contacts: - type: contact - id: 6622409a8a6818704e8a6c93 + id: 663a04556ef5d45c04c86b2e external_id: '70' first_contact_reply: admin_assignee_id: @@ -5848,11 +5902,13 @@ paths: data: [] total_count: 0 has_more: false + ai_agent: + ai_agent_participated: false conversation_parts: type: conversation_part.list conversation_parts: - type: conversation_part - id: '8' + id: '407' part_type: note body: |-

An Unordered HTML List

@@ -5867,41 +5923,39 @@ paths:
  • Tea
  • Milk
    • - created_at: 1713520795 - updated_at: 1713520795 - notified_at: 1713520795 + created_at: 1715078230 + updated_at: 1715078230 + notified_at: 1715078230 assigned_to: author: - id: '991266443' + id: '991272250' type: admin - name: Ciaran206 Lee - email: admin206@email.com + name: Ciaran207 Lee + email: admin207@email.com attachments: [] external_id: redacted: false metadata: {} total_count: 1 - ai_agent: - ai_agent_participated: false Admin quick_reply reply: value: type: conversation - id: '59' - created_at: 1713520796 - updated_at: 1713520796 + id: '1779' + created_at: 1715078231 + updated_at: 1715078231 waiting_since: snoozed_until: source: type: conversation - id: '403918095' + id: '403919021' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991266445' - name: Ciaran207 Lee - email: admin207@email.com + id: '991272252' + name: Ciaran208 Lee + email: admin208@email.com attachments: [] url: redacted: false @@ -5909,7 +5963,7 @@ paths: type: contact.list contacts: - type: contact - id: 6622409b8a6818704e8a6c94 + id: 663a04576ef5d45c04c86b2f external_id: '70' first_contact_reply: admin_assignee_id: @@ -5934,48 +5988,48 @@ paths: data: [] total_count: 0 has_more: false + ai_agent: + ai_agent_participated: false conversation_parts: type: conversation_part.list conversation_parts: - type: conversation_part - id: '9' + id: '408' part_type: quick_reply body: - created_at: 1713520796 - updated_at: 1713520796 - notified_at: 1713520796 + created_at: 1715078231 + updated_at: 1715078231 + notified_at: 1715078231 assigned_to: author: - id: '991266445' + id: '991272252' type: admin - name: Ciaran207 Lee - email: admin207@email.com + name: Ciaran208 Lee + email: admin208@email.com attachments: [] external_id: redacted: false metadata: {} total_count: 1 - ai_agent: - ai_agent_participated: false User last conversation reply: value: type: conversation - id: '60' - created_at: 1713520797 - updated_at: 1713520798 - waiting_since: 1713520798 + id: '1780' + created_at: 1715078232 + updated_at: 1715078233 + waiting_since: 1715078233 snoozed_until: source: type: conversation - id: '403918096' + id: '403919022' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991266447' - name: Ciaran208 Lee - email: admin208@email.com + id: '991272254' + name: Ciaran209 Lee + email: admin209@email.com attachments: [] url: redacted: false @@ -5983,10 +6037,10 @@ paths: type: contact.list contacts: - type: contact - id: 6622409d8a6818704e8a6c95 + id: 663a04586ef5d45c04c86b30 external_id: '70' first_contact_reply: - created_at: 1713520798 + created_at: 1715078233 type: conversation url: admin_assignee_id: @@ -6011,19 +6065,21 @@ paths: data: [] total_count: 0 has_more: false + ai_agent: + ai_agent_participated: false conversation_parts: type: conversation_part.list conversation_parts: - type: conversation_part - id: '10' + id: '409' part_type: open body: "

    Thanks again :)

    " - created_at: 1713520798 - updated_at: 1713520798 - notified_at: 1713520798 + created_at: 1715078233 + updated_at: 1715078233 + notified_at: 1715078233 assigned_to: author: - id: 6622409d8a6818704e8a6c95 + id: 663a04586ef5d45c04c86b30 type: user name: Joe Bloggs email: joe@bloggs.com @@ -6032,8 +6088,6 @@ paths: redacted: false metadata: {} total_count: 1 - ai_agent: - ai_agent_participated: false schema: "$ref": "#/components/schemas/conversation" '404': @@ -6044,7 +6098,7 @@ paths: Not found: value: type: error.list - request_id: e23584ea-b4f5-4cc9-bc11-a77caa6b70e4 + request_id: 73ff9660-6b69-42c1-957d-b4782e0446c0 errors: - code: not_found message: Resource Not Found @@ -6058,7 +6112,7 @@ paths: Unauthorized: value: type: error.list - request_id: 4a13708c-9c76-4b13-b248-ecaff06a5fe2 + request_id: a02fe322-05a6-4cad-953b-6881bc97a3a0 errors: - code: unauthorized message: Access Token Invalid @@ -6072,7 +6126,7 @@ paths: API plan restricted: value: type: error.list - request_id: b7d0a68d-0162-4ef6-8e10-b03d73195b18 + request_id: b12dbd34-d9e7-4ea6-a651-58e477e12256 errors: - code: api_plan_restricted message: Active subscription needed. @@ -6089,14 +6143,14 @@ paths: value: message_type: comment type: user - intercom_user_id: 662240978a6818704e8a6c92 + intercom_user_id: 663a04536ef5d45c04c86b2d body: Thanks again :) admin_note_reply: summary: Admin note reply value: message_type: note type: admin - admin_id: 991266443 + admin_id: 991272250 body: "

    An Unordered HTML List

    An Ordered HTML List

    \
    1. Coffee
    2. Tea
    3. Milk
    @@ -6106,25 +6160,25 @@ paths: value: message_type: quick_reply type: admin - admin_id: 991266445 + admin_id: 991272252 reply_options: - text: 'Yes' - uuid: 2a10c04a-fb2d-45e4-a34e-d8105b69084c + uuid: ddd7056c-9c96-4d28-95db-0bb69ee1db1b - text: 'No' - uuid: 1089bca6-3c73-4d37-9296-743766c28be6 + uuid: c60e2dbd-ddca-4a04-af8e-905f73aa5e92 user_last_conversation_reply: summary: User last conversation reply value: message_type: comment type: user - intercom_user_id: 6622409d8a6818704e8a6c95 + intercom_user_id: 663a04586ef5d45c04c86b30 body: Thanks again :) not_found: summary: Not found value: message_type: comment type: user - intercom_user_id: 6622409f8a6818704e8a6c96 + intercom_user_id: 663a045a6ef5d45c04c86b31 body: Thanks again :) "/conversations/{id}/parts": post: @@ -6159,22 +6213,22 @@ paths: Close a conversation: value: type: conversation - id: '64' - created_at: 1713520803 - updated_at: 1713520803 + id: '1784' + created_at: 1715078237 + updated_at: 1715078238 waiting_since: snoozed_until: source: type: conversation - id: '403918100' + id: '403919026' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991266455' - name: Ciaran212 Lee - email: admin212@email.com + id: '991272262' + name: Ciaran213 Lee + email: admin213@email.com attachments: [] url: redacted: false @@ -6182,7 +6236,7 @@ paths: type: contact.list contacts: - type: contact - id: 662240a38a6818704e8a6c99 + id: 663a045d6ef5d45c04c86b34 external_id: '70' first_contact_reply: admin_assignee_id: @@ -6207,48 +6261,48 @@ paths: data: [] total_count: 0 has_more: false + ai_agent: + ai_agent_participated: false conversation_parts: type: conversation_part.list conversation_parts: - type: conversation_part - id: '11' + id: '410' part_type: close body: "

    Goodbye :)

    " - created_at: 1713520804 - updated_at: 1713520804 - notified_at: 1713520804 + created_at: 1715078238 + updated_at: 1715078238 + notified_at: 1715078238 assigned_to: author: - id: '991266455' + id: '991272262' type: admin - name: Ciaran212 Lee - email: admin212@email.com + name: Ciaran213 Lee + email: admin213@email.com attachments: [] external_id: redacted: false metadata: {} total_count: 1 - ai_agent: - ai_agent_participated: false Snooze a conversation: value: type: conversation - id: '65' - created_at: 1713520805 - updated_at: 1713520805 + id: '1785' + created_at: 1715078239 + updated_at: 1715078240 waiting_since: - snoozed_until: 1713524405 + snoozed_until: 1715081840 source: type: conversation - id: '403918101' + id: '403919027' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991266457' - name: Ciaran213 Lee - email: admin213@email.com + id: '991272264' + name: Ciaran214 Lee + email: admin214@email.com attachments: [] url: redacted: false @@ -6256,7 +6310,7 @@ paths: type: contact.list contacts: - type: contact - id: 662240a58a6818704e8a6c9a + id: 663a045f6ef5d45c04c86b35 external_id: '70' first_contact_reply: admin_assignee_id: @@ -6281,48 +6335,48 @@ paths: data: [] total_count: 0 has_more: false + ai_agent: + ai_agent_participated: false conversation_parts: type: conversation_part.list conversation_parts: - type: conversation_part - id: '12' + id: '411' part_type: snoozed body: - created_at: 1713520805 - updated_at: 1713520805 - notified_at: 1713520805 + created_at: 1715078240 + updated_at: 1715078240 + notified_at: 1715078240 assigned_to: author: - id: '991266457' + id: '991272264' type: admin - name: Ciaran213 Lee - email: admin213@email.com + name: Ciaran214 Lee + email: admin214@email.com attachments: [] external_id: redacted: false metadata: {} total_count: 1 - ai_agent: - ai_agent_participated: false Open a conversation: value: type: conversation - id: '70' - created_at: 1713520804 - updated_at: 1713520812 + id: '1790' + created_at: 1715078238 + updated_at: 1715078247 waiting_since: snoozed_until: source: type: conversation - id: '403918102' + id: '403919028' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991266459' - name: Ciaran214 Lee - email: admin214@email.com + id: '991272266' + name: Ciaran215 Lee + email: admin215@email.com attachments: [] url: redacted: false @@ -6330,7 +6384,7 @@ paths: type: contact.list contacts: - type: contact - id: 662240a88a6818704e8a6c9f + id: 663a045e6ef5d45c04c86b3a external_id: '74' first_contact_reply: admin_assignee_id: @@ -6355,48 +6409,48 @@ paths: data: [] total_count: 0 has_more: false + ai_agent: + ai_agent_participated: false conversation_parts: type: conversation_part.list conversation_parts: - type: conversation_part - id: '14' + id: '413' part_type: open body: - created_at: 1713520812 - updated_at: 1713520812 - notified_at: 1713520812 + created_at: 1715078247 + updated_at: 1715078247 + notified_at: 1715078247 assigned_to: author: - id: '991266459' + id: '991272266' type: admin - name: Ciaran214 Lee - email: admin214@email.com + name: Ciaran215 Lee + email: admin215@email.com attachments: [] external_id: redacted: false metadata: {} total_count: 1 - ai_agent: - ai_agent_participated: false Assign a conversation: value: type: conversation - id: '75' - created_at: 1713520813 - updated_at: 1713520814 + id: '1795' + created_at: 1715078248 + updated_at: 1715078249 waiting_since: snoozed_until: source: type: conversation - id: '403918105' + id: '403919031' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991266462' - name: Ciaran216 Lee - email: admin216@email.com + id: '991272269' + name: Ciaran217 Lee + email: admin217@email.com attachments: [] url: redacted: false @@ -6404,10 +6458,10 @@ paths: type: contact.list contacts: - type: contact - id: 662240ad8a6818704e8a6ca3 + id: 663a04686ef5d45c04c86b3e external_id: '70' first_contact_reply: - admin_assignee_id: 991266462 + admin_assignee_id: 991272269 team_assignee_id: open: true state: open @@ -6429,31 +6483,31 @@ paths: data: [] total_count: 0 has_more: false + ai_agent: + ai_agent_participated: false conversation_parts: type: conversation_part.list conversation_parts: - type: conversation_part - id: '15' + id: '414' part_type: assign_and_reopen body: - created_at: 1713520814 - updated_at: 1713520814 - notified_at: 1713520814 + created_at: 1715078249 + updated_at: 1715078249 + notified_at: 1715078249 assigned_to: type: admin - id: '991266462' + id: '991272269' author: - id: '991266462' + id: '991272269' type: admin - name: Ciaran216 Lee - email: admin216@email.com + name: Ciaran217 Lee + email: admin217@email.com attachments: [] external_id: redacted: false metadata: {} total_count: 1 - ai_agent: - ai_agent_participated: false schema: "$ref": "#/components/schemas/conversation" '404': @@ -6464,7 +6518,7 @@ paths: Not found: value: type: error.list - request_id: d3b0ae13-85b2-45bc-8c6c-ce8e004aba8c + request_id: aee122ef-99db-408b-93a9-a3ef6c9c3edd errors: - code: not_found message: Resource Not Found @@ -6478,7 +6532,7 @@ paths: Unauthorized: value: type: error.list - request_id: cac19acb-b1e7-4de9-acc3-bbf18fa4ec70 + request_id: 477d750b-bf16-446b-b2c6-1dcd904170f4 errors: - code: unauthorized message: Access Token Invalid @@ -6492,7 +6546,7 @@ paths: API plan restricted: value: type: error.list - request_id: 7ca0dcd5-6287-44dc-9d0a-0256d7e15e64 + request_id: 5614dd6c-4b2e-47e1-8dc5-c46793a4a258 errors: - code: api_plan_restricted message: Active subscription needed. @@ -6513,32 +6567,32 @@ paths: value: message_type: close type: admin - admin_id: 991266455 + admin_id: 991272262 body: Goodbye :) snooze_a_conversation: summary: Snooze a conversation value: message_type: snoozed - admin_id: 991266457 - snoozed_until: 1713524405 + admin_id: 991272264 + snoozed_until: 1715081840 open_a_conversation: summary: Open a conversation value: message_type: open - admin_id: 991266459 + admin_id: 991272266 assign_a_conversation: summary: Assign a conversation value: message_type: assignment type: admin - admin_id: 991266462 - assignee_id: 991266462 + admin_id: 991272269 + assignee_id: 991272269 not_found: summary: Not found value: message_type: close type: admin - admin_id: 991266464 + admin_id: 991272271 body: Goodbye :) "/conversations/{id}/run_assignment_rules": post: @@ -6572,22 +6626,22 @@ paths: Assign a conversation using assignment rules: value: type: conversation - id: '79' - created_at: 1713520818 - updated_at: 1713520819 + id: '1799' + created_at: 1715078253 + updated_at: 1715078254 waiting_since: snoozed_until: source: type: conversation - id: '403918109' + id: '403919035' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991266470' - name: Ciaran220 Lee - email: admin220@email.com + id: '991272277' + name: Ciaran221 Lee + email: admin221@email.com attachments: [] url: redacted: false @@ -6595,7 +6649,7 @@ paths: type: contact.list contacts: - type: contact - id: 662240b28a6818704e8a6ca7 + id: 663a046d6ef5d45c04c86b42 external_id: '70' first_contact_reply: admin_assignee_id: @@ -6620,31 +6674,31 @@ paths: data: [] total_count: 0 has_more: false + ai_agent: + ai_agent_participated: false conversation_parts: type: conversation_part.list conversation_parts: - type: conversation_part - id: '16' + id: '415' part_type: default_assignment body: - created_at: 1713520819 - updated_at: 1713520819 - notified_at: 1713520819 + created_at: 1715078254 + updated_at: 1715078254 + notified_at: 1715078254 assigned_to: type: nobody_admin id: author: - id: '991266471' + id: '991272278' type: bot name: Operator - email: operator+this_is_an_id400_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id402_that_should_be_at_least_@intercom.io attachments: [] external_id: redacted: false metadata: {} total_count: 1 - ai_agent: - ai_agent_participated: false schema: "$ref": "#/components/schemas/conversation" '404': @@ -6655,7 +6709,7 @@ paths: Not found: value: type: error.list - request_id: 62fa8805-6006-4385-b4e5-af88d591d1aa + request_id: 0c6d189b-1b5a-439d-96c7-6de1fa5f2daa errors: - code: not_found message: Resource Not Found @@ -6669,7 +6723,7 @@ paths: Unauthorized: value: type: error.list - request_id: 4885b9b7-baa1-47ae-a414-e7e01dc1ee3c + request_id: 11d952cd-ea5b-47a7-b833-8c827a41d64e errors: - code: unauthorized message: Access Token Invalid @@ -6683,7 +6737,7 @@ paths: API plan restricted: value: type: error.list - request_id: 57d22d6e-7867-4e6d-9b62-60bda3e29f00 + request_id: adedd110-51d5-4ce7-a932-d23a12371784 errors: - code: api_plan_restricted message: Active subscription needed. @@ -6724,7 +6778,7 @@ paths: value: customers: - type: user - id: 662240b78a6818704e8a6cab + id: 663a04726ef5d45c04c86b46 schema: "$ref": "#/components/schemas/conversation" '404': @@ -6735,7 +6789,7 @@ paths: Not found: value: type: error.list - request_id: 7e5f327c-63c4-425a-a34c-6896bc562e20 + request_id: 8776adb2-9258-4f7e-b866-83bdbc5abc16 errors: - code: not_found message: Resource Not Found @@ -6749,7 +6803,7 @@ paths: Unauthorized: value: type: error.list - request_id: 53de8f4d-b8fd-45f0-8c39-89d3c713c2ee + request_id: 22c77708-c46a-47a6-9082-8a43f7082836 errors: - code: unauthorized message: Access Token Invalid @@ -6763,7 +6817,7 @@ paths: API plan restricted: value: type: error.list - request_id: 4b31c297-2300-47ca-b327-3a6a5a044a91 + request_id: 5e67105e-f7e2-4490-ae2b-f9fd651f4de1 errors: - code: api_plan_restricted message: Active subscription needed. @@ -6778,15 +6832,15 @@ paths: attach_a_contact_to_a_conversation: summary: Attach a contact to a conversation value: - admin_id: 991266478 + admin_id: 991272285 customer: - intercom_user_id: 662240b78a6818704e8a6cab + intercom_user_id: 663a04726ef5d45c04c86b46 not_found: summary: Not found value: - admin_id: 991266480 + admin_id: 991272287 customer: - intercom_user_id: 662240b88a6818704e8a6cac + intercom_user_id: 663a04736ef5d45c04c86b47 "/conversations/{conversation_id}/customers/{contact_id}": delete: summary: Detach a contact from a group conversation @@ -6829,7 +6883,7 @@ paths: value: customers: - type: user - id: 662240c18a6818704e8a6cb7 + id: 663a047c6ef5d45c04c86b52 schema: "$ref": "#/components/schemas/conversation" '404': @@ -6840,14 +6894,14 @@ paths: Conversation not found: value: type: error.list - request_id: e4f4b969-c6c3-4d9f-a472-a75bddc9cc33 + request_id: 7df90d83-0f05-4a36-8347-7aca5f494894 errors: - code: not_found message: Resource Not Found Contact not found: value: type: error.list - request_id: 9bf8f4b8-c4e0-433b-91b1-7a6a09e1b078 + request_id: 23c275d1-ace9-47bb-b891-ea2ef41352bd errors: - code: not_found message: User Not Found @@ -6861,7 +6915,7 @@ paths: Last customer: value: type: error.list - request_id: 9b0ba8d9-82d7-4ce7-9b48-405797aef60b + request_id: '008a10aa-89be-4eae-bbba-a17341afd90b' errors: - code: parameter_invalid message: Removing the last customer is not allowed @@ -6875,7 +6929,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2da61660-2dce-48d2-9fac-f1b73b94880a + request_id: cf0f47d6-9a3b-4b47-a314-ccb2c7484467 errors: - code: unauthorized message: Access Token Invalid @@ -6889,7 +6943,7 @@ paths: API plan restricted: value: type: error.list - request_id: fa43eb93-8bf5-48e0-a298-18ef1f7d88b5 + request_id: 1ee3b61a-72fa-425d-af2b-ec1bc332fd6c errors: - code: api_plan_restricted message: Active subscription needed. @@ -6904,27 +6958,27 @@ paths: detach_a_contact_from_a_group_conversation: summary: Detach a contact from a group conversation value: - admin_id: 991266486 + admin_id: 991272293 customer: - intercom_user_id: 662240bc8a6818704e8a6caf + intercom_user_id: 663a04766ef5d45c04c86b4a conversation_not_found: summary: Conversation not found value: - admin_id: 991266489 + admin_id: 991272296 customer: - intercom_user_id: 662240c28a6818704e8a6cb8 + intercom_user_id: 663a047d6ef5d45c04c86b53 contact_not_found: summary: Contact not found value: - admin_id: 991266492 + admin_id: 991272299 customer: - intercom_user_id: 662240c88a6818704e8a6cc0 + intercom_user_id: 663a04836ef5d45c04c86b5b last_customer: summary: Last customer value: - admin_id: 991266495 + admin_id: 991272302 customer: - intercom_user_id: 662240ce8a6818704e8a6cc8 + intercom_user_id: 663a04896ef5d45c04c86b63 "/conversations/redact": post: summary: Redact a conversation part @@ -6952,22 +7006,22 @@ paths: Redact a conversation part: value: type: conversation - id: '141' - created_at: 1713520864 - updated_at: 1713520866 - waiting_since: 1713520864 + id: '1861' + created_at: 1715078299 + updated_at: 1715078300 + waiting_since: 1715078299 snoozed_until: source: type: conversation - id: '403918135' + id: '403919061' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991266504' - name: Ciaran240 Lee - email: admin240@email.com + id: '991272311' + name: Ciaran241 Lee + email: admin241@email.com attachments: [] url: redacted: false @@ -6975,10 +7029,10 @@ paths: type: contact.list contacts: - type: contact - id: 662240e08a6818704e8a6ce0 + id: 663a049b6ef5d45c04c86b7b external_id: '70' first_contact_reply: - created_at: 1713520864 + created_at: 1715078299 type: conversation url: admin_assignee_id: @@ -7003,19 +7057,21 @@ paths: data: [] total_count: 0 has_more: false + ai_agent: + ai_agent_participated: false conversation_parts: type: conversation_part.list conversation_parts: - type: conversation_part - id: '24' + id: '423' part_type: open body: "

    This message was deleted

    " - created_at: 1713520864 - updated_at: 1713520866 - notified_at: 1713520864 + created_at: 1715078299 + updated_at: 1715078300 + notified_at: 1715078299 assigned_to: author: - id: 662240e08a6818704e8a6ce0 + id: 663a049b6ef5d45c04c86b7b type: user name: Joe Bloggs email: joe@bloggs.com @@ -7024,8 +7080,6 @@ paths: redacted: true metadata: {} total_count: 1 - ai_agent: - ai_agent_participated: false schema: "$ref": "#/components/schemas/conversation" '404': @@ -7036,7 +7090,7 @@ paths: Not found: value: type: error.list - request_id: fc4f63f8-e2fa-4f24-8ab1-8c69fd7ee85f + request_id: 2ffe6338-0a02-4148-a1f7-180684084069 errors: - code: conversation_part_or_message_not_found message: Conversation part or message not found @@ -7050,7 +7104,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9da0bc3d-dfdf-48ff-968e-8b38fb08b828 + request_id: 17f22612-e1bd-4c1a-b113-bc18a31153cf errors: - code: unauthorized message: Access Token Invalid @@ -7066,8 +7120,8 @@ paths: summary: Redact a conversation part value: type: conversation_part - conversation_id: 141 - conversation_part_id: 24 + conversation_id: 1861 + conversation_part_id: 423 not_found: summary: Not found value: @@ -7102,22 +7156,22 @@ paths: successful: value: type: ticket - id: '144' - ticket_id: '1' + id: '1864' + ticket_id: '98' ticket_attributes: {} ticket_state: submitted ticket_state_internal_label: Submitted ticket_state_external_label: Submitted ticket_type: type: ticket_type - id: '1' + id: '323' name: my-ticket-type-1 description: my ticket type description is awesome. icon: "\U0001F981" - workspace_id: this_is_an_id440_that_should_be_at_least_ + workspace_id: this_is_an_id442_that_should_be_at_least_ archived: false - created_at: 1713520872 - updated_at: 1713520872 + created_at: 1715078306 + updated_at: 1715078306 is_internal: false ticket_type_attributes: type: list @@ -7127,40 +7181,40 @@ paths: type: contact.list contacts: - type: contact - id: 662240e68a6818704e8a6ce3 + id: 663a04a06ef5d45c04c86b7e external_id: '70' admin_assignee_id: '0' team_assignee_id: '0' - created_at: 1713520870 - updated_at: 1713520872 + created_at: 1715078304 + updated_at: 1715078307 ticket_parts: type: ticket_part.list ticket_parts: - type: ticket_part - id: '26' + id: '425' part_type: comment body: "

    Comment for message

    " - created_at: 1713520870 - updated_at: 1713520870 + created_at: 1715078304 + updated_at: 1715078304 author: - id: 662240e68a6818704e8a6ce3 + id: 663a04a06ef5d45c04c86b7e type: user name: Joe Bloggs email: joe@bloggs.com attachments: [] redacted: false - type: ticket_part - id: '27' + id: '426' part_type: ticket_state_updated_by_admin ticket_state: submitted previous_ticket_state: submitted - created_at: 1713520872 - updated_at: 1713520872 + created_at: 1715078307 + updated_at: 1715078307 author: - id: '991266514' + id: '991272321' type: bot name: Operator - email: operator+this_is_an_id440_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id442_that_should_be_at_least_@intercom.io attachments: [] redacted: false total_count: 2 @@ -7182,7 +7236,7 @@ paths: Bad request: value: type: error.list - request_id: 4e793cef-8074-4580-aef4-868c545c515b + request_id: 9298e4a2-f0a9-46af-a27e-d7f18ea7cd54 errors: - code: parameter_invalid message: Ticket type is not a customer ticket type @@ -7197,11 +7251,11 @@ paths: successful: summary: successful value: - ticket_type_id: '1' + ticket_type_id: '323' bad_request: summary: Bad request value: - ticket_type_id: '2' + ticket_type_id: '324' "/custom_object_instances/{custom_object_type_identifier}": parameters: - name: custom_object_type_identifier @@ -7230,14 +7284,14 @@ paths: examples: successful: value: - id: '1' + id: '6' type: object_type_identifier_1 custom_attributes: {} external_id: '123' external_created_at: 1392036272 external_updated_at: 1392036272 - created_at: 1713520876 - updated_at: 1713520876 + created_at: 1715078310 + updated_at: 1715078310 schema: "$ref": "#/components/schemas/custom_object_instance" '401': @@ -7248,7 +7302,7 @@ paths: Unauthorized: value: type: error.list - request_id: ae0ba456-0621-479a-887b-d65b4c2b7fe0 + request_id: 3a9c4546-423e-4f36-a705-f8644043e2da errors: - code: unauthorized message: Access Token Invalid @@ -7308,14 +7362,14 @@ paths: examples: successful: value: - id: '3' + id: '8' type: object_type_identifier_4 custom_attributes: {} external_id: '123' external_created_at: external_updated_at: - created_at: 1713520877 - updated_at: 1713520877 + created_at: 1715078312 + updated_at: 1715078312 schema: "$ref": "#/components/schemas/custom_object_instance" '401': @@ -7326,7 +7380,7 @@ paths: Unauthorized: value: type: error.list - request_id: 1022a302-864b-4d07-b5d3-0155f98de9be + request_id: 494d783d-a4ca-4756-b14a-ebec37f466cd errors: - code: unauthorized message: Access Token Invalid @@ -7366,14 +7420,14 @@ paths: examples: successful: value: - id: '4' + id: '9' type: object_type_identifier_6 custom_attributes: {} external_id: '123' external_created_at: external_updated_at: - created_at: 1713520878 - updated_at: 1713520878 + created_at: 1715078313 + updated_at: 1715078313 schema: "$ref": "#/components/schemas/custom_object_instance" '401': @@ -7384,7 +7438,7 @@ paths: Unauthorized: value: type: error.list - request_id: 3207bb9e-a700-4102-b1fc-5311b90c0c8e + request_id: 4c80e985-63fc-42b6-aeb0-ed5d0d1be967 errors: - code: unauthorized message: Access Token Invalid @@ -7415,7 +7469,7 @@ paths: examples: successful: value: - id: '5' + id: '10' object: object_type_identifier_8 deleted: true schema: @@ -7428,7 +7482,7 @@ paths: Unauthorized: value: type: error.list - request_id: 96c03fb0-410d-40af-a668-55d6e86508ae + request_id: d75b00da-d5e1-4625-bdbc-e694a08157ff errors: - code: unauthorized message: Access Token Invalid @@ -7614,7 +7668,7 @@ paths: custom: false archived: false model: company - - id: 2 + - id: 178 type: data_attribute name: The One Ring full_name: custom_attributes.The One Ring @@ -7627,9 +7681,9 @@ paths: messenger_writable: true custom: true archived: false - admin_id: '991266531' - created_at: 1713520879 - updated_at: 1713520879 + admin_id: '991272338' + created_at: 1715078315 + updated_at: 1715078315 model: company - type: data_attribute name: id @@ -7701,7 +7755,7 @@ paths: Unauthorized: value: type: error.list - request_id: 23cb8456-9dde-4183-adfa-2a7131e43421 + request_id: d65842fe-1657-463f-bd18-dd155d780df3 errors: - code: unauthorized message: Access Token Invalid @@ -7726,7 +7780,7 @@ paths: examples: Successful: value: - id: 5 + id: 181 type: data_attribute name: Mithril Shirt full_name: custom_attributes.Mithril Shirt @@ -7737,9 +7791,9 @@ paths: messenger_writable: false custom: true archived: false - admin_id: '991266533' - created_at: 1713520881 - updated_at: 1713520881 + admin_id: '991272340' + created_at: 1715078316 + updated_at: 1715078316 model: company schema: "$ref": "#/components/schemas/data_attribute" @@ -7751,7 +7805,7 @@ paths: Same name already exists: value: type: error.list - request_id: cbd5bb07-294d-4910-b906-2a3866d71fab + request_id: '098cc44a-4ad7-40b3-a35b-943ef9084087' errors: - code: parameter_invalid message: You already have 'The One Ring' in your company data. @@ -7759,7 +7813,7 @@ paths: Invalid name: value: type: error.list - request_id: da785dcb-be06-499f-8516-98ccdeb3eae2 + request_id: 72e7a4ef-6dbb-463c-af9e-750867c3ab5f errors: - code: parameter_invalid message: Your name for this attribute must only contain alphanumeric @@ -7767,7 +7821,7 @@ paths: Attribute already exists: value: type: error.list - request_id: 12d32317-4f90-4afd-91ab-8a33578ed387 + request_id: 455911c3-3def-4519-aa63-7cc081729bbc errors: - code: parameter_invalid message: You already have 'The One Ring' in your company data. @@ -7775,14 +7829,14 @@ paths: Invalid Data Type: value: type: error.list - request_id: 5bcdaa14-a6dd-4298-b1c9-e3b76965b6e8 + request_id: f8bcfb0d-783f-41ea-a923-f2299c5505cf errors: - code: parameter_invalid message: Data Type isn't an option Too few options for list: value: type: error.list - request_id: 63ef3269-6287-4bf8-a4da-223073641c94 + request_id: 10bdd5db-2ebf-48d4-ad7c-d49fe85cf014 errors: - code: parameter_invalid message: The Data Attribute model field must be either contact @@ -7797,7 +7851,7 @@ paths: Unauthorized: value: type: error.list - request_id: 3f607b19-89de-4bd7-a694-d796310dd18d + request_id: dd7e1739-80a3-43de-afc1-805bd8beee12 errors: - code: unauthorized message: Access Token Invalid @@ -7876,7 +7930,7 @@ paths: examples: Successful: value: - id: 12 + id: 188 type: data_attribute name: The One Ring full_name: custom_attributes.The One Ring @@ -7891,9 +7945,9 @@ paths: messenger_writable: true custom: true archived: false - admin_id: '991266540' - created_at: 1713520884 - updated_at: 1713520884 + admin_id: '991272347' + created_at: 1715078319 + updated_at: 1715078319 model: company schema: "$ref": "#/components/schemas/data_attribute" @@ -7905,7 +7959,7 @@ paths: Too few options in list: value: type: error.list - request_id: bfbf134e-d698-4221-abbc-c21ce6011a2f + request_id: 0be46271-22e2-49c7-83de-db841148e357 errors: - code: parameter_invalid message: Options isn't an array @@ -7919,7 +7973,7 @@ paths: Attribute Not Found: value: type: error.list - request_id: cbb2596d-164d-4cfe-96fe-5e41d8358497 + request_id: 72bec517-914c-48f9-8b2b-bbb77472c4a7 errors: - code: field_not_found message: We couldn't find that data attribute to update @@ -7933,7 +7987,7 @@ paths: Has Dependant Object: value: type: error.list - request_id: bf46824d-716d-4e0d-9bdd-92fb311c0a39 + request_id: 1598e3c6-de6c-4055-bfb1-de143528dce6 errors: - code: data_invalid message: The Data Attribute you are trying to archive has a @@ -7948,7 +8002,7 @@ paths: Unauthorized: value: type: error.list - request_id: 1a0a5b7c-6809-4324-82d4-770cbe405208 + request_id: 49e91846-1042-41a4-b1f9-052ca9ef1a73 errors: - code: unauthorized message: Access Token Invalid @@ -8053,7 +8107,7 @@ paths: Unauthorized: value: type: error.list - request_id: e04388b0-c529-4de9-90cb-2e71b664894c + request_id: 9aedfc14-0907-441b-adce-c8632bef89bd errors: - code: unauthorized message: Access Token Invalid @@ -8140,7 +8194,7 @@ paths: pages: next: http://api.intercom.test/events?next page email: user26@email.com - intercom_user_id: 662240f88a6818704e8a6ce9 + intercom_user_id: 663a04b36ef5d45c04c86b84 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 schema: "$ref": "#/components/schemas/data_event_summary" @@ -8152,7 +8206,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2243410a-458a-42b8-ade1-f09c74bb6933 + request_id: c125b954-ec58-435c-b59d-92aeb920bb53 errors: - code: unauthorized message: Access Token Invalid @@ -8183,7 +8237,7 @@ paths: Unauthorized: value: type: error.list - request_id: 96b69fa7-c1d2-424d-95f4-636951de08f2 + request_id: 6763f08f-aca1-4b54-9743-323c017f44a0 errors: - code: unauthorized message: Access Token Invalid @@ -8227,7 +8281,7 @@ paths: examples: successful: value: - job_identifier: z6mlk4gftvln4pqu + job_identifier: o3ysb42xyqmcpykb status: pending download_url: '' download_expires_at: '' @@ -8242,8 +8296,8 @@ paths: successful: summary: successful value: - created_at_after: 1713502890 - created_at_before: 1713520890 + created_at_after: 1715060326 + created_at_before: 1715078326 "/export/content/data/{job_identifier}": get: summary: Show content data export @@ -8277,7 +8331,7 @@ paths: examples: successful: value: - job_identifier: 4soqnsj1rqzwuay0 + job_identifier: mnbvpjfgy6h62f4v status: pending download_url: '' download_expires_at: '' @@ -8309,7 +8363,7 @@ paths: examples: successful: value: - job_identifier: te8j54eeq4q86dao + job_identifier: zorih9m16ofmzrrn status: canceled download_url: '' download_expires_at: '' @@ -8370,32 +8424,32 @@ paths: user message created: value: type: user_message - id: '403918140' - created_at: 1713520893 + id: '403919066' + created_at: 1715078328 body: heyy message_type: inapp - conversation_id: '146' + conversation_id: '1866' lead message created: value: type: user_message - id: '403918141' - created_at: 1713520894 + id: '403919067' + created_at: 1715078329 body: heyy message_type: inapp - conversation_id: '147' + conversation_id: '1867' admin message created: value: type: admin_message - id: '5' - created_at: 1713520895 + id: '60' + created_at: 1715078331 subject: heyy body: heyy message_type: inapp owner: type: admin - id: '991266563' - name: Ciaran292 Lee - email: admin292@email.com + id: '991272370' + name: Ciaran293 Lee + email: admin293@email.com away_mode_enabled: false away_mode_reassign: false schema: @@ -8408,14 +8462,14 @@ paths: No body supplied for message: value: type: error.list - request_id: 4eb8be9b-d3cb-4ada-90cc-b823f973bede + request_id: dc955aac-8bf8-4c82-9278-a20427cb1bcf errors: - code: parameter_invalid message: Body is required No body supplied for email message: value: type: error.list - request_id: d51ffc9b-3b5c-47e5-b0b2-71013af8012c + request_id: a05f8aa8-db90-44b0-8577-7d2e738d881d errors: - code: parameter_invalid message: Body is required @@ -8429,7 +8483,7 @@ paths: No subject supplied for email message: value: type: error.list - request_id: 140e2cb3-1b1a-43c6-a3d8-0ab5a3d1ce07 + request_id: ce140228-f4c5-42b7-90be-b73e8a9efede errors: - code: parameter_not_found message: No subject supplied for email message @@ -8443,7 +8497,7 @@ paths: Unauthorized: value: type: error.list - request_id: 66331443-67ec-4219-beb5-cae905211a6e + request_id: a3d20c31-aa53-4047-b080-8b9393250409 errors: - code: unauthorized message: Access Token Invalid @@ -8457,7 +8511,7 @@ paths: API plan restricted: value: type: error.list - request_id: c2cf8f24-c822-45ed-a083-ebb822344564 + request_id: f127410a-ffed-4aa6-a554-dded3a001d88 errors: - code: api_plan_restricted message: Active subscription needed. @@ -8474,7 +8528,7 @@ paths: value: from: type: user - id: 662240fd8a6818704e8a6cee + id: 663a04b86ef5d45c04c86b89 body: heyy referer: https://twitter.com/bob lead_message_created: @@ -8482,7 +8536,7 @@ paths: value: from: type: lead - id: 662240fe8a6818704e8a6cef + id: 663a04b96ef5d45c04c86b8a body: heyy referer: https://twitter.com/bob admin_message_created: @@ -8490,10 +8544,10 @@ paths: value: from: type: admin - id: '991266563' + id: '991272370' to: type: user - id: 662240ff8a6818704e8a6cf0 + id: 663a04ba6ef5d45c04c86b8b message_type: conversation body: heyy no_body_supplied_for_message: @@ -8501,10 +8555,10 @@ paths: value: from: type: admin - id: '991266565' + id: '991272372' to: type: user - id: 662241008a6818704e8a6cf1 + id: 663a04bb6ef5d45c04c86b8c message_type: inapp body: subject: heyy @@ -8513,7 +8567,7 @@ paths: value: from: type: admin - id: '991266566' + id: '991272373' to: type: user user_id: '70' @@ -8524,10 +8578,10 @@ paths: value: from: type: admin - id: '991266567' + id: '991272374' to: type: user - id: 662241018a6818704e8a6cf3 + id: 663a04bc6ef5d45c04c86b8e message_type: email body: subject: heyy @@ -8558,12 +8612,12 @@ paths: total_pages: 1 type: pages data: - - id: '2' + - id: '155' type: news-item - workspace_id: this_is_an_id530_that_should_be_at_least_ + workspace_id: this_is_an_id532_that_should_be_at_least_ title: We have news body: "

    Hello there,

    " - sender_id: 991266574 + sender_id: 991272379 state: draft labels: [] cover_image_url: @@ -8573,15 +8627,15 @@ paths: - - deliver_silently: false - created_at: 1713520899 - updated_at: 1713520899 + created_at: 1715078334 + updated_at: 1715078334 newsfeed_assignments: [] - - id: '1' + - id: '156' type: news-item - workspace_id: this_is_an_id530_that_should_be_at_least_ + workspace_id: this_is_an_id532_that_should_be_at_least_ title: We have news body: "

    Hello there,

    " - sender_id: 991266572 + sender_id: 991272381 state: draft labels: [] cover_image_url: @@ -8591,8 +8645,8 @@ paths: - - deliver_silently: false - created_at: 1713520898 - updated_at: 1713520898 + created_at: 1715078334 + updated_at: 1715078334 newsfeed_assignments: [] total_count: 2 schema: @@ -8605,7 +8659,7 @@ paths: Unauthorized: value: type: error.list - request_id: 1748b168-4798-47a6-8d6a-fc7034ac0603 + request_id: 5732a580-e77e-4e51-b589-75ee6fe294c4 errors: - code: unauthorized message: Access Token Invalid @@ -8630,12 +8684,12 @@ paths: examples: successful: value: - id: '5' + id: '159' type: news-item - workspace_id: this_is_an_id534_that_should_be_at_least_ + workspace_id: this_is_an_id536_that_should_be_at_least_ title: Halloween is here! body: "

    New costumes in store for this spooky season

    " - sender_id: 991266581 + sender_id: 991272388 state: live labels: - New @@ -8646,10 +8700,10 @@ paths: - "\U0001F606" - "\U0001F605" deliver_silently: true - created_at: 1713520900 - updated_at: 1713520900 + created_at: 1715078336 + updated_at: 1715078336 newsfeed_assignments: - - newsfeed_id: 3 + - newsfeed_id: 278 published_at: 1664638214 schema: "$ref": "#/components/schemas/news_item" @@ -8661,7 +8715,7 @@ paths: Unauthorized: value: type: error.list - request_id: 963332ab-c783-4cd0-bb0a-269b58eb036d + request_id: 2ac35167-66cb-4ccd-9908-143065859162 errors: - code: unauthorized message: Access Token Invalid @@ -8682,14 +8736,14 @@ paths: - Product - Update - New - sender_id: 991266581 + sender_id: 991272388 deliver_silently: true reactions: - "\U0001F606" - "\U0001F605" state: live newsfeed_assignments: - - newsfeed_id: 3 + - newsfeed_id: 278 published_at: 1664638214 "/news/news_items/{id}": get: @@ -8718,12 +8772,12 @@ paths: examples: successful: value: - id: '6' + id: '160' type: news-item - workspace_id: this_is_an_id538_that_should_be_at_least_ + workspace_id: this_is_an_id540_that_should_be_at_least_ title: We have news body: "

    Hello there,

    " - sender_id: 991266584 + sender_id: 991272391 state: live labels: [] cover_image_url: @@ -8733,11 +8787,11 @@ paths: - - deliver_silently: false - created_at: 1713520901 - updated_at: 1713520901 + created_at: 1715078337 + updated_at: 1715078337 newsfeed_assignments: - - newsfeed_id: 5 - published_at: 1713520901 + - newsfeed_id: 280 + published_at: 1715078337 schema: "$ref": "#/components/schemas/news_item" '404': @@ -8748,7 +8802,7 @@ paths: News Item Not Found: value: type: error.list - request_id: bc941ac0-f60c-42bd-950e-1e54a16d8cd8 + request_id: e105015c-1097-4cd2-9783-b43e1a1fde60 errors: - code: not_found message: Resource Not Found @@ -8762,7 +8816,7 @@ paths: Unauthorized: value: type: error.list - request_id: 45712a9e-7edc-4cd3-98dc-46d577b03fd0 + request_id: 1255a388-1e6d-4454-a23a-3bdfdc45a81e errors: - code: unauthorized message: Access Token Invalid @@ -8793,12 +8847,12 @@ paths: examples: successful: value: - id: '9' + id: '163' type: news-item - workspace_id: this_is_an_id544_that_should_be_at_least_ + workspace_id: this_is_an_id546_that_should_be_at_least_ title: Christmas is here! body: "

    New gifts in store for the jolly season

    " - sender_id: 991266592 + sender_id: 991272399 state: live labels: [] cover_image_url: @@ -8806,8 +8860,8 @@ paths: - "\U0001F61D" - "\U0001F602" deliver_silently: false - created_at: 1713520903 - updated_at: 1713520903 + created_at: 1715078339 + updated_at: 1715078340 newsfeed_assignments: [] schema: "$ref": "#/components/schemas/news_item" @@ -8819,7 +8873,7 @@ paths: News Item Not Found: value: type: error.list - request_id: 7d7f54ae-4d4a-41b8-a922-6f942c1c8770 + request_id: 99633673-9778-4480-8469-5dec4070d2d6 errors: - code: not_found message: Resource Not Found @@ -8833,7 +8887,7 @@ paths: Unauthorized: value: type: error.list - request_id: 49c50484-c541-46b5-b46a-40effe468071 + request_id: 855b532e-3e7f-4738-adac-acbe2ba77aa6 errors: - code: unauthorized message: Access Token Invalid @@ -8850,7 +8904,7 @@ paths: value: title: Christmas is here! body: "

    New gifts in store for the jolly season

    " - sender_id: 991266592 + sender_id: 991272399 reactions: - "\U0001F61D" - "\U0001F602" @@ -8859,7 +8913,7 @@ paths: value: title: Christmas is here! body: "

    New gifts in store for the jolly season

    " - sender_id: 991266595 + sender_id: 991272402 reactions: - "\U0001F61D" - "\U0001F602" @@ -8889,7 +8943,7 @@ paths: examples: successful: value: - id: '12' + id: '166' object: news-item deleted: true schema: @@ -8902,7 +8956,7 @@ paths: News Item Not Found: value: type: error.list - request_id: a2b0784d-59fb-47c0-8baf-0295669d02e7 + request_id: 74a17a5a-7c34-4c04-b479-30a45ee64c5c errors: - code: not_found message: Resource Not Found @@ -8916,7 +8970,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2786dc7a-d37c-4feb-9de7-578ec371c5da + request_id: 28829a6e-5bc2-41d2-8848-0e0cb5155726 errors: - code: unauthorized message: Access Token Invalid @@ -8969,7 +9023,7 @@ paths: Unauthorized: value: type: error.list - request_id: 339b1549-833d-41c6-83f1-a041770245e5 + request_id: 5f346dde-f91c-4774-baa2-ba8d069010ba errors: - code: unauthorized message: Access Token Invalid @@ -9002,16 +9056,16 @@ paths: total_pages: 1 type: pages data: - - id: '18' + - id: '293' type: newsfeed name: Visitor Feed - created_at: 1713520908 - updated_at: 1713520908 - - id: '19' + created_at: 1715078344 + updated_at: 1715078344 + - id: '294' type: newsfeed name: Visitor Feed - created_at: 1713520908 - updated_at: 1713520908 + created_at: 1715078344 + updated_at: 1715078344 total_count: 2 schema: "$ref": "#/components/schemas/paginated_response" @@ -9023,7 +9077,7 @@ paths: Unauthorized: value: type: error.list - request_id: e79cb0fa-08ad-4276-a33c-e400693a6f42 + request_id: f222c65a-7c29-4ad3-be06-f3a999ddf77d errors: - code: unauthorized message: Access Token Invalid @@ -9057,11 +9111,11 @@ paths: examples: successful: value: - id: '22' + id: '297' type: newsfeed name: Visitor Feed - created_at: 1713520909 - updated_at: 1713520909 + created_at: 1715078345 + updated_at: 1715078345 schema: "$ref": "#/components/schemas/newsfeed" '401': @@ -9072,7 +9126,7 @@ paths: Unauthorized: value: type: error.list - request_id: 4c253a5a-b7a6-4290-978b-80aa3602e469 + request_id: '09458d85-0c96-4b71-8320-0469db07c358' errors: - code: unauthorized message: Access Token Invalid @@ -9106,16 +9160,16 @@ paths: Note found: value: type: note - id: '11' - created_at: 1712829710 + id: '154' + created_at: 1714387146 contact: type: contact - id: 6622410e8a6818704e8a6cf6 + id: 663a04ca6ef5d45c04c86b91 author: type: admin - id: '991266611' - name: Ciaran339 Lee - email: admin339@email.com + id: '991272418' + name: Ciaran340 Lee + email: admin340@email.com away_mode_enabled: false away_mode_reassign: false body: "

    This is a note.

    " @@ -9129,7 +9183,7 @@ paths: Note not found: value: type: error.list - request_id: d6fb8705-fe5f-4e95-8da0-fda6ee056cf0 + request_id: db5a2768-16a8-4351-9807-ad9a189c4ad1 errors: - code: not_found message: Resource Not Found @@ -9143,7 +9197,7 @@ paths: Unauthorized: value: type: error.list - request_id: aa980adc-75f0-4f43-95d0-ecec86c32fb9 + request_id: c5c8d1c4-bd20-48d7-ae7a-7fa2a0575179 errors: - code: unauthorized message: Access Token Invalid @@ -9179,16 +9233,16 @@ paths: type: segment.list segments: - type: segment - id: 6622410f8a6818704e8a6cf9 + id: 663a04cc6ef5d45c04c86b94 name: John segment - created_at: 1713520911 - updated_at: 1713520911 + created_at: 1715078348 + updated_at: 1715078348 person_type: user - type: segment - id: 6622410f8a6818704e8a6cfa + id: 663a04cc6ef5d45c04c86b95 name: Jane segment - created_at: 1713520911 - updated_at: 1713520911 + created_at: 1715078348 + updated_at: 1715078348 person_type: user schema: "$ref": "#/components/schemas/segment_list" @@ -9200,7 +9254,7 @@ paths: Unauthorized: value: type: error.list - request_id: 1380fd79-b050-40cf-8885-c90cdcdc286c + request_id: b66bdfa3-923a-441f-837f-587662b2fe0d errors: - code: unauthorized message: Access Token Invalid @@ -9234,10 +9288,10 @@ paths: Successful response: value: type: segment - id: 662241108a6818704e8a6cfd + id: 663a04cd6ef5d45c04c86b98 name: John segment - created_at: 1713520912 - updated_at: 1713520912 + created_at: 1715078349 + updated_at: 1715078349 person_type: user schema: "$ref": "#/components/schemas/segment" @@ -9249,7 +9303,7 @@ paths: Segment not found: value: type: error.list - request_id: 1c3b6776-5fbc-4db9-af2a-422071a68619 + request_id: a9bb0e59-af87-4eb5-9325-f84dd52d4705 errors: - code: not_found message: Resource Not Found @@ -9263,7 +9317,7 @@ paths: Unauthorized: value: type: error.list - request_id: 149fbfcf-9a55-491a-aa19-72d7ca8b769e + request_id: 85faabfc-1a49-4e9d-87f3-fa790cb29b82 errors: - code: unauthorized message: Access Token Invalid @@ -9293,7 +9347,7 @@ paths: type: list data: - type: subscription - id: '45' + id: '551' state: live consent_type: opt_out default_translation: @@ -9316,7 +9370,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0b9dc2c7-faec-4fbf-9ff5-9f8a1a26037d + request_id: 3b4e2cde-d3c5-46f3-beab-c74d406589ce errors: - code: unauthorized message: Access Token Invalid @@ -9346,7 +9400,7 @@ paths: examples: successful: value: - url: http://via.intercom.io/msgr/3bf99322-fb56-4cd5-93a5-ad7244253029 + url: http://via.intercom.io/msgr/2468eee7-3b2c-4cb6-ba42-972d21834488 type: phone_call_redirect schema: "$ref": "#/components/schemas/phone_switch" @@ -9379,7 +9433,7 @@ paths: Unauthorized: value: type: error.list - request_id: 33c4daf1-fbb7-4c7c-b993-cec47e92e3a7 + request_id: 32425d50-49f1-44f5-aa4a-965ba11c4f00 errors: - code: unauthorized message: Access Token Invalid @@ -9442,7 +9496,7 @@ paths: type: list data: - type: tag - id: '23' + id: '499' name: Manual tag 1 schema: "$ref": "#/components/schemas/tag_list" @@ -9454,7 +9508,7 @@ paths: Unauthorized: value: type: error.list - request_id: '09c8a1a9-c576-46a9-8565-6b410531c3d6' + request_id: 955e1c13-2aa9-4620-a2dd-29efa15917d1 errors: - code: unauthorized message: Access Token Invalid @@ -9493,7 +9547,7 @@ paths: Action successful: value: type: tag - id: '26' + id: '502' name: test schema: "$ref": "#/components/schemas/tag" @@ -9505,7 +9559,7 @@ paths: Invalid parameters: value: type: error.list - request_id: 24c0153e-1a24-4601-b0d7-54418d585a09 + request_id: 3f3dabae-50bc-45b3-b449-89fde4cf223c errors: - code: parameter_invalid message: invalid tag parameters @@ -9519,14 +9573,14 @@ paths: Company not found: value: type: error.list - request_id: 9827b080-75bd-4b04-91dc-75675b002b67 + request_id: 1d51df50-1f47-4103-808f-4c6656cc780a errors: - code: company_not_found message: Company Not Found User not found: value: type: error.list - request_id: 64ca1e6a-d863-421b-b499-6b00ab3543ee + request_id: 6577c567-c0d5-4d50-ab9f-2d87bd72e2c4 errors: - code: not_found message: User Not Found @@ -9540,7 +9594,7 @@ paths: Unauthorized: value: type: error.list - request_id: 15af870f-e413-4a78-85b0-fe2021f2c17a + request_id: 02c230fb-36a6-45f5-b26c-e0b630778c72 errors: - code: unauthorized message: Access Token Invalid @@ -9606,7 +9660,7 @@ paths: Tag found: value: type: tag - id: '34' + id: '510' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -9618,7 +9672,7 @@ paths: Tag not found: value: type: error.list - request_id: 6cdc9d8b-b435-4ebc-b9ab-3994a2277a92 + request_id: 321450b2-1954-4502-9ff3-0f9c46eeeb4c errors: - code: not_found message: Resource Not Found @@ -9632,7 +9686,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0a838bd8-8de8-450b-987c-bdfe2b3352e1 + request_id: 7dcc4c3c-8a04-4c55-a5c9-7ce355d87080 errors: - code: unauthorized message: Access Token Invalid @@ -9668,7 +9722,7 @@ paths: Resource not found: value: type: error.list - request_id: 72f77d8d-3da6-42a3-b47f-da2b03dc8a26 + request_id: '029d8d34-1f03-4978-bd63-0e65baff62d8' errors: - code: not_found message: Resource Not Found @@ -9682,7 +9736,7 @@ paths: Tag has dependent objects: value: type: error.list - request_id: a1a8465f-12ab-45f6-9263-6ec045f5c265 + request_id: 03e7315a-1ce7-4d15-ad48-e7edf23c1dfd errors: - code: tag_has_dependent_objects message: 'Unable to delete Tag with dependent objects. Segments: @@ -9697,7 +9751,7 @@ paths: Unauthorized: value: type: error.list - request_id: 4e6bade8-b9cc-4970-a92b-74425b17f39d + request_id: 397b8279-105f-4f27-a7cf-b094f84e1b7d errors: - code: unauthorized message: Access Token Invalid @@ -9735,7 +9789,7 @@ paths: Unauthorized: value: type: error.list - request_id: c5c72701-9576-4dc7-9bf6-58fb6d4f090e + request_id: 03044116-5a67-4589-a584-a0e7054558a8 errors: - code: unauthorized message: Access Token Invalid @@ -9770,7 +9824,7 @@ paths: successful: value: type: team - id: '991266649' + id: '991272456' name: team 1 admin_ids: [] schema: @@ -9783,7 +9837,7 @@ paths: Team not found: value: type: error.list - request_id: 8f740909-b1b5-4572-ab90-763d793a8d1d + request_id: 03ebf3b3-4f8d-45b6-adc0-ace03bd5fd33 errors: - code: team_not_found message: Team not found @@ -9797,7 +9851,7 @@ paths: Unauthorized: value: type: error.list - request_id: 34f01a98-71e8-4ffa-a5ce-9dfa126e7788 + request_id: a940030c-364d-4881-849b-44fbe41ff0a8 errors: - code: unauthorized message: Access Token Invalid @@ -9830,8 +9884,8 @@ paths: Ticket Type Attribute created: value: type: ticket_type_attribute - id: '22' - workspace_id: this_is_an_id636_that_should_be_at_least_ + id: '883' + workspace_id: this_is_an_id638_that_should_be_at_least_ name: Attribute Title description: Attribute Description data_type: string @@ -9843,10 +9897,10 @@ paths: visible_on_create: true visible_to_contacts: true default: false - ticket_type_id: 3 + ticket_type_id: 325 archived: false - created_at: 1713520930 - updated_at: 1713520930 + created_at: 1715078891 + updated_at: 1715078891 schema: "$ref": "#/components/schemas/ticket_type_attribute" '401': @@ -9857,7 +9911,7 @@ paths: Unauthorized: value: type: error.list - request_id: 77fa71d3-6f94-4fea-bb14-c7949248a2c1 + request_id: 6319d427-be51-426c-9dc8-2c5edec55077 errors: - code: unauthorized message: Access Token Invalid @@ -9910,8 +9964,8 @@ paths: Ticket Type Attribute updated: value: type: ticket_type_attribute - id: '27' - workspace_id: this_is_an_id640_that_should_be_at_least_ + id: '888' + workspace_id: this_is_an_id642_that_should_be_at_least_ name: name description: New Attribute Description data_type: string @@ -9921,10 +9975,10 @@ paths: visible_on_create: false visible_to_contacts: false default: false - ticket_type_id: 5 + ticket_type_id: 327 archived: false - created_at: 1713520931 - updated_at: 1713520931 + created_at: 1715078892 + updated_at: 1715078892 schema: "$ref": "#/components/schemas/ticket_type_attribute" '401': @@ -9935,7 +9989,7 @@ paths: Unauthorized: value: type: error.list - request_id: 32ea7c1f-4419-4b1e-bbf6-6a8cc0b5bb36 + request_id: 325e00e4-27c8-45c6-bb7c-cea350c05977 errors: - code: unauthorized message: Access Token Invalid @@ -9974,21 +10028,21 @@ paths: type: list data: - type: ticket_type - id: '7' + id: '329' name: Bug Report description: Bug Report Template icon: "\U0001F39F️" - workspace_id: this_is_an_id644_that_should_be_at_least_ + workspace_id: this_is_an_id646_that_should_be_at_least_ archived: false - created_at: 1713520932 - updated_at: 1713520932 + created_at: 1715078893 + updated_at: 1715078893 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '30' - workspace_id: this_is_an_id644_that_should_be_at_least_ + id: '891' + workspace_id: this_is_an_id646_that_should_be_at_least_ name: _default_title_ description: '' data_type: string @@ -10000,13 +10054,13 @@ paths: visible_on_create: true visible_to_contacts: true default: true - ticket_type_id: 7 + ticket_type_id: 329 archived: false - created_at: 1713520932 - updated_at: 1713520932 + created_at: 1715078893 + updated_at: 1715078893 - type: ticket_type_attribute - id: '32' - workspace_id: this_is_an_id644_that_should_be_at_least_ + id: '893' + workspace_id: this_is_an_id646_that_should_be_at_least_ name: name description: description data_type: string @@ -10017,13 +10071,13 @@ paths: visible_on_create: false visible_to_contacts: false default: false - ticket_type_id: 7 + ticket_type_id: 329 archived: false - created_at: 1713520932 - updated_at: 1713520932 + created_at: 1715078893 + updated_at: 1715078893 - type: ticket_type_attribute - id: '31' - workspace_id: this_is_an_id644_that_should_be_at_least_ + id: '892' + workspace_id: this_is_an_id646_that_should_be_at_least_ name: _default_description_ description: '' data_type: string @@ -10035,10 +10089,10 @@ paths: visible_on_create: true visible_to_contacts: true default: true - ticket_type_id: 7 + ticket_type_id: 329 archived: false - created_at: 1713520932 - updated_at: 1713520932 + created_at: 1715078893 + updated_at: 1715078893 category: Customer schema: "$ref": "#/components/schemas/ticket_type_list" @@ -10050,7 +10104,7 @@ paths: Unauthorized: value: type: error.list - request_id: f82d2a29-3d6f-442b-84a0-d1db250289a6 + request_id: d31c5f96-54db-456e-aa1e-d84c03a5d5b7 errors: - code: unauthorized message: Access Token Invalid @@ -10079,21 +10133,21 @@ paths: Ticket type created: value: type: ticket_type - id: '10' + id: '332' name: Customer Issue description: Customer Report Template icon: "\U0001F39F️" - workspace_id: this_is_an_id648_that_should_be_at_least_ + workspace_id: this_is_an_id650_that_should_be_at_least_ archived: false - created_at: 1713520933 - updated_at: 1713520933 + created_at: 1715078894 + updated_at: 1715078894 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '39' - workspace_id: this_is_an_id648_that_should_be_at_least_ + id: '900' + workspace_id: this_is_an_id650_that_should_be_at_least_ name: _default_title_ description: '' data_type: string @@ -10105,13 +10159,13 @@ paths: visible_on_create: true visible_to_contacts: true default: true - ticket_type_id: 10 + ticket_type_id: 332 archived: false - created_at: 1713520933 - updated_at: 1713520933 + created_at: 1715078894 + updated_at: 1715078894 - type: ticket_type_attribute - id: '40' - workspace_id: this_is_an_id648_that_should_be_at_least_ + id: '901' + workspace_id: this_is_an_id650_that_should_be_at_least_ name: _default_description_ description: '' data_type: string @@ -10123,10 +10177,10 @@ paths: visible_on_create: true visible_to_contacts: true default: true - ticket_type_id: 10 + ticket_type_id: 332 archived: false - created_at: 1713520933 - updated_at: 1713520933 + created_at: 1715078894 + updated_at: 1715078894 category: Customer schema: "$ref": "#/components/schemas/ticket_type" @@ -10138,7 +10192,7 @@ paths: Unauthorized: value: type: error.list - request_id: be6b3ef2-7339-438c-b9ea-92cc6714d5ee + request_id: 52ef2be7-d245-4306-99ba-378de0fa3de1 errors: - code: unauthorized message: Access Token Invalid @@ -10184,21 +10238,21 @@ paths: Ticket type found: value: type: ticket_type - id: '12' + id: '334' name: Bug Report description: Bug Report Template icon: "\U0001F39F️" - workspace_id: this_is_an_id652_that_should_be_at_least_ + workspace_id: this_is_an_id654_that_should_be_at_least_ archived: false - created_at: 1713520934 - updated_at: 1713520934 + created_at: 1715078895 + updated_at: 1715078895 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '44' - workspace_id: this_is_an_id652_that_should_be_at_least_ + id: '905' + workspace_id: this_is_an_id654_that_should_be_at_least_ name: _default_title_ description: '' data_type: string @@ -10210,13 +10264,13 @@ paths: visible_on_create: true visible_to_contacts: true default: true - ticket_type_id: 12 + ticket_type_id: 334 archived: false - created_at: 1713520934 - updated_at: 1713520934 + created_at: 1715078895 + updated_at: 1715078895 - type: ticket_type_attribute - id: '46' - workspace_id: this_is_an_id652_that_should_be_at_least_ + id: '907' + workspace_id: this_is_an_id654_that_should_be_at_least_ name: name description: description data_type: string @@ -10227,13 +10281,13 @@ paths: visible_on_create: false visible_to_contacts: false default: false - ticket_type_id: 12 + ticket_type_id: 334 archived: false - created_at: 1713520934 - updated_at: 1713520934 + created_at: 1715078895 + updated_at: 1715078895 - type: ticket_type_attribute - id: '45' - workspace_id: this_is_an_id652_that_should_be_at_least_ + id: '906' + workspace_id: this_is_an_id654_that_should_be_at_least_ name: _default_description_ description: '' data_type: string @@ -10245,10 +10299,10 @@ paths: visible_on_create: true visible_to_contacts: true default: true - ticket_type_id: 12 + ticket_type_id: 334 archived: false - created_at: 1713520934 - updated_at: 1713520934 + created_at: 1715078895 + updated_at: 1715078895 category: Customer schema: "$ref": "#/components/schemas/ticket_type" @@ -10260,7 +10314,7 @@ paths: Unauthorized: value: type: error.list - request_id: b99e1f99-b10e-4bfd-8fb3-cc5edfda0e88 + request_id: 85011a2f-5b37-4c2d-9097-17cba3a32e8b errors: - code: unauthorized message: Access Token Invalid @@ -10293,21 +10347,21 @@ paths: Ticket type updated: value: type: ticket_type - id: '14' + id: '336' name: Bug Report 2 description: Bug Report Template icon: "\U0001F39F️" - workspace_id: this_is_an_id656_that_should_be_at_least_ + workspace_id: this_is_an_id658_that_should_be_at_least_ archived: false - created_at: 1713520935 - updated_at: 1713520935 + created_at: 1715078896 + updated_at: 1715078896 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '50' - workspace_id: this_is_an_id656_that_should_be_at_least_ + id: '911' + workspace_id: this_is_an_id658_that_should_be_at_least_ name: _default_title_ description: '' data_type: string @@ -10319,13 +10373,13 @@ paths: visible_on_create: true visible_to_contacts: true default: true - ticket_type_id: 14 + ticket_type_id: 336 archived: false - created_at: 1713520935 - updated_at: 1713520935 + created_at: 1715078896 + updated_at: 1715078896 - type: ticket_type_attribute - id: '52' - workspace_id: this_is_an_id656_that_should_be_at_least_ + id: '913' + workspace_id: this_is_an_id658_that_should_be_at_least_ name: name description: description data_type: string @@ -10336,13 +10390,13 @@ paths: visible_on_create: false visible_to_contacts: false default: false - ticket_type_id: 14 + ticket_type_id: 336 archived: false - created_at: 1713520935 - updated_at: 1713520935 + created_at: 1715078896 + updated_at: 1715078896 - type: ticket_type_attribute - id: '51' - workspace_id: this_is_an_id656_that_should_be_at_least_ + id: '912' + workspace_id: this_is_an_id658_that_should_be_at_least_ name: _default_description_ description: '' data_type: string @@ -10354,10 +10408,10 @@ paths: visible_on_create: true visible_to_contacts: true default: true - ticket_type_id: 14 + ticket_type_id: 336 archived: false - created_at: 1713520935 - updated_at: 1713520935 + created_at: 1715078896 + updated_at: 1715078896 category: Customer schema: "$ref": "#/components/schemas/ticket_type" @@ -10369,7 +10423,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8ab1efcb-0d8d-499b-8d2b-a749f9676ba7 + request_id: a4f36e6b-2dc8-468b-a17d-32e8583ee26c errors: - code: unauthorized message: Access Token Invalid @@ -10415,13 +10469,13 @@ paths: User reply: value: type: ticket_part - id: '30' + id: '429' part_type: comment body: "

    Thanks again :)

    " - created_at: 1713520938 - updated_at: 1713520938 + created_at: 1715078899 + updated_at: 1715078899 author: - id: 662241298a6818704e8a6d20 + id: 663a06f36ef5d45c04c86bbb type: user name: email: user30@email.com @@ -10430,7 +10484,7 @@ paths: Admin note reply: value: type: ticket_part - id: '32' + id: '431' part_type: note body: |-

    An Unordered HTML List

    @@ -10445,27 +10499,27 @@ paths:
  • Tea
  • Milk
    • - created_at: 1713520940 - updated_at: 1713520940 + created_at: 1715078902 + updated_at: 1715078902 author: - id: '991266676' + id: '991272483' type: admin - name: Ciaran398 Lee - email: admin398@email.com + name: Ciaran399 Lee + email: admin399@email.com attachments: [] redacted: false Admin quick_reply reply: value: type: ticket_part - id: '34' + id: '433' part_type: quick_reply - created_at: 1713520943 - updated_at: 1713520943 + created_at: 1715078905 + updated_at: 1715078905 author: - id: '991266681' + id: '991272488' type: admin - name: Ciaran402 Lee - email: admin402@email.com + name: Ciaran403 Lee + email: admin403@email.com attachments: [] redacted: false schema: @@ -10478,7 +10532,7 @@ paths: Not found: value: type: error.list - request_id: 4e0bdaa5-40c5-4e77-a2d3-0ec5a00a9bcb + request_id: 559cb28f-46a3-4df1-97fb-89d2bbc5cb20 errors: - code: not_found message: Resource Not Found @@ -10492,7 +10546,7 @@ paths: Unauthorized: value: type: error.list - request_id: 215c0a4c-0056-4276-bb1d-9337c0490b9d + request_id: 839b8b92-8fa4-4765-971d-e84770bdca15 errors: - code: unauthorized message: Access Token Invalid @@ -10509,14 +10563,14 @@ paths: value: message_type: comment type: user - intercom_user_id: 662241298a6818704e8a6d20 + intercom_user_id: 663a06f36ef5d45c04c86bbb body: Thanks again :) admin_note_reply: summary: Admin note reply value: message_type: note type: admin - admin_id: 991266676 + admin_id: 991272483 body: "

    An Unordered HTML List

    An Ordered HTML List

    \
    1. Coffee
    2. Tea
    3. Milk
    @@ -10526,18 +10580,18 @@ paths: value: message_type: quick_reply type: admin - admin_id: 991266681 + admin_id: 991272488 reply_options: - text: 'Yes' - uuid: 159d7428-aa96-4574-9521-20bff41f7565 + uuid: 13bbdf49-36e8-4c2a-b3f4-a5f49b98e627 - text: 'No' - uuid: a5b6660a-6ab5-4e1d-ac0e-fd1e77c78264 + uuid: 0db2ff74-34f4-4336-a04f-b5d74eff00fb not_found: summary: Not found value: message_type: comment type: user - intercom_user_id: 662241308a6818704e8a6d23 + intercom_user_id: 663a06fa6ef5d45c04c86bbe body: Thanks again :) "/tickets/{ticket_id}/tags": post: @@ -10569,7 +10623,7 @@ paths: successful: value: type: tag - id: '42' + id: '518' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -10581,7 +10635,7 @@ paths: Ticket not found: value: type: error.list - request_id: ad847e34-8253-422f-91ab-f85b30e83e4e + request_id: 2c1ea69a-86dd-4c46-b8a1-2c790aad8889 errors: - code: ticket_not_found message: Ticket not found @@ -10595,7 +10649,7 @@ paths: Unauthorized: value: type: error.list - request_id: 93ffa95a-7d01-43ee-bb9a-4f0286437715 + request_id: '0967b789-b7a8-49e6-9745-57b64aca4ea0' errors: - code: unauthorized message: Access Token Invalid @@ -10624,13 +10678,13 @@ paths: successful: summary: successful value: - id: 42 - admin_id: 991266691 + id: 518 + admin_id: 991272498 ticket_not_found: summary: Ticket not found value: - id: 43 - admin_id: 991266694 + id: 519 + admin_id: 991272501 "/tickets/{ticket_id}/tags/{id}": delete: summary: Remove tag from a ticket @@ -10668,7 +10722,7 @@ paths: successful: value: type: tag - id: '45' + id: '521' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -10680,14 +10734,14 @@ paths: Ticket not found: value: type: error.list - request_id: 0dfc0071-32fa-4a90-8dfb-7ce336bb4e5a + request_id: 161a924f-5c77-4b4f-88c7-714f611c40a2 errors: - code: ticket_not_found message: Ticket not found Tag not found: value: type: error.list - request_id: bf75f22e-428b-49fb-a02b-46862f3f5bca + request_id: 9ae8d102-ae80-4ee1-93c3-2c2f780ffd62 errors: - code: tag_not_found message: Tag not found @@ -10701,7 +10755,7 @@ paths: Unauthorized: value: type: error.list - request_id: d5cf9cba-2274-49bb-b7e0-9d15c93407c5 + request_id: 15ae2bce-6834-400e-bc1d-b710fdf7ff5f errors: - code: unauthorized message: Access Token Invalid @@ -10724,15 +10778,15 @@ paths: successful: summary: successful value: - admin_id: 991266700 + admin_id: 991272507 ticket_not_found: summary: Ticket not found value: - admin_id: 991266703 + admin_id: 991272510 tag_not_found: summary: Tag not found value: - admin_id: 991266706 + admin_id: 991272513 "/tickets": post: summary: Create a ticket @@ -10754,8 +10808,8 @@ paths: Successful response: value: type: ticket - id: '159' - ticket_id: '12' + id: '1879' + ticket_id: '109' ticket_attributes: title: example description: there is a problem @@ -10764,21 +10818,21 @@ paths: ticket_state_external_label: Submitted ticket_type: type: ticket_type - id: '28' + id: '350' name: my-ticket-type-15 description: my ticket type description is awesome. icon: "\U0001F981" - workspace_id: this_is_an_id684_that_should_be_at_least_ + workspace_id: this_is_an_id686_that_should_be_at_least_ archived: false - created_at: 1713520957 - updated_at: 1713520957 + created_at: 1715078921 + updated_at: 1715078921 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '64' - workspace_id: this_is_an_id684_that_should_be_at_least_ + id: '925' + workspace_id: this_is_an_id686_that_should_be_at_least_ name: title description: ola data_type: string @@ -10789,13 +10843,13 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 28 + ticket_type_id: 350 archived: false - created_at: 1713520958 - updated_at: 1713520958 + created_at: 1715078921 + updated_at: 1715078921 - type: ticket_type_attribute - id: '65' - workspace_id: this_is_an_id684_that_should_be_at_least_ + id: '926' + workspace_id: this_is_an_id686_that_should_be_at_least_ name: description description: ola data_type: string @@ -10806,36 +10860,36 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 28 + ticket_type_id: 350 archived: false - created_at: 1713520958 - updated_at: 1713520958 + created_at: 1715078921 + updated_at: 1715078921 category: Back-office contacts: type: contact.list contacts: - type: contact - id: 6622413e8a6818704e8a6d2b + id: 663a07096ef5d45c04c86bc6 external_id: '70' admin_assignee_id: '0' team_assignee_id: '0' - created_at: 1713520958 - updated_at: 1713520958 + created_at: 1715078921 + updated_at: 1715078922 ticket_parts: type: ticket_part.list ticket_parts: - type: ticket_part - id: '35' + id: '434' part_type: ticket_state_updated_by_admin ticket_state: submitted previous_ticket_state: submitted - created_at: 1713520958 - updated_at: 1713520958 + created_at: 1715078922 + updated_at: 1715078922 author: - id: '991266718' + id: '991272525' type: bot name: Operator - email: operator+this_is_an_id684_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id686_that_should_be_at_least_@intercom.io attachments: [] redacted: false total_count: 1 @@ -10857,7 +10911,7 @@ paths: Unauthorized: value: type: error.list - request_id: 7b1ef162-db71-42f1-9bfd-8dd367e1abca + request_id: df4a024e-678d-4dc6-ab3d-d15ecd9601c0 errors: - code: unauthorized message: Access Token Invalid @@ -10872,9 +10926,9 @@ paths: successful_response: summary: Successful response value: - ticket_type_id: 28 + ticket_type_id: 350 contacts: - - id: 6622413e8a6818704e8a6d2b + - id: 663a07096ef5d45c04c86bc6 ticket_attributes: title: example description: there is a problem @@ -10905,8 +10959,8 @@ paths: Successful response: value: type: ticket - id: '160' - ticket_id: '13' + id: '1880' + ticket_id: '110' ticket_attributes: title: example description: there is a problem @@ -10915,21 +10969,21 @@ paths: ticket_state_external_label: In progress ticket_type: type: ticket_type - id: '30' + id: '352' name: my-ticket-type-17 description: my ticket type description is awesome. icon: "\U0001F981" - workspace_id: this_is_an_id688_that_should_be_at_least_ + workspace_id: this_is_an_id690_that_should_be_at_least_ archived: false - created_at: 1713520960 - updated_at: 1713520960 + created_at: 1715078923 + updated_at: 1715078923 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '69' - workspace_id: this_is_an_id688_that_should_be_at_least_ + id: '930' + workspace_id: this_is_an_id690_that_should_be_at_least_ name: title description: ola data_type: string @@ -10940,13 +10994,13 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 30 + ticket_type_id: 352 archived: false - created_at: 1713520960 - updated_at: 1713520960 + created_at: 1715078923 + updated_at: 1715078923 - type: ticket_type_attribute - id: '70' - workspace_id: this_is_an_id688_that_should_be_at_least_ + id: '931' + workspace_id: this_is_an_id690_that_should_be_at_least_ name: description description: ola data_type: string @@ -10957,106 +11011,106 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 30 + ticket_type_id: 352 archived: false - created_at: 1713520960 - updated_at: 1713520960 + created_at: 1715078923 + updated_at: 1715078923 category: Back-office contacts: type: contact.list contacts: - type: contact - id: 662241408a6818704e8a6d2c - external_id: 05dd8373-6b71-4f96-8051-a361768a11b7 - admin_assignee_id: '991266732' + id: 663a070c6ef5d45c04c86bc7 + external_id: c47f0f46-24b2-4fe1-9a6c-5811dc81d5f7 + admin_assignee_id: '991272539' team_assignee_id: '0' - created_at: 1713520960 - updated_at: 1713520963 + created_at: 1715078924 + updated_at: 1715078926 ticket_parts: type: ticket_part.list ticket_parts: - type: ticket_part - id: '36' + id: '435' part_type: ticket_state_updated_by_admin ticket_state: submitted previous_ticket_state: submitted - created_at: 1713520961 - updated_at: 1713520961 + created_at: 1715078924 + updated_at: 1715078924 author: - id: '991266730' + id: '991272537' type: admin - name: Ciaran442 Lee - email: admin442@email.com + name: Ciaran443 Lee + email: admin443@email.com attachments: [] redacted: false - type: ticket_part - id: '37' + id: '436' part_type: ticket_attribute_updated_by_admin - created_at: 1713520962 - updated_at: 1713520962 + created_at: 1715078925 + updated_at: 1715078925 author: - id: '991266731' + id: '991272538' type: bot name: Operator - email: operator+this_is_an_id688_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id690_that_should_be_at_least_@intercom.io attachments: [] redacted: false - type: ticket_part - id: '38' + id: '437' part_type: ticket_attribute_updated_by_admin - created_at: 1713520962 - updated_at: 1713520962 + created_at: 1715078926 + updated_at: 1715078926 author: - id: '991266731' + id: '991272538' type: bot name: Operator - email: operator+this_is_an_id688_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id690_that_should_be_at_least_@intercom.io attachments: [] redacted: false - type: ticket_part - id: '39' + id: '438' part_type: ticket_state_updated_by_admin ticket_state: in_progress previous_ticket_state: submitted - created_at: 1713520962 - updated_at: 1713520962 + created_at: 1715078926 + updated_at: 1715078926 author: - id: '991266731' + id: '991272538' type: bot name: Operator - email: operator+this_is_an_id688_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id690_that_should_be_at_least_@intercom.io attachments: [] redacted: false - type: ticket_part - id: '40' + id: '439' part_type: assignment - created_at: 1713520963 - updated_at: 1713520963 + created_at: 1715078926 + updated_at: 1715078926 assigned_to: type: admin - id: '991266732' + id: '991272539' author: - id: '991266730' + id: '991272537' type: admin - name: Ciaran442 Lee - email: admin442@email.com + name: Ciaran443 Lee + email: admin443@email.com attachments: [] redacted: false - type: ticket_part - id: '41' + id: '440' part_type: snoozed - created_at: 1713520963 - updated_at: 1713520963 + created_at: 1715078926 + updated_at: 1715078926 author: - id: '991266731' + id: '991272538' type: bot name: Operator - email: operator+this_is_an_id688_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id690_that_should_be_at_least_@intercom.io attachments: [] redacted: false total_count: 6 open: true - snoozed_until: 1713628800 + snoozed_until: 1715184000 linked_objects: type: list data: [] @@ -11074,14 +11128,14 @@ paths: Admin not found: value: type: error.list - request_id: b56e4f63-60d6-47ec-9b21-e5a47b645bdd + request_id: 35c8dcb7-82b2-4be6-a493-2efe1710bb4d errors: - code: assignee_not_found message: Assignee not found Assignee not found: value: type: error.list - request_id: 54da5358-3235-4f05-be51-186856562267 + request_id: 889114d3-7099-401b-ada5-38a9b7e83f5a errors: - code: assignee_not_found message: Assignee not found @@ -11093,7 +11147,7 @@ paths: Unauthorized: value: type: error.list - request_id: ec300e5a-20f3-4878-a7f8-e865a96d6b2e + request_id: 98f5df55-1635-4d9a-aead-528e1c79b65f errors: - code: unauthorized message: Access Token Invalid @@ -11113,8 +11167,8 @@ paths: description: there is a problem state: in_progress assignment: - admin_id: '991266730' - assignee_id: '991266732' + admin_id: '991272537' + assignee_id: '991272539' open: true snoozed_until: 1673609604 admin_not_found: @@ -11126,7 +11180,7 @@ paths: state: in_progress assignment: admin_id: '123' - assignee_id: '991266740' + assignee_id: '991272547' assignee_not_found: summary: Assignee not found value: @@ -11135,7 +11189,7 @@ paths: description: there is a problem state: in_progress assignment: - admin_id: '991266746' + admin_id: '991272553' assignee_id: '456' get: summary: Retrieve a ticket @@ -11163,8 +11217,8 @@ paths: Ticket found: value: type: ticket - id: '163' - ticket_id: '16' + id: '1883' + ticket_id: '113' ticket_attributes: title: attribute_value description: @@ -11173,21 +11227,21 @@ paths: ticket_state_external_label: Submitted ticket_type: type: ticket_type - id: '34' + id: '356' name: my-ticket-type-21 description: my ticket type description is awesome. icon: "\U0001F981" - workspace_id: this_is_an_id696_that_should_be_at_least_ + workspace_id: this_is_an_id698_that_should_be_at_least_ archived: false - created_at: 1713520968 - updated_at: 1713520968 + created_at: 1715078932 + updated_at: 1715078932 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '80' - workspace_id: this_is_an_id696_that_should_be_at_least_ + id: '941' + workspace_id: this_is_an_id698_that_should_be_at_least_ name: title description: ola data_type: string @@ -11198,13 +11252,13 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 34 + ticket_type_id: 356 archived: false - created_at: 1713520968 - updated_at: 1713520968 + created_at: 1715078932 + updated_at: 1715078932 - type: ticket_type_attribute - id: '81' - workspace_id: this_is_an_id696_that_should_be_at_least_ + id: '942' + workspace_id: this_is_an_id698_that_should_be_at_least_ name: description description: ola data_type: string @@ -11215,36 +11269,36 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 34 + ticket_type_id: 356 archived: false - created_at: 1713520968 - updated_at: 1713520968 + created_at: 1715078932 + updated_at: 1715078932 category: Back-office contacts: type: contact.list contacts: - type: contact - id: 662241488a6818704e8a6d2f - external_id: a06fb358-1a79-4b09-8bb1-02036230f16f + id: 663a07146ef5d45c04c86bca + external_id: 869b7016-7943-4b05-83a0-6a6d9d336b30 admin_assignee_id: '0' team_assignee_id: '0' - created_at: 1713520969 - updated_at: 1713520969 + created_at: 1715078933 + updated_at: 1715078933 ticket_parts: type: ticket_part.list ticket_parts: - type: ticket_part - id: '44' + id: '443' part_type: ticket_state_updated_by_admin ticket_state: submitted previous_ticket_state: submitted - created_at: 1713520969 - updated_at: 1713520969 + created_at: 1715078933 + updated_at: 1715078933 author: - id: '991266759' + id: '991272566' type: admin - name: Ciaran468 Lee - email: admin468@email.com + name: Ciaran469 Lee + email: admin469@email.com attachments: [] redacted: false total_count: 1 @@ -11266,7 +11320,7 @@ paths: Unauthorized: value: type: error.list - request_id: 34cff155-5521-403f-ad21-109a4c064816 + request_id: 9a48792e-b57f-495a-a642-e307d1112d97 errors: - code: unauthorized message: Access Token Invalid @@ -11289,6 +11343,12 @@ paths: To search for tickets, you send a `POST` request to `https://api.intercom.io/tickets/search`. This will accept a query object in the body which will define your filters. + {% admonition type="warning" name="Optimizing search queries" %} + Search queries can be complex, so optimizing them can help the performance of your search. + Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize + pagination to limit the number of results returned. The default is `20` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param. + {% /admonition %} ### Nesting & Limitations @@ -11356,8 +11416,8 @@ paths: total_count: 1 tickets: - type: ticket - id: '164' - ticket_id: '17' + id: '1884' + ticket_id: '114' ticket_attributes: title: attribute_value description: @@ -11366,21 +11426,21 @@ paths: ticket_state_external_label: Submitted ticket_type: type: ticket_type - id: '36' + id: '358' name: my-ticket-type-23 description: my ticket type description is awesome. icon: "\U0001F981" - workspace_id: this_is_an_id700_that_should_be_at_least_ + workspace_id: this_is_an_id702_that_should_be_at_least_ archived: false - created_at: 1713520971 - updated_at: 1713520971 + created_at: 1715078935 + updated_at: 1715078935 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '85' - workspace_id: this_is_an_id700_that_should_be_at_least_ + id: '946' + workspace_id: this_is_an_id702_that_should_be_at_least_ name: title description: ola data_type: string @@ -11391,13 +11451,13 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 36 + ticket_type_id: 358 archived: false - created_at: 1713520971 - updated_at: 1713520971 + created_at: 1715078935 + updated_at: 1715078935 - type: ticket_type_attribute - id: '86' - workspace_id: this_is_an_id700_that_should_be_at_least_ + id: '947' + workspace_id: this_is_an_id702_that_should_be_at_least_ name: description description: ola data_type: string @@ -11408,36 +11468,36 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 36 + ticket_type_id: 358 archived: false - created_at: 1713520971 - updated_at: 1713520971 + created_at: 1715078935 + updated_at: 1715078935 category: Back-office contacts: type: contact.list contacts: - type: contact - id: 6622414b8a6818704e8a6d30 - external_id: 36e6f616-d21b-4f80-b521-bf3eaaec0ace + id: 663a07186ef5d45c04c86bcb + external_id: 92f34145-8062-4a6b-aef2-daff82c9a313 admin_assignee_id: '0' team_assignee_id: '0' - created_at: 1713520971 - updated_at: 1713520972 + created_at: 1715078936 + updated_at: 1715078936 ticket_parts: type: ticket_part.list ticket_parts: - type: ticket_part - id: '45' + id: '444' part_type: ticket_state_updated_by_admin ticket_state: submitted previous_ticket_state: submitted - created_at: 1713520972 - updated_at: 1713520972 + created_at: 1715078936 + updated_at: 1715078936 author: - id: '991266772' + id: '991272579' type: admin - name: Ciaran480 Lee - email: admin480@email.com + name: Ciaran481 Lee + email: admin481@email.com attachments: [] redacted: false total_count: 1 @@ -11465,15 +11525,15 @@ paths: value: - field: id operator: "=" - value: '164' + value: '1884' - operator: OR value: - field: id operator: "=" - value: '164' + value: '1884' - field: id operator: "=" - value: '164' + value: '1884' "/visitors": put: summary: Update a visitor @@ -11500,7 +11560,7 @@ paths: successful: value: type: visitor - id: 6622414e8a6818704e8a6d33 + id: 663a071a6ef5d45c04c86bce user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' @@ -11510,16 +11570,16 @@ paths: avatar: type: avatar image_url: https://static.intercomassets.com/app/pseudonym_avatars_2019/grey-astronaut.png - app_id: this_is_an_id704_that_should_be_at_least_ + app_id: this_is_an_id706_that_should_be_at_least_ companies: type: company.list companies: [] location_data: {} last_request_at: - created_at: 1713520974 - remote_created_at: 1713520974 - signed_up_at: 1713520974 - updated_at: 1713520974 + created_at: 1715078938 + remote_created_at: 1715078938 + signed_up_at: 1715078938 + updated_at: 1715078939 session_count: 0 social_profiles: type: social_profile.list @@ -11552,7 +11612,7 @@ paths: visitor Not Found: value: type: error.list - request_id: 23fa7d97-2322-474d-9cef-81ab39ce344d + request_id: 03d2e09a-323d-4864-b075-65e1cb817ad0 errors: - code: not_found message: Visitor Not Found @@ -11566,7 +11626,7 @@ paths: Unauthorized: value: type: error.list - request_id: 732cc7ec-1478-4e9e-927b-652f33865fa3 + request_id: 367419e5-7119-498f-aa10-2f39b6200bd8 errors: - code: unauthorized message: Access Token Invalid @@ -11581,7 +11641,7 @@ paths: successful: summary: successful value: - id: 6622414e8a6818704e8a6d33 + id: 663a071a6ef5d45c04c86bce name: Gareth Bale visitor_not_found: summary: visitor Not Found @@ -11614,107 +11674,7 @@ paths: successful: value: type: visitor - id: 662241508a6818704e8a6d39 - user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 - anonymous: true - email: '' - phone: - name: - pseudonym: - avatar: - type: avatar - image_url: - app_id: this_is_an_id710_that_should_be_at_least_ - companies: - type: company.list - companies: [] - location_data: {} - last_request_at: - created_at: 1713520976 - remote_created_at: 1713520976 - signed_up_at: 1713520976 - updated_at: 1713520976 - session_count: 0 - social_profiles: - type: social_profile.list - social_profiles: [] - owner_id: - unsubscribed_from_emails: false - marked_email_as_spam: false - has_hard_bounced: false - tags: - type: tag.list - tags: [] - segments: - type: segment.list - segments: [] - custom_attributes: {} - referrer: - utm_campaign: - utm_content: - utm_medium: - utm_source: - utm_term: - do_not_track: - schema: - "$ref": "#/components/schemas/visitor" - '404': - description: Visitor not found - content: - application/json: - examples: - Visitor not found: - value: - type: error.list - request_id: 2695cc28-deeb-4c83-b337-0bb9034f9523 - errors: - - code: not_found - message: Visitor Not Found - schema: - "$ref": "#/components/schemas/error" - '401': - description: Unauthorized - content: - application/json: - examples: - Unauthorized: - value: - type: error.list - request_id: 07227b94-54ec-4b7f-8c68-084ad93a9634 - errors: - - code: unauthorized - message: Access Token Invalid - schema: - "$ref": "#/components/schemas/error" - "/visitors/{id}": - get: - summary: Retrieve a visitor with ID - parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - - name: id - in: path - required: true - description: Id provided by Intercom. - example: 5e1c4c1c-7b1e-4b5d-8c1c-5e1c4c1c7b1e - schema: - type: string - tags: - - Visitors - operationId: retrieveVisitor - description: You can fetch the details of a single visitor. - responses: - '200': - description: successful - content: - application/json: - examples: - successful: - value: - type: visitor - id: 662241518a6818704e8a6d3f + id: 663a071c6ef5d45c04c86bd4 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' @@ -11724,16 +11684,16 @@ paths: avatar: type: avatar image_url: - app_id: this_is_an_id716_that_should_be_at_least_ + app_id: this_is_an_id712_that_should_be_at_least_ companies: type: company.list companies: [] location_data: {} last_request_at: - created_at: 1713520977 - remote_created_at: 1713520977 - signed_up_at: 1713520977 - updated_at: 1713520977 + created_at: 1715078940 + remote_created_at: 1715078940 + signed_up_at: 1715078940 + updated_at: 1715078940 session_count: 0 social_profiles: type: social_profile.list @@ -11766,7 +11726,7 @@ paths: Visitor not found: value: type: error.list - request_id: 7486527d-1f04-4427-aebc-f1e25768242d + request_id: c4f4f91a-b6fb-4ab3-8675-73bb23e0b271 errors: - code: not_found message: Visitor Not Found @@ -11780,106 +11740,7 @@ paths: Unauthorized: value: type: error.list - request_id: 35700b67-1c0c-42b2-b15f-9dfe43369333 - errors: - - code: unauthorized - message: Access Token Invalid - schema: - "$ref": "#/components/schemas/error" - delete: - summary: Delete a visitor - parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - - name: id - in: path - required: true - description: Id provided by Intercom. - example: 5e1c4c1c-7b1e-4b5d-8c1c-5e1c4c1c7b1e - schema: - type: string - tags: - - Visitors - operationId: deleteVisitor - description: You can delete a single visitor. - responses: - '200': - description: successful - content: - application/json: - examples: - successful: - value: - type: visitor - id: 662241538a6818704e8a6d45 - user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 - anonymous: true - email: '' - phone: - name: - pseudonym: - avatar: - type: avatar - image_url: - app_id: this_is_an_id722_that_should_be_at_least_ - companies: - type: company.list - companies: [] - location_data: {} - last_request_at: - created_at: 1713520979 - remote_created_at: 1713520979 - signed_up_at: 1713520979 - updated_at: 1713520979 - session_count: 0 - social_profiles: - type: social_profile.list - social_profiles: [] - owner_id: - unsubscribed_from_emails: false - marked_email_as_spam: false - has_hard_bounced: false - tags: - type: tag.list - tags: [] - segments: - type: segment.list - segments: [] - custom_attributes: {} - referrer: - utm_campaign: - utm_content: - utm_medium: - utm_source: - utm_term: - do_not_track: - schema: - "$ref": "#/components/schemas/visitor_deleted_object" - '404': - description: Visitor Not Found - content: - application/json: - examples: - Visitor Not Found: - value: - type: error.list - request_id: ad18e216-2dd6-4193-9bb8-a8a39ecdd15a - errors: - - code: not_found - message: User Not Found - schema: - "$ref": "#/components/schemas/error" - '401': - description: Unauthorized - content: - application/json: - examples: - Unauthorized: - value: - type: error.list - request_id: c1061da9-bb8f-4488-9b96-67963fd67c59 + request_id: 4415c4dd-793e-4e69-adc8-dc340c99ed0d errors: - code: unauthorized message: Access Token Invalid @@ -11910,8 +11771,8 @@ paths: successful: value: type: contact - id: 662241558a6818704e8a6d4c - workspace_id: this_is_an_id728_that_should_be_at_least_ + id: 663a071d6ef5d45c04c86bdb + workspace_id: this_is_an_id718_that_should_be_at_least_ external_id: role: user email: foo@bar.com @@ -11926,9 +11787,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1713520981 - updated_at: 1713520981 - signed_up_at: 1713520981 + created_at: 1715078941 + updated_at: 1715078942 + signed_up_at: 1715078941 last_seen_at: last_replied_at: last_contacted_at: @@ -11962,31 +11823,31 @@ paths: tags: type: list data: [] - url: "/contacts/662241558a6818704e8a6d4c/tags" + url: "/contacts/663a071d6ef5d45c04c86bdb/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/662241558a6818704e8a6d4c/notes" + url: "/contacts/663a071d6ef5d45c04c86bdb/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/662241558a6818704e8a6d4c/companies" + url: "/contacts/663a071d6ef5d45c04c86bdb/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/662241558a6818704e8a6d4c/subscriptions" + url: "/contacts/663a071d6ef5d45c04c86bdb/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/662241558a6818704e8a6d4c/subscriptions" + url: "/contacts/663a071d6ef5d45c04c86bdb/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -12005,7 +11866,7 @@ paths: Unauthorized: value: type: error.list - request_id: 6b259269-8861-48b1-bf50-64c214f5e899 + request_id: 4d1831f0-910f-451b-8330-6756edb75487 errors: - code: unauthorized message: Access Token Invalid @@ -12534,7 +12395,7 @@ components: description: The customer satisfaction rating remark given to AI Agent. example: Very helpful! content_sources: - "$ref": "#/components/schemas/content_source_list" + "$ref": "#/components/schemas/content_sources_list" app: title: App type: object @@ -13093,6 +12954,51 @@ components: "$ref": "#/components/schemas/customer_request" required: - email + call: + title: Call + type: object + description: Calls are objects that represent voice and video communication + with users. + properties: + type: + type: string + description: String representing the object's type. Always has the value + `call`. + example: call + id: + type: integer + description: The unique identifier for the call which is given by Intercom. + example: 1234 + workspace_id: + type: string + description: The id of the workspace which the call belongs to. + example: ecahpwf5 + created_at: + type: integer + format: date-time + description: "(UNIX timestamp) The time when the call was created." + example: 1571672154 + updated_at: + type: integer + format: date-time + description: "(UNIX timestamp) The time when the call was last updated." + example: 1571672154 + call_list: + title: Call List + type: object + description: A list of Calls associated with a given workspace. + properties: + type: + type: string + description: Always list + enum: + - list + example: list + data: + type: array + description: The list of Call objects + items: + "$ref": "#/components/schemas/call" close_conversation_request: title: Close Conversation Request type: object @@ -14227,7 +14133,7 @@ components: type: string description: The ISO 639 language code of the content source. example: en - content_source_list: + content_sources_list: title: Content Source List nullable: false properties: @@ -15459,6 +15365,46 @@ components: "$ref": "#/components/schemas/custom_attributes" required: - phone + create_section_request: + description: You can create a Section + type: object + title: Create Section Request Payload + properties: + name: + type: string + description: The name of the collection. For multilingual collections, this + will be the name of the default language's content. + example: Section 51 + parent_id: + type: integer + description: The id for the collection this section will be within. + example: 18 + translated_content: + nullable: true + "$ref": "#/components/schemas/group_translated_content" + required: + - name + - parent_id + create_ticket_reply_request: + title: Create Ticket Reply Request Payload + type: object + properties: + body: + type: string + description: The message body of the note, which may contain HTML. + example: "

    Okay!

    " + message_type: + type: string + description: The type of the reply. Only `note` is supported at the moment. + example: note + default: note + admin_id: + type: string + description: The id of the admin who is making the note. + example: '1234' + required: + - body + - admin_id create_ticket_reply_with_comment_request: title: Create Ticket Reply Request Payload oneOf: @@ -15506,6 +15452,11 @@ components: - email example: - id: '1234' + company_id: + type: string + description: The ID of the company that the ticket is associated with. The + ID that you set upon company creation. + example: '1234' created_at: type: integer description: The time the ticket was created. If not provided, the current @@ -16192,6 +16143,26 @@ components: type: boolean description: Whether the news item was deleted successfully or not. example: true + deleted_section_object: + title: Deleted Section Object + type: object + description: Response returned when an object is deleted + properties: + id: + type: string + description: The unique identifier for the section which you provided in + the URL. + example: '6890762' + object: + type: string + description: The type of object which was deleted. - `section` + enum: + - section + example: section + deleted: + type: boolean + description: Whether the section was deleted successfully or not. + example: true detach_contact_from_conversation_request: properties: admin_id: @@ -16615,6 +16586,7 @@ components: - '2.8' - '2.9' - '2.10' + - '2.11' - Unstable linked_object: title: Linked Object @@ -16733,6 +16705,8 @@ components: - body - message_type multiple_filter_search_request: + title: Multiple Filter Search Request + description: Search using Intercoms Search APIs with more than one filter. type: object properties: operator: @@ -17219,6 +17193,102 @@ components: "$ref": "#/components/schemas/starting_after_paging" required: - query + section: + title: Section + type: object + x-tags: + - Help Center + description: Sections are subdivisions of a collection, with a collection potentially + having multiple sections. + properties: + type: + type: string + description: The type of object - `section`. + enum: + - section + default: section + example: section + id: + type: string + description: The unique identifier for the section which is given by Intercom. + example: '6871119' + workspace_id: + type: string + description: The id of the workspace which the section belongs to. + example: hfi1bx4l + name: + type: string + description: The name of the section. For multilingual sections, this will + be the name of the default language's content. + example: Default language name + created_at: + type: integer + format: date-time + description: The time when the section was created. For multilingual sections, + this will be the timestamp of creation of the default language's content. + example: 1672928359 + updated_at: + type: integer + format: date-time + description: The time when the section was last updated. For multilingual + sections, this will be the timestamp of last update of the default language's + content. + example: 1672928610 + url: + type: string + nullable: true + description: The URL of the section. For multilingual help centers, this + will be the URL of the section for the default language. + example: http://intercom.test/help/section/name + icon: + type: string + nullable: true + description: The icon of the section. + example: book-bookmark + order: + type: integer + description: The order of the section in relation to others sections within + a collection. Values go from `0` upwards. `0` is the default if there's + no order. + example: '1' + parent_id: + oneOf: + - type: integer + title: Integer + - type: string + title: String + description: The id of the parent section. + example: 6871119 + default_locale: + type: string + description: The default locale of the help center. This field is only returned + for multilingual help centers. + example: en + translated_content: + nullable: true + "$ref": "#/components/schemas/group_translated_content" + section_list: + title: Sections + type: object + description: This will return a list of Sections for the App. + properties: + type: + type: string + description: The type of the object - `list`. + enum: + - list + example: list + pages: + "$ref": "#/components/schemas/cursor_pages" + total_count: + type: integer + description: A count of the total number of sections. + example: 12 + data: + type: array + description: An array of section objects + items: + "$ref": "#/components/schemas/section" segment: title: Segment type: object @@ -17284,12 +17354,14 @@ components: description: A pagination object, which may be empty, indicating no further pages to fetch. single_filter_search_request: + title: Single Filter Search Request + description: Search using Intercoms Search APIs with a single filter. type: object properties: field: type: string - description: The Intercom defined id representing the company. - example: custom_attributes.social_network + description: The accepted field that you want to search on. + example: created_at operator: type: string enum: @@ -17303,12 +17375,13 @@ components: - "!~" - "^" - "$" - description: The Intercom defined id representing the company. - example: "=" + description: The accepted operators you can use to define how you want to + search for the value. + example: ">" value: type: string - description: The Intercom defined id representing the company. - example: facebook + description: The value that you want to search on. + example: '73732934' sla_applied: title: Applied SLA type: object @@ -17381,16 +17454,20 @@ components: description: The name of the Social media profile example: http://twitter.com/th1sland starting_after_paging: - title: StartingAfterPaging + title: 'Pagination: Starting After' type: object nullable: true properties: - page: + per_page: type: integer + description: The number of results to fetch per page. example: 2 starting_after: type: string - example: 1HaSB+xrOyyMXAkS/c1RteCL7BzOzTvYjmjakgTergIH31eoe2v4/sbLsJWP\nIncfQLD3ouPkZlCwJ86F\n + description: The cursor to use in the next request to get the next page + of results. + nullable: true + example: your-cursor-from-response subscription_type: title: Subscription Types type: object @@ -17778,6 +17855,54 @@ components: example: 12345 pages: "$ref": "#/components/schemas/cursor_pages" + ticket_note: + title: A Ticket Part representing a note + type: object + description: A Ticket Part representing a note in the ticket + properties: + type: + type: string + description: Always ticket_part + example: ticket_part + enum: + - ticket_part + id: + type: string + description: The id representing the note. + example: '3' + part_type: + type: string + description: Always note + example: note + enum: + - note + body: + type: string + nullable: true + description: The message body, which may contain HTML. + example: "

    Okay!

    " + created_at: + type: integer + format: date-time + description: The time the note was created. + example: 1663597223 + updated_at: + type: integer + format: date-time + description: The last time the note was updated. + example: 1663597260 + author: + "$ref": "#/components/schemas/ticket_part_author" + attachments: + title: Ticket part attachments + type: array + description: A list of attachments for the part. + items: + "$ref": "#/components/schemas/part_attachment" + redacted: + type: boolean + description: Whether or not the ticket part has been redacted. + example: false ticket_part: title: Ticket Part type: object @@ -18441,6 +18566,23 @@ components: - url - locale - source_id + update_section_request: + description: You can update a Section + type: object + title: Update Section Request Payload + properties: + name: + type: string + description: The name of the collection. For multilingual collections, this + will be the name of the default language's content. + example: Section 51 + parent_id: + type: integer + description: The id for the collection this section will be within. + example: 18 + translated_content: + nullable: true + "$ref": "#/components/schemas/group_translated_content" update_ticket_request: description: You can update a Ticket type: object @@ -18915,6 +19057,8 @@ tags: You can then iterate through the content from that source via its API and POST it to the External Pages endpoint. That endpoint has an *external_id* parameter which allows you to specify the identifier from the source. The endpoint will then either create a new External Page or update an existing one as appropriate.", - name: Articles description: Everything about your Articles +- name: Calls + description: Everything about your Calls - name: Companies description: Everything about your Companies - name: Contacts diff --git a/descriptions/2.10/api.intercom.io.yaml b/descriptions/2.10/api.intercom.io.yaml index 8de3e2d..3facfa2 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: '991282282' + id: '991270928' 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: 1712222856 + created_at: 1715077406 secure: false identity_verification: false timezone: America/Los_Angeles @@ -83,7 +83,7 @@ paths: Successful response: value: type: admin - id: '991282283' + id: '991270929' 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: b3148b57-0832-4923-b370-e8d379653672 + request_id: 2421ecd4-99e9-4379-bc79-23b26e0e02bb errors: - code: admin_not_found message: Admin for admin_id not found @@ -114,7 +114,7 @@ paths: Unauthorized: value: type: error.list - request_id: 605017bc-f2f7-4804-8de8-44314b46b5c3 + request_id: b342bb22-2468-4a98-9276-3884817b04bb errors: - code: unauthorized message: Access Token Invalid @@ -201,10 +201,10 @@ paths: per_page: 20 total_pages: 1 activity_logs: - - id: aa756aa6-6876-41df-8a61-12a725928dca + - id: 997dd8e8-8c29-4846-8455-abfd2f5e8753 performed_by: type: admin - id: '991282286' + id: '991270933' email: admin5@email.com ip: 127.0.0.1 metadata: @@ -213,21 +213,21 @@ paths: title: Initial message title before: Initial message title after: Eventual message title - created_at: 1712222861 + created_at: 1715077411 activity_type: message_state_change activity_description: Ciaran5 Lee changed your Initial message title message from Initial message title to Eventual message title. - - id: f8f4f90d-16b3-4d0e-ad27-61bcd732b216 + - id: 3d2a6e4e-f1b7-4d58-b50d-76be9ada3f22 performed_by: type: admin - id: '991282286' + id: '991270933' email: admin5@email.com ip: 127.0.0.1 metadata: before: before after: after - created_at: 1712222861 + created_at: 1715077411 activity_type: app_name_change activity_description: Ciaran5 Lee changed your app name from before to after. @@ -241,7 +241,7 @@ paths: Unauthorized: value: type: error.list - request_id: 3c66f663-8da6-4bc2-881e-f6897ce6c5fe + request_id: 49577be4-c240-4476-a50e-ac170d36c8fb errors: - code: unauthorized message: Access Token Invalid @@ -271,7 +271,7 @@ paths: admins: - type: admin email: admin7@email.com - id: '991282288' + id: '991270935' name: Ciaran7 Lee away_mode_enabled: false away_mode_reassign: false @@ -287,7 +287,7 @@ paths: Unauthorized: value: type: error.list - request_id: f0417635-c7b8-4838-8dc9-3cf8928cc741 + request_id: 8a38e5ba-e63c-4345-92b9-b5e60add4a95 errors: - code: unauthorized message: Access Token Invalid @@ -321,7 +321,7 @@ paths: Admin found: value: type: admin - id: '991282290' + id: '991270937' 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: f56a4eac-2b37-4616-b413-258c6e5b9f42 + request_id: f9c7e45d-ab01-416d-bf48-da16de157441 errors: - code: admin_not_found message: Admin not found @@ -352,7 +352,7 @@ paths: Unauthorized: value: type: error.list - request_id: 66a8d55a-0db5-4e0f-856d-4bd19b5fdbe7 + request_id: ca779380-1011-4d4d-aa15-1dbdc981bf1a errors: - code: unauthorized message: Access Token Invalid @@ -390,20 +390,20 @@ paths: total_pages: 1 total_count: 1 data: - - id: '620' + - id: '160' type: article workspace_id: this_is_an_id22_that_should_be_at_least_4 - parent_id: 2514 + parent_id: 646 parent_type: collection parent_ids: [] title: This is the article title description: '' body: '' - author_id: 991282293 + author_id: 991270940 state: published - created_at: 1712222867 - updated_at: 1712222867 - url: http://help-center.test/myapp-22/en/articles/620-this-is-the-article-title + created_at: 1715077416 + updated_at: 1715077416 + 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: 93d0798c-d7f6-4df9-9da7-47246ccb80ba + request_id: 5a601154-1106-4ddd-b15d-dd004bdb61e0 errors: - code: unauthorized message: Access Token Invalid @@ -439,10 +439,10 @@ paths: examples: article created: value: - id: '623' + id: '163' type: article workspace_id: this_is_an_id26_that_should_be_at_least_4 - parent_id: 2516 + 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: 991282298 + author_id: 991270945 state: published - created_at: 1712222869 - updated_at: 1712222869 - url: http://help-center.test/myapp-26/en/articles/623-thanks-for-everything + created_at: 1715077418 + updated_at: 1715077418 + 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: e7dd045b-0e36-4d45-94c5-b36e7d25ed8f + request_id: a99f16d3-58a4-47d4-9e09-a982682c028d 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: 4978fe69-3601-4e13-b6c3-e82b2b713288 + request_id: 67df9f5f-260c-4396-a7e4-42fbbd865f76 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: 991282298 + author_id: 991270945 state: published - parent_id: 2516 + 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: 991282298 + author_id: 991270945 state: published bad_request: summary: Bad Request @@ -550,10 +550,10 @@ paths: examples: Article found: value: - id: '626' + id: '166' type: article workspace_id: this_is_an_id32_that_should_be_at_least_4 - parent_id: 2519 + parent_id: 651 parent_type: collection parent_ids: [] statistics: @@ -567,11 +567,11 @@ paths: title: This is the article title description: '' body: '' - author_id: 991282303 + author_id: 991270950 state: published - created_at: 1712222871 - updated_at: 1712222871 - url: http://help-center.test/myapp-32/en/articles/626-this-is-the-article-title + created_at: 1715077420 + updated_at: 1715077420 + 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: ab8070c0-2c88-4e20-825d-25e3f088cd01 + request_id: 1c4b0d27-6983-4ae7-be1e-fc1d6526f06e errors: - code: not_found message: Resource Not Found @@ -596,7 +596,7 @@ paths: Unauthorized: value: type: error.list - request_id: 7f39b002-8a2b-470d-8597-390d681e412d + request_id: 380cc1b2-8a38-477a-9eee-51e2c96c1822 errors: - code: unauthorized message: Access Token Invalid @@ -629,10 +629,10 @@ paths: examples: successful: value: - id: '629' + id: '169' type: article workspace_id: this_is_an_id38_that_should_be_at_least_4 - parent_id: 2522 + 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: 991282309 + author_id: 991270956 state: published - created_at: 1712222873 - updated_at: 1712222874 - url: http://help-center.test/myapp-38/en/articles/629-christmas-is-here + created_at: 1715077422 + updated_at: 1715077423 + 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: f197b6bc-7913-41aa-9205-501758f13190 + request_id: c1fa5e60-22b4-48bc-94ec-13a2378fcad0 errors: - code: not_found message: Resource Not Found @@ -675,7 +675,7 @@ paths: Unauthorized: value: type: error.list - request_id: abf4bc91-02e8-4e4a-9836-e1837ff866dd + request_id: f6d43a22-c33a-4ed7-bbf7-0d0f1f8b348d errors: - code: unauthorized message: Access Token Invalid @@ -723,7 +723,7 @@ paths: examples: successful: value: - id: '632' + id: '172' object: article deleted: true schema: @@ -736,7 +736,7 @@ paths: Article Not Found: value: type: error.list - request_id: a0d6a575-dd38-4a7f-85dd-b8be3b76f2fa + request_id: 1ea1dee9-b266-4c41-94c9-3a1be6405989 errors: - code: not_found message: Resource Not Found @@ -750,7 +750,7 @@ paths: Unauthorized: value: type: error.list - request_id: 768c4d38-c0cf-447c-a883-2a327e6fc5e6 + request_id: 34e4d60e-c3ac-4c78-8703-38eb54150c96 errors: - code: unauthorized message: Access Token Invalid @@ -810,7 +810,7 @@ paths: total_count: 1 data: articles: - - id: '636' + - id: '176' 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: 991282322 + author_id: 991270969 state: draft - created_at: 1712222878 - updated_at: 1712222878 + created_at: 1715077426 + updated_at: 1715077426 url: highlights: [] pages: @@ -840,7 +840,7 @@ paths: Unauthorized: value: type: error.list - request_id: bf15fea2-1b26-471a-bbf4-7a8fed81e9e4 + request_id: 95f43352-dee5-4c92-a33a-94a8ae96e621 errors: - code: unauthorized message: Access Token Invalid @@ -871,27 +871,27 @@ paths: value: type: list data: - - id: '2530' + - id: '662' 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: 1712222879 - updated_at: 1712222879 + created_at: 1715077428 + updated_at: 1715077428 description: english collection description icon: bookmark parent_id: - help_center_id: 1230 - - id: '2531' + help_center_id: 326 + - id: '663' 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: 1712222879 - updated_at: 1712222879 + created_at: 1715077428 + updated_at: 1715077428 description: icon: bookmark - parent_id: '2530' + parent_id: '662' help_center_id: total_count: 2 pages: @@ -909,7 +909,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8076adda-d6ed-468a-ac0c-1ffb587cb358 + request_id: 1f323b93-daad-46a9-8400-2b629562d400 errors: - code: unauthorized message: Access Token Invalid @@ -934,17 +934,17 @@ paths: examples: collection created: value: - id: '2536' + id: '668' 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: 1712222881 - updated_at: 1712222881 + created_at: 1715077429 + updated_at: 1715077429 description: '' icon: book-bookmark parent_id: - help_center_id: 1232 + help_center_id: 328 schema: "$ref": "#/components/schemas/collection" '400': @@ -955,7 +955,7 @@ paths: Bad Request: value: type: error.list - request_id: 0e353cb7-748e-4a4b-9120-83aefdaeaa45 + request_id: 678b0ad9-61ae-4085-be8c-620d2ae017c3 errors: - code: parameter_not_found message: Name is a required parameter. @@ -969,7 +969,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0b0ad42f-762d-44c0-a33f-3d6eada6bfd6 + request_id: 626ff37c-fa62-4b9f-adff-0bbc1a183a07 errors: - code: unauthorized message: Access Token Invalid @@ -1017,17 +1017,17 @@ paths: examples: Collection found: value: - id: '2541' + id: '673' 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: 1712222882 - updated_at: 1712222882 + created_at: 1715077430 + updated_at: 1715077430 description: english collection description icon: bookmark parent_id: - help_center_id: 1235 + help_center_id: 331 schema: "$ref": "#/components/schemas/collection" '404': @@ -1038,7 +1038,7 @@ paths: Collection not found: value: type: error.list - request_id: 7aa2a04e-be0f-40ab-887b-68a9471bd2d1 + request_id: b0a63228-2a8f-4d62-92b2-afd969cdf46c errors: - code: not_found message: Resource Not Found @@ -1052,7 +1052,7 @@ paths: Unauthorized: value: type: error.list - request_id: 39f1842c-a3b1-4b22-931b-a0671e73b1f1 + request_id: b4ed1917-19dd-48e7-acb1-19096547e3e8 errors: - code: unauthorized message: Access Token Invalid @@ -1085,17 +1085,17 @@ paths: examples: successful: value: - id: '2547' + id: '679' 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: 1712222884 - updated_at: 1712222884 + created_at: 1715077431 + updated_at: 1715077432 description: english collection description icon: folder parent_id: - help_center_id: 1238 + help_center_id: 334 schema: "$ref": "#/components/schemas/collection" '404': @@ -1106,7 +1106,7 @@ paths: Collection Not Found: value: type: error.list - request_id: 9235bd0e-09df-4757-ab5a-1494377e3fdc + request_id: d35dd57b-c63d-4c82-b478-83d14aa0e8c5 errors: - code: not_found message: Resource Not Found @@ -1120,7 +1120,7 @@ paths: Unauthorized: value: type: error.list - request_id: ab6b48f1-1f55-47d7-9ac5-2eb14dfd030c + request_id: c7b48326-d5d4-495b-bbaf-f9d5cd38a0c6 errors: - code: unauthorized message: Access Token Invalid @@ -1167,7 +1167,7 @@ paths: examples: successful: value: - id: '2553' + id: '685' object: collection deleted: true schema: @@ -1180,7 +1180,7 @@ paths: collection Not Found: value: type: error.list - request_id: d2015db1-4a43-45e5-a0a9-505705eea000 + request_id: 50ed6876-b230-4d66-bfca-025c9b026419 errors: - code: not_found message: Resource Not Found @@ -1194,7 +1194,7 @@ paths: Unauthorized: value: type: error.list - request_id: c158ea75-7171-4e84-9f8d-2faa9c48f0fa + request_id: f084582a-1130-4d07-911b-d799065d5026 errors: - code: unauthorized message: Access Token Invalid @@ -1228,10 +1228,10 @@ paths: examples: Collection found: value: - id: '1244' + id: '340' workspace_id: this_is_an_id82_that_should_be_at_least_4 - created_at: 1712222887 - updated_at: 1712222887 + created_at: 1715077435 + updated_at: 1715077435 identifier: help-center-1 website_turned_on: false display_name: Intercom Help Center @@ -1245,7 +1245,7 @@ paths: Collection not found: value: type: error.list - request_id: c044c3bd-077d-48d2-987a-f2a4b3a818a3 + request_id: afe1834c-50ef-4bcf-87bc-05fbe2dd27f3 errors: - code: not_found message: Resource Not Found @@ -1259,7 +1259,7 @@ paths: Unauthorized: value: type: error.list - request_id: b1d6dd9d-4321-40be-9407-ae0d6e83ddcd + request_id: b478c970-eaf9-465f-a688-8717953ff8bd errors: - code: unauthorized message: Access Token Invalid @@ -1297,7 +1297,7 @@ paths: Unauthorized: value: type: error.list - request_id: d1cf0bcb-6876-491c-98e3-80accd0168ae + request_id: d81edb45-ca47-40cf-9e60-61df09a5e1a8 errors: - code: unauthorized message: Access Token Invalid @@ -1334,12 +1334,12 @@ paths: value: type: company company_id: company_remote_id - id: 660e72ac6abd01bd27af60cf + id: 663a013f914417f88d1d8bdb app_id: this_is_an_id105_that_should_be_at_least_ name: my company remote_created_at: 1374138000 - created_at: 1712222892 - updated_at: 1712222892 + created_at: 1715077439 + updated_at: 1715077439 monthly_spend: 0 session_count: 0 user_count: 0 @@ -1376,7 +1376,7 @@ paths: Unauthorized: value: type: error.list - request_id: d35f2281-f636-40a4-a94b-f1b0f530ff5b + request_id: bd08f239-ccee-4ee0-b64b-3931e0f447e7 errors: - code: unauthorized message: Access Token Invalid @@ -1474,12 +1474,12 @@ paths: data: - type: company company_id: remote_companies_scroll_2 - id: 660e72ae6abd01bd27af60d7 + id: 663a0141914417f88d1d8be3 app_id: this_is_an_id111_that_should_be_at_least_ name: IntercomQATest1 - remote_created_at: 1712222894 - created_at: 1712222894 - updated_at: 1712222894 + remote_created_at: 1715077441 + created_at: 1715077441 + updated_at: 1715077441 monthly_spend: 0 session_count: 0 user_count: 4 @@ -1508,7 +1508,7 @@ paths: Company Not Found: value: type: error.list - request_id: a5a91f6c-a403-4e35-9f4d-600a6456e991 + request_id: acb09b15-3620-426e-b613-48c7db5713d8 errors: - code: company_not_found message: Company Not Found @@ -1522,7 +1522,7 @@ paths: Unauthorized: value: type: error.list - request_id: 6dee17a9-883a-49c4-b500-33daa6bc6b73 + request_id: d3b275ef-4ae9-4dc7-9409-382892284c9b errors: - code: unauthorized message: Access Token Invalid @@ -1557,12 +1557,12 @@ paths: value: type: company company_id: '1' - id: 660e72b06abd01bd27af60e2 + id: 663a0143914417f88d1d8bee app_id: this_is_an_id117_that_should_be_at_least_ name: company1 - remote_created_at: 1712222896 - created_at: 1712222896 - updated_at: 1712222896 + remote_created_at: 1715077443 + created_at: 1715077443 + updated_at: 1715077443 monthly_spend: 0 session_count: 0 user_count: 1 @@ -1584,7 +1584,7 @@ paths: Company Not Found: value: type: error.list - request_id: 4d4ef244-2c89-41be-b25e-55b9d67e8b0e + request_id: 467d73dc-99cf-44bb-87fb-91107aea524d errors: - code: company_not_found message: Company Not Found @@ -1598,7 +1598,7 @@ paths: Unauthorized: value: type: error.list - request_id: 86aee5da-9caa-4693-9ca1-b5af922d8aa1 + request_id: b6940f73-f270-467d-bfe9-2b58f09c5127 errors: - code: unauthorized message: Access Token Invalid @@ -1637,12 +1637,12 @@ paths: value: type: company company_id: '1' - id: 660e72b26abd01bd27af60ec + id: 663a0145914417f88d1d8bf8 app_id: this_is_an_id123_that_should_be_at_least_ name: company2 - remote_created_at: 1712222898 - created_at: 1712222898 - updated_at: 1712222898 + remote_created_at: 1715077445 + created_at: 1715077445 + updated_at: 1715077445 monthly_spend: 0 session_count: 0 user_count: 1 @@ -1664,7 +1664,7 @@ paths: Company Not Found: value: type: error.list - request_id: 1544a9b8-bc30-41cf-98a3-517ec247975d + request_id: b6d35115-9040-4e08-82f2-559cb845bf26 errors: - code: company_not_found message: Company Not Found @@ -1678,7 +1678,7 @@ paths: Unauthorized: value: type: error.list - request_id: 37eae7d7-b1bf-4178-9540-2a768db8213c + request_id: b2368c0a-341c-4b8e-9f04-7142f6fc5dfe errors: - code: unauthorized message: Access Token Invalid @@ -1710,7 +1710,7 @@ paths: examples: Successful: value: - id: 660e72b46abd01bd27af60f6 + id: 663a0147914417f88d1d8c02 object: company deleted: true schema: @@ -1723,7 +1723,7 @@ paths: Company Not Found: value: type: error.list - request_id: 775d0b64-3b7d-490d-85f7-8844285a25c9 + request_id: cb0bdd4c-c6c8-4b5b-86f5-50a8883bd1d3 errors: - code: company_not_found message: Company Not Found @@ -1737,7 +1737,7 @@ paths: Unauthorized: value: type: error.list - request_id: f40703da-ca02-46ab-af36-6ec3acc009ca + request_id: 732fbe28-17cb-40ec-8bca-b8e3c92545cb errors: - code: unauthorized message: Access Token Invalid @@ -1789,7 +1789,7 @@ paths: Company Not Found: value: type: error.list - request_id: 4402d85a-b61c-4c34-adc9-6df798de302b + request_id: 36a7f78d-4489-4ed2-8257-a2b00a4cc3a7 errors: - code: company_not_found message: Company Not Found @@ -1803,7 +1803,7 @@ paths: Unauthorized: value: type: error.list - request_id: 72fa2d31-5f84-4ad2-b2a2-126c31bb8587 + request_id: 3ddf8974-498e-41a4-b7d9-faf8b120e80c errors: - code: unauthorized message: Access Token Invalid @@ -1848,7 +1848,7 @@ paths: Company Not Found: value: type: error.list - request_id: d5008e51-ca26-43d9-bf67-4025de384b3a + request_id: 35ae3ad0-7305-4f21-a204-58831e197511 errors: - code: company_not_found message: Company Not Found @@ -1862,7 +1862,7 @@ paths: Unauthorized: value: type: error.list - request_id: b66fdf27-c887-4a1a-a70f-bc3dd1b3f332 + request_id: 619f3748-611b-4f4b-bf7e-bde4f42225c4 errors: - code: unauthorized message: Access Token Invalid @@ -1879,14 +1879,14 @@ paths: - name: page in: query required: false - description: what page of results to fetch. Defaults to first page + description: The page of results to fetch. Defaults to first page example: 1 schema: type: integer - name: per_page in: query required: false - description: how many results per page. Defaults to 15 + description: How many results to return per page. Defaults to 15 example: 15 schema: type: integer @@ -1907,6 +1907,10 @@ paths: Note that the API does not include companies who have no associated users in list responses. When using the Companies endpoint and the pages object to iterate through the returned companies, there is a limit of 10,000 Companies that can be returned. If you need to list or iterate on more than 10,000 Companies, please use the [Scroll API](https://developers.intercom.com/reference#iterating-over-all-companies). + {% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `20` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. + {% /admonition %} responses: '200': description: Successful @@ -1919,12 +1923,12 @@ paths: data: - type: company company_id: remote_companies_scroll_2 - id: 660e72ba6abd01bd27af6112 + id: 663a014e914417f88d1d8c1e app_id: this_is_an_id147_that_should_be_at_least_ name: IntercomQATest1 - remote_created_at: 1712222906 - created_at: 1712222906 - updated_at: 1712222906 + remote_created_at: 1715077454 + created_at: 1715077454 + updated_at: 1715077454 monthly_spend: 0 session_count: 0 user_count: 4 @@ -1953,7 +1957,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2daa4c56-0059-4fca-aa2d-6894d25254fb + request_id: 8a393ae9-2d00-41ac-bf25-dbe4218d3917 errors: - code: unauthorized message: Access Token Invalid @@ -1976,23 +1980,22 @@ paths: tags: - Companies operationId: scrollOverAllCompanies - description: " The `list all companies` functionality does not work well - for huge datasets, and can result in errors and performance problems when - paging deeply. The Scroll API provides an efficient mechanism for iterating - over all companies in a dataset.\n\n- Each app can only have 1 scroll open - at a time. You'll get an error message if you try to have more than one open - per app.\n- If the scroll isn't used for 1 minute, it expires and calls with - that scroll param will fail\n- If the end of the scroll is reached, \"companies\" - will be empty and the scroll parameter will expire\n\n> \U0001F4D8 Scroll - Parameter\n>\n> You can get the first page of companies by simply sending - a GET request to the scroll endpoint. For subsequent requests you will need - to use the scroll parameter from the response.\n\n> ❗️ Scroll network timeouts\n>\n> - Since scroll is often used on large datasets network errors such as timeouts - can be encountered. When this occurs you will need to restart your scroll - query as it is not possible to continue from a specific point when using scroll.\n>\n> - When this occurs you will see a HTTP 500 error with the following message:\n> - \"Request failed due to an internal network error. Please restart the scroll - operation.\"\n" + description: |2 + The `list all companies` functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. The Scroll API provides an efficient mechanism for iterating over all companies in a dataset. + + - Each app can only have 1 scroll open at a time. You'll get an error message if you try to have more than one open per app. + - If the scroll isn't used for 1 minute, it expires and calls with that scroll param will fail + - If the end of the scroll is reached, "companies" will be empty and the scroll parameter will expire + + {% admonition type="info" name="Scroll Parameter" %} + You can get the first page of companies by simply sending a GET request to the scroll endpoint. + For subsequent requests you will need to use the scroll parameter from the response. + {% /admonition %} + {% admonition type="danger" name="Scroll network timeouts" %} + Since scroll is often used on large datasets network errors such as timeouts can be encountered. When this occurs you will see a HTTP 500 error with the following message: + "Request failed due to an internal network error. Please restart the scroll operation." + If this happens, you will need to restart your scroll query: It is not possible to continue from a specific point when using scroll. + {% /admonition %} responses: '200': description: Successful @@ -2005,12 +2008,12 @@ paths: data: - type: company company_id: remote_companies_scroll_2 - id: 660e72bb6abd01bd27af6118 + id: 663a014f914417f88d1d8c24 app_id: this_is_an_id151_that_should_be_at_least_ name: IntercomQATest1 - remote_created_at: 1712222907 - created_at: 1712222907 - updated_at: 1712222907 + remote_created_at: 1715077455 + created_at: 1715077455 + updated_at: 1715077455 monthly_spend: 0 session_count: 0 user_count: 4 @@ -2024,7 +2027,7 @@ paths: custom_attributes: {} pages: total_count: - scroll_param: 5ff562e0-dcba-45bb-a6ca-ec9dcf49bb0f + scroll_param: 27079d6c-d474-4193-aef3-c538bc85bc5d schema: "$ref": "#/components/schemas/company_scroll" '401': @@ -2035,7 +2038,7 @@ paths: Unauthorized: value: type: error.list - request_id: b031f704-6ee6-47e5-8b0b-229d0b7ae7e5 + request_id: d20e96e7-7a1a-4ffb-98f1-38068d1c6a93 errors: - code: unauthorized message: Access Token Invalid @@ -2070,12 +2073,12 @@ paths: value: type: company company_id: '1' - id: 660e72bd6abd01bd27af6121 + id: 663a0151914417f88d1d8c2d app_id: this_is_an_id155_that_should_be_at_least_ name: company6 - remote_created_at: 1712222909 - created_at: 1712222909 - updated_at: 1712222909 + remote_created_at: 1715077457 + created_at: 1715077457 + updated_at: 1715077457 monthly_spend: 0 session_count: 0 user_count: 1 @@ -2097,7 +2100,7 @@ paths: Bad Request: value: type: error.list - request_id: 006c649a-1b22-498e-a40d-9adccaf0b3d8 + request_id: c0e48c32-d556-4bd6-ba57-8e3237191d74 errors: - code: parameter_not_found message: company not specified @@ -2111,7 +2114,7 @@ paths: Company Not Found: value: type: error.list - request_id: 880ef525-2b76-4582-b6ee-1ceeb04937cc + request_id: 929f4ffe-9d02-4f14-8427-35830390b570 errors: - code: company_not_found message: Company Not Found @@ -2125,7 +2128,7 @@ paths: Unauthorized: value: type: error.list - request_id: 55a53828-88b8-4d6d-9354-8b48afe472b0 + request_id: 0c579743-c16e-4c0f-9824-c1659b70d992 errors: - code: unauthorized message: Access Token Invalid @@ -2148,7 +2151,7 @@ paths: successful: summary: Successful value: - id: 660e72bd6abd01bd27af6121 + id: 663a0151914417f88d1d8c2d bad_request: summary: Bad Request value: @@ -2187,13 +2190,13 @@ paths: data: - type: company company_id: '1' - id: 660e72c36abd01bd27af6142 + id: 663a0157914417f88d1d8c4e app_id: this_is_an_id171_that_should_be_at_least_ name: company12 - remote_created_at: 1712222915 - created_at: 1712222915 - updated_at: 1712222915 - last_request_at: 1712050115 + remote_created_at: 1715077463 + created_at: 1715077463 + updated_at: 1715077463 + last_request_at: 1714904663 monthly_spend: 0 session_count: 0 user_count: 1 @@ -2222,7 +2225,7 @@ paths: Contact not found: value: type: error.list - request_id: ca3baf03-5f2e-4440-a037-e30bc7549d51 + request_id: 63a6a3bf-465f-4cb1-bde0-6f5f8f5bf084 errors: - code: not_found message: User Not Found @@ -2236,7 +2239,7 @@ paths: Unauthorized: value: type: error.list - request_id: d3096c67-8ef1-49ef-817d-42ebdc3e60e6 + request_id: 8b50ddd1-b021-4565-b21a-4db434b9eac9 errors: - code: unauthorized message: Access Token Invalid @@ -2279,12 +2282,12 @@ paths: value: type: company company_id: '1' - id: 660e72c06abd01bd27af6131 + id: 663a0154914417f88d1d8c3d app_id: this_is_an_id163_that_should_be_at_least_ name: company8 - remote_created_at: 1712222912 - created_at: 1712222912 - updated_at: 1712222912 + remote_created_at: 1715077460 + created_at: 1715077460 + updated_at: 1715077460 monthly_spend: 0 session_count: 0 user_count: 0 @@ -2306,14 +2309,14 @@ paths: Company Not Found: value: type: error.list - request_id: bd738bec-fc20-44bd-9e42-c30f6d424a0d + request_id: 387c769d-6a90-411f-aac6-62c0acfdc0b5 errors: - code: company_not_found message: Company Not Found Contact Not Found: value: type: error.list - request_id: c47b082c-f3b3-4e9a-b090-c38ab04e1eb5 + request_id: 6018d91a-2eb9-46df-93bc-f924bfcba481 errors: - code: not_found message: User Not Found @@ -2327,7 +2330,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8f58415d-eec3-4266-b6cc-947b07d6cbbe + request_id: 7a429739-2e09-4f1b-97c8-9ef3ecdfacf3 errors: - code: unauthorized message: Access Token Invalid @@ -2363,42 +2366,42 @@ paths: type: list data: - type: note - id: '439' - created_at: 1711618117 + id: '120' + created_at: 1714472666 contact: type: contact - id: 660e72c56abd01bd27af614d + id: 663a015a914417f88d1d8c59 author: type: admin - id: '991282382' + id: '991271029' name: Ciaran101 Lee email: admin101@email.com away_mode_enabled: false away_mode_reassign: false body: "

    This is a note.

    " - type: note - id: '438' - created_at: 1711531717 + id: '119' + created_at: 1714386266 contact: type: contact - id: 660e72c56abd01bd27af614d + id: 663a015a914417f88d1d8c59 author: type: admin - id: '991282382' + id: '991271029' name: Ciaran101 Lee email: admin101@email.com away_mode_enabled: false away_mode_reassign: false body: "

    This is a note.

    " - type: note - id: '437' - created_at: 1711531717 + id: '118' + created_at: 1714386266 contact: type: contact - id: 660e72c56abd01bd27af614d + id: 663a015a914417f88d1d8c59 author: type: admin - id: '991282382' + id: '991271029' name: Ciaran101 Lee email: admin101@email.com away_mode_enabled: false @@ -2421,7 +2424,7 @@ paths: Contact not found: value: type: error.list - request_id: 2323554d-e2c6-47bc-a4fd-3595bf3a999c + request_id: d047289d-64cf-42ec-a070-16d77a2318df errors: - code: not_found message: User Not Found @@ -2455,14 +2458,14 @@ paths: Successful response: value: type: note - id: '444' - created_at: 1712222918 + id: '125' + created_at: 1715077467 contact: type: contact - id: 660e72c66abd01bd27af614f + id: 663a015b914417f88d1d8c5b author: type: admin - id: '991282384' + id: '991271031' name: Ciaran103 Lee email: admin103@email.com away_mode_enabled: false @@ -2478,14 +2481,14 @@ paths: Admin not found: value: type: error.list - request_id: 6e1985e1-0d58-42c5-b4b0-8ccb1ebd9549 + request_id: c25c09c7-57a7-4e95-8a29-887e673cabfc errors: - code: not_found message: Resource Not Found Contact not found: value: type: error.list - request_id: 573adfff-793d-45f5-a46b-f918ede53a00 + request_id: 860106e6-e505-4eb0-9b36-6b243cd17d8b errors: - code: not_found message: User Not Found @@ -2515,20 +2518,20 @@ paths: successful_response: summary: Successful response value: - contact_id: 660e72c66abd01bd27af614f - admin_id: 991282384 + contact_id: 663a015b914417f88d1d8c5b + admin_id: 991271031 body: Hello admin_not_found: summary: Admin not found value: - contact_id: 660e72c66abd01bd27af6150 + contact_id: 663a015c914417f88d1d8c5c admin_id: 123 body: Hello contact_not_found: summary: Contact not found value: contact_id: 123 - admin_id: 991282386 + admin_id: 991271033 body: Hello "/contacts/{contact_id}/segments": get: @@ -2561,10 +2564,10 @@ paths: type: list data: - type: segment - id: 660e72c86abd01bd27af6152 + id: 663a015d914417f88d1d8c5e name: segment - created_at: 1712222920 - updated_at: 1712222920 + created_at: 1715077469 + updated_at: 1715077469 person_type: user schema: "$ref": "#/components/schemas/contact_segments" @@ -2576,7 +2579,7 @@ paths: Contact not found: value: type: error.list - request_id: 7969b669-54ef-410c-b718-6fd0ff36b274 + request_id: 016d5f8c-539b-468c-b1b5-b98ffeab6582 errors: - code: not_found message: User Not Found @@ -2590,7 +2593,7 @@ paths: Unauthorized: value: type: error.list - request_id: c3bf2974-6ab8-4f79-90dc-1f53f17a90d4 + request_id: 6a90b053-00fd-4897-a1c1-1443aed6c6e6 errors: - code: unauthorized message: Access Token Invalid @@ -2634,7 +2637,7 @@ paths: type: list data: - type: subscription - id: '1561' + id: '415' state: live consent_type: opt_out default_translation: @@ -2648,7 +2651,7 @@ paths: content_types: - email - type: subscription - id: '1563' + id: '417' state: live consent_type: opt_in default_translation: @@ -2671,7 +2674,7 @@ paths: Contact not found: value: type: error.list - request_id: 75d0762d-b3c1-4c1c-bfa2-5e048dd8d6bb + request_id: 7b5f1303-5b4d-4725-af8f-534ee2890d7b errors: - code: not_found message: User Not Found @@ -2685,7 +2688,7 @@ paths: Unauthorized: value: type: error.list - request_id: f669529c-9769-4a95-a483-986c3e097cc1 + request_id: 612376b5-228a-44e7-b5b0-2b30cbb2749f errors: - code: unauthorized message: Access Token Invalid @@ -2726,7 +2729,7 @@ paths: Successful: value: type: subscription - id: '1576' + id: '430' state: live consent_type: opt_in default_translation: @@ -2749,14 +2752,14 @@ paths: Contact not found: value: type: error.list - request_id: ce501648-68fe-4dc6-9f32-77366139eab4 + request_id: 2bfecb7d-ea30-49af-94ec-9011b0d2fc66 errors: - code: not_found message: User Not Found Resource not found: value: type: error.list - request_id: 0f88688b-65cc-4b8b-9e7c-69aaeee4c0fa + request_id: 370beaf0-2380-4ab0-8f2a-b1eb7a95cb0b errors: - code: not_found message: Resource Not Found @@ -2770,7 +2773,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9383626a-ceeb-4c56-91ea-a0f9101f92b4 + request_id: ec0a22a0-63b6-43cc-b06b-4cf29263be94 errors: - code: unauthorized message: Access Token Invalid @@ -2798,12 +2801,12 @@ paths: successful: summary: Successful value: - id: 1576 + id: 430 consent_type: opt_in contact_not_found: summary: Contact not found value: - id: 1580 + id: 434 consent_type: opt_in resource_not_found: summary: Resource not found @@ -2849,7 +2852,7 @@ paths: Successful: value: type: subscription - id: '1592' + id: '446' state: live consent_type: opt_in default_translation: @@ -2872,14 +2875,14 @@ paths: Contact not found: value: type: error.list - request_id: b88ecace-7ab8-49d0-b6a9-99d44e4ebb0f + request_id: 5e689c96-cd8a-4114-adfb-b2bea51a3f85 errors: - code: not_found message: User Not Found Resource not found: value: type: error.list - request_id: 76a9dc4d-111f-4fd4-b503-1d2c4653b6f8 + request_id: 3b4c3029-58c7-460b-8ddb-101a57b8e06b errors: - code: not_found message: Resource Not Found @@ -2893,7 +2896,7 @@ paths: Unauthorized: value: type: error.list - request_id: a2e7adca-4db3-4223-ad4c-a4e64ebd1143 + request_id: f6dbee23-4b74-4d0e-9faf-e186de188849 errors: - code: unauthorized message: Access Token Invalid @@ -2931,7 +2934,7 @@ paths: type: list data: - type: tag - id: '1399' + id: '385' name: Manual tag schema: "$ref": "#/components/schemas/tag_list" @@ -2943,7 +2946,7 @@ paths: Contact not found: value: type: error.list - request_id: bed6fa53-2d1a-4c1e-bc5a-79eb0546bf46 + request_id: cec5bf70-2830-4b7a-8f4c-2fa50d444da7 errors: - code: not_found message: User Not Found @@ -2957,7 +2960,7 @@ paths: Unauthorized: value: type: error.list - request_id: 83df584e-1c76-4ecc-9b3a-d2b337567972 + request_id: 4d4bc856-f181-41f9-84d7-a815be998ec8 errors: - code: unauthorized message: Access Token Invalid @@ -2992,7 +2995,7 @@ paths: successful: value: type: tag - id: '1400' + id: '386' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -3004,14 +3007,14 @@ paths: Contact not found: value: type: error.list - request_id: 5c2a99ef-7799-40aa-9421-d029dedd109e + request_id: f38cd691-bb15-4931-937d-ef2c6d68305c errors: - code: not_found message: User Not Found Tag not found: value: type: error.list - request_id: ae32ca35-00ce-4fa4-8ed0-b1517ab10d37 + request_id: a1f33b73-07f7-4061-bb87-01e7973d4088 errors: - code: not_found message: Resource Not Found @@ -3025,7 +3028,7 @@ paths: Unauthorized: value: type: error.list - request_id: 88c774b4-c660-4c10-8c6e-754440470611 + request_id: cdb94d8d-e1df-4a28-8c5e-ae9f76aeae2c errors: - code: unauthorized message: Access Token Invalid @@ -3048,11 +3051,11 @@ paths: successful: summary: successful value: - id: 1400 + id: 386 contact_not_found: summary: Contact not found value: - id: 1401 + id: 387 tag_not_found: summary: Tag not found value: @@ -3094,7 +3097,7 @@ paths: successful: value: type: tag - id: '1403' + id: '389' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -3106,14 +3109,14 @@ paths: Contact not found: value: type: error.list - request_id: d0950757-567f-424b-a97c-2a82c47b6fd0 + request_id: 2d5919bf-e4c0-4a66-8a86-2af56b9e3f84 errors: - code: not_found message: User Not Found Tag not found: value: type: error.list - request_id: e172030f-9be5-4059-994b-e68475929a3b + request_id: 20f5dda3-d909-41eb-8211-33e999ffd542 errors: - code: not_found message: Resource Not Found @@ -3127,7 +3130,7 @@ paths: Unauthorized: value: type: error.list - request_id: cedd7f8f-9094-4b66-8611-b23c44357b0a + request_id: 81ea4f25-33f3-4665-8bad-c74d6c15ff7e errors: - code: unauthorized message: Access Token Invalid @@ -3161,7 +3164,7 @@ paths: successful: value: type: contact - id: 660e72d66abd01bd27af6169 + id: 663a016a914417f88d1d8c75 workspace_id: this_is_an_id237_that_should_be_at_least_ external_id: '70' role: user @@ -3176,9 +3179,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1712222934 - updated_at: 1712222934 - signed_up_at: 1712222934 + created_at: 1715077482 + updated_at: 1715077482 + signed_up_at: 1715077482 last_seen_at: last_replied_at: last_contacted_at: @@ -3212,31 +3215,31 @@ paths: tags: type: list data: [] - url: "/contacts/660e72d66abd01bd27af6169/tags" + url: "/contacts/663a016a914417f88d1d8c75/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/660e72d66abd01bd27af6169/notes" + url: "/contacts/663a016a914417f88d1d8c75/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/660e72d66abd01bd27af6169/companies" + url: "/contacts/663a016a914417f88d1d8c75/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/660e72d66abd01bd27af6169/subscriptions" + url: "/contacts/663a016a914417f88d1d8c75/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/660e72d66abd01bd27af6169/subscriptions" + url: "/contacts/663a016a914417f88d1d8c75/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3255,7 +3258,7 @@ paths: Unauthorized: value: type: error.list - request_id: 88a38072-9a53-400d-8f55-3cdd28d66862 + request_id: 3f734599-191e-4020-a31b-ca4339070e67 errors: - code: unauthorized message: Access Token Invalid @@ -3300,7 +3303,7 @@ paths: successful: value: type: contact - id: 660e72d76abd01bd27af616a + id: 663a016b914417f88d1d8c76 workspace_id: this_is_an_id241_that_should_be_at_least_ external_id: '70' role: user @@ -3315,9 +3318,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1712222935 - updated_at: 1712222935 - signed_up_at: 1712222935 + created_at: 1715077483 + updated_at: 1715077483 + signed_up_at: 1715077483 last_seen_at: last_replied_at: last_contacted_at: @@ -3351,31 +3354,31 @@ paths: tags: type: list data: [] - url: "/contacts/660e72d76abd01bd27af616a/tags" + url: "/contacts/663a016b914417f88d1d8c76/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/660e72d76abd01bd27af616a/notes" + url: "/contacts/663a016b914417f88d1d8c76/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/660e72d76abd01bd27af616a/companies" + url: "/contacts/663a016b914417f88d1d8c76/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/660e72d76abd01bd27af616a/subscriptions" + url: "/contacts/663a016b914417f88d1d8c76/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/660e72d76abd01bd27af616a/subscriptions" + url: "/contacts/663a016b914417f88d1d8c76/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3394,7 +3397,7 @@ paths: Unauthorized: value: type: error.list - request_id: 6c148188-26e2-4b5d-a8db-a845aa344840 + request_id: 4f9195ed-1e2e-41bc-b8b7-a1569eb05485 errors: - code: unauthorized message: Access Token Invalid @@ -3425,7 +3428,7 @@ paths: examples: successful: value: - id: 660e72d96abd01bd27af616b + id: 663a016c914417f88d1d8c77 external_id: '70' type: contact deleted: true @@ -3439,7 +3442,7 @@ paths: Unauthorized: value: type: error.list - request_id: b224cb1f-0eae-45f9-aa1d-f9918d013bac + request_id: 1f2ac655-6242-4f6d-a049-8dba88796108 errors: - code: unauthorized message: Access Token Invalid @@ -3467,7 +3470,7 @@ paths: successful: value: type: contact - id: 660e72da6abd01bd27af616d + id: 663a016e914417f88d1d8c79 workspace_id: this_is_an_id249_that_should_be_at_least_ external_id: '70' role: user @@ -3482,9 +3485,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1712222938 - updated_at: 1712222939 - signed_up_at: 1712222938 + created_at: 1715077486 + updated_at: 1715077486 + signed_up_at: 1715077486 last_seen_at: last_replied_at: last_contacted_at: @@ -3518,31 +3521,31 @@ paths: tags: type: list data: [] - url: "/contacts/660e72da6abd01bd27af616d/tags" + url: "/contacts/663a016e914417f88d1d8c79/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/660e72da6abd01bd27af616d/notes" + url: "/contacts/663a016e914417f88d1d8c79/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/660e72da6abd01bd27af616d/companies" + url: "/contacts/663a016e914417f88d1d8c79/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/660e72da6abd01bd27af616d/subscriptions" + url: "/contacts/663a016e914417f88d1d8c79/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/660e72da6abd01bd27af616d/subscriptions" + url: "/contacts/663a016e914417f88d1d8c79/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3561,7 +3564,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2f5a25dc-7027-4de5-8739-d1dc4bea5978 + request_id: eea7b74c-c9d8-4a67-b9f1-e66cd3cf7623 errors: - code: unauthorized message: Access Token Invalid @@ -3576,8 +3579,8 @@ paths: successful: summary: successful value: - from: 660e72da6abd01bd27af616c - into: 660e72da6abd01bd27af616d + from: 663a016e914417f88d1d8c78 + into: 663a016e914417f88d1d8c79 "/contacts/search": post: summary: Search contacts @@ -3596,6 +3599,12 @@ paths: This will accept a query object in the body which will define your filters in order to search for contacts. + {% admonition type="warning" name="Optimizing search queries" %} + Search queries can be complex, so optimizing them can help the performance of your search. + Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize + pagination to limit the number of results returned. The default is `50` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param. + {% /admonition %} ### Contact Creation Delay If a contact has recently been created, there is a possibility that it will not yet be available when searching. This means that it may not appear in the response. This delay can take a few minutes. If you need to be instantly notified it is recommended to use webhooks and iterate to see if they match your search filters. @@ -3710,7 +3719,7 @@ paths: Unauthorized: value: type: error.list - request_id: 1fb03194-ec12-49f6-a9a2-8a308b96cd90 + request_id: 007b6c5e-c12e-418b-a2ef-b69a57913c2a errors: - code: unauthorized message: Access Token Invalid @@ -3730,15 +3739,15 @@ paths: value: - field: id operator: "=" - value: 660e72dc6abd01bd27af6170 + value: 663a0170914417f88d1d8c7c - operator: OR value: - field: id operator: "=" - value: 660e72dc6abd01bd27af6170 + value: 663a0170914417f88d1d8c7c - field: id operator: "=" - value: 660e72dc6abd01bd27af6170 + value: 663a0170914417f88d1d8c7c "/contacts": get: summary: List all contacts @@ -3750,7 +3759,12 @@ paths: tags: - Contacts operationId: ListContacts - description: You can fetch a list of all contacts. + description: | + You can fetch a list of all contacts (ie. users or leads) in your workspace. + {% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `50` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. + {% /admonition %} responses: '200': description: successful @@ -3777,7 +3791,7 @@ paths: Unauthorized: value: type: error.list - request_id: 979f3f96-41e9-4e2d-beca-cf3c99390c2b + request_id: 05ebd64f-aa76-4b8d-99b1-73b15b0bde4f errors: - code: unauthorized message: Access Token Invalid @@ -3803,7 +3817,7 @@ paths: successful: value: type: contact - id: 660e72de6abd01bd27af6172 + id: 663a0172914417f88d1d8c7e workspace_id: this_is_an_id261_that_should_be_at_least_ external_id: role: user @@ -3818,8 +3832,8 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1712222942 - updated_at: 1712222942 + created_at: 1715077490 + updated_at: 1715077490 signed_up_at: last_seen_at: last_replied_at: @@ -3854,31 +3868,31 @@ paths: tags: type: list data: [] - url: "/contacts/660e72de6abd01bd27af6172/tags" + url: "/contacts/663a0172914417f88d1d8c7e/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/660e72de6abd01bd27af6172/notes" + url: "/contacts/663a0172914417f88d1d8c7e/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/660e72de6abd01bd27af6172/companies" + url: "/contacts/663a0172914417f88d1d8c7e/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/660e72de6abd01bd27af6172/subscriptions" + url: "/contacts/663a0172914417f88d1d8c7e/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/660e72de6abd01bd27af6172/subscriptions" + url: "/contacts/663a0172914417f88d1d8c7e/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3897,7 +3911,7 @@ paths: Unauthorized: value: type: error.list - request_id: 758fcd3e-ddb1-4d7d-b8e6-3261a336127a + request_id: 33085475-0b7c-401e-9924-e9e21eb2612a errors: - code: unauthorized message: Access Token Invalid @@ -3941,7 +3955,7 @@ paths: examples: successful: value: - id: 660e72e06abd01bd27af6173 + id: 663a0174914417f88d1d8c7f external_id: '70' type: contact archived: true @@ -3974,7 +3988,7 @@ paths: examples: successful: value: - id: 660e72e06abd01bd27af6174 + id: 663a0175914417f88d1d8c80 external_id: '70' type: contact archived: false @@ -4010,7 +4024,7 @@ paths: successful: value: type: tag - id: '1405' + id: '391' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -4022,7 +4036,7 @@ paths: Conversation not found: value: type: error.list - request_id: 916cf6bf-d98e-46ac-91e4-05c66b62fdac + request_id: 25f12b90-05c1-4cc8-b661-2c7577ff617e errors: - code: not_found message: Conversation not found @@ -4036,7 +4050,7 @@ paths: Unauthorized: value: type: error.list - request_id: 383cdc47-8888-4977-b4c7-917d9b291d47 + request_id: 1d88c6ad-20b2-4df6-8366-bff39d02380e errors: - code: unauthorized message: Access Token Invalid @@ -4065,13 +4079,13 @@ paths: successful: summary: successful value: - id: 1405 - admin_id: 991282417 + id: 391 + admin_id: 991271064 conversation_not_found: summary: Conversation not found value: - id: 1406 - admin_id: 991282419 + id: 392 + admin_id: 991271066 "/conversations/{conversation_id}/tags/{id}": delete: summary: Remove tag from a conversation @@ -4109,7 +4123,7 @@ paths: successful: value: type: tag - id: '1408' + id: '394' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -4121,14 +4135,14 @@ paths: Conversation not found: value: type: error.list - request_id: 0e088e1c-e1e3-4de4-9c75-1d00a0ad55ff + request_id: e4b5fe51-d99b-4d0e-be3d-2d1c62e1213d errors: - code: not_found message: Conversation not found Tag not found: value: type: error.list - request_id: c0f40ecf-62a1-4cdf-bebe-0810e71fa6de + request_id: 6e26d45e-0861-49ea-b89b-36b99368344b errors: - code: tag_not_found message: Tag not found @@ -4142,7 +4156,7 @@ paths: Unauthorized: value: type: error.list - request_id: 59948dcc-1a5c-4028-96f3-a511577b710d + request_id: 8f817458-aa9a-4274-9f7c-684496ee9ab2 errors: - code: unauthorized message: Access Token Invalid @@ -4165,15 +4179,15 @@ paths: successful: summary: successful value: - admin_id: 991282421 + admin_id: 991271068 conversation_not_found: summary: Conversation not found value: - admin_id: 991282423 + admin_id: 991271070 tag_not_found: summary: Tag not found value: - admin_id: 991282424 + admin_id: 991271071 "/conversations": get: summary: List all conversations @@ -4202,7 +4216,11 @@ paths: description: | You can fetch a list of all conversations. - You can optionally request the result page size and the cursor to start after to fetch the result + You can optionally request the result page size and the cursor to start after to fetch the result. + {% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `20` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. + {% /admonition %} responses: '200': description: successful @@ -4220,20 +4238,20 @@ paths: total_count: 1 conversations: - type: conversation - id: '4755' - created_at: 1712222953 - updated_at: 1712222953 + id: '1397' + created_at: 1715077501 + updated_at: 1715077501 waiting_since: snoozed_until: source: type: conversation - id: '403920827' + id: '403918815' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991282427' + id: '991271074' name: Ciaran143 Lee email: admin143@email.com attachments: [] @@ -4243,7 +4261,7 @@ paths: type: contact.list contacts: - type: contact - id: 660e72e86abd01bd27af6178 + id: 663a017d914417f88d1d8c84 external_id: '70' first_contact_reply: admin_assignee_id: @@ -4278,7 +4296,7 @@ paths: Unauthorized: value: type: error.list - request_id: 219eb6ab-9aee-4431-89ea-b7acb9d1f5cb + request_id: 4a22d780-e2a6-4247-b0b2-3fc489531f71 errors: - code: unauthorized message: Access Token Invalid @@ -4292,7 +4310,7 @@ paths: API plan restricted: value: type: error.list - request_id: 62a95b4c-6b98-4507-82f2-ba7729bdf93d + request_id: 2908efde-66d1-4ef9-bdc0-a6d1ce45b511 errors: - code: api_plan_restricted message: Active subscription needed. @@ -4328,11 +4346,11 @@ paths: conversation created: value: type: user_message - id: '403920837' - created_at: 1712222969 + id: '403918825' + created_at: 1715077521 body: Hello there message_type: inapp - conversation_id: '4780' + conversation_id: '1425' schema: "$ref": "#/components/schemas/message" '404': @@ -4343,7 +4361,7 @@ paths: Contact Not Found: value: type: error.list - request_id: bd94f0d6-deb3-48e8-8548-b38ff79e68dd + request_id: 3fff6359-7714-4133-bff0-3148543d253e errors: - code: not_found message: User Not Found @@ -4357,7 +4375,7 @@ paths: Unauthorized: value: type: error.list - request_id: dca9c57b-301d-4ae1-a37c-5c404944246b + request_id: 0ba00882-eb4e-4d19-a55d-060b19d98b25 errors: - code: unauthorized message: Access Token Invalid @@ -4371,7 +4389,7 @@ paths: API plan restricted: value: type: error.list - request_id: 62d3a819-0fd3-4998-83ee-c0fd8a5eb258 + request_id: 6980df80-9c29-4195-9241-bf1b861a846e errors: - code: api_plan_restricted message: Active subscription needed. @@ -4388,7 +4406,7 @@ paths: value: from: type: user - id: 660e72f96abd01bd27af618d + id: 663a0190914417f88d1d8c9c body: Hello there contact_not_found: summary: Contact Not Found @@ -4432,11 +4450,7 @@ paths: The maximum number of conversation parts that can be returned via the API is 500. If you have more than that we will return the 500 most recent conversation parts. {% /admonition %} - ### Bot Name in Conversation Parts - - For conversation parts generated by a bot, bot name will depend on the following: - - Customers that never turned on AI answers will have `operator` as the bot name - - Customers that have turned on AI answers at some point will have `fin` as the bot name + For AI agent conversation metadata, please note that you need to have the agent enabled in your workspace, which is a [paid feature](https://www.intercom.com/help/en/articles/8205718-fin-resolutions#h_97f8c2e671). responses: '200': description: conversation found @@ -4446,22 +4460,22 @@ paths: conversation found: value: type: conversation - id: '4784' - created_at: 1712222973 - updated_at: 1712222973 + id: '1429' + created_at: 1715077525 + updated_at: 1715077525 waiting_since: snoozed_until: source: type: conversation - id: '403920841' + id: '403918829' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991282438' - name: Ciaran150 Lee - email: admin150@email.com + id: '991271091' + name: Ciaran153 Lee + email: admin153@email.com attachments: [] url: redacted: false @@ -4469,7 +4483,7 @@ paths: type: contact.list contacts: - type: contact - id: 660e72fd6abd01bd27af6191 + id: 663a0195914417f88d1d8ca0 external_id: '70' first_contact_reply: admin_assignee_id: @@ -4508,7 +4522,7 @@ paths: Not found: value: type: error.list - request_id: 1c3a7a04-57b0-4236-94a0-bf33abae9744 + request_id: ae0411d2-6737-441b-890e-57718694d087 errors: - code: not_found message: Resource Not Found @@ -4522,7 +4536,7 @@ paths: Unauthorized: value: type: error.list - request_id: 7a41d680-a2e4-4bf5-8bcf-8b719db1c29a + request_id: bee1472a-bcb2-490d-8e40-ed3fff42b1c3 errors: - code: unauthorized message: Access Token Invalid @@ -4536,7 +4550,7 @@ paths: API plan restricted: value: type: error.list - request_id: dd860657-5ece-4554-acac-069c34d0bc62 + request_id: 8ce99f6d-7f25-48e6-8f04-752eacee5141 errors: - code: api_plan_restricted message: Active subscription needed. @@ -4583,22 +4597,22 @@ paths: conversation found: value: type: conversation - id: '4788' - created_at: 1712222978 - updated_at: 1712222979 + id: '1433' + created_at: 1715077530 + updated_at: 1715077531 waiting_since: snoozed_until: source: type: conversation - id: '403920845' + id: '403918833' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991282442' - name: Ciaran154 Lee - email: admin154@email.com + id: '991271099' + name: Ciaran157 Lee + email: admin157@email.com attachments: [] url: redacted: false @@ -4606,7 +4620,7 @@ paths: type: contact.list contacts: - type: contact - id: 660e73016abd01bd27af6195 + id: 663a019a914417f88d1d8ca4 external_id: '70' first_contact_reply: admin_assignee_id: @@ -4637,34 +4651,34 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '1114' + id: '315' part_type: conversation_attribute_updated_by_admin body: - created_at: 1712222979 - updated_at: 1712222979 - notified_at: 1712222979 + created_at: 1715077531 + updated_at: 1715077531 + notified_at: 1715077531 assigned_to: author: - id: '991282447' + id: '991271100' type: bot name: Operator - email: operator+this_is_an_id307_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id310_that_should_be_at_least_@intercom.io attachments: [] external_id: redacted: false - type: conversation_part - id: '1115' + id: '316' part_type: conversation_attribute_updated_by_admin body: - created_at: 1712222979 - updated_at: 1712222979 - notified_at: 1712222979 + created_at: 1715077531 + updated_at: 1715077531 + notified_at: 1715077531 assigned_to: author: - id: '991282447' + id: '991271100' type: bot name: Operator - email: operator+this_is_an_id307_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id310_that_should_be_at_least_@intercom.io attachments: [] external_id: redacted: false @@ -4679,7 +4693,7 @@ paths: Not found: value: type: error.list - request_id: 7a3acc60-086a-4849-8477-4ce385771589 + request_id: b612157e-aeeb-4d9a-bb71-32fecd7d056e errors: - code: not_found message: Resource Not Found @@ -4693,7 +4707,7 @@ paths: Unauthorized: value: type: error.list - request_id: b60bf60f-1f8e-4a17-ad8e-30ba7d05654d + request_id: 032d01b8-dd0e-4179-97a1-a2f6d3057e2d errors: - code: unauthorized message: Access Token Invalid @@ -4707,7 +4721,7 @@ paths: API plan restricted: value: type: error.list - request_id: 70029a2f-d113-414f-b997-0ab918e7b039 + request_id: 93d056d2-6f7d-4f1e-93df-35fe971877da errors: - code: api_plan_restricted message: Active subscription needed. @@ -4750,6 +4764,12 @@ paths: To search for conversations, you need to send a `POST` request to `https://api.intercom.io/conversations/search`. This will accept a query object in the body which will define your filters in order to search for conversations. + {% admonition type="warning" name="Optimizing search queries" %} + Search queries can be complex, so optimizing them can help the performance of your search. + Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize + pagination to limit the number of results returned. The default is `20` results per page and maximum is `150`. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param. + {% /admonition %} ### Nesting & Limitations @@ -4813,6 +4833,13 @@ paths: | conversation_rating.remark | String | | conversation_rating.contact_id | String | | conversation_rating.admin_d | String | + | ai_agent_participated | Boolean | + | ai_agent.resolution_state | String | + | ai_agent.last_answer_type | String | + | ai_agent.rating | Integer | + | ai_agent.rating_remark | String | + | ai_agent.source_type | String | + | ai_agent.source_title | String | ### Accepted Operators @@ -4847,22 +4874,22 @@ paths: total_count: 1 conversations: - type: conversation - id: '4795' - created_at: 1712222986 - updated_at: 1712222986 + id: '1440' + created_at: 1715077540 + updated_at: 1715077540 waiting_since: snoozed_until: source: type: conversation - id: '403920852' + id: '403918840' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991282466' - name: Ciaran177 Lee - email: admin177@email.com + id: '991271129' + name: Ciaran180 Lee + email: admin180@email.com attachments: [] url: redacted: false @@ -4870,7 +4897,7 @@ paths: type: contact.list contacts: - type: contact - id: 660e73096abd01bd27af619c + id: 663a01a4914417f88d1d8cab external_id: '70' first_contact_reply: admin_assignee_id: @@ -4911,15 +4938,15 @@ paths: value: - field: id operator: "=" - value: '4795' + value: '1440' - operator: OR value: - field: id operator: "=" - value: '4795' + value: '1440' - field: id operator: "=" - value: '4795' + value: '1440' "/conversations/{id}/reply": post: summary: Reply to a conversation @@ -4950,22 +4977,22 @@ paths: User reply: value: type: conversation - id: '4803' - created_at: 1712222991 - updated_at: 1712222992 - waiting_since: 1712222992 + id: '1449' + created_at: 1715077546 + updated_at: 1715077547 + waiting_since: 1715077547 snoozed_until: source: type: conversation - id: '403920855' + id: '403918843' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991282468' - name: Ciaran178 Lee - email: admin178@email.com + id: '991271132' + name: Ciaran182 Lee + email: admin182@email.com attachments: [] url: redacted: false @@ -4973,10 +5000,10 @@ paths: type: contact.list contacts: - type: contact - id: 660e730f6abd01bd27af61a3 + id: 663a01aa914417f88d1d8cb3 external_id: '70' first_contact_reply: - created_at: 1712222992 + created_at: 1715077547 type: conversation url: admin_assignee_id: @@ -5005,15 +5032,15 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '1117' + id: '318' part_type: open body: "

    Thanks again :)

    " - created_at: 1712222992 - updated_at: 1712222992 - notified_at: 1712222992 + created_at: 1715077547 + updated_at: 1715077547 + notified_at: 1715077547 assigned_to: author: - id: 660e730f6abd01bd27af61a3 + id: 663a01aa914417f88d1d8cb3 type: user name: Joe Bloggs email: joe@bloggs.com @@ -5024,22 +5051,22 @@ paths: Admin note reply: value: type: conversation - id: '4804' - created_at: 1712222993 - updated_at: 1712222993 + id: '1450' + created_at: 1715077548 + updated_at: 1715077549 waiting_since: snoozed_until: source: type: conversation - id: '403920856' + id: '403918844' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991282470' - name: Ciaran179 Lee - email: admin179@email.com + id: '991271134' + name: Ciaran183 Lee + email: admin183@email.com attachments: [] url: redacted: false @@ -5047,7 +5074,7 @@ paths: type: contact.list contacts: - type: contact - id: 660e73116abd01bd27af61a4 + id: 663a01ac914417f88d1d8cb4 external_id: '70' first_contact_reply: admin_assignee_id: @@ -5076,7 +5103,7 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '1118' + id: '319' part_type: note body: |-

    An Unordered HTML List

    @@ -5091,15 +5118,15 @@ paths:
  • Tea
  • Milk
    • - created_at: 1712222993 - updated_at: 1712222993 - notified_at: 1712222993 + created_at: 1715077549 + updated_at: 1715077549 + notified_at: 1715077549 assigned_to: author: - id: '991282470' + id: '991271134' type: admin - name: Ciaran179 Lee - email: admin179@email.com + name: Ciaran183 Lee + email: admin183@email.com attachments: [] external_id: redacted: false @@ -5107,22 +5134,22 @@ paths: User last conversation reply: value: type: conversation - id: '4806' - created_at: 1712222995 - updated_at: 1712222996 - waiting_since: 1712222996 + id: '1452' + created_at: 1715077551 + updated_at: 1715077552 + waiting_since: 1715077552 snoozed_until: source: type: conversation - id: '403920858' + id: '403918846' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991282472' - name: Ciaran181 Lee - email: admin181@email.com + id: '991271138' + name: Ciaran185 Lee + email: admin185@email.com attachments: [] url: redacted: false @@ -5130,10 +5157,10 @@ paths: type: contact.list contacts: - type: contact - id: 660e73136abd01bd27af61a6 + id: 663a01af914417f88d1d8cb6 external_id: '70' first_contact_reply: - created_at: 1712222996 + created_at: 1715077552 type: conversation url: admin_assignee_id: @@ -5162,15 +5189,15 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '1119' + id: '320' part_type: open body: "

    Thanks again :)

    " - created_at: 1712222996 - updated_at: 1712222996 - notified_at: 1712222996 + created_at: 1715077552 + updated_at: 1715077552 + notified_at: 1715077552 assigned_to: author: - id: 660e73136abd01bd27af61a6 + id: 663a01af914417f88d1d8cb6 type: user name: Joe Bloggs email: joe@bloggs.com @@ -5188,7 +5215,7 @@ paths: Not found: value: type: error.list - request_id: 3bd1f737-7c6c-4a9b-ac7b-80643609f32b + request_id: 1bba81de-0fdb-478b-baa5-6574e0e4286c errors: - code: not_found message: Resource Not Found @@ -5202,7 +5229,7 @@ paths: Unauthorized: value: type: error.list - request_id: d1baf31a-cba3-4b01-89f1-24f8c20eaae9 + request_id: 4dafbbfd-e367-4f2a-9ff9-c3e2b9b0c9b7 errors: - code: unauthorized message: Access Token Invalid @@ -5216,7 +5243,7 @@ paths: API plan restricted: value: type: error.list - request_id: 8b3c20f2-432e-4b19-bd35-965071f876d2 + request_id: 1d1ae41c-8c45-4ba3-af4b-af038108d6c8 errors: - code: api_plan_restricted message: Active subscription needed. @@ -5233,14 +5260,14 @@ paths: value: message_type: comment type: user - intercom_user_id: 660e730f6abd01bd27af61a3 + intercom_user_id: 663a01aa914417f88d1d8cb3 body: Thanks again :) admin_note_reply: summary: Admin note reply value: message_type: note type: admin - admin_id: 991282470 + admin_id: 991271134 body: "

    An Unordered HTML List

    An Ordered HTML List

    \
    1. Coffee
    2. Tea
    3. Milk
    @@ -5250,14 +5277,14 @@ paths: value: message_type: comment type: user - intercom_user_id: 660e73136abd01bd27af61a6 + intercom_user_id: 663a01af914417f88d1d8cb6 body: Thanks again :) not_found: summary: Not found value: message_type: comment type: user - intercom_user_id: 660e73156abd01bd27af61a7 + intercom_user_id: 663a01b1914417f88d1d8cb7 body: Thanks again :) "/conversations/{id}/parts": post: @@ -5292,22 +5319,22 @@ paths: Close a conversation: value: type: conversation - id: '4810' - created_at: 1712223000 - updated_at: 1712223000 + id: '1456' + created_at: 1715077556 + updated_at: 1715077557 waiting_since: snoozed_until: source: type: conversation - id: '403920862' + id: '403918850' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991282477' - name: Ciaran185 Lee - email: admin185@email.com + id: '991271146' + name: Ciaran189 Lee + email: admin189@email.com attachments: [] url: redacted: false @@ -5315,7 +5342,7 @@ paths: type: contact.list contacts: - type: contact - id: 660e73186abd01bd27af61aa + id: 663a01b4914417f88d1d8cba external_id: '70' first_contact_reply: admin_assignee_id: @@ -5344,18 +5371,18 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '1120' + id: '321' part_type: close body: "

    Goodbye :)

    " - created_at: 1712223000 - updated_at: 1712223000 - notified_at: 1712223000 + created_at: 1715077557 + updated_at: 1715077557 + notified_at: 1715077557 assigned_to: author: - id: '991282477' + id: '991271146' type: admin - name: Ciaran185 Lee - email: admin185@email.com + name: Ciaran189 Lee + email: admin189@email.com attachments: [] external_id: redacted: false @@ -5363,22 +5390,22 @@ paths: Snooze a conversation: value: type: conversation - id: '4811' - created_at: 1712223002 - updated_at: 1712223002 + id: '1457' + created_at: 1715077558 + updated_at: 1715077559 waiting_since: - snoozed_until: 1712226602 + snoozed_until: 1715081159 source: type: conversation - id: '403920863' + id: '403918851' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991282478' - name: Ciaran186 Lee - email: admin186@email.com + id: '991271148' + name: Ciaran190 Lee + email: admin190@email.com attachments: [] url: redacted: false @@ -5386,7 +5413,7 @@ paths: type: contact.list contacts: - type: contact - id: 660e73196abd01bd27af61ab + id: 663a01b6914417f88d1d8cbb external_id: '70' first_contact_reply: admin_assignee_id: @@ -5415,18 +5442,18 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '1121' + id: '322' part_type: snoozed body: - created_at: 1712223002 - updated_at: 1712223002 - notified_at: 1712223002 + created_at: 1715077559 + updated_at: 1715077559 + notified_at: 1715077559 assigned_to: author: - id: '991282478' + id: '991271148' type: admin - name: Ciaran186 Lee - email: admin186@email.com + name: Ciaran190 Lee + email: admin190@email.com attachments: [] external_id: redacted: false @@ -5434,22 +5461,22 @@ paths: Open a conversation: value: type: conversation - id: '4816' - created_at: 1712223000 - updated_at: 1712223008 + id: '1462' + created_at: 1715077557 + updated_at: 1715077565 waiting_since: snoozed_until: source: type: conversation - id: '403920864' + id: '403918852' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991282479' - name: Ciaran187 Lee - email: admin187@email.com + id: '991271150' + name: Ciaran191 Lee + email: admin191@email.com attachments: [] url: redacted: false @@ -5457,7 +5484,7 @@ paths: type: contact.list contacts: - type: contact - id: 660e731c6abd01bd27af61b0 + id: 663a01b5914417f88d1d8cc0 external_id: '74' first_contact_reply: admin_assignee_id: @@ -5486,18 +5513,18 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '1123' + id: '324' part_type: open body: - created_at: 1712223008 - updated_at: 1712223008 - notified_at: 1712223008 + created_at: 1715077565 + updated_at: 1715077565 + notified_at: 1715077565 assigned_to: author: - id: '991282479' + id: '991271150' type: admin - name: Ciaran187 Lee - email: admin187@email.com + name: Ciaran191 Lee + email: admin191@email.com attachments: [] external_id: redacted: false @@ -5505,22 +5532,22 @@ paths: Assign a conversation: value: type: conversation - id: '4820' - created_at: 1712223009 - updated_at: 1712223009 + id: '1467' + created_at: 1715077567 + updated_at: 1715077567 waiting_since: snoozed_until: source: type: conversation - id: '403920867' + id: '403918855' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991282481' - name: Ciaran188 Lee - email: admin188@email.com + id: '991271153' + name: Ciaran193 Lee + email: admin193@email.com attachments: [] url: redacted: false @@ -5528,10 +5555,10 @@ paths: type: contact.list contacts: - type: contact - id: 660e73216abd01bd27af61b3 + id: 663a01be914417f88d1d8cc4 external_id: '70' first_contact_reply: - admin_assignee_id: 991282481 + admin_assignee_id: 991271153 team_assignee_id: open: true state: open @@ -5557,20 +5584,20 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '1124' + id: '325' part_type: assign_and_reopen body: - created_at: 1712223009 - updated_at: 1712223009 - notified_at: 1712223009 + created_at: 1715077567 + updated_at: 1715077567 + notified_at: 1715077567 assigned_to: type: admin - id: '991282481' + id: '991271153' author: - id: '991282481' + id: '991271153' type: admin - name: Ciaran188 Lee - email: admin188@email.com + name: Ciaran193 Lee + email: admin193@email.com attachments: [] external_id: redacted: false @@ -5585,7 +5612,7 @@ paths: Not found: value: type: error.list - request_id: 4164973d-fcc4-4157-a0e9-1079a417e310 + request_id: 4e8435a7-cf51-4c49-8824-0639dd10f24b errors: - code: not_found message: Resource Not Found @@ -5599,7 +5626,7 @@ paths: Unauthorized: value: type: error.list - request_id: 4eedd286-33c8-4945-99c1-7918268ac573 + request_id: f3a8318e-6bd3-4875-afc2-9d9f6e4d6e25 errors: - code: unauthorized message: Access Token Invalid @@ -5613,7 +5640,7 @@ paths: API plan restricted: value: type: error.list - request_id: 1726e634-6e37-40ba-88c2-2529b88b8f55 + request_id: 728a7807-9a70-42f4-a70b-f86af0d7749e errors: - code: api_plan_restricted message: Active subscription needed. @@ -5634,32 +5661,32 @@ paths: value: message_type: close type: admin - admin_id: 991282477 + admin_id: 991271146 body: Goodbye :) snooze_a_conversation: summary: Snooze a conversation value: message_type: snoozed - admin_id: 991282478 - snoozed_until: 1712226602 + admin_id: 991271148 + snoozed_until: 1715081159 open_a_conversation: summary: Open a conversation value: message_type: open - admin_id: 991282479 + admin_id: 991271150 assign_a_conversation: summary: Assign a conversation value: message_type: assignment type: admin - admin_id: 991282481 - assignee_id: 991282481 + admin_id: 991271153 + assignee_id: 991271153 not_found: summary: Not found value: message_type: close type: admin - admin_id: 991282483 + admin_id: 991271155 body: Goodbye :) "/conversations/{id}/run_assignment_rules": post: @@ -5693,22 +5720,22 @@ paths: Assign a conversation using assignment rules: value: type: conversation - id: '4824' - created_at: 1712223013 - updated_at: 1712223014 + id: '1471' + created_at: 1715077572 + updated_at: 1715077573 waiting_since: snoozed_until: source: type: conversation - id: '403920871' + id: '403918859' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991282486' - name: Ciaran192 Lee - email: admin192@email.com + id: '991271161' + name: Ciaran197 Lee + email: admin197@email.com attachments: [] url: redacted: false @@ -5716,7 +5743,7 @@ paths: type: contact.list contacts: - type: contact - id: 660e73256abd01bd27af61b7 + id: 663a01c4914417f88d1d8cc8 external_id: '70' first_contact_reply: admin_assignee_id: @@ -5745,20 +5772,20 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '1125' + id: '326' part_type: default_assignment body: - created_at: 1712223014 - updated_at: 1712223014 - notified_at: 1712223014 + created_at: 1715077573 + updated_at: 1715077573 + notified_at: 1715077573 assigned_to: type: nobody_admin id: author: - id: '991282487' + id: '991271162' type: bot name: Operator - email: operator+this_is_an_id348_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id353_that_should_be_at_least_@intercom.io attachments: [] external_id: redacted: false @@ -5773,7 +5800,7 @@ paths: Not found: value: type: error.list - request_id: 65f05362-f259-49d4-94ac-92f99a6bfa38 + request_id: 8979a4d3-7e2c-4c43-84e3-add6a4de8d6c errors: - code: not_found message: Resource Not Found @@ -5787,7 +5814,7 @@ paths: Unauthorized: value: type: error.list - request_id: 99662f70-daf2-4dc0-827c-1a679d113c78 + request_id: bbd2325c-3158-463a-81f4-e0809ed84e46 errors: - code: unauthorized message: Access Token Invalid @@ -5801,7 +5828,7 @@ paths: API plan restricted: value: type: error.list - request_id: e40a50df-4639-44ce-b642-06f76d702176 + request_id: 4e57fcab-6bb6-443e-abb4-a6160ef04efb errors: - code: api_plan_restricted message: Active subscription needed. @@ -5842,7 +5869,7 @@ paths: value: customers: - type: user - id: 660e732a6abd01bd27af61bb + id: 663a01c9914417f88d1d8ccc schema: "$ref": "#/components/schemas/conversation" '404': @@ -5853,7 +5880,7 @@ paths: Not found: value: type: error.list - request_id: e6c37d77-68d2-4e07-9461-6152cdcce4d9 + request_id: 897e714f-f2b6-4bb8-9d13-44f72b9a86a1 errors: - code: not_found message: Resource Not Found @@ -5867,7 +5894,7 @@ paths: Unauthorized: value: type: error.list - request_id: 1b474674-90c2-41d3-9aff-aa22b8e3dbd3 + request_id: bc701145-eb41-4409-910b-2913cd4d74b9 errors: - code: unauthorized message: Access Token Invalid @@ -5881,7 +5908,7 @@ paths: API plan restricted: value: type: error.list - request_id: 418aba92-e787-424b-bd83-4ae98b3e13fc + request_id: 9f58108c-b4b2-4eb1-954e-d4cd274dea46 errors: - code: api_plan_restricted message: Active subscription needed. @@ -5896,15 +5923,15 @@ paths: attach_a_contact_to_a_conversation: summary: Attach a contact to a conversation value: - admin_id: 991282491 + admin_id: 991271169 customer: - intercom_user_id: 660e732a6abd01bd27af61bb + intercom_user_id: 663a01c9914417f88d1d8ccc not_found: summary: Not found value: - admin_id: 991282492 + admin_id: 991271171 customer: - intercom_user_id: 660e732b6abd01bd27af61bc + intercom_user_id: 663a01ca914417f88d1d8ccd "/conversations/{conversation_id}/customers/{contact_id}": delete: summary: Detach a contact from a group conversation @@ -5947,7 +5974,7 @@ paths: value: customers: - type: user - id: 660e73326abd01bd27af61c6 + id: 663a01d4914417f88d1d8cd8 schema: "$ref": "#/components/schemas/conversation" '404': @@ -5958,14 +5985,14 @@ paths: Conversation not found: value: type: error.list - request_id: 5d426405-98a3-47dd-b637-ecf2cc1b49b0 + request_id: 508dc745-d971-42ac-ac3c-2ffcaa13fdc8 errors: - code: not_found message: Resource Not Found Contact not found: value: type: error.list - request_id: ff520161-e5fa-4019-8aed-0dc52cd59d2f + request_id: bd4f9097-9e86-4e49-9d06-e2fee34ef004 errors: - code: not_found message: User Not Found @@ -5979,7 +6006,7 @@ paths: Last customer: value: type: error.list - request_id: 6f8b5eb5-4885-4247-a4b0-1b7e8bc67286 + request_id: 5d21f294-aa34-47c7-9e76-41ca6e4198a1 errors: - code: parameter_invalid message: Removing the last customer is not allowed @@ -5993,7 +6020,7 @@ paths: Unauthorized: value: type: error.list - request_id: 67ffcb60-ed42-4590-b2ae-0859465e01f4 + request_id: dba87a82-30db-4de7-94d0-c50667b694c5 errors: - code: unauthorized message: Access Token Invalid @@ -6007,7 +6034,7 @@ paths: API plan restricted: value: type: error.list - request_id: 1baf7686-8290-4c4c-bf69-d48797a4fd9a + request_id: 28fdbabf-6305-4c19-8095-a41e5f268450 errors: - code: api_plan_restricted message: Active subscription needed. @@ -6022,27 +6049,27 @@ paths: detach_a_contact_from_a_group_conversation: summary: Detach a contact from a group conversation value: - admin_id: 991282495 + admin_id: 991271177 customer: - intercom_user_id: 660e732e6abd01bd27af61bf + intercom_user_id: 663a01ce914417f88d1d8cd0 conversation_not_found: summary: Conversation not found value: - admin_id: 991282497 + admin_id: 991271180 customer: - intercom_user_id: 660e73336abd01bd27af61c7 + intercom_user_id: 663a01d5914417f88d1d8cd9 contact_not_found: summary: Contact not found value: - admin_id: 991282499 + admin_id: 991271183 customer: - intercom_user_id: 660e73386abd01bd27af61ce + intercom_user_id: 663a01db914417f88d1d8ce1 last_customer: summary: Last customer value: - admin_id: 991282501 + admin_id: 991271186 customer: - intercom_user_id: 660e733d6abd01bd27af61d5 + intercom_user_id: 663a01e1914417f88d1d8ce9 "/conversations/redact": post: summary: Redact a conversation part @@ -6070,22 +6097,22 @@ paths: Redact a conversation part: value: type: conversation - id: '4880' - created_at: 1712223053 - updated_at: 1712223055 - waiting_since: 1712223054 + id: '1533' + created_at: 1715077620 + updated_at: 1715077621 + waiting_since: 1715077620 snoozed_until: source: type: conversation - id: '403920897' + id: '403918885' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991282507' - name: Ciaran206 Lee - email: admin206@email.com + id: '991271195' + name: Ciaran217 Lee + email: admin217@email.com attachments: [] url: redacted: false @@ -6093,10 +6120,10 @@ paths: type: contact.list contacts: - type: contact - id: 660e734d6abd01bd27af61ea + id: 663a01f4914417f88d1d8d01 external_id: '70' first_contact_reply: - created_at: 1712223054 + created_at: 1715077620 type: conversation url: admin_assignee_id: @@ -6125,15 +6152,15 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '1133' + id: '334' part_type: open body: "

    This message was deleted

    " - created_at: 1712223054 - updated_at: 1712223055 - notified_at: 1712223054 + created_at: 1715077620 + updated_at: 1715077621 + notified_at: 1715077620 assigned_to: author: - id: 660e734d6abd01bd27af61ea + id: 663a01f4914417f88d1d8d01 type: user name: Joe Bloggs email: joe@bloggs.com @@ -6151,7 +6178,7 @@ paths: Not found: value: type: error.list - request_id: a03abf6a-7897-4dda-9c4e-2aef3f78750a + request_id: bf26077c-e556-4cb8-af40-9b0aefeb8168 errors: - code: conversation_part_or_message_not_found message: Conversation part or message not found @@ -6165,7 +6192,7 @@ paths: Unauthorized: value: type: error.list - request_id: e8170fa3-d818-4e70-b13d-4b17ef23149b + request_id: b784fe50-2b15-4723-af94-bc2fdbf59cff errors: - code: unauthorized message: Access Token Invalid @@ -6181,8 +6208,8 @@ paths: summary: Redact a conversation part value: type: conversation_part - conversation_id: 4880 - conversation_part_id: 1133 + conversation_id: 1533 + conversation_part_id: 334 not_found: summary: Not found value: @@ -6217,22 +6244,22 @@ paths: successful: value: type: ticket - id: '4883' - ticket_id: '207' + id: '1536' + ticket_id: '64' ticket_attributes: {} ticket_state: submitted ticket_state_internal_label: Submitted ticket_state_external_label: Submitted ticket_type: type: ticket_type - id: '875' + id: '251' name: my-ticket-type-1 description: my ticket type description is awesome. icon: "\U0001F981" - workspace_id: this_is_an_id382_that_should_be_at_least_ + workspace_id: this_is_an_id393_that_should_be_at_least_ archived: false - created_at: 1712223061 - updated_at: 1712223061 + created_at: 1715077628 + updated_at: 1715077628 is_internal: false ticket_type_attributes: type: list @@ -6242,40 +6269,40 @@ paths: type: contact.list contacts: - type: contact - id: 660e73536abd01bd27af61ed + id: 663a01fa914417f88d1d8d04 external_id: '70' admin_assignee_id: '0' team_assignee_id: '0' - created_at: 1712223059 - updated_at: 1712223061 + created_at: 1715077626 + updated_at: 1715077628 ticket_parts: type: ticket_part.list ticket_parts: - type: ticket_part - id: '1135' + id: '336' part_type: comment body: "

    Comment for message

    " - created_at: 1712223059 - updated_at: 1712223059 + created_at: 1715077626 + updated_at: 1715077626 author: - id: 660e73536abd01bd27af61ed + id: 663a01fa914417f88d1d8d04 type: user name: Joe Bloggs email: joe@bloggs.com attachments: [] redacted: false - type: ticket_part - id: '1136' + id: '337' part_type: ticket_state_updated_by_admin ticket_state: submitted previous_ticket_state: submitted - created_at: 1712223061 - updated_at: 1712223061 + created_at: 1715077628 + updated_at: 1715077628 author: - id: '991282516' + id: '991271205' type: bot name: Operator - email: operator+this_is_an_id382_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id393_that_should_be_at_least_@intercom.io attachments: [] redacted: false total_count: 2 @@ -6297,7 +6324,7 @@ paths: Bad request: value: type: error.list - request_id: 2d30f8b9-7d54-4285-9d0e-370737156a51 + request_id: f5a88034-f194-4500-a967-ead8512cb114 errors: - code: parameter_invalid message: Ticket type is not a customer ticket type @@ -6312,11 +6339,11 @@ paths: successful: summary: successful value: - ticket_type_id: '875' + ticket_type_id: '251' bad_request: summary: Bad request value: - ticket_type_id: '876' + ticket_type_id: '252' "/data_attributes": get: summary: List all data attributes @@ -6497,7 +6524,7 @@ paths: custom: false archived: false model: company - - id: 517 + - id: 146 type: data_attribute name: The One Ring full_name: custom_attributes.The One Ring @@ -6510,9 +6537,9 @@ paths: messenger_writable: true custom: true archived: false - admin_id: '991282533' - created_at: 1712223067 - updated_at: 1712223067 + admin_id: '991271222' + created_at: 1715077633 + updated_at: 1715077633 model: company - type: data_attribute name: id @@ -6584,7 +6611,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2c807fea-7d83-4016-ae76-b5edde40f64d + request_id: e98891c3-3961-4abf-874b-59a7c7c00bba errors: - code: unauthorized message: Access Token Invalid @@ -6609,7 +6636,7 @@ paths: examples: Successful: value: - id: 520 + id: 149 type: data_attribute name: Mithril Shirt full_name: custom_attributes.Mithril Shirt @@ -6620,9 +6647,9 @@ paths: messenger_writable: true custom: true archived: false - admin_id: '991282535' - created_at: 1712223068 - updated_at: 1712223068 + admin_id: '991271224' + created_at: 1715077635 + updated_at: 1715077635 model: company schema: "$ref": "#/components/schemas/data_attribute" @@ -6634,7 +6661,7 @@ paths: Same name already exists: value: type: error.list - request_id: a63d9837-7544-4c66-99f7-5c1915880c8f + request_id: ae3168ef-69e9-4325-9fbc-d491ded3e636 errors: - code: parameter_invalid message: You already have 'The One Ring' in your company data. @@ -6642,7 +6669,7 @@ paths: Invalid name: value: type: error.list - request_id: e7c2778d-5a1a-47e5-8f39-a89ab69331bf + request_id: acc4505a-54c8-4ea5-bb03-9f3305a94870 errors: - code: parameter_invalid message: Your name for this attribute must only contain alphanumeric @@ -6650,7 +6677,7 @@ paths: Attribute already exists: value: type: error.list - request_id: 40f88e81-38cc-46e3-9a2c-f883b718935e + request_id: '0709c72e-3a60-40d9-8643-ede0c265703e' errors: - code: parameter_invalid message: You already have 'The One Ring' in your company data. @@ -6658,14 +6685,14 @@ paths: Invalid Data Type: value: type: error.list - request_id: c508163f-5479-4075-9806-ceabf30d21fe + request_id: d138d770-6c61-4104-b1df-77b1510912e2 errors: - code: parameter_invalid message: Data Type isn't an option Too few options for list: value: type: error.list - request_id: 54e068bb-d5cd-4fa6-a157-f608f9d124e0 + request_id: 533e61bd-b2bf-4347-be54-e3ae64dbd00a errors: - code: parameter_invalid message: The Data Attribute model field must be either contact @@ -6680,7 +6707,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0054a447-a283-444c-bff9-81dd56eaaca7 + request_id: c4aff757-be8f-4629-bd8f-72541b491453 errors: - code: unauthorized message: Access Token Invalid @@ -6759,7 +6786,7 @@ paths: examples: Successful: value: - id: 527 + id: 156 type: data_attribute name: The One Ring full_name: custom_attributes.The One Ring @@ -6774,9 +6801,9 @@ paths: messenger_writable: true custom: true archived: false - admin_id: '991282542' - created_at: 1712223071 - updated_at: 1712223072 + admin_id: '991271231' + created_at: 1715077638 + updated_at: 1715077638 model: company schema: "$ref": "#/components/schemas/data_attribute" @@ -6788,7 +6815,7 @@ paths: Too few options in list: value: type: error.list - request_id: 3b97c5e0-08e2-4f45-8194-1c6df189b000 + request_id: 547a061f-3077-4508-8074-cd2c7dfc4e02 errors: - code: parameter_invalid message: Options isn't an array @@ -6802,7 +6829,7 @@ paths: Attribute Not Found: value: type: error.list - request_id: befc38f4-256d-4f11-ad8d-ccd977480470 + request_id: e6ba58e5-9e98-4517-8c27-bbcc8d146468 errors: - code: field_not_found message: We couldn't find that data attribute to update @@ -6816,7 +6843,7 @@ paths: Has Dependant Object: value: type: error.list - request_id: fe9904bc-0aad-4473-bd59-ae68c4e6cefc + request_id: 5630c9ae-7429-496a-8258-322067e2058f errors: - code: data_invalid message: The Data Attribute you are trying to archive has a @@ -6831,7 +6858,7 @@ paths: Unauthorized: value: type: error.list - request_id: f8d5f0da-9118-40a4-8ef1-f43dcef94326 + request_id: 1d18e3e9-221a-408e-89ce-eba37f2afbc8 errors: - code: unauthorized message: Access Token Invalid @@ -6936,7 +6963,7 @@ paths: Unauthorized: value: type: error.list - request_id: 932adcae-2cc6-4fe6-9cb7-69584636f469 + request_id: 752f72c0-5daa-4dda-b69e-38fa837c6dcf errors: - code: unauthorized message: Access Token Invalid @@ -7023,7 +7050,7 @@ paths: pages: next: http://api.intercom.test/events?next page email: user26@email.com - intercom_user_id: 660e73646abd01bd27af61f3 + intercom_user_id: 663a020a914417f88d1d8d0a user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 schema: "$ref": "#/components/schemas/data_event_summary" @@ -7035,7 +7062,7 @@ paths: Unauthorized: value: type: error.list - request_id: e1ecdb53-9a76-4a51-b31f-cad175267461 + request_id: 9c0138f6-c115-45d5-af17-27a41dc8062e errors: - code: unauthorized message: Access Token Invalid @@ -7066,7 +7093,7 @@ paths: Unauthorized: value: type: error.list - request_id: fe2891d3-0fc1-465e-927b-7135a8b1c9cd + request_id: bd97867d-83a8-4f48-91b5-f4a2090b6b32 errors: - code: unauthorized message: Access Token Invalid @@ -7110,7 +7137,7 @@ paths: examples: successful: value: - job_identifier: i98ddeatu75wac5b + job_identifier: f2ldw927alkjbfs3 status: pending download_url: '' download_expires_at: '' @@ -7125,8 +7152,8 @@ paths: successful: summary: successful value: - created_at_after: 1712205079 - created_at_before: 1712223079 + created_at_after: 1715059644 + created_at_before: 1715077644 "/export/content/data/{job_identifier}": get: summary: Show content data export @@ -7160,7 +7187,7 @@ paths: examples: successful: value: - job_identifier: idb96ixvzmgffzdv + job_identifier: jgbvev270hi1yih4 status: pending download_url: '' download_expires_at: '' @@ -7192,7 +7219,7 @@ paths: examples: successful: value: - job_identifier: r1bwd5nvehk98ucp + job_identifier: b9if6f6yol69up4u status: canceled download_url: '' download_expires_at: '' @@ -7253,32 +7280,32 @@ paths: user message created: value: type: user_message - id: '403920902' - created_at: 1712223081 + id: '403918890' + created_at: 1715077647 body: heyy message_type: inapp - conversation_id: '4885' + conversation_id: '1538' lead message created: value: type: user_message - id: '403920903' - created_at: 1712223083 + id: '403918891' + created_at: 1715077648 body: heyy message_type: inapp - conversation_id: '4886' + conversation_id: '1539' admin message created: value: type: admin_message - id: '165' - created_at: 1712223084 + id: '50' + created_at: 1715077649 subject: heyy body: heyy message_type: inapp owner: type: admin - id: '991282565' - name: Ciaran258 Lee - email: admin258@email.com + id: '991271254' + name: Ciaran269 Lee + email: admin269@email.com away_mode_enabled: false away_mode_reassign: false schema: @@ -7291,14 +7318,14 @@ paths: No body supplied for message: value: type: error.list - request_id: ec83f165-9ef0-4951-b5d8-221cb37daf23 + request_id: 7ca574ba-04ae-4565-8abe-3a0fef6437f6 errors: - code: parameter_invalid message: Body is required No body supplied for email message: value: type: error.list - request_id: 44635c57-9c64-42a4-9732-33166d51114f + request_id: 251063fb-a2be-4f43-8202-60fb95ba5296 errors: - code: parameter_invalid message: Body is required @@ -7312,7 +7339,7 @@ paths: No subject supplied for email message: value: type: error.list - request_id: e8de296f-a2ae-4ccc-a0d9-fa034be7050f + request_id: 1f691ae4-e688-4e32-aad6-993a9ea1f6df errors: - code: parameter_not_found message: No subject supplied for email message @@ -7326,7 +7353,7 @@ paths: Unauthorized: value: type: error.list - request_id: 6e5cb3d3-5d18-4fbe-984d-e09d094373e2 + request_id: d5547d6e-bf4d-4190-a8f2-6f30fe48ecc2 errors: - code: unauthorized message: Access Token Invalid @@ -7340,7 +7367,7 @@ paths: API plan restricted: value: type: error.list - request_id: 754a85fb-54f0-4719-b91d-8c5ec0394fa1 + request_id: 626a8008-9544-4147-886f-d75736f4ea5b errors: - code: api_plan_restricted message: Active subscription needed. @@ -7357,7 +7384,7 @@ paths: value: from: type: user - id: 660e73696abd01bd27af61f8 + id: 663a020e914417f88d1d8d0f body: heyy referer: https://twitter.com/bob lead_message_created: @@ -7365,7 +7392,7 @@ paths: value: from: type: lead - id: 660e736a6abd01bd27af61f9 + id: 663a0210914417f88d1d8d10 body: heyy referer: https://twitter.com/bob admin_message_created: @@ -7373,10 +7400,10 @@ paths: value: from: type: admin - id: '991282565' + id: '991271254' to: type: user - id: 660e736b6abd01bd27af61fa + id: 663a0211914417f88d1d8d11 message_type: conversation body: heyy no_body_supplied_for_message: @@ -7384,10 +7411,10 @@ paths: value: from: type: admin - id: '991282567' + id: '991271256' to: type: user - id: 660e736c6abd01bd27af61fb + id: 663a0212914417f88d1d8d12 message_type: inapp body: subject: heyy @@ -7396,7 +7423,7 @@ paths: value: from: type: admin - id: '991282568' + id: '991271257' to: type: user user_id: '70' @@ -7407,10 +7434,10 @@ paths: value: from: type: admin - id: '991282569' + id: '991271258' to: type: user - id: 660e736e6abd01bd27af61fd + id: 663a0213914417f88d1d8d14 message_type: email body: subject: heyy @@ -7441,12 +7468,12 @@ paths: total_pages: 1 type: pages data: - - id: '449' + - id: '128' type: news-item - workspace_id: this_is_an_id472_that_should_be_at_least_ + workspace_id: this_is_an_id483_that_should_be_at_least_ title: We have news body: "

    Hello there,

    " - sender_id: 991282574 + sender_id: 991271265 state: draft labels: [] cover_image_url: @@ -7456,15 +7483,15 @@ paths: - - deliver_silently: false - created_at: 1712223087 - updated_at: 1712223087 + created_at: 1715077653 + updated_at: 1715077653 newsfeed_assignments: [] - - id: '450' + - id: '127' type: news-item - workspace_id: this_is_an_id472_that_should_be_at_least_ + workspace_id: this_is_an_id483_that_should_be_at_least_ title: We have news body: "

    Hello there,

    " - sender_id: 991282576 + sender_id: 991271263 state: draft labels: [] cover_image_url: @@ -7474,8 +7501,8 @@ paths: - - deliver_silently: false - created_at: 1712223087 - updated_at: 1712223087 + created_at: 1715077652 + updated_at: 1715077652 newsfeed_assignments: [] total_count: 2 schema: @@ -7488,7 +7515,7 @@ paths: Unauthorized: value: type: error.list - request_id: 911e2d2c-a31e-42f9-86ba-7be75b38cc33 + request_id: 79fce71a-26c4-4cf6-8493-36241321c0c4 errors: - code: unauthorized message: Access Token Invalid @@ -7513,12 +7540,12 @@ paths: examples: successful: value: - id: '453' + id: '131' type: news-item - workspace_id: this_is_an_id476_that_should_be_at_least_ + workspace_id: this_is_an_id487_that_should_be_at_least_ title: Halloween is here! body: "

    New costumes in store for this spooky season

    " - sender_id: 991282583 + sender_id: 991271272 state: live labels: - New @@ -7529,10 +7556,10 @@ paths: - "\U0001F606" - "\U0001F605" deliver_silently: true - created_at: 1712223089 - updated_at: 1712223089 + created_at: 1715077654 + updated_at: 1715077654 newsfeed_assignments: - - newsfeed_id: 803 + - newsfeed_id: 228 published_at: 1664638214 schema: "$ref": "#/components/schemas/news_item" @@ -7544,7 +7571,7 @@ paths: Unauthorized: value: type: error.list - request_id: ebd421c2-e75a-4dab-8617-d64efe4748e0 + request_id: fefbd7d9-8413-4cfc-8109-697f9c613503 errors: - code: unauthorized message: Access Token Invalid @@ -7565,14 +7592,14 @@ paths: - Product - Update - New - sender_id: 991282583 + sender_id: 991271272 deliver_silently: true reactions: - "\U0001F606" - "\U0001F605" state: live newsfeed_assignments: - - newsfeed_id: 803 + - newsfeed_id: 228 published_at: 1664638214 "/news/news_items/{id}": get: @@ -7601,12 +7628,12 @@ paths: examples: successful: value: - id: '454' + id: '132' type: news-item - workspace_id: this_is_an_id480_that_should_be_at_least_ + workspace_id: this_is_an_id491_that_should_be_at_least_ title: We have news body: "

    Hello there,

    " - sender_id: 991282586 + sender_id: 991271275 state: live labels: [] cover_image_url: @@ -7616,11 +7643,11 @@ paths: - - deliver_silently: false - created_at: 1712223091 - updated_at: 1712223091 + created_at: 1715077656 + updated_at: 1715077656 newsfeed_assignments: - - newsfeed_id: 805 - published_at: 1712223091 + - newsfeed_id: 230 + published_at: 1715077656 schema: "$ref": "#/components/schemas/news_item" '404': @@ -7631,7 +7658,7 @@ paths: News Item Not Found: value: type: error.list - request_id: 0c74b0c8-c753-46a5-b976-a4cf4ee85057 + request_id: 224f98be-fe33-4b9b-9b43-858c5b3955cd errors: - code: not_found message: Resource Not Found @@ -7645,7 +7672,7 @@ paths: Unauthorized: value: type: error.list - request_id: bf9aebed-b403-4cfe-8340-01dc05a36bfc + request_id: '09b920ce-6a42-4a17-bed7-032a827e496f' errors: - code: unauthorized message: Access Token Invalid @@ -7676,12 +7703,12 @@ paths: examples: successful: value: - id: '457' + id: '135' type: news-item - workspace_id: this_is_an_id486_that_should_be_at_least_ + workspace_id: this_is_an_id497_that_should_be_at_least_ title: Christmas is here! body: "

    New gifts in store for the jolly season

    " - sender_id: 991282594 + sender_id: 991271283 state: live labels: [] cover_image_url: @@ -7689,8 +7716,8 @@ paths: - "\U0001F61D" - "\U0001F602" deliver_silently: false - created_at: 1712223093 - updated_at: 1712223093 + created_at: 1715077657 + updated_at: 1715077658 newsfeed_assignments: [] schema: "$ref": "#/components/schemas/news_item" @@ -7702,7 +7729,7 @@ paths: News Item Not Found: value: type: error.list - request_id: f8cfe412-7d36-4045-98de-9bc2977dfdea + request_id: 585786aa-fe66-4348-8086-998f22db3ad6 errors: - code: not_found message: Resource Not Found @@ -7716,7 +7743,7 @@ paths: Unauthorized: value: type: error.list - request_id: 1691ee70-c78d-47c6-9abc-62448af44b0d + request_id: 28cdd8c5-d1a8-4907-8af4-6d1d43e9f217 errors: - code: unauthorized message: Access Token Invalid @@ -7733,7 +7760,7 @@ paths: value: title: Christmas is here! body: "

    New gifts in store for the jolly season

    " - sender_id: 991282594 + sender_id: 991271283 reactions: - "\U0001F61D" - "\U0001F602" @@ -7742,7 +7769,7 @@ paths: value: title: Christmas is here! body: "

    New gifts in store for the jolly season

    " - sender_id: 991282597 + sender_id: 991271286 reactions: - "\U0001F61D" - "\U0001F602" @@ -7772,7 +7799,7 @@ paths: examples: successful: value: - id: '460' + id: '138' object: news-item deleted: true schema: @@ -7785,7 +7812,7 @@ paths: News Item Not Found: value: type: error.list - request_id: 576a40fa-dad2-4259-a36e-97c8293f8d7f + request_id: fee41041-b155-4545-8303-84c02480a04f errors: - code: not_found message: Resource Not Found @@ -7799,7 +7826,7 @@ paths: Unauthorized: value: type: error.list - request_id: 217d50e5-afcd-48eb-ae3e-77422b51fcfb + request_id: f531b9a4-79a5-46fa-9b4f-1a9525ff41dc errors: - code: unauthorized message: Access Token Invalid @@ -7852,7 +7879,7 @@ paths: Unauthorized: value: type: error.list - request_id: 17152217-5941-4bd4-840f-99692b6d208d + request_id: 26715d25-fd74-4f62-b0a9-07855744e3d6 errors: - code: unauthorized message: Access Token Invalid @@ -7885,16 +7912,16 @@ paths: total_pages: 1 type: pages data: - - id: '818' + - id: '243' type: newsfeed name: Visitor Feed - created_at: 1712223098 - updated_at: 1712223098 - - id: '819' + created_at: 1715077662 + updated_at: 1715077662 + - id: '244' type: newsfeed name: Visitor Feed - created_at: 1712223098 - updated_at: 1712223098 + created_at: 1715077662 + updated_at: 1715077662 total_count: 2 schema: "$ref": "#/components/schemas/paginated_response" @@ -7906,7 +7933,7 @@ paths: Unauthorized: value: type: error.list - request_id: e56ad5f1-6c44-4999-9614-1ac77cb1a648 + request_id: defc0ad9-28fa-4a8c-83d7-1c5ef2056b3d errors: - code: unauthorized message: Access Token Invalid @@ -7940,11 +7967,11 @@ paths: examples: successful: value: - id: '822' + id: '247' type: newsfeed name: Visitor Feed - created_at: 1712223099 - updated_at: 1712223099 + created_at: 1715077663 + updated_at: 1715077663 schema: "$ref": "#/components/schemas/newsfeed" '401': @@ -7955,7 +7982,7 @@ paths: Unauthorized: value: type: error.list - request_id: c2012c43-04eb-45eb-91a1-2651f16426c4 + request_id: 5b84bcc1-655d-4bd0-9c9f-0af2b9cd92fc errors: - code: unauthorized message: Access Token Invalid @@ -7989,16 +8016,16 @@ paths: Note found: value: type: note - id: '447' - created_at: 1711531900 + id: '128' + created_at: 1714386464 contact: type: contact - id: 660e737c6abd01bd27af6200 + id: 663a0220914417f88d1d8d17 author: type: admin - id: '991282613' - name: Ciaran305 Lee - email: admin305@email.com + id: '991271302' + name: Ciaran316 Lee + email: admin316@email.com away_mode_enabled: false away_mode_reassign: false body: "

    This is a note.

    " @@ -8012,7 +8039,7 @@ paths: Note not found: value: type: error.list - request_id: 8278a67c-b6c5-4f84-b3c1-bf23de5be67a + request_id: 7d7396a1-2a7e-4e71-9b49-a343c63cb1e6 errors: - code: not_found message: Resource Not Found @@ -8026,7 +8053,7 @@ paths: Unauthorized: value: type: error.list - request_id: 6f0dfe5b-4919-4da9-81dc-5a907afe9c9c + request_id: 72b11ced-2ed1-42f4-b9b9-806ac8e948f8 errors: - code: unauthorized message: Access Token Invalid @@ -8062,16 +8089,16 @@ paths: type: segment.list segments: - type: segment - id: 660e737d6abd01bd27af6203 + id: 663a0222914417f88d1d8d1a name: John segment - created_at: 1712223101 - updated_at: 1712223101 + created_at: 1715077666 + updated_at: 1715077666 person_type: user - type: segment - id: 660e737e6abd01bd27af6204 + id: 663a0222914417f88d1d8d1b name: Jane segment - created_at: 1712223102 - updated_at: 1712223102 + created_at: 1715077666 + updated_at: 1715077666 person_type: user schema: "$ref": "#/components/schemas/segment_list" @@ -8083,7 +8110,7 @@ paths: Unauthorized: value: type: error.list - request_id: 419a08a9-f746-4410-b1d4-289bc66dd6b7 + request_id: 221ca737-a411-49cf-b598-96adaccaacaf errors: - code: unauthorized message: Access Token Invalid @@ -8117,10 +8144,10 @@ paths: Successful response: value: type: segment - id: 660e737f6abd01bd27af6207 + id: 663a0223914417f88d1d8d1e name: John segment - created_at: 1712223103 - updated_at: 1712223103 + created_at: 1715077667 + updated_at: 1715077667 person_type: user schema: "$ref": "#/components/schemas/segment" @@ -8132,7 +8159,7 @@ paths: Segment not found: value: type: error.list - request_id: 9e17224f-5a5f-4e7b-bebf-77363e4abd67 + request_id: c1c85173-cb14-4d85-91f0-30e7b748e876 errors: - code: not_found message: Resource Not Found @@ -8146,7 +8173,7 @@ paths: Unauthorized: value: type: error.list - request_id: c098a219-43df-43f2-9e1a-2bc542d17d87 + request_id: ee5f13a4-9d5e-4c6e-9020-0db612c300f8 errors: - code: unauthorized message: Access Token Invalid @@ -8176,7 +8203,7 @@ paths: type: list data: - type: subscription - id: '1605' + id: '459' state: live consent_type: opt_out default_translation: @@ -8199,7 +8226,7 @@ paths: Unauthorized: value: type: error.list - request_id: 4aee7d25-df02-48c7-888f-c6218aa6ce30 + request_id: 0bb1f3cf-4f69-4f06-b05e-86ea92a0844e errors: - code: unauthorized message: Access Token Invalid @@ -8229,7 +8256,7 @@ paths: examples: successful: value: - url: http://via.intercom.io/msgr/ce9c9f4a-c77c-492f-92fd-3bfe29efb497 + url: http://via.intercom.io/msgr/73a1a935-4bc8-492b-b8ec-1926bac7d8d8 type: phone_call_redirect schema: "$ref": "#/components/schemas/phone_switch" @@ -8262,7 +8289,7 @@ paths: Unauthorized: value: type: error.list - request_id: 54083c65-6e83-41af-8346-823b2de2afe4 + request_id: 8140f9ba-f157-4383-9a2b-7ef86eed44b5 errors: - code: unauthorized message: Access Token Invalid @@ -8325,7 +8352,7 @@ paths: type: list data: - type: tag - id: '1421' + id: '407' name: Manual tag 1 schema: "$ref": "#/components/schemas/tag_list" @@ -8337,7 +8364,7 @@ paths: Unauthorized: value: type: error.list - request_id: cbaa50b3-cc19-43df-a4fe-cd51b770e02c + request_id: 3502399f-6723-4028-8d8f-e9053b74b71a errors: - code: unauthorized message: Access Token Invalid @@ -8376,7 +8403,7 @@ paths: Action successful: value: type: tag - id: '1424' + id: '410' name: test schema: "$ref": "#/components/schemas/tag" @@ -8388,7 +8415,7 @@ paths: Invalid parameters: value: type: error.list - request_id: f9587c57-3373-4404-a3a3-79af9889f566 + request_id: 6eecc8ec-380a-4feb-8fcc-aef0c1928a16 errors: - code: parameter_invalid message: invalid tag parameters @@ -8402,14 +8429,14 @@ paths: Company not found: value: type: error.list - request_id: 73af6ec4-7503-4705-9302-fc0504e8302d + request_id: 4e333c8a-64a9-417d-aab5-39c05e549592 errors: - code: company_not_found message: Company Not Found User not found: value: type: error.list - request_id: 8c890eb9-34ee-4941-9226-5a5445317729 + request_id: 591f9e47-5cb5-4e73-8089-7e0a31adf133 errors: - code: not_found message: User Not Found @@ -8423,7 +8450,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2bae5381-1b4e-4040-9b12-e7639f90583b + request_id: 5a9bec3e-7e4e-48c0-9db8-d9126612486c errors: - code: unauthorized message: Access Token Invalid @@ -8489,7 +8516,7 @@ paths: Tag found: value: type: tag - id: '1432' + id: '418' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -8501,7 +8528,7 @@ paths: Tag not found: value: type: error.list - request_id: 41f921f1-ba44-4512-8098-b6f12d700286 + request_id: 0f90bdcc-ad16-46d8-b98d-407aa3a910b3 errors: - code: not_found message: Resource Not Found @@ -8515,7 +8542,7 @@ paths: Unauthorized: value: type: error.list - request_id: 111e0274-8594-40ca-a98b-afd8ffe45ec9 + request_id: 322c6b96-6a8f-4c80-9630-683769b56dcf errors: - code: unauthorized message: Access Token Invalid @@ -8551,7 +8578,7 @@ paths: Resource not found: value: type: error.list - request_id: 007c42d3-0d45-492d-b5f3-f76b0e1a0b9f + request_id: 0e048328-9fe8-401b-ace4-f7667136673f errors: - code: not_found message: Resource Not Found @@ -8565,7 +8592,7 @@ paths: Tag has dependent objects: value: type: error.list - request_id: 0a6752d7-ea34-499b-b671-e1d1e1911010 + request_id: 48b4ede9-24b6-4084-af44-4289a26bdc12 errors: - code: tag_has_dependent_objects message: 'Unable to delete Tag with dependent objects. Segments: @@ -8580,7 +8607,7 @@ paths: Unauthorized: value: type: error.list - request_id: 6c48255a-8906-42f2-b32e-b2693e649fc0 + request_id: 62ea0bd1-c9f2-4303-b418-bf154d23c9b3 errors: - code: unauthorized message: Access Token Invalid @@ -8618,7 +8645,7 @@ paths: Unauthorized: value: type: error.list - request_id: ccd5983d-dfa4-4c15-ad0a-f2b575623ab7 + request_id: 6a363138-f586-418a-b0d2-0d19fc2c88b3 errors: - code: unauthorized message: Access Token Invalid @@ -8653,7 +8680,7 @@ paths: successful: value: type: team - id: '991282651' + id: '991271340' name: team 1 admin_ids: [] schema: @@ -8666,7 +8693,7 @@ paths: Team not found: value: type: error.list - request_id: d95b8582-714f-47dc-b588-69fa247621d2 + request_id: eb4fea02-feaf-4bbb-9352-28e86b8cafba errors: - code: team_not_found message: Team not found @@ -8680,7 +8707,7 @@ paths: Unauthorized: value: type: error.list - request_id: f268f543-6414-44d2-989e-f7296e4dbb96 + request_id: e8f12b0f-f004-4f52-894d-58cff5f7e3a2 errors: - code: unauthorized message: Access Token Invalid @@ -8713,8 +8740,8 @@ paths: Ticket Type Attribute created: value: type: ticket_type_attribute - id: '2440' - workspace_id: this_is_an_id578_that_should_be_at_least_ + id: '709' + workspace_id: this_is_an_id589_that_should_be_at_least_ name: Attribute Title description: Attribute Description data_type: string @@ -8726,10 +8753,10 @@ paths: visible_on_create: true visible_to_contacts: true default: false - ticket_type_id: 877 + ticket_type_id: 253 archived: false - created_at: 1712223120 - updated_at: 1712223120 + created_at: 1715077684 + updated_at: 1715077684 schema: "$ref": "#/components/schemas/ticket_type_attribute" '401': @@ -8740,7 +8767,7 @@ paths: Unauthorized: value: type: error.list - request_id: 898a5275-39a7-4052-b744-3e207b3348f6 + request_id: 426fa592-11cc-42f9-8a81-97f5f9ebba69 errors: - code: unauthorized message: Access Token Invalid @@ -8793,8 +8820,8 @@ paths: Ticket Type Attribute updated: value: type: ticket_type_attribute - id: '2445' - workspace_id: this_is_an_id582_that_should_be_at_least_ + id: '714' + workspace_id: this_is_an_id593_that_should_be_at_least_ name: name description: New Attribute Description data_type: string @@ -8804,10 +8831,10 @@ paths: visible_on_create: false visible_to_contacts: false default: false - ticket_type_id: 879 + ticket_type_id: 255 archived: false - created_at: 1712223121 - updated_at: 1712223121 + created_at: 1715077685 + updated_at: 1715077685 schema: "$ref": "#/components/schemas/ticket_type_attribute" '401': @@ -8818,7 +8845,7 @@ paths: Unauthorized: value: type: error.list - request_id: 07e02d6b-03c4-447a-9dad-cf28940c45d2 + request_id: 4866b2ad-1131-4f39-903d-0d39438e6d73 errors: - code: unauthorized message: Access Token Invalid @@ -8857,21 +8884,21 @@ paths: type: list data: - type: ticket_type - id: '881' + id: '257' name: Bug Report description: Bug Report Template icon: "\U0001F39F️" - workspace_id: this_is_an_id586_that_should_be_at_least_ + workspace_id: this_is_an_id597_that_should_be_at_least_ archived: false - created_at: 1712223122 - updated_at: 1712223122 + created_at: 1715077686 + updated_at: 1715077686 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '2448' - workspace_id: this_is_an_id586_that_should_be_at_least_ + id: '717' + workspace_id: this_is_an_id597_that_should_be_at_least_ name: _default_title_ description: '' data_type: string @@ -8883,13 +8910,13 @@ paths: visible_on_create: true visible_to_contacts: true default: true - ticket_type_id: 881 + ticket_type_id: 257 archived: false - created_at: 1712223122 - updated_at: 1712223122 + created_at: 1715077686 + updated_at: 1715077686 - type: ticket_type_attribute - id: '2450' - workspace_id: this_is_an_id586_that_should_be_at_least_ + id: '719' + workspace_id: this_is_an_id597_that_should_be_at_least_ name: name description: description data_type: string @@ -8900,13 +8927,13 @@ paths: visible_on_create: false visible_to_contacts: false default: false - ticket_type_id: 881 + ticket_type_id: 257 archived: false - created_at: 1712223122 - updated_at: 1712223122 + created_at: 1715077686 + updated_at: 1715077686 - type: ticket_type_attribute - id: '2449' - workspace_id: this_is_an_id586_that_should_be_at_least_ + id: '718' + workspace_id: this_is_an_id597_that_should_be_at_least_ name: _default_description_ description: '' data_type: string @@ -8918,10 +8945,10 @@ paths: visible_on_create: true visible_to_contacts: true default: true - ticket_type_id: 881 + ticket_type_id: 257 archived: false - created_at: 1712223122 - updated_at: 1712223122 + created_at: 1715077686 + updated_at: 1715077686 category: Customer schema: "$ref": "#/components/schemas/ticket_type_list" @@ -8933,7 +8960,7 @@ paths: Unauthorized: value: type: error.list - request_id: 10b89058-bc9b-4de4-855a-705b3f7491b0 + request_id: af0904d2-3f4e-464d-bb93-f4efec256630 errors: - code: unauthorized message: Access Token Invalid @@ -8962,21 +8989,21 @@ paths: Ticket type created: value: type: ticket_type - id: '884' + id: '260' name: Customer Issue description: Customer Report Template icon: "\U0001F39F️" - workspace_id: this_is_an_id590_that_should_be_at_least_ + workspace_id: this_is_an_id601_that_should_be_at_least_ archived: false - created_at: 1712223124 - updated_at: 1712223124 + created_at: 1715077687 + updated_at: 1715077687 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '2457' - workspace_id: this_is_an_id590_that_should_be_at_least_ + id: '726' + workspace_id: this_is_an_id601_that_should_be_at_least_ name: _default_title_ description: '' data_type: string @@ -8988,13 +9015,13 @@ paths: visible_on_create: true visible_to_contacts: true default: true - ticket_type_id: 884 + ticket_type_id: 260 archived: false - created_at: 1712223124 - updated_at: 1712223124 + created_at: 1715077688 + updated_at: 1715077688 - type: ticket_type_attribute - id: '2458' - workspace_id: this_is_an_id590_that_should_be_at_least_ + id: '727' + workspace_id: this_is_an_id601_that_should_be_at_least_ name: _default_description_ description: '' data_type: string @@ -9006,10 +9033,10 @@ paths: visible_on_create: true visible_to_contacts: true default: true - ticket_type_id: 884 + ticket_type_id: 260 archived: false - created_at: 1712223124 - updated_at: 1712223124 + created_at: 1715077688 + updated_at: 1715077688 category: Customer schema: "$ref": "#/components/schemas/ticket_type" @@ -9021,7 +9048,7 @@ paths: Unauthorized: value: type: error.list - request_id: 5ee68dbf-49fe-40c2-be38-6e5b23679276 + request_id: fea4bfde-3f91-4411-a1b0-f310f0ac2201 errors: - code: unauthorized message: Access Token Invalid @@ -9067,21 +9094,21 @@ paths: Ticket type found: value: type: ticket_type - id: '886' + id: '262' name: Bug Report description: Bug Report Template icon: "\U0001F39F️" - workspace_id: this_is_an_id594_that_should_be_at_least_ + workspace_id: this_is_an_id605_that_should_be_at_least_ archived: false - created_at: 1712223125 - updated_at: 1712223125 + created_at: 1715077688 + updated_at: 1715077688 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '2462' - workspace_id: this_is_an_id594_that_should_be_at_least_ + id: '731' + workspace_id: this_is_an_id605_that_should_be_at_least_ name: _default_title_ description: '' data_type: string @@ -9093,13 +9120,13 @@ paths: visible_on_create: true visible_to_contacts: true default: true - ticket_type_id: 886 + ticket_type_id: 262 archived: false - created_at: 1712223125 - updated_at: 1712223125 + created_at: 1715077688 + updated_at: 1715077688 - type: ticket_type_attribute - id: '2464' - workspace_id: this_is_an_id594_that_should_be_at_least_ + id: '733' + workspace_id: this_is_an_id605_that_should_be_at_least_ name: name description: description data_type: string @@ -9110,13 +9137,13 @@ paths: visible_on_create: false visible_to_contacts: false default: false - ticket_type_id: 886 + ticket_type_id: 262 archived: false - created_at: 1712223125 - updated_at: 1712223125 + created_at: 1715077688 + updated_at: 1715077688 - type: ticket_type_attribute - id: '2463' - workspace_id: this_is_an_id594_that_should_be_at_least_ + id: '732' + workspace_id: this_is_an_id605_that_should_be_at_least_ name: _default_description_ description: '' data_type: string @@ -9128,10 +9155,10 @@ paths: visible_on_create: true visible_to_contacts: true default: true - ticket_type_id: 886 + ticket_type_id: 262 archived: false - created_at: 1712223125 - updated_at: 1712223125 + created_at: 1715077688 + updated_at: 1715077688 category: Customer schema: "$ref": "#/components/schemas/ticket_type" @@ -9143,7 +9170,7 @@ paths: Unauthorized: value: type: error.list - request_id: 3c973783-7388-40b5-9982-c1bf0b096d69 + request_id: da9ec546-09ab-47b0-9901-5940d58d4638 errors: - code: unauthorized message: Access Token Invalid @@ -9176,21 +9203,21 @@ paths: Ticket type updated: value: type: ticket_type - id: '888' + id: '264' name: Bug Report 2 description: Bug Report Template icon: "\U0001F39F️" - workspace_id: this_is_an_id598_that_should_be_at_least_ + workspace_id: this_is_an_id609_that_should_be_at_least_ archived: false - created_at: 1712223126 - updated_at: 1712223127 + created_at: 1715077689 + updated_at: 1715077689 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '2468' - workspace_id: this_is_an_id598_that_should_be_at_least_ + id: '737' + workspace_id: this_is_an_id609_that_should_be_at_least_ name: _default_title_ description: '' data_type: string @@ -9202,13 +9229,13 @@ paths: visible_on_create: true visible_to_contacts: true default: true - ticket_type_id: 888 + ticket_type_id: 264 archived: false - created_at: 1712223126 - updated_at: 1712223126 + created_at: 1715077689 + updated_at: 1715077689 - type: ticket_type_attribute - id: '2470' - workspace_id: this_is_an_id598_that_should_be_at_least_ + id: '739' + workspace_id: this_is_an_id609_that_should_be_at_least_ name: name description: description data_type: string @@ -9219,13 +9246,13 @@ paths: visible_on_create: false visible_to_contacts: false default: false - ticket_type_id: 888 + ticket_type_id: 264 archived: false - created_at: 1712223126 - updated_at: 1712223126 + created_at: 1715077689 + updated_at: 1715077689 - type: ticket_type_attribute - id: '2469' - workspace_id: this_is_an_id598_that_should_be_at_least_ + id: '738' + workspace_id: this_is_an_id609_that_should_be_at_least_ name: _default_description_ description: '' data_type: string @@ -9237,10 +9264,10 @@ paths: visible_on_create: true visible_to_contacts: true default: true - ticket_type_id: 888 + ticket_type_id: 264 archived: false - created_at: 1712223126 - updated_at: 1712223126 + created_at: 1715077689 + updated_at: 1715077689 category: Customer schema: "$ref": "#/components/schemas/ticket_type" @@ -9252,7 +9279,7 @@ paths: Unauthorized: value: type: error.list - request_id: 6558fb4a-e538-474a-8be0-b0c2a15b1a50 + request_id: dea7879e-2b0a-4bd7-83ea-11947df46a3b errors: - code: unauthorized message: Access Token Invalid @@ -9298,13 +9325,13 @@ paths: User reply: value: type: ticket_part - id: '1139' + id: '340' part_type: comment body: "

    Thanks again :)

    " - created_at: 1712223129 - updated_at: 1712223129 + created_at: 1715077692 + updated_at: 1715077692 author: - id: 660e73996abd01bd27af622a + id: 663a023c914417f88d1d8d41 type: user name: email: user30@email.com @@ -9313,7 +9340,7 @@ paths: Admin note reply: value: type: ticket_part - id: '1141' + id: '342' part_type: note body: |-

    An Unordered HTML List

    @@ -9328,27 +9355,27 @@ paths:
  • Tea
  • Milk
    • - created_at: 1712223132 - updated_at: 1712223132 + created_at: 1715077694 + updated_at: 1715077694 author: - id: '991282678' + id: '991271367' type: admin - name: Ciaran364 Lee - email: admin364@email.com + name: Ciaran375 Lee + email: admin375@email.com attachments: [] redacted: false Admin quick_reply reply: value: type: ticket_part - id: '1143' + id: '344' part_type: quick_reply - created_at: 1712223135 - updated_at: 1712223135 + created_at: 1715077697 + updated_at: 1715077697 author: - id: '991282683' + id: '991271372' type: admin - name: Ciaran368 Lee - email: admin368@email.com + name: Ciaran379 Lee + email: admin379@email.com attachments: [] redacted: false schema: @@ -9361,7 +9388,7 @@ paths: Not found: value: type: error.list - request_id: 2fde67b4-e880-4617-872f-1b865910add9 + request_id: 3ba587aa-b5a8-4964-8685-4e51cf067c9d errors: - code: not_found message: Resource Not Found @@ -9375,7 +9402,7 @@ paths: Unauthorized: value: type: error.list - request_id: c387924c-8bf7-4979-a1e2-77670f7ae5e9 + request_id: c1607bc3-0fc0-4c23-8ea0-68f9ce1366d0 errors: - code: unauthorized message: Access Token Invalid @@ -9392,14 +9419,14 @@ paths: value: message_type: comment type: user - intercom_user_id: 660e73996abd01bd27af622a + intercom_user_id: 663a023c914417f88d1d8d41 body: Thanks again :) admin_note_reply: summary: Admin note reply value: message_type: note type: admin - admin_id: 991282678 + admin_id: 991271367 body: "

    An Unordered HTML List

    An Ordered HTML List

    \
    1. Coffee
    2. Tea
    3. Milk
    @@ -9409,18 +9436,18 @@ paths: value: message_type: quick_reply type: admin - admin_id: 991282683 + admin_id: 991271372 reply_options: - text: 'Yes' - uuid: f88c9da5-365f-4578-8f5a-108611a16ef3 + uuid: 96a37f3e-5b13-4013-b34b-833886c2a87a - text: 'No' - uuid: de46cbbf-48f8-45c1-a487-d7f817b95b2c + uuid: '09fad886-2505-43ef-b5e3-aea6b67d95d1' not_found: summary: Not found value: message_type: comment type: user - intercom_user_id: 660e73a16abd01bd27af622d + intercom_user_id: 663a0242914417f88d1d8d44 body: Thanks again :) "/tickets/{ticket_id}/tags": post: @@ -9452,7 +9479,7 @@ paths: successful: value: type: tag - id: '1440' + id: '426' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -9464,7 +9491,7 @@ paths: Ticket not found: value: type: error.list - request_id: 22516d1f-1a97-457e-8f3e-9e35c3724a78 + request_id: 9fb34c5d-0b23-4299-b00c-18168adcb36f errors: - code: ticket_not_found message: Ticket not found @@ -9478,7 +9505,7 @@ paths: Unauthorized: value: type: error.list - request_id: 11b489e1-4dc2-49db-86bc-12d5eccb438f + request_id: c057a286-780e-47f8-8180-5bd49f12dcdf errors: - code: unauthorized message: Access Token Invalid @@ -9507,13 +9534,13 @@ paths: successful: summary: successful value: - id: 1440 - admin_id: 991282693 + id: 426 + admin_id: 991271382 ticket_not_found: summary: Ticket not found value: - id: 1441 - admin_id: 991282696 + id: 427 + admin_id: 991271385 "/tickets/{ticket_id}/tags/{id}": delete: summary: Remove tag from a ticket @@ -9551,7 +9578,7 @@ paths: successful: value: type: tag - id: '1443' + id: '429' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -9563,14 +9590,14 @@ paths: Ticket not found: value: type: error.list - request_id: bd0c0062-2178-4a46-ae8f-be01beb99393 + request_id: 0a320306-0505-4b13-9215-c650f21fb206 errors: - code: ticket_not_found message: Ticket not found Tag not found: value: type: error.list - request_id: 6ee18c4e-b3be-476f-b4bc-fa87f56c4a70 + request_id: 4d1b6aef-2cdb-4801-afa4-22e41323dc32 errors: - code: tag_not_found message: Tag not found @@ -9584,7 +9611,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8aa28acb-a1e5-4674-8867-1022490d651f + request_id: f0e5e21e-7368-409b-aae7-895b2463937b errors: - code: unauthorized message: Access Token Invalid @@ -9607,15 +9634,15 @@ paths: successful: summary: successful value: - admin_id: 991282702 + admin_id: 991271391 ticket_not_found: summary: Ticket not found value: - admin_id: 991282705 + admin_id: 991271394 tag_not_found: summary: Tag not found value: - admin_id: 991282708 + admin_id: 991271397 "/tickets": post: summary: Create a ticket @@ -9637,8 +9664,8 @@ paths: Successful response: value: type: ticket - id: '4898' - ticket_id: '218' + id: '1551' + ticket_id: '75' ticket_attributes: title: example description: there is a problem @@ -9647,21 +9674,21 @@ paths: ticket_state_external_label: Submitted ticket_type: type: ticket_type - id: '902' + id: '278' name: my-ticket-type-15 description: my ticket type description is awesome. icon: "\U0001F981" - workspace_id: this_is_an_id626_that_should_be_at_least_ + workspace_id: this_is_an_id637_that_should_be_at_least_ archived: false - created_at: 1712223152 - updated_at: 1712223152 + created_at: 1715077712 + updated_at: 1715077712 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '2482' - workspace_id: this_is_an_id626_that_should_be_at_least_ + id: '751' + workspace_id: this_is_an_id637_that_should_be_at_least_ name: title description: ola data_type: string @@ -9672,13 +9699,13 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 902 + ticket_type_id: 278 archived: false - created_at: 1712223152 - updated_at: 1712223152 + created_at: 1715077712 + updated_at: 1715077712 - type: ticket_type_attribute - id: '2483' - workspace_id: this_is_an_id626_that_should_be_at_least_ + id: '752' + workspace_id: this_is_an_id637_that_should_be_at_least_ name: description description: ola data_type: string @@ -9689,36 +9716,36 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 902 + ticket_type_id: 278 archived: false - created_at: 1712223153 - updated_at: 1712223153 + created_at: 1715077712 + updated_at: 1715077712 category: Back-office contacts: type: contact.list contacts: - type: contact - id: 660e73b16abd01bd27af6235 + id: 663a0250914417f88d1d8d4c external_id: '70' admin_assignee_id: '0' team_assignee_id: '0' - created_at: 1712223153 - updated_at: 1712223154 + created_at: 1715077712 + updated_at: 1715077713 ticket_parts: type: ticket_part.list ticket_parts: - type: ticket_part - id: '1144' + id: '345' part_type: ticket_state_updated_by_admin ticket_state: submitted previous_ticket_state: submitted - created_at: 1712223154 - updated_at: 1712223154 + created_at: 1715077713 + updated_at: 1715077713 author: - id: '991282720' + id: '991271409' type: bot name: Operator - email: operator+this_is_an_id626_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id637_that_should_be_at_least_@intercom.io attachments: [] redacted: false total_count: 1 @@ -9740,7 +9767,7 @@ paths: Unauthorized: value: type: error.list - request_id: 96ba8969-c5c7-4ee8-9737-f4418eea45e7 + request_id: ada6f379-670a-4fac-b7c0-8b4f73b2f966 errors: - code: unauthorized message: Access Token Invalid @@ -9755,9 +9782,9 @@ paths: successful_response: summary: Successful response value: - ticket_type_id: 902 + ticket_type_id: 278 contacts: - - id: 660e73b16abd01bd27af6235 + - id: 663a0250914417f88d1d8d4c ticket_attributes: title: example description: there is a problem @@ -9788,8 +9815,8 @@ paths: Successful response: value: type: ticket - id: '4899' - ticket_id: '219' + id: '1552' + ticket_id: '76' ticket_attributes: title: example description: there is a problem @@ -9798,21 +9825,21 @@ paths: ticket_state_external_label: In progress ticket_type: type: ticket_type - id: '904' + id: '280' name: my-ticket-type-17 description: my ticket type description is awesome. icon: "\U0001F981" - workspace_id: this_is_an_id630_that_should_be_at_least_ + workspace_id: this_is_an_id641_that_should_be_at_least_ archived: false - created_at: 1712223155 - updated_at: 1712223155 + created_at: 1715077714 + updated_at: 1715077714 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '2487' - workspace_id: this_is_an_id630_that_should_be_at_least_ + id: '756' + workspace_id: this_is_an_id641_that_should_be_at_least_ name: title description: ola data_type: string @@ -9823,13 +9850,13 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 904 + ticket_type_id: 280 archived: false - created_at: 1712223155 - updated_at: 1712223155 + created_at: 1715077714 + updated_at: 1715077714 - type: ticket_type_attribute - id: '2488' - workspace_id: this_is_an_id630_that_should_be_at_least_ + id: '757' + workspace_id: this_is_an_id641_that_should_be_at_least_ name: description description: ola data_type: string @@ -9840,106 +9867,106 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 904 + ticket_type_id: 280 archived: false - created_at: 1712223155 - updated_at: 1712223155 + created_at: 1715077714 + updated_at: 1715077714 category: Back-office contacts: type: contact.list contacts: - type: contact - id: 660e73b36abd01bd27af6236 - external_id: c6314907-b086-43d5-892a-481e5dab9e4f - admin_assignee_id: '991282734' + id: 663a0253914417f88d1d8d4d + external_id: d159a1af-f1a0-42fb-ac94-a9a278f6b19b + admin_assignee_id: '991271423' team_assignee_id: '0' - created_at: 1712223156 - updated_at: 1712223158 + created_at: 1715077715 + updated_at: 1715077718 ticket_parts: type: ticket_part.list ticket_parts: - type: ticket_part - id: '1145' + id: '346' part_type: ticket_state_updated_by_admin ticket_state: submitted previous_ticket_state: submitted - created_at: 1712223156 - updated_at: 1712223156 + created_at: 1715077715 + updated_at: 1715077715 author: - id: '991282732' + id: '991271421' type: admin - name: Ciaran408 Lee - email: admin408@email.com + name: Ciaran419 Lee + email: admin419@email.com attachments: [] redacted: false - type: ticket_part - id: '1146' + id: '347' part_type: ticket_attribute_updated_by_admin - created_at: 1712223157 - updated_at: 1712223157 + created_at: 1715077716 + updated_at: 1715077716 author: - id: '991282733' + id: '991271422' type: bot name: Operator - email: operator+this_is_an_id630_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id641_that_should_be_at_least_@intercom.io attachments: [] redacted: false - type: ticket_part - id: '1147' + id: '348' part_type: ticket_attribute_updated_by_admin - created_at: 1712223157 - updated_at: 1712223157 + created_at: 1715077717 + updated_at: 1715077717 author: - id: '991282733' + id: '991271422' type: bot name: Operator - email: operator+this_is_an_id630_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id641_that_should_be_at_least_@intercom.io attachments: [] redacted: false - type: ticket_part - id: '1148' + id: '349' part_type: ticket_state_updated_by_admin ticket_state: in_progress previous_ticket_state: submitted - created_at: 1712223158 - updated_at: 1712223158 + created_at: 1715077717 + updated_at: 1715077717 author: - id: '991282733' + id: '991271422' type: bot name: Operator - email: operator+this_is_an_id630_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id641_that_should_be_at_least_@intercom.io attachments: [] redacted: false - type: ticket_part - id: '1149' + id: '350' part_type: assignment - created_at: 1712223158 - updated_at: 1712223158 + created_at: 1715077717 + updated_at: 1715077717 assigned_to: type: admin - id: '991282734' + id: '991271423' author: - id: '991282732' + id: '991271421' type: admin - name: Ciaran408 Lee - email: admin408@email.com + name: Ciaran419 Lee + email: admin419@email.com attachments: [] redacted: false - type: ticket_part - id: '1150' + id: '351' part_type: snoozed - created_at: 1712223158 - updated_at: 1712223158 + created_at: 1715077718 + updated_at: 1715077718 author: - id: '991282733' + id: '991271422' type: bot name: Operator - email: operator+this_is_an_id630_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id641_that_should_be_at_least_@intercom.io attachments: [] redacted: false total_count: 6 open: true - snoozed_until: 1712332800 + snoozed_until: 1715184000 linked_objects: type: list data: [] @@ -9957,14 +9984,14 @@ paths: Admin not found: value: type: error.list - request_id: a5fd8548-a870-4ca7-ac77-6adbdbc8b258 + request_id: 6aa2451a-bfd8-4f76-9a94-457d9313ab4c errors: - code: assignee_not_found message: Assignee not found Assignee not found: value: type: error.list - request_id: 90409b1d-83a7-4d50-99b7-12eded21e67e + request_id: ec3ce1cd-a8a9-429b-a5cb-00fc6ac4a68d errors: - code: assignee_not_found message: Assignee not found @@ -9976,7 +10003,7 @@ paths: Unauthorized: value: type: error.list - request_id: bc6ed064-d3ce-4afc-b3ff-110ab84d18de + request_id: 18e07fb0-2b87-40c5-bef3-54b35fb917cc errors: - code: unauthorized message: Access Token Invalid @@ -9996,8 +10023,8 @@ paths: description: there is a problem state: in_progress assignment: - admin_id: '991282732' - assignee_id: '991282734' + admin_id: '991271421' + assignee_id: '991271423' open: true snoozed_until: 1673609604 admin_not_found: @@ -10009,7 +10036,7 @@ paths: state: in_progress assignment: admin_id: '123' - assignee_id: '991282742' + assignee_id: '991271431' assignee_not_found: summary: Assignee not found value: @@ -10018,7 +10045,7 @@ paths: description: there is a problem state: in_progress assignment: - admin_id: '991282748' + admin_id: '991271437' assignee_id: '456' get: summary: Retrieve a ticket @@ -10046,8 +10073,8 @@ paths: Ticket found: value: type: ticket - id: '4902' - ticket_id: '222' + id: '1555' + ticket_id: '79' ticket_attributes: title: attribute_value description: @@ -10056,21 +10083,21 @@ paths: ticket_state_external_label: Submitted ticket_type: type: ticket_type - id: '908' + id: '284' name: my-ticket-type-21 description: my ticket type description is awesome. icon: "\U0001F981" - workspace_id: this_is_an_id638_that_should_be_at_least_ + workspace_id: this_is_an_id649_that_should_be_at_least_ archived: false - created_at: 1712223165 - updated_at: 1712223165 + created_at: 1715077723 + updated_at: 1715077723 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '2498' - workspace_id: this_is_an_id638_that_should_be_at_least_ + id: '767' + workspace_id: this_is_an_id649_that_should_be_at_least_ name: title description: ola data_type: string @@ -10081,13 +10108,13 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 908 + ticket_type_id: 284 archived: false - created_at: 1712223165 - updated_at: 1712223165 + created_at: 1715077723 + updated_at: 1715077723 - type: ticket_type_attribute - id: '2499' - workspace_id: this_is_an_id638_that_should_be_at_least_ + id: '768' + workspace_id: this_is_an_id649_that_should_be_at_least_ name: description description: ola data_type: string @@ -10098,36 +10125,36 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 908 + ticket_type_id: 284 archived: false - created_at: 1712223165 - updated_at: 1712223165 + created_at: 1715077723 + updated_at: 1715077723 category: Back-office contacts: type: contact.list contacts: - type: contact - id: 660e73bd6abd01bd27af6239 - external_id: 6e53e8ae-3dc5-4d94-82bd-a31908760f77 + id: 663a025b914417f88d1d8d50 + external_id: 4e5c5327-5553-4cf9-96f1-384e9fdd020b admin_assignee_id: '0' team_assignee_id: '0' - created_at: 1712223165 - updated_at: 1712223166 + created_at: 1715077724 + updated_at: 1715077724 ticket_parts: type: ticket_part.list ticket_parts: - type: ticket_part - id: '1153' + id: '354' part_type: ticket_state_updated_by_admin ticket_state: submitted previous_ticket_state: submitted - created_at: 1712223166 - updated_at: 1712223166 + created_at: 1715077724 + updated_at: 1715077724 author: - id: '991282761' + id: '991271450' type: admin - name: Ciaran434 Lee - email: admin434@email.com + name: Ciaran445 Lee + email: admin445@email.com attachments: [] redacted: false total_count: 1 @@ -10149,7 +10176,7 @@ paths: Unauthorized: value: type: error.list - request_id: 7e42f456-8424-4ccd-b4af-436c125118f8 + request_id: afd92b70-8340-428c-bd01-4c1c46b424fd errors: - code: unauthorized message: Access Token Invalid @@ -10172,6 +10199,12 @@ paths: To search for tickets, you send a `POST` request to `https://api.intercom.io/tickets/search`. This will accept a query object in the body which will define your filters. + {% admonition type="warning" name="Optimizing search queries" %} + Search queries can be complex, so optimizing them can help the performance of your search. + Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize + pagination to limit the number of results returned. The default is `20` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param. + {% /admonition %} ### Nesting & Limitations @@ -10239,8 +10272,8 @@ paths: total_count: 1 tickets: - type: ticket - id: '4903' - ticket_id: '223' + id: '1556' + ticket_id: '80' ticket_attributes: title: attribute_value description: @@ -10249,21 +10282,21 @@ paths: ticket_state_external_label: Submitted ticket_type: type: ticket_type - id: '910' + id: '286' name: my-ticket-type-23 description: my ticket type description is awesome. icon: "\U0001F981" - workspace_id: this_is_an_id642_that_should_be_at_least_ + workspace_id: this_is_an_id653_that_should_be_at_least_ archived: false - created_at: 1712223168 - updated_at: 1712223168 + created_at: 1715077726 + updated_at: 1715077726 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '2503' - workspace_id: this_is_an_id642_that_should_be_at_least_ + id: '772' + workspace_id: this_is_an_id653_that_should_be_at_least_ name: title description: ola data_type: string @@ -10274,13 +10307,13 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 910 + ticket_type_id: 286 archived: false - created_at: 1712223168 - updated_at: 1712223168 + created_at: 1715077726 + updated_at: 1715077726 - type: ticket_type_attribute - id: '2504' - workspace_id: this_is_an_id642_that_should_be_at_least_ + id: '773' + workspace_id: this_is_an_id653_that_should_be_at_least_ name: description description: ola data_type: string @@ -10291,36 +10324,36 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 910 + ticket_type_id: 286 archived: false - created_at: 1712223168 - updated_at: 1712223168 + created_at: 1715077726 + updated_at: 1715077726 category: Back-office contacts: type: contact.list contacts: - type: contact - id: 660e73c06abd01bd27af623a - external_id: ba95f43e-ddbd-4e7a-9581-54ff26ae28e4 + id: 663a025f914417f88d1d8d51 + external_id: e6474acf-1e38-4cfd-978a-93ca4a2bbebc admin_assignee_id: '0' team_assignee_id: '0' - created_at: 1712223168 - updated_at: 1712223169 + created_at: 1715077727 + updated_at: 1715077727 ticket_parts: type: ticket_part.list ticket_parts: - type: ticket_part - id: '1154' + id: '355' part_type: ticket_state_updated_by_admin ticket_state: submitted previous_ticket_state: submitted - created_at: 1712223169 - updated_at: 1712223169 + created_at: 1715077727 + updated_at: 1715077727 author: - id: '991282774' + id: '991271463' type: admin - name: Ciaran446 Lee - email: admin446@email.com + name: Ciaran457 Lee + email: admin457@email.com attachments: [] redacted: false total_count: 1 @@ -10348,15 +10381,15 @@ paths: value: - field: id operator: "=" - value: '4903' + value: '1556' - operator: OR value: - field: id operator: "=" - value: '4903' + value: '1556' - field: id operator: "=" - value: '4903' + value: '1556' "/visitors": put: summary: Update a visitor @@ -10383,26 +10416,26 @@ paths: successful: value: type: visitor - id: 660e73c36abd01bd27af623d + id: 663a0261914417f88d1d8d54 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' phone: name: Gareth Bale - pseudonym: Silver Basketball + pseudonym: Grey Stereo avatar: type: avatar - image_url: https://static.intercomassets.com/app/pseudonym_avatars_2019/silver-basketball.png - app_id: this_is_an_id646_that_should_be_at_least_ + image_url: https://static.intercomassets.com/app/pseudonym_avatars_2019/grey-stereo.png + app_id: this_is_an_id657_that_should_be_at_least_ companies: type: company.list companies: [] location_data: {} last_request_at: - created_at: 1712223171 - remote_created_at: 1712223171 - signed_up_at: 1712223171 - updated_at: 1712223171 + created_at: 1715077729 + remote_created_at: 1715077729 + signed_up_at: 1715077729 + updated_at: 1715077729 session_count: 0 social_profiles: type: social_profile.list @@ -10435,7 +10468,7 @@ paths: visitor Not Found: value: type: error.list - request_id: 6c4915ff-452a-4bb7-8fd4-4664a5706ac4 + request_id: 01a9b57a-4369-476b-9279-7b945e6a6009 errors: - code: not_found message: Visitor Not Found @@ -10449,7 +10482,7 @@ paths: Unauthorized: value: type: error.list - request_id: 47a5d662-d183-42a5-8180-ba0c6414a8ef + request_id: 1076f7f9-0ef9-45b9-8110-68753e3a9efe errors: - code: unauthorized message: Access Token Invalid @@ -10464,7 +10497,7 @@ paths: successful: summary: successful value: - id: 660e73c36abd01bd27af623d + id: 663a0261914417f88d1d8d54 name: Gareth Bale visitor_not_found: summary: visitor Not Found @@ -10497,7 +10530,7 @@ paths: successful: value: type: visitor - id: 660e73c56abd01bd27af6243 + id: 663a0263914417f88d1d8d5a user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' @@ -10507,16 +10540,16 @@ paths: avatar: type: avatar image_url: - app_id: this_is_an_id652_that_should_be_at_least_ + app_id: this_is_an_id663_that_should_be_at_least_ companies: type: company.list companies: [] location_data: {} last_request_at: - created_at: 1712223173 - remote_created_at: 1712223173 - signed_up_at: 1712223173 - updated_at: 1712223173 + created_at: 1715077731 + remote_created_at: 1715077731 + signed_up_at: 1715077731 + updated_at: 1715077731 session_count: 0 social_profiles: type: social_profile.list @@ -10549,7 +10582,7 @@ paths: Visitor not found: value: type: error.list - request_id: 387bc369-1066-42da-be33-294e8acf20fa + request_id: 3afc2adb-1dff-4ad6-b2ba-35e4bb1b958e errors: - code: not_found message: Visitor Not Found @@ -10563,206 +10596,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8ffa536e-07eb-40e6-846e-4a0aa956fd4b - errors: - - code: unauthorized - message: Access Token Invalid - schema: - "$ref": "#/components/schemas/error" - "/visitors/{id}": - get: - summary: Retrieve a visitor with ID - parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - - name: id - in: path - required: true - description: Id provided by Intercom. - example: 5e1c4c1c-7b1e-4b5d-8c1c-5e1c4c1c7b1e - schema: - type: string - tags: - - Visitors - operationId: retrieveVisitor - description: You can fetch the details of a single visitor. - responses: - '200': - description: successful - content: - application/json: - examples: - successful: - value: - type: visitor - id: 660e73c76abd01bd27af6249 - user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 - anonymous: true - email: '' - phone: - name: - pseudonym: - avatar: - type: avatar - image_url: - app_id: this_is_an_id658_that_should_be_at_least_ - companies: - type: company.list - companies: [] - location_data: {} - last_request_at: - created_at: 1712223175 - remote_created_at: 1712223175 - signed_up_at: 1712223175 - updated_at: 1712223175 - session_count: 0 - social_profiles: - type: social_profile.list - social_profiles: [] - owner_id: - unsubscribed_from_emails: false - marked_email_as_spam: false - has_hard_bounced: false - tags: - type: tag.list - tags: [] - segments: - type: segment.list - segments: [] - custom_attributes: {} - referrer: - utm_campaign: - utm_content: - utm_medium: - utm_source: - utm_term: - do_not_track: - schema: - "$ref": "#/components/schemas/visitor" - '404': - description: Visitor not found - content: - application/json: - examples: - Visitor not found: - value: - type: error.list - request_id: fa70c86c-62e2-4b0d-ab19-88b412e658e0 - errors: - - code: not_found - message: Visitor Not Found - schema: - "$ref": "#/components/schemas/error" - '401': - description: Unauthorized - content: - application/json: - examples: - Unauthorized: - value: - type: error.list - request_id: 40aeb187-0564-4918-b26a-227ed5c81cb1 - errors: - - code: unauthorized - message: Access Token Invalid - schema: - "$ref": "#/components/schemas/error" - delete: - summary: Delete a visitor - parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - - name: id - in: path - required: true - description: Id provided by Intercom. - example: 5e1c4c1c-7b1e-4b5d-8c1c-5e1c4c1c7b1e - schema: - type: string - tags: - - Visitors - operationId: deleteVisitor - description: You can delete a single visitor. - responses: - '200': - description: successful - content: - application/json: - examples: - successful: - value: - type: visitor - id: 660e73c86abd01bd27af624f - user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 - anonymous: true - email: '' - phone: - name: - pseudonym: - avatar: - type: avatar - image_url: - app_id: this_is_an_id664_that_should_be_at_least_ - companies: - type: company.list - companies: [] - location_data: {} - last_request_at: - created_at: 1712223176 - remote_created_at: 1712223176 - signed_up_at: 1712223176 - updated_at: 1712223177 - session_count: 0 - social_profiles: - type: social_profile.list - social_profiles: [] - owner_id: - unsubscribed_from_emails: false - marked_email_as_spam: false - has_hard_bounced: false - tags: - type: tag.list - tags: [] - segments: - type: segment.list - segments: [] - custom_attributes: {} - referrer: - utm_campaign: - utm_content: - utm_medium: - utm_source: - utm_term: - do_not_track: - schema: - "$ref": "#/components/schemas/visitor_deleted_object" - '404': - description: Visitor Not Found - content: - application/json: - examples: - Visitor Not Found: - value: - type: error.list - request_id: c0518c74-9f64-4c7e-bf69-83f7fe821f75 - errors: - - code: not_found - message: User Not Found - schema: - "$ref": "#/components/schemas/error" - '401': - description: Unauthorized - content: - application/json: - examples: - Unauthorized: - value: - type: error.list - request_id: 33afeaab-c788-4ae4-a9a3-93a1735c685e + request_id: 2a90c43c-e90a-4040-92b9-7030d0b91a73 errors: - code: unauthorized message: Access Token Invalid @@ -10793,8 +10627,8 @@ paths: successful: value: type: contact - id: 660e73ca6abd01bd27af6256 - workspace_id: this_is_an_id670_that_should_be_at_least_ + id: 663a0265914417f88d1d8d61 + workspace_id: this_is_an_id669_that_should_be_at_least_ external_id: role: user email: foo@bar.com @@ -10808,9 +10642,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1712223178 - updated_at: 1712223179 - signed_up_at: 1712223178 + created_at: 1715077733 + updated_at: 1715077733 + signed_up_at: 1715077733 last_seen_at: last_replied_at: last_contacted_at: @@ -10844,31 +10678,31 @@ paths: tags: type: list data: [] - url: "/contacts/660e73ca6abd01bd27af6256/tags" + url: "/contacts/663a0265914417f88d1d8d61/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/660e73ca6abd01bd27af6256/notes" + url: "/contacts/663a0265914417f88d1d8d61/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/660e73ca6abd01bd27af6256/companies" + url: "/contacts/663a0265914417f88d1d8d61/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/660e73ca6abd01bd27af6256/subscriptions" + url: "/contacts/663a0265914417f88d1d8d61/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/660e73ca6abd01bd27af6256/subscriptions" + url: "/contacts/663a0265914417f88d1d8d61/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -10887,7 +10721,7 @@ paths: Unauthorized: value: type: error.list - request_id: 43d90f4a-542c-495e-b008-4ee1a6a5e73a + request_id: 99ee6eee-34c1-429c-8b75-ca700735e641 errors: - code: unauthorized message: Access Token Invalid @@ -14024,6 +13858,11 @@ components: - email example: - id: '1234' + company_id: + type: string + description: The ID of the company that the ticket is associated with. The + ID that you set upon company creation. + example: '1234' ticket_attributes: "$ref": "#/components/schemas/ticket_request_custom_attributes" required: @@ -14999,6 +14838,7 @@ components: - '2.8' - '2.9' - '2.10' + - '2.11' - Unstable linked_object: title: Linked Object @@ -15117,6 +14957,8 @@ components: - body - message_type multiple_filter_search_request: + title: Multiple Filter Search Request + description: Search using Intercoms Search APIs with more than one filter. type: object properties: operator: @@ -15668,12 +15510,14 @@ components: description: A pagination object, which may be empty, indicating no further pages to fetch. single_filter_search_request: + title: Single Filter Search Request + description: Search using Intercoms Search APIs with a single filter. type: object properties: field: type: string - description: The Intercom defined id representing the company. - example: custom_attributes.social_network + description: The accepted field that you want to search on. + example: created_at operator: type: string enum: @@ -15687,12 +15531,13 @@ components: - "!~" - "^" - "$" - description: The Intercom defined id representing the company. - example: "=" + description: The accepted operators you can use to define how you want to + search for the value. + example: ">" value: type: string - description: The Intercom defined id representing the company. - example: facebook + description: The value that you want to search on. + example: '73732934' sla_applied: title: Applied SLA type: object @@ -15765,16 +15610,20 @@ components: description: The name of the Social media profile example: http://twitter.com/th1sland starting_after_paging: - title: StartingAfterPaging + title: 'Pagination: Starting After' type: object nullable: true properties: - page: + per_page: type: integer + description: The number of results to fetch per page. example: 2 starting_after: type: string - example: 1HaSB+xrOyyMXAkS/c1RteCL7BzOzTvYjmjakgTergIH31eoe2v4/sbLsJWP\nIncfQLD3ouPkZlCwJ86F\n + description: The cursor to use in the next request to get the next page + of results. + nullable: true + example: your-cursor-from-response subscription_type: title: Subscription Types type: object diff --git a/descriptions/2.11/api.intercom.io.yaml b/descriptions/2.11/api.intercom.io.yaml new file mode 100644 index 0000000..20baf29 --- /dev/null +++ b/descriptions/2.11/api.intercom.io.yaml @@ -0,0 +1,17254 @@ +--- +openapi: 3.0.1 +info: + title: Intercom API + version: '2.11' + description: The intercom API reference. + contact: + name: Intercom Developer Hub + url: https://developers.intercom.com + license: + name: MIT + url: https://spdx.org/licenses/MIT +paths: + "/me": + get: + summary: Identify an admin + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Admins + operationId: identifyAdmin + description: "\nYou can view the currently authorised admin along with the embedded + app object (a \"workspace\" in legacy terminology).\n\n> \U0001F6A7 Single + Sign On\n>\n> If you are building a custom \"Log in with Intercom\" flow for + your site, and you call the `/me` endpoint to identify the logged-in user, + you should not accept any sign-ins from users with unverified email addresses + as it poses a potential impersonation security risk.\n" + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: admin + id: '991271474' + email: admin1@email.com + name: Ciaran1 Lee + email_verified: true + app: + type: app + id_code: this_is_an_id1_that_should_be_at_least_40 + name: MyApp 1 + created_at: 1715077743 + secure: false + identity_verification: false + timezone: America/Los_Angeles + region: US + avatar: + type: avatar + image_url: https://static.intercomassets.com/assets/default-avatars/admins/128.png + has_inbox_seat: true + schema: + "$ref": "#/components/schemas/admin_with_app" + "/admins/{id}/away": + put: + summary: Set an admin to away + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier of a given admin + schema: + type: integer + tags: + - Admins + operationId: setAwayAdmin + description: You can set an Admin as away for the Inbox. + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: admin + id: '991271475' + name: Ciaran2 Lee + email: admin2@email.com + away_mode_enabled: true + away_mode_reassign: true + has_inbox_seat: true + team_ids: [] + schema: + "$ref": "#/components/schemas/admin" + '404': + description: Admin not found + content: + application/json: + examples: + Admin not found: + value: + type: error.list + request_id: 1fce66ca-83a6-4a52-b276-7846645373fa + errors: + - code: admin_not_found + message: Admin for admin_id not found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 61941b54-dbb2-406c-a252-147534a32eb8 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + type: object + required: + - away_mode_enabled + - away_mode_reassign + properties: + away_mode_enabled: + type: boolean + description: Set to "true" to change the status of the admin to + away. + example: true + default: true + away_mode_reassign: + type: boolean + description: Set to "true" to assign any new conversation replies + to your default inbox. + example: false + default: false + examples: + successful_response: + summary: Successful response + value: + away_mode_enabled: true + away_mode_reassign: true + admin_not_found: + summary: Admin not found + value: + away_mode_enabled: true + away_mode_reassign: true + unauthorized: + summary: Unauthorized + value: + away_mode_enabled: true + away_mode_reassign: true + "/admins/activity_logs": + get: + summary: List all activity logs + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: created_at_after + in: query + required: true + description: The start date that you request data for. It must be formatted + as a UNIX timestamp. + example: '1677253093' + schema: + type: string + - name: created_at_before + in: query + required: false + description: The end date that you request data for. It must be formatted + as a UNIX timestamp. + example: '1677861493' + schema: + type: string + tags: + - Admins + operationId: listActivityLogs + description: You can get a log of activities by all admins in an app. + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: activity_log.list + pages: + type: pages + next: + page: 1 + per_page: 20 + total_pages: 1 + activity_logs: + - id: 0fecfb55-5580-4770-8a0a-11073f60f8cf + performed_by: + type: admin + id: '991271479' + email: admin5@email.com + ip: 127.0.0.1 + metadata: + message: + id: 123 + title: Initial message title + before: Initial message title + after: Eventual message title + created_at: 1715077748 + activity_type: message_state_change + activity_description: Ciaran5 Lee changed your Initial message + title message from Initial message title to Eventual message + title. + - id: abc674cf-7787-45cf-918f-b5fae3e27eea + performed_by: + type: admin + id: '991271479' + email: admin5@email.com + ip: 127.0.0.1 + metadata: + before: before + after: after + created_at: 1715077748 + 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': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: f34e491d-e99d-414e-8692-3c6857b9045b + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/admins": + get: + summary: List all admins + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Admins + operationId: listAdmins + description: You can fetch a list of admins for a given workspace. + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: admin.list + admins: + - type: admin + email: admin7@email.com + id: '991271481' + name: Ciaran7 Lee + away_mode_enabled: false + away_mode_reassign: false + has_inbox_seat: true + team_ids: [] + schema: + "$ref": "#/components/schemas/admin_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: d6f7893d-5814-4cff-81b7-ec926904ed91 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/admins/{id}": + get: + summary: Retrieve an admin + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier of a given admin + example: 123 + schema: + type: integer + tags: + - Admins + operationId: retrieveAdmin + description: You can retrieve the details of a single admin. + responses: + '200': + description: Admin found + content: + application/json: + examples: + Admin found: + value: + type: admin + id: '991271483' + name: Ciaran9 Lee + email: admin9@email.com + away_mode_enabled: false + away_mode_reassign: false + has_inbox_seat: true + team_ids: [] + schema: + "$ref": "#/components/schemas/admin" + '404': + description: Admin not found + content: + application/json: + examples: + Admin not found: + value: + type: error.list + request_id: 3d1bc3f6-0d12-44a4-88c2-efa4a180c3c1 + errors: + - code: admin_not_found + message: Admin not found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: eda8c985-a00f-4983-8da5-cd947ad36ec8 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/articles": + get: + summary: List all articles + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Articles + operationId: listArticles + description: "You can fetch a list of all articles by making a GET request to + `https://api.intercom.io/articles`.\n\n> \U0001F4D8 How are the articles sorted + and ordered?\n>\n> Articles will be returned in descending order on the `updated_at` + attribute. This means if you need to iterate through results then we'll show + the most recently updated articles first.\n" + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + pages: + type: pages + page: 1 + per_page: 25 + total_pages: 1 + total_count: 1 + data: + - id: '179' + type: article + workspace_id: this_is_an_id22_that_should_be_at_least_4 + parent_id: 717 + parent_type: collection + parent_ids: [] + title: This is the article title + description: '' + body: '' + author_id: 991271486 + state: published + created_at: 1715077754 + updated_at: 1715077754 + url: http://help-center.test/myapp-22/en/articles/179-this-is-the-article-title + schema: + "$ref": "#/components/schemas/article_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: a1dd047f-bd82-40c5-ba89-84694eadb879 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + post: + summary: Create an article + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Articles + operationId: createArticle + description: You can create a new article by making a POST request to `https://api.intercom.io/articles`. + responses: + '200': + description: article created + content: + application/json: + examples: + article created: + value: + id: '182' + type: article + workspace_id: this_is_an_id26_that_should_be_at_least_4 + parent_id: 719 + parent_type: collection + parent_ids: [] + statistics: + type: article_statistics + views: 0 + conversations: 0 + reactions: 0 + happy_reaction_percentage: 0 + neutral_reaction_percentage: 0 + sad_reaction_percentage: 0 + title: Thanks for everything + description: Description of the Article + body:

    Body of the Article

    + author_id: 991271491 + state: published + created_at: 1715077756 + updated_at: 1715077756 + url: http://help-center.test/myapp-26/en/articles/182-thanks-for-everything + schema: + "$ref": "#/components/schemas/article" + '400': + description: Bad Request + content: + application/json: + examples: + Bad Request: + value: + type: error.list + request_id: b243bba3-7ba6-448a-a183-52c026434717 + errors: + - code: parameter_not_found + message: author_id must be in the main body or default locale + translated_content object + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 0e3e8587-a71d-4e11-a7a2-124a900ae63b + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_article_request" + examples: + article_created: + summary: article created + value: + title: Thanks for everything + description: Description of the Article + body: Body of the Article + author_id: 991271491 + state: published + parent_id: 719 + parent_type: collection + translated_content: + fr: + title: Merci pour tout + description: Description de l'article + body: Corps de l'article + author_id: 991271491 + state: published + bad_request: + summary: Bad Request + value: + title: Thanks for everything + description: Description of the Article + body: Body of the Article + state: published + "/articles/{id}": + get: + summary: Retrieve an article + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the article which is given by Intercom. + example: 123 + schema: + type: integer + tags: + - Articles + operationId: retrieveArticle + description: You can fetch the details of a single article by making a GET request + to `https://api.intercom.io/articles/`. + responses: + '200': + description: Article found + content: + application/json: + examples: + Article found: + value: + id: '185' + type: article + workspace_id: this_is_an_id32_that_should_be_at_least_4 + parent_id: 722 + parent_type: collection + parent_ids: [] + statistics: + type: article_statistics + views: 0 + conversations: 0 + reactions: 0 + happy_reaction_percentage: 0 + neutral_reaction_percentage: 0 + sad_reaction_percentage: 0 + title: This is the article title + description: '' + body: '' + author_id: 991271496 + state: published + created_at: 1715077758 + updated_at: 1715077758 + url: http://help-center.test/myapp-32/en/articles/185-this-is-the-article-title + schema: + "$ref": "#/components/schemas/article" + '404': + description: Article not found + content: + application/json: + examples: + Article not found: + value: + type: error.list + request_id: dcefbc25-f07e-404b-8310-a0009c71c68a + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 92056e3f-7695-4111-9b1b-07e0a5f2c470 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + put: + summary: Update an article + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the article which is given by Intercom. + example: 123 + schema: + type: integer + tags: + - Articles + operationId: updateArticle + description: You can update the details of a single article by making a PUT + request to `https://api.intercom.io/articles/`. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: '188' + type: article + workspace_id: this_is_an_id38_that_should_be_at_least_4 + parent_id: 725 + parent_type: collection + parent_ids: [] + statistics: + type: article_statistics + views: 0 + conversations: 0 + reactions: 0 + happy_reaction_percentage: 0 + neutral_reaction_percentage: 0 + sad_reaction_percentage: 0 + title: Christmas is here! + description: '' + body:

    New gifts in store for the jolly season

    + author_id: 991271502 + state: published + created_at: 1715077759 + updated_at: 1715077760 + url: http://help-center.test/myapp-38/en/articles/188-christmas-is-here + schema: + "$ref": "#/components/schemas/article" + '404': + description: Article Not Found + content: + application/json: + examples: + Article Not Found: + value: + type: error.list + request_id: 21f89be7-397d-4778-a6da-4cb68e6ae05f + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 94adca72-86f6-4fd7-ae76-66c64f670c23 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/update_article_request" + examples: + successful: + summary: successful + value: + title: Christmas is here! + body: "

    New gifts in store for the jolly season

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

    New gifts in store for the jolly season

    " + delete: + summary: Delete an article + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the article which is given by Intercom. + example: 123 + schema: + type: integer + tags: + - Articles + operationId: deleteArticle + description: You can delete a single article by making a DELETE request to `https://api.intercom.io/articles/`. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: '191' + object: article + deleted: true + schema: + "$ref": "#/components/schemas/deleted_article_object" + '404': + description: Article Not Found + content: + application/json: + examples: + Article Not Found: + value: + type: error.list + request_id: c6e72fe5-70a0-4b33-994d-2ad6d3fb85c4 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 842c011c-dffa-41f9-b6b9-c5ec818f65ef + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/articles/search": + get: + summary: Search for articles + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: phrase + in: query + required: false + description: The phrase within your articles to search for. + example: Getting started + schema: + type: string + - name: state + in: query + required: false + description: The state of the Articles returned. One of `published`, `draft` + or `all`. + example: published + schema: + type: string + - name: help_center_id + in: query + required: false + description: The ID of the Help Center to search in. + example: 123 + schema: + type: integer + - name: highlight + in: query + required: false + description: Return a highlighted version of the matching content within your + articles. Refer to the response schema for more details. + example: false + schema: + type: boolean + tags: + - Articles + operationId: searchArticles + description: You can search for articles by making a GET request to `https://api.intercom.io/articles/search`. + responses: + '200': + description: Search successful + content: + application/json: + examples: + Search successful: + value: + type: list + total_count: 1 + data: + articles: + - id: '195' + type: article + workspace_id: this_is_an_id50_that_should_be_at_least_4 + parent_id: + parent_type: + parent_ids: [] + title: Title 1 + description: '' + body: '' + author_id: 991271515 + state: draft + created_at: 1715077764 + updated_at: 1715077764 + url: + highlights: [] + pages: + type: pages + page: 1 + total_pages: 1 + per_page: 10 + schema: + "$ref": "#/components/schemas/article_search_response" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 1775bba6-bed0-4cc1-882e-28a6e65873df + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/help_center/collections": + get: + summary: List all collections + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Help Center + operationId: listAllCollections + description: | + You can fetch a list of all collections by making a GET request to `https://api.intercom.io/help_center/collections`. + + Collections will be returned in descending order on the `updated_at` attribute. This means if you need to iterate through results then we'll show the most recently updated collections first. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: list + data: + - id: '733' + 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: 1715077765 + updated_at: 1715077765 + description: english collection description + icon: bookmark + parent_id: + help_center_id: 357 + - id: '734' + 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: 1715077765 + updated_at: 1715077765 + description: + icon: bookmark + parent_id: '733' + help_center_id: + total_count: 2 + pages: + type: pages + page: 1 + per_page: 20 + total_pages: 1 + schema: + "$ref": "#/components/schemas/collection_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: ea185852-5b68-47da-8e25-e44494ebc545 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + post: + summary: Create a collection + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Help Center + operationId: createCollection + description: You can create a new collection by making a POST request to `https://api.intercom.io/help_center/collections.` + responses: + '200': + description: collection created + content: + application/json: + examples: + collection created: + value: + id: '739' + 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: 1715077767 + updated_at: 1715077767 + description: '' + icon: book-bookmark + parent_id: + help_center_id: 359 + schema: + "$ref": "#/components/schemas/collection" + '400': + description: Bad Request + content: + application/json: + examples: + Bad Request: + value: + type: error.list + request_id: 795d43be-393e-4311-9c5e-4bfa272ab318 + errors: + - code: parameter_not_found + message: Name is a required parameter. + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 493e1e87-2a88-4a52-a547-a7641986f263 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_collection_request" + examples: + collection_created: + summary: collection created + value: + name: Thanks for everything + bad_request: + summary: Bad Request + value: + description: Missing required parameter + "/help_center/collections/{id}": + get: + summary: Retrieve a collection + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the collection which is given by Intercom. + example: 123 + schema: + type: integer + tags: + - Help Center + operationId: retrieveCollection + description: You can fetch the details of a single collection by making a GET + request to `https://api.intercom.io/help_center/collections/`. + responses: + '200': + description: Collection found + content: + application/json: + examples: + Collection found: + value: + id: '744' + 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: 1715077768 + updated_at: 1715077768 + description: english collection description + icon: bookmark + parent_id: + help_center_id: 362 + schema: + "$ref": "#/components/schemas/collection" + '404': + description: Collection not found + content: + application/json: + examples: + Collection not found: + value: + type: error.list + request_id: 7d9053ea-f3b1-4d3a-a55c-442baada7766 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: d7634e4e-0004-4af2-b059-90278fcce655 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + put: + summary: Update a collection + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the collection which is given by Intercom. + example: 123 + schema: + type: integer + tags: + - Help Center + operationId: updateCollection + description: You can update the details of a single collection by making a PUT + request to `https://api.intercom.io/collections/`. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: '750' + 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: 1715077769 + updated_at: 1715077769 + description: english collection description + icon: folder + parent_id: + help_center_id: 365 + schema: + "$ref": "#/components/schemas/collection" + '404': + description: Collection Not Found + content: + application/json: + examples: + Collection Not Found: + value: + type: error.list + request_id: d491a808-b2f9-41ad-b8f1-cefb6f9ff929 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 99e0bb4d-c75f-431c-b4ba-95dcacdf1ffb + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/update_collection_request" + examples: + successful: + summary: successful + value: + name: Update collection name + collection_not_found: + summary: Collection Not Found + value: + name: Update collection name + delete: + summary: Delete a collection + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the collection which is given by Intercom. + example: 123 + schema: + type: integer + tags: + - Help Center + operationId: deleteCollection + description: You can delete a single collection by making a DELETE request to + `https://api.intercom.io/collections/`. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: '756' + object: collection + deleted: true + schema: + "$ref": "#/components/schemas/deleted_collection_object" + '404': + description: collection Not Found + content: + application/json: + examples: + collection Not Found: + value: + type: error.list + request_id: cbe12e6c-21c4-4486-8b34-d3f76403ae8c + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 4db77883-6efe-4329-8873-97068e417e4b + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/help_center/help_centers/{id}": + get: + summary: Retrieve a Help Center + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the collection which is given by Intercom. + example: 123 + schema: + type: integer + tags: + - Help Center + operationId: retrieveHelpCenter + description: You can fetch the details of a single Help Center by making a GET + request to `https://api.intercom.io/help_center/help_center/`. + responses: + '200': + description: Collection found + content: + application/json: + examples: + Collection found: + value: + id: '371' + workspace_id: this_is_an_id82_that_should_be_at_least_4 + created_at: 1715077772 + updated_at: 1715077772 + identifier: help-center-1 + website_turned_on: false + display_name: Intercom Help Center + schema: + "$ref": "#/components/schemas/help_center" + '404': + description: Collection not found + content: + application/json: + examples: + Collection not found: + value: + type: error.list + request_id: 710eef1d-b3e9-4ff9-b377-c3837e925831 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 8354a63f-9d70-4a31-9d4c-5e8b2f18936a + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/help_center/help_centers": + get: + summary: List all Help Centers + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Help Center + operationId: listHelpCenters + description: You can list all Help Centers by making a GET request to `https://api.intercom.io/help_center/help_centers`. + responses: + '200': + description: Help Centers found + content: + application/json: + examples: + Help Centers found: + value: + type: list + data: [] + schema: + "$ref": "#/components/schemas/help_center_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: bb71f904-570f-498c-ade8-39b5b219ca1e + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/companies": + post: + summary: Create or Update a company + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Companies + operationId: createOrUpdateCompany + description: | + You can create or update a company. + + Companies will be only visible in Intercom when there is at least one associated user. + + Companies are looked up via `company_id` in a `POST` request, if not found via `company_id`, the new company will be created, if found, that company will be updated. + + {% admonition type="attention" name="Using `company_id`" %} + You can set a unique `company_id` value when creating a company. However, it is not possible to update `company_id`. Be sure to set a unique value once upon creation of the company. + {% /admonition %} + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: company + company_id: company_remote_id + id: 663a0290262d16a19645ed92 + app_id: this_is_an_id105_that_should_be_at_least_ + name: my company + remote_created_at: 1374138000 + created_at: 1715077776 + updated_at: 1715077776 + monthly_spend: 0 + session_count: 0 + user_count: 0 + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + plan: {} + custom_attributes: + creation_source: api + schema: + "$ref": "#/components/schemas/company" + '400': + description: Bad Request + content: + application/json: + examples: + Bad Request: + value: + type: error.list + request_id: + errors: + - code: bad_request + message: bad 'test' parameter + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: cd01eca4-663f-4190-bc58-9126d4e656e7 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_or_update_company_request" + examples: + successful: + summary: Successful + value: + company_id: company_remote_id + name: my company + remote_created_at: 1374138000 + bad_request: + summary: Bad Request + value: + test: invalid + get: + summary: Retrieve companies + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: name + in: query + required: false + description: The `name` of the company to filter by. + example: my company + schema: + type: string + - name: company_id + in: query + required: false + description: The `company_id` of the company to filter by. + example: '12345' + schema: + type: string + - name: tag_id + in: query + required: false + description: The `tag_id` of the company to filter by. + example: '678910' + schema: + type: string + - name: segment_id + in: query + required: false + description: The `segment_id` of the company to filter by. + example: '98765' + schema: + type: string + - name: page + in: query + required: false + description: The page of results to fetch. Defaults to first page + example: 1 + schema: + type: integer + - name: per_page + in: query + required: false + description: How many results to display per page. Defaults to 15 + example: 15 + schema: + type: integer + tags: + - Companies + operationId: retrieveCompany + 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 + content: + application/json: + examples: + Successful: + value: + type: list + data: + - type: company + company_id: remote_companies_scroll_2 + id: 663a0292262d16a19645ed9a + app_id: this_is_an_id111_that_should_be_at_least_ + name: IntercomQATest1 + remote_created_at: 1715077778 + created_at: 1715077778 + updated_at: 1715077778 + monthly_spend: 0 + session_count: 0 + user_count: 4 + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + plan: {} + custom_attributes: {} + pages: + type: pages + next: + page: 1 + per_page: 15 + total_pages: 1 + total_count: 1 + schema: + "$ref": "#/components/schemas/company_list" + '404': + description: Company Not Found + content: + application/json: + examples: + Company Not Found: + value: + type: error.list + request_id: d2cbda33-b552-49b6-a4c1-daf549959f83 + errors: + - code: company_not_found + message: Company Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: c02bf604-d79f-40b8-9dd8-4aa54d5c0acc + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/companies/{id}": + get: + summary: Retrieve a company by ID + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the company which is given by Intercom + example: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + schema: + type: string + tags: + - Companies + operationId: RetrieveACompanyById + description: You can fetch a single company. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: company + company_id: '1' + id: 663a0295262d16a19645eda5 + app_id: this_is_an_id117_that_should_be_at_least_ + name: company1 + remote_created_at: 1715077781 + created_at: 1715077781 + updated_at: 1715077781 + monthly_spend: 0 + session_count: 0 + user_count: 1 + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + plan: {} + custom_attributes: {} + schema: + "$ref": "#/components/schemas/company" + '404': + description: Company Not Found + content: + application/json: + examples: + Company Not Found: + value: + type: error.list + request_id: 75be7244-b069-496d-b59f-2aabad82ff84 + errors: + - code: company_not_found + message: Company Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 32622983-4b94-4c6c-bdeb-7ac280849a3f + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + put: + summary: Update a company + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the company which is given by Intercom + example: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + schema: + type: string + tags: + - Companies + operationId: UpdateCompany + description: | + You can update a single company using the Intercom provisioned `id`. + + {% admonition type="attention" name="Using `company_id`" %} + When updating a company it is not possible to update `company_id`. This can only be set once upon creation of the company. + {% /admonition %} + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: company + company_id: '1' + id: 663a0297262d16a19645edaf + app_id: this_is_an_id123_that_should_be_at_least_ + name: company2 + remote_created_at: 1715077783 + created_at: 1715077783 + updated_at: 1715077783 + monthly_spend: 0 + session_count: 0 + user_count: 1 + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + plan: {} + custom_attributes: {} + schema: + "$ref": "#/components/schemas/company" + '404': + description: Company Not Found + content: + application/json: + examples: + Company Not Found: + value: + type: error.list + request_id: 6941e48b-2e79-4faa-850b-b88c93ae6d70 + errors: + - code: company_not_found + message: Company Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: deaf2ab5-4bf8-46bc-b9f2-0d9192074049 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + delete: + summary: Delete a company + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the company which is given by Intercom + example: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + schema: + type: string + tags: + - Companies + operationId: deleteCompany + description: You can delete a single company. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + id: 663a0299262d16a19645edb9 + object: company + deleted: true + schema: + "$ref": "#/components/schemas/deleted_company_object" + '404': + description: Company Not Found + content: + application/json: + examples: + Company Not Found: + value: + type: error.list + request_id: a0c1b1d0-520b-4172-858a-446230d83cb7 + errors: + - code: company_not_found + message: Company Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 5d7cf8f8-d7e7-4b13-80e6-9a9265d825ac + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/companies/{id}/contacts": + get: + summary: List attached contacts + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the company which is given by Intercom + example: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + schema: + type: string + tags: + - Companies + - Contacts + operationId: ListAttachedContacts + description: You can fetch a list of all contacts that belong to a company. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: list + data: [] + total_count: 0 + pages: + type: pages + page: 1 + per_page: 50 + total_pages: 0 + schema: + "$ref": "#/components/schemas/company_attached_contacts" + '404': + description: Company Not Found + content: + application/json: + examples: + Company Not Found: + value: + type: error.list + request_id: 1018d8c3-d0cc-4be1-9e31-37668a4322be + errors: + - code: company_not_found + message: Company Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 9ec31597-acb9-4fb2-b303-074ee5c95b9d + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/companies/{id}/segments": + get: + summary: List attached segments for companies + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the company which is given by Intercom + example: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + schema: + type: string + tags: + - Companies + operationId: ListAttachedSegmentsForCompanies + description: You can fetch a list of all segments that belong to a company. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: list + data: [] + schema: + "$ref": "#/components/schemas/company_attached_segments" + '404': + description: Company Not Found + content: + application/json: + examples: + Company Not Found: + value: + type: error.list + request_id: 93e9bb7f-b25d-44de-9fa9-c4264bba4db9 + errors: + - code: company_not_found + message: Company Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: f8d6751f-f95f-4a8d-a79d-10aaa32c9bf0 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/companies/list": + post: + summary: List all companies + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: page + in: query + required: false + description: The page of results to fetch. Defaults to first page + example: 1 + schema: + type: integer + - name: per_page + in: query + required: false + description: How many results to return per page. Defaults to 15 + example: 15 + schema: + type: integer + - name: order + in: query + required: false + description: "`asc` or `desc`. Return the companies in ascending or descending + order. Defaults to desc" + example: desc + schema: + type: string + tags: + - Companies + operationId: listAllCompanies + description: | + You can list companies. The company list is sorted by the `last_request_at` field and by default is ordered descending, most recently requested first. + + Note that the API does not include companies who have no associated users in list responses. + + When using the Companies endpoint and the pages object to iterate through the returned companies, there is a limit of 10,000 Companies that can be returned. If you need to list or iterate on more than 10,000 Companies, please use the [Scroll API](https://developers.intercom.com/reference#iterating-over-all-companies). + {% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `20` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. + {% /admonition %} + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: list + data: + - type: company + company_id: remote_companies_scroll_2 + id: 663a02a0262d16a19645edd5 + app_id: this_is_an_id147_that_should_be_at_least_ + name: IntercomQATest1 + remote_created_at: 1715077792 + created_at: 1715077792 + updated_at: 1715077792 + monthly_spend: 0 + session_count: 0 + user_count: 4 + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + plan: {} + custom_attributes: {} + pages: + type: pages + next: + page: 1 + per_page: 15 + total_pages: 1 + total_count: 1 + schema: + "$ref": "#/components/schemas/company_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 146e3f4e-206c-4202-8506-5db801c92376 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/companies/scroll": + get: + summary: Scroll over all companies + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: scroll_param + in: query + required: false + description: '' + schema: + type: string + tags: + - Companies + operationId: scrollOverAllCompanies + description: |2 + The `list all companies` functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. The Scroll API provides an efficient mechanism for iterating over all companies in a dataset. + + - Each app can only have 1 scroll open at a time. You'll get an error message if you try to have more than one open per app. + - If the scroll isn't used for 1 minute, it expires and calls with that scroll param will fail + - If the end of the scroll is reached, "companies" will be empty and the scroll parameter will expire + + {% admonition type="info" name="Scroll Parameter" %} + You can get the first page of companies by simply sending a GET request to the scroll endpoint. + For subsequent requests you will need to use the scroll parameter from the response. + {% /admonition %} + {% admonition type="danger" name="Scroll network timeouts" %} + Since scroll is often used on large datasets network errors such as timeouts can be encountered. When this occurs you will see a HTTP 500 error with the following message: + "Request failed due to an internal network error. Please restart the scroll operation." + If this happens, you will need to restart your scroll query: It is not possible to continue from a specific point when using scroll. + {% /admonition %} + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: list + data: + - type: company + company_id: remote_companies_scroll_2 + id: 663a02a1262d16a19645eddb + app_id: this_is_an_id151_that_should_be_at_least_ + name: IntercomQATest1 + remote_created_at: 1715077793 + created_at: 1715077793 + updated_at: 1715077793 + monthly_spend: 0 + session_count: 0 + user_count: 4 + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + plan: {} + custom_attributes: {} + pages: + total_count: + scroll_param: 2c29a605-ea03-4caa-be38-238c18408d1a + schema: + "$ref": "#/components/schemas/company_scroll" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 8704600c-3c0e-4b9d-aefe-7f300b9af06f + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/contacts/{id}/companies": + post: + summary: Attach a Contact to a Company + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the contact which is given by Intercom + schema: + type: string + tags: + - Companies + - Contacts + operationId: attachContactToACompany + description: You can attach a company to a single contact. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: company + company_id: '1' + id: 663a02a3262d16a19645ede4 + app_id: this_is_an_id155_that_should_be_at_least_ + name: company6 + remote_created_at: 1715077795 + created_at: 1715077795 + updated_at: 1715077795 + monthly_spend: 0 + session_count: 0 + user_count: 1 + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + plan: {} + custom_attributes: {} + schema: + "$ref": "#/components/schemas/company" + '400': + description: Bad Request + content: + application/json: + examples: + Bad Request: + value: + type: error.list + request_id: 3e133f54-dcd3-4626-acf9-d4e1ba3538b3 + errors: + - code: parameter_not_found + message: company not specified + schema: + "$ref": "#/components/schemas/error" + '404': + description: Company Not Found + content: + application/json: + examples: + Company Not Found: + value: + type: error.list + request_id: 7cd23e44-4081-47a5-ba1b-3f5d294d7cea + errors: + - code: company_not_found + message: Company Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 11660514-dffc-4eeb-b830-840dddd493a7 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + type: object + required: + - id + properties: + id: + type: string + description: The unique identifier for the company which is given + by Intercom + example: 58a430d35458202d41b1e65b + examples: + successful: + summary: Successful + value: + id: 663a02a3262d16a19645ede4 + bad_request: + summary: Bad Request + value: + company_not_found: + summary: Company Not Found + value: + id: '123' + get: + summary: List attached companies for contact + parameters: + - name: id + in: path + description: The unique identifier for the contact which is given by Intercom + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Contacts + - Companies + operationId: listCompaniesForAContact + description: You can fetch a list of companies that are associated to a contact. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + data: + - type: company + company_id: '1' + id: 663a02a9262d16a19645ee05 + app_id: this_is_an_id171_that_should_be_at_least_ + name: company12 + remote_created_at: 1715077801 + created_at: 1715077801 + updated_at: 1715077801 + last_request_at: 1714905001 + monthly_spend: 0 + session_count: 0 + user_count: 1 + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + plan: {} + custom_attributes: {} + pages: + type: pages + next: + page: 1 + per_page: 50 + total_pages: 1 + total_count: 1 + schema: + "$ref": "#/components/schemas/contact_attached_companies" + '404': + description: Contact not found + content: + application/json: + examples: + Contact not found: + value: + type: error.list + request_id: 2923fa5d-a5c2-4330-93ce-888b14ef7050 + errors: + - code: not_found + message: User Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: a46a4d77-cebb-4877-85f5-8a128dbc39a7 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/contacts/{contact_id}/companies/{id}": + delete: + summary: Detach a contact from a company + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: contact_id + in: path + required: true + description: The unique identifier for the contact which is given by Intercom + example: 58a430d35458202d41b1e65b + schema: + type: string + - name: id + in: path + required: true + description: The unique identifier for the company which is given by Intercom + example: 58a430d35458202d41b1e65b + schema: + type: string + tags: + - Companies + - Contacts + operationId: detachContactFromACompany + description: You can detach a company from a single contact. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: company + company_id: '1' + id: 663a02a6262d16a19645edf4 + app_id: this_is_an_id163_that_should_be_at_least_ + name: company8 + remote_created_at: 1715077798 + created_at: 1715077798 + updated_at: 1715077798 + monthly_spend: 0 + session_count: 0 + user_count: 0 + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + plan: {} + custom_attributes: {} + schema: + "$ref": "#/components/schemas/company" + '404': + description: Contact Not Found + content: + application/json: + examples: + Company Not Found: + value: + type: error.list + request_id: d013f24c-a34f-4a52-8b19-ee727f0ac465 + errors: + - code: company_not_found + message: Company Not Found + Contact Not Found: + value: + type: error.list + request_id: 74e1def3-684e-4a9d-ad16-cec26513fd3b + errors: + - code: not_found + message: User Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: a677c95c-d517-47bc-b17f-792b9687d74b + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/contacts/{id}/notes": + get: + summary: List all notes + parameters: + - name: id + in: path + required: true + description: The unique identifier of a contact. + schema: + type: integer + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Notes + - Contacts + operationId: listNotes + description: You can fetch a list of notes that are associated to a contact. + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: list + data: + - type: note + id: '133' + created_at: 1714473003 + contact: + type: contact + id: 663a02ab262d16a19645ee10 + author: + type: admin + id: '991271575' + name: Ciaran101 Lee + email: admin101@email.com + away_mode_enabled: false + away_mode_reassign: false + body: "

    This is a note.

    " + - type: note + id: '132' + created_at: 1714386603 + contact: + type: contact + id: 663a02ab262d16a19645ee10 + author: + type: admin + id: '991271575' + name: Ciaran101 Lee + email: admin101@email.com + away_mode_enabled: false + away_mode_reassign: false + body: "

    This is a note.

    " + - type: note + id: '131' + created_at: 1714386603 + contact: + type: contact + id: 663a02ab262d16a19645ee10 + author: + type: admin + id: '991271575' + name: Ciaran101 Lee + email: admin101@email.com + away_mode_enabled: false + away_mode_reassign: false + body: "

    This is a note.

    " + total_count: 3 + pages: + type: pages + next: + page: 1 + per_page: 50 + total_pages: 1 + schema: + "$ref": "#/components/schemas/note_list" + '404': + description: Contact not found + content: + application/json: + examples: + Contact not found: + value: + type: error.list + request_id: a6aeff8e-62bc-4e1c-b420-dc594f2eb28d + errors: + - code: not_found + message: User Not Found + schema: + "$ref": "#/components/schemas/error" + post: + summary: Create a note + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier of a given contact. + example: '123' + schema: + type: integer + tags: + - Notes + - Contacts + operationId: createNote + description: You can add a note to a single contact. + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: note + id: '138' + created_at: 1715077805 + contact: + type: contact + id: 663a02ac262d16a19645ee12 + author: + type: admin + id: '991271577' + name: Ciaran103 Lee + email: admin103@email.com + away_mode_enabled: false + away_mode_reassign: false + body: "

    Hello

    " + schema: + "$ref": "#/components/schemas/note" + '404': + description: Contact not found + content: + application/json: + examples: + Admin not found: + value: + type: error.list + request_id: e862b5ef-bf7a-4969-8136-bd6af35eef5c + errors: + - code: not_found + message: Resource Not Found + Contact not found: + value: + type: error.list + request_id: 9942d67e-8016-40a9-bd9b-ed4c9c23189c + errors: + - code: not_found + message: User Not Found + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + type: object + required: + - body + properties: + body: + type: string + description: The text of the note. + example: New note + contact_id: + type: string + description: The unique identifier of a given contact. + example: '123' + admin_id: + type: string + description: The unique identifier of a given admin. + example: '123' + examples: + successful_response: + summary: Successful response + value: + contact_id: 663a02ac262d16a19645ee12 + admin_id: 991271577 + body: Hello + admin_not_found: + summary: Admin not found + value: + contact_id: 663a02ad262d16a19645ee13 + admin_id: 123 + body: Hello + contact_not_found: + summary: Contact not found + value: + contact_id: 123 + admin_id: 991271579 + body: Hello + "/contacts/{contact_id}/segments": + get: + summary: List attached segments for contact + parameters: + - name: contact_id + in: path + description: The unique identifier for the contact which is given by Intercom + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Contacts + - Segments + operationId: listSegmentsForAContact + description: You can fetch a list of segments that are associated to a contact. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + data: + - type: segment + id: 663a02ae262d16a19645ee15 + name: segment + created_at: 1715077806 + updated_at: 1715077806 + person_type: user + schema: + "$ref": "#/components/schemas/contact_segments" + '404': + description: Contact not found + content: + application/json: + examples: + Contact not found: + value: + type: error.list + request_id: b0215ffa-cbcb-4b88-8f54-4c5168df13eb + errors: + - code: not_found + message: User Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: fe71f424-20f5-4686-8f92-7b82f16c8e7e + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/contacts/{contact_id}/subscriptions": + get: + summary: List subscriptions for a contact + parameters: + - name: contact_id + in: path + description: The unique identifier for the contact which is given by Intercom + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Contacts + - Subscription Types + operationId: listSubscriptionsForAContact + description: | + You can fetch a list of subscription types that are attached to a contact. These can be subscriptions that a user has 'opted-in' to or has 'opted-out' from, depending on the subscription type. + This will return a list of Subscription Type objects that the contact is associated with. + + The data property will show a combined list of: + + 1.Opt-out subscription types that the user has opted-out from. + 2.Opt-in subscription types that the user has opted-in to receiving. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: list + data: + - type: subscription + id: '461' + state: live + consent_type: opt_out + default_translation: + name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + translations: + - name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + content_types: + - email + - type: subscription + id: '463' + state: live + consent_type: opt_in + default_translation: + name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + translations: + - name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + content_types: + - sms_message + schema: + "$ref": "#/components/schemas/subscription_type_list" + '404': + description: Contact not found + content: + application/json: + examples: + Contact not found: + value: + type: error.list + request_id: 32cde830-767e-4da9-b029-ca6eed37b70a + errors: + - code: not_found + message: User Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 3f523481-c443-4f19-a598-06a8129a7dbc + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + post: + summary: Add subscription to a contact + tags: + - Subscription Types + - Contacts + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: contact_id + in: path + description: The unique identifier for the contact which is given by Intercom + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + operationId: attachSubscriptionTypeToContact + description: | + You can add a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in: + + 1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type. + + 2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type. + + This will return a subscription type model for the subscription type that was added to the contact. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: subscription + id: '476' + state: live + consent_type: opt_in + default_translation: + name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + translations: + - name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + content_types: + - sms_message + schema: + "$ref": "#/components/schemas/subscription_type" + '404': + description: Resource not found + content: + application/json: + examples: + Contact not found: + value: + type: error.list + request_id: 7216cefa-a692-49ca-92e6-a963b550ae91 + errors: + - code: not_found + message: User Not Found + Resource not found: + value: + type: error.list + request_id: a9d47fd9-af87-45d4-9044-3c09c52a2190 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 27affd4b-a8c3-4710-b125-07478d8ce081 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + type: object + required: + - id + - consent_type + properties: + id: + type: string + description: The unique identifier for the subscription which is + given by Intercom + example: '37846' + consent_type: + type: string + description: The consent_type of a subscription, opt_out or opt_in. + example: opt_in + examples: + successful: + summary: Successful + value: + id: 476 + consent_type: opt_in + contact_not_found: + summary: Contact not found + value: + id: 480 + consent_type: opt_in + resource_not_found: + summary: Resource not found + value: + id: invalid_id + consent_type: opt_in + "/contacts/{contact_id}/subscriptions/{id}": + delete: + summary: Remove subscription from a contact + tags: + - Subscription Types + - Contacts + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: contact_id + in: path + description: The unique identifier for the contact which is given by Intercom + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + - name: id + in: path + description: The unique identifier for the subscription type which is given + by Intercom + example: '37846' + required: true + schema: + type: string + operationId: detachSubscriptionTypeToContact + description: You can remove a specific subscription from a contact. This will + return a subscription type model for the subscription type that was removed + from the contact. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: subscription + id: '492' + state: live + consent_type: opt_in + default_translation: + name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + translations: + - name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + content_types: + - sms_message + schema: + "$ref": "#/components/schemas/subscription_type" + '404': + description: Resource not found + content: + application/json: + examples: + Contact not found: + value: + type: error.list + request_id: a212e19b-e843-472d-915d-095b5bd93d98 + errors: + - code: not_found + message: User Not Found + Resource not found: + value: + type: error.list + request_id: 6902ca73-b3e5-4f3a-9ef6-b607643df65d + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: d30967d0-d0c4-4aaa-8b6a-038e33b263dc + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/contacts/{contact_id}/tags": + get: + summary: List tags attached to a contact + tags: + - Contacts + - Tags + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: contact_id + in: path + description: The unique identifier for the contact which is given by Intercom + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + operationId: listTagsForAContact + description: You can fetch a list of all tags that are attached to a specific + contact. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + data: + - type: tag + id: '431' + name: Manual tag + schema: + "$ref": "#/components/schemas/tag_list" + '404': + description: Contact not found + content: + application/json: + examples: + Contact not found: + value: + type: error.list + request_id: '04280c60-d2c5-4534-8274-d1a6a221541d' + errors: + - code: not_found + message: User Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 67474bb2-1937-4e03-a58d-07c162a82bcf + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + post: + summary: Add tag to a contact + tags: + - Tags + - Contacts + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: contact_id + in: path + description: The unique identifier for the contact which is given by Intercom + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + operationId: attachTagToContact + description: You can tag a specific contact. This will return a tag object for + the tag that was added to the contact. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: tag + id: '432' + name: Manual tag + schema: + "$ref": "#/components/schemas/tag" + '404': + description: Tag not found + content: + application/json: + examples: + Contact not found: + value: + type: error.list + request_id: 1d189db3-0ae8-48ff-9c89-4da238a235f2 + errors: + - code: not_found + message: User Not Found + Tag not found: + value: + type: error.list + request_id: 22f2177e-0155-4f74-91f0-59ff1728e093 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: dd404f10-3580-4466-be0d-5bb81440d511 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + type: object + required: + - id + properties: + id: + type: string + description: The unique identifier for the tag which is given by + Intercom + example: '7522907' + examples: + successful: + summary: successful + value: + id: 432 + contact_not_found: + summary: Contact not found + value: + id: 433 + tag_not_found: + summary: Tag not found + value: + id: '123' + "/contacts/{contact_id}/tags/{id}": + delete: + summary: Remove tag from a contact + tags: + - Tags + - Contacts + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: contact_id + in: path + description: The unique identifier for the contact which is given by Intercom + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + - name: id + in: path + description: The unique identifier for the tag which is given by Intercom + example: '7522907' + required: true + schema: + type: string + operationId: detachTagFromContact + description: You can remove tag from a specific contact. This will return a + tag object for the tag that was removed from the contact. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: tag + id: '435' + name: Manual tag + schema: + "$ref": "#/components/schemas/tag" + '404': + description: Tag not found + content: + application/json: + examples: + Contact not found: + value: + type: error.list + request_id: e3aafb14-2239-4e89-9e82-34548ba9ea2d + errors: + - code: not_found + message: User Not Found + Tag not found: + value: + type: error.list + request_id: 4ab6fa73-404c-4f1c-a4a8-c6701fe84cfe + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 9610a1e7-a565-4086-83fa-315a9808a605 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/contacts/{id}": + put: + summary: Update a contact + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: id + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + tags: + - Contacts + operationId: UpdateContact + description: You can update an existing contact (ie. user or lead). + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: contact + id: 663a02bb262d16a19645ee2c + workspace_id: this_is_an_id237_that_should_be_at_least_ + external_id: '70' + role: user + email: joebloggs@intercom.io + phone: + name: joe bloggs + avatar: + owner_id: + social_profiles: + type: list + data: [] + has_hard_bounced: false + marked_email_as_spam: false + unsubscribed_from_emails: false + created_at: 1715077819 + updated_at: 1715077819 + signed_up_at: 1715077819 + last_seen_at: + last_replied_at: + last_contacted_at: + last_email_opened_at: + last_email_clicked_at: + language_override: + browser: + browser_version: + browser_language: + os: + location: + type: location + country: + region: + city: + country_code: + continent_code: + android_app_name: + android_app_version: + android_device: + android_os_version: + android_sdk_version: + android_last_seen_at: + ios_app_name: + ios_app_version: + ios_device: + ios_os_version: + ios_sdk_version: + ios_last_seen_at: + custom_attributes: {} + tags: + type: list + data: [] + url: "/contacts/663a02bb262d16a19645ee2c/tags" + total_count: 0 + has_more: false + notes: + type: list + data: [] + url: "/contacts/663a02bb262d16a19645ee2c/notes" + total_count: 0 + has_more: false + companies: + type: list + data: [] + url: "/contacts/663a02bb262d16a19645ee2c/companies" + total_count: 0 + has_more: false + opted_out_subscription_types: + type: list + data: [] + url: "/contacts/663a02bb262d16a19645ee2c/subscriptions" + total_count: 0 + has_more: false + opted_in_subscription_types: + type: list + data: [] + url: "/contacts/663a02bb262d16a19645ee2c/subscriptions" + total_count: 0 + has_more: false + utm_campaign: + utm_content: + utm_medium: + utm_source: + utm_term: + referrer: + schema: + "$ref": "#/components/schemas/contact" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 0455671c-e915-48ce-9f99-999a0f5456b9 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + oneOf: + - "$ref": "#/components/schemas/update_contact_request" + examples: + successful: + summary: successful + value: + email: joebloggs@intercom.io + name: joe bloggs + get: + summary: Get a contact + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: id + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + tags: + - Contacts + operationId: ShowContact + description: You can fetch the details of a single contact. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: contact + id: 663a02bc262d16a19645ee2d + workspace_id: this_is_an_id241_that_should_be_at_least_ + external_id: '70' + role: user + email: joe@bloggs.com + phone: + name: Joe Bloggs + avatar: + owner_id: + social_profiles: + type: list + data: [] + has_hard_bounced: false + marked_email_as_spam: false + unsubscribed_from_emails: false + created_at: 1715077820 + updated_at: 1715077820 + signed_up_at: 1715077820 + last_seen_at: + last_replied_at: + last_contacted_at: + last_email_opened_at: + last_email_clicked_at: + language_override: + browser: + browser_version: + browser_language: + os: + location: + type: location + country: + region: + city: + country_code: + continent_code: + android_app_name: + android_app_version: + android_device: + android_os_version: + android_sdk_version: + android_last_seen_at: + ios_app_name: + ios_app_version: + ios_device: + ios_os_version: + ios_sdk_version: + ios_last_seen_at: + custom_attributes: {} + tags: + type: list + data: [] + url: "/contacts/663a02bc262d16a19645ee2d/tags" + total_count: 0 + has_more: false + notes: + type: list + data: [] + url: "/contacts/663a02bc262d16a19645ee2d/notes" + total_count: 0 + has_more: false + companies: + type: list + data: [] + url: "/contacts/663a02bc262d16a19645ee2d/companies" + total_count: 0 + has_more: false + opted_out_subscription_types: + type: list + data: [] + url: "/contacts/663a02bc262d16a19645ee2d/subscriptions" + total_count: 0 + has_more: false + opted_in_subscription_types: + type: list + data: [] + url: "/contacts/663a02bc262d16a19645ee2d/subscriptions" + total_count: 0 + has_more: false + utm_campaign: + utm_content: + utm_medium: + utm_source: + utm_term: + referrer: + schema: + "$ref": "#/components/schemas/contact" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: ed63fbeb-1984-451f-8a19-8ca42ab149c2 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + delete: + summary: Delete a contact + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: id + required: true + schema: + type: string + tags: + - Contacts + operationId: DeleteContact + description: You can delete a single contact. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: 663a02be262d16a19645ee2e + external_id: '70' + type: contact + deleted: true + schema: + "$ref": "#/components/schemas/contact_deleted" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: ca889b01-29b5-4b03-80bb-39db56edd24e + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/contacts/merge": + post: + summary: Merge a lead and a user + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Contacts + operationId: MergeContact + description: You can merge a contact with a `role` of `lead` into a contact + with a `role` of `user`. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: contact + id: 663a02bf262d16a19645ee30 + workspace_id: this_is_an_id249_that_should_be_at_least_ + external_id: '70' + role: user + email: joe@bloggs.com + phone: + name: Joe Bloggs + avatar: + owner_id: + social_profiles: + type: list + data: [] + has_hard_bounced: false + marked_email_as_spam: false + unsubscribed_from_emails: false + created_at: 1715077823 + updated_at: 1715077824 + signed_up_at: 1715077823 + last_seen_at: + last_replied_at: + last_contacted_at: + last_email_opened_at: + last_email_clicked_at: + language_override: + browser: + browser_version: + browser_language: + os: + location: + type: location + country: + region: + city: + country_code: + continent_code: + android_app_name: + android_app_version: + android_device: + android_os_version: + android_sdk_version: + android_last_seen_at: + ios_app_name: + ios_app_version: + ios_device: + ios_os_version: + ios_sdk_version: + ios_last_seen_at: + custom_attributes: {} + tags: + type: list + data: [] + url: "/contacts/663a02bf262d16a19645ee30/tags" + total_count: 0 + has_more: false + notes: + type: list + data: [] + url: "/contacts/663a02bf262d16a19645ee30/notes" + total_count: 0 + has_more: false + companies: + type: list + data: [] + url: "/contacts/663a02bf262d16a19645ee30/companies" + total_count: 0 + has_more: false + opted_out_subscription_types: + type: list + data: [] + url: "/contacts/663a02bf262d16a19645ee30/subscriptions" + total_count: 0 + has_more: false + opted_in_subscription_types: + type: list + data: [] + url: "/contacts/663a02bf262d16a19645ee30/subscriptions" + total_count: 0 + has_more: false + utm_campaign: + utm_content: + utm_medium: + utm_source: + utm_term: + referrer: + schema: + "$ref": "#/components/schemas/contact" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: fe503371-2fda-4cde-8a29-9db3fb1f8e5b + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/merge_contacts_request" + examples: + successful: + summary: successful + value: + from: 663a02bf262d16a19645ee2f + into: 663a02bf262d16a19645ee30 + "/contacts/search": + post: + summary: Search contacts + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Contacts + operationId: SearchContacts + description: | + You can search for multiple contacts by the value of their attributes in order to fetch exactly who you want. + + To search for contacts, you need to send a `POST` request to `https://api.intercom.io/contacts/search`. + + This will accept a query object in the body which will define your filters in order to search for contacts. + + {% admonition type="warning" name="Optimizing search queries" %} + Search queries can be complex, so optimizing them can help the performance of your search. + Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize + pagination to limit the number of results returned. The default is `50` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param. + {% /admonition %} + ### Contact Creation Delay + + If a contact has recently been created, there is a possibility that it will not yet be available when searching. This means that it may not appear in the response. This delay can take a few minutes. If you need to be instantly notified it is recommended to use webhooks and iterate to see if they match your search filters. + + ### Nesting & Limitations + + You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). + There are some limitations to the amount of multiple's there can be: + * There's a limit of max 2 nested filters + * There's a limit of max 15 filters for each AND or OR group + + ### Searching for Timestamp Fields + + All timestamp fields (created_at, updated_at etc.) are indexed as Dates for Contact Search queries; Datetime queries are not currently supported. This means you can only query for timestamp fields by day - not hour, minute or second. + For example, if you search for all Contacts with a created_at value greater (>) than 1577869200 (the UNIX timestamp for January 1st, 2020 9:00 AM), that will be interpreted as 1577836800 (January 1st, 2020 12:00 AM). The search results will then include Contacts created from January 2nd, 2020 12:00 AM onwards. + If you'd like to get contacts created on January 1st, 2020 you should search with a created_at value equal (=) to 1577836800 (January 1st, 2020 12:00 AM). + This behaviour applies only to timestamps used in search queries. The search results will still contain the full UNIX timestamp and be sorted accordingly. + + ### Accepted Fields + + Most key listed as part of the Contacts Model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `"foorbar"`). + + | Field | Type | + | ---------------------------------- | ------------------------------ | + | id | String | + | role | String
    Accepts user or lead | + | name | String | + | avatar | String | + | owner_id | Integer | + | email | String | + | email_domain | String | + | phone | String | + | formatted_phone | String | + | external_id | String | + | created_at | Date (UNIX Timestamp) | + | signed_up_at | Date (UNIX Timestamp) | + | updated_at | Date (UNIX Timestamp) | + | last_seen_at | Date (UNIX Timestamp) | + | last_contacted_at | Date (UNIX Timestamp) | + | last_replied_at | Date (UNIX Timestamp) | + | last_email_opened_at | Date (UNIX Timestamp) | + | last_email_clicked_at | Date (UNIX Timestamp) | + | language_override | String | + | browser | String | + | browser_language | String | + | os | String | + | location.country | String | + | location.region | String | + | location.city | String | + | unsubscribed_from_emails | Boolean | + | marked_email_as_spam | Boolean | + | has_hard_bounced | Boolean | + | ios_last_seen_at | Date (UNIX Timestamp) | + | ios_app_version | String | + | ios_device | String | + | ios_app_device | String | + | ios_os_version | String | + | ios_app_name | String | + | ios_sdk_version | String | + | android_last_seen_at | Date (UNIX Timestamp) | + | android_app_version | String | + | android_device | String | + | android_app_name | String | + | andoid_sdk_version | String | + | segment_id | String | + | tag_id | String | + | custom_attributes.{attribute_name} | String | + + ### Accepted Operators + + {% admonition type="attention" name="Searching based on `created_at`" %} + You cannot use the `<=` or `>=` operators to search by `created_at`. + {% /admonition %} + + The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`"="`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates). + + | Operator | Valid Types | Description | + | :------- | :------------------------------- | :--------------------------------------------------------------- | + | = | All | Equals | + | != | All | Doesn't Equal | + | IN | All | In
    Shortcut for `OR` queries
    Values must be in Array | + | NIN | All | Not In
    Shortcut for `OR !` queries
    Values must be in Array | + | > | Integer
    Date (UNIX Timestamp) | Greater than | + | < | Integer
    Date (UNIX Timestamp) | Lower than | + | ~ | String | Contains | + | !~ | String | Doesn't Contain | + | ^ | String | Starts With | + | $ | String | Ends With | + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + data: [] + total_count: 0 + pages: + type: pages + page: 1 + per_page: 50 + total_pages: 0 + schema: + "$ref": "#/components/schemas/contact_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: cc8ecde9-c27c-406c-8f8c-db26998fd9ed + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/search_request" + examples: + successful: + summary: successful + value: + query: + operator: AND + value: + - field: id + operator: "=" + value: 663a02c1262d16a19645ee33 + - operator: OR + value: + - field: id + operator: "=" + value: 663a02c1262d16a19645ee33 + - field: id + operator: "=" + value: 663a02c1262d16a19645ee33 + "/contacts": + get: + summary: List all contacts + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Contacts + operationId: ListContacts + description: | + You can fetch a list of all contacts (ie. users or leads) in your workspace. + {% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `50` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. + {% /admonition %} + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + data: [] + total_count: 0 + pages: + type: pages + page: 1 + per_page: 10 + total_pages: 0 + schema: + "$ref": "#/components/schemas/contact_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 71e1b4c8-c5ea-4b83-b6f5-d2125e726916 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + post: + summary: Create contact + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Contacts + operationId: CreateContact + description: You can create a new contact (ie. user or lead). + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: contact + id: 663a02c4262d16a19645ee35 + workspace_id: this_is_an_id261_that_should_be_at_least_ + external_id: + role: user + email: joebloggs@intercom.io + phone: + name: + avatar: + owner_id: + social_profiles: + type: list + data: [] + has_hard_bounced: false + marked_email_as_spam: false + unsubscribed_from_emails: false + created_at: 1715077828 + updated_at: 1715077828 + signed_up_at: + last_seen_at: + last_replied_at: + last_contacted_at: + last_email_opened_at: + last_email_clicked_at: + language_override: + browser: + browser_version: + browser_language: + os: + location: + type: location + country: + region: + city: + country_code: + continent_code: + android_app_name: + android_app_version: + android_device: + android_os_version: + android_sdk_version: + android_last_seen_at: + ios_app_name: + ios_app_version: + ios_device: + ios_os_version: + ios_sdk_version: + ios_last_seen_at: + custom_attributes: {} + tags: + type: list + data: [] + url: "/contacts/663a02c4262d16a19645ee35/tags" + total_count: 0 + has_more: false + notes: + type: list + data: [] + url: "/contacts/663a02c4262d16a19645ee35/notes" + total_count: 0 + has_more: false + companies: + type: list + data: [] + url: "/contacts/663a02c4262d16a19645ee35/companies" + total_count: 0 + has_more: false + opted_out_subscription_types: + type: list + data: [] + url: "/contacts/663a02c4262d16a19645ee35/subscriptions" + total_count: 0 + has_more: false + opted_in_subscription_types: + type: list + data: [] + url: "/contacts/663a02c4262d16a19645ee35/subscriptions" + total_count: 0 + has_more: false + utm_campaign: + utm_content: + utm_medium: + utm_source: + utm_term: + referrer: + schema: + "$ref": "#/components/schemas/contact" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: e0060857-b6d2-4cd0-8975-053a086ed3c4 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + oneOf: + - "$ref": "#/components/schemas/create_contact_request" + examples: + successful: + summary: successful + value: + email: joebloggs@intercom.io + "/contacts/{id}/archive": + post: + summary: Archive contact + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: id + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + tags: + - Contacts + operationId: ArchiveContact + description: You can archive a single contact. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: 663a02c5262d16a19645ee36 + external_id: '70' + type: contact + archived: true + schema: + "$ref": "#/components/schemas/contact_archived" + "/contacts/{id}/unarchive": + post: + summary: Unarchive contact + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: id + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + tags: + - Contacts + operationId: UnarchiveContact + description: You can unarchive a single contact. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: 663a02c6262d16a19645ee37 + external_id: '70' + type: contact + archived: false + schema: + "$ref": "#/components/schemas/contact_unarchived" + "/conversations/{conversation_id}/tags": + post: + summary: Add tag to a conversation + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: conversation_id + in: path + description: conversation_id + example: '64619700005694' + required: true + schema: + type: string + tags: + - Tags + - Conversations + operationId: attachTagToConversation + description: You can tag a specific conversation. This will return a tag object + for the tag that was added to the conversation. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: tag + id: '437' + name: Manual tag + schema: + "$ref": "#/components/schemas/tag" + '404': + description: Conversation not found + content: + application/json: + examples: + Conversation not found: + value: + type: error.list + request_id: 97111355-62a2-4a07-9146-fec7fe0596e0 + errors: + - code: not_found + message: Conversation not found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 5783d0a3-2149-4384-adf7-9234f2fada8f + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + type: object + required: + - id + - admin_id + properties: + id: + type: string + description: The unique identifier for the tag which is given by + Intercom + example: '7522907' + admin_id: + type: string + description: The unique identifier for the admin which is given + by Intercom. + example: '780' + examples: + successful: + summary: successful + value: + id: 437 + admin_id: 991271610 + conversation_not_found: + summary: Conversation not found + value: + id: 438 + admin_id: 991271612 + "/conversations/{conversation_id}/tags/{id}": + delete: + summary: Remove tag from a conversation + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: conversation_id + in: path + description: conversation_id + example: '64619700005694' + required: true + schema: + type: string + - name: id + in: path + description: id + example: '7522907' + required: true + schema: + type: string + tags: + - Tags + - Conversations + operationId: detachTagFromConversation + description: You can remove tag from a specific conversation. This will return + a tag object for the tag that was removed from the conversation. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: tag + id: '440' + name: Manual tag + schema: + "$ref": "#/components/schemas/tag" + '404': + description: Tag not found + content: + application/json: + examples: + Conversation not found: + value: + type: error.list + request_id: 2cb69ad1-fa8e-48a4-9834-cc8f6601ee66 + errors: + - code: not_found + message: Conversation not found + Tag not found: + value: + type: error.list + request_id: ba46fc92-22fe-4a2a-a7eb-eaef95abfe4e + errors: + - code: tag_not_found + message: Tag not found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: d870c06e-696e-4f9a-99ef-dca52634e70d + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + type: object + required: + - admin_id + properties: + admin_id: + type: string + description: The unique identifier for the admin which is given + by Intercom. + example: '123' + examples: + successful: + summary: successful + value: + admin_id: 991271614 + conversation_not_found: + summary: Conversation not found + value: + admin_id: 991271616 + tag_not_found: + summary: Tag not found + value: + admin_id: 991271617 + "/conversations": + get: + summary: List all conversations + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: per_page + in: query + schema: + type: integer + default: 20 + maximum: 150 + required: false + description: How many results per page + - name: starting_after + in: query + required: false + description: String used to get the next page of conversations. + schema: + type: string + tags: + - Conversations + operationId: listConversations + description: | + You can fetch a list of all conversations. + + You can optionally request the result page size and the cursor to start after to fetch the result. + {% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `20` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. + {% /admonition %} + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: conversation.list + pages: + type: pages + page: 1 + per_page: 20 + total_pages: 1 + total_count: 1 + conversations: + - type: conversation + id: '1561' + created_at: 1715077839 + updated_at: 1715077839 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918903' + delivered_as: admin_initiated + subject: '' + body: "

    this is the message body

    " + author: + type: admin + id: '991271620' + name: Ciaran143 Lee + email: admin143@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 663a02ce262d16a19645ee3b + external_id: '70' + first_contact_reply: + admin_assignee_id: + team_assignee_id: + open: false + state: closed + read: false + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + schema: + "$ref": "#/components/schemas/paginated_response" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 59fba2db-7d73-457f-a3af-95de3f0071ac + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: API plan restricted + content: + application/json: + examples: + API plan restricted: + value: + type: error.list + request_id: b5fb622f-1159-426f-a932-ed25d3406ebe + errors: + - code: api_plan_restricted + message: Active subscription needed. + schema: + "$ref": "#/components/schemas/error" + post: + summary: Creates a conversation + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Conversations + operationId: createConversation + description: |+ + You can create a conversation that has been initiated by a contact (ie. user or lead). + The conversation can be an in-app message only. + + {% admonition type="info" name="Sending for visitors" %} + You can also send a message from a visitor by specifying their `user_id` or `id` value in the `from` field, along with a `type` field value of `contact`. + This visitor will be automatically converted to a contact with a lead role once the conversation is created. + {% /admonition %} + + This will return the Message model that has been created. + + responses: + '200': + description: conversation created + content: + application/json: + examples: + conversation created: + value: + type: user_message + id: '403918913' + created_at: 1715077858 + body: Hello there + message_type: inapp + conversation_id: '1589' + schema: + "$ref": "#/components/schemas/message" + '404': + description: Contact Not Found + content: + application/json: + examples: + Contact Not Found: + value: + type: error.list + request_id: 8f3229dc-397c-4df4-aea3-676e2b613309 + errors: + - code: not_found + message: User Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 6f378d37-7546-4010-b0e3-59ff5cccf3ec + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: API plan restricted + content: + application/json: + examples: + API plan restricted: + value: + type: error.list + request_id: d9ae8da7-a92b-4472-a804-96ea69d1b5d7 + errors: + - code: api_plan_restricted + message: Active subscription needed. + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_conversation_request" + examples: + conversation_created: + summary: conversation created + value: + from: + type: user + id: 663a02e1262d16a19645ee53 + body: Hello there + contact_not_found: + summary: Contact Not Found + value: + from: + type: user + id: 123_doesnt_exist + body: Hello there + "/conversations/{id}": + get: + summary: Retrieve a conversation + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The id of the conversation to target + example: 123 + schema: + type: integer + - name: display_as + in: query + required: false + description: Set to plaintext to retrieve conversation messages in plain text. + example: plaintext + schema: + type: string + tags: + - Conversations + operationId: retrieveConversation + description: |2 + + You can fetch the details of a single conversation. + + This will return a single Conversation model with all its conversation parts. + + {% admonition type="warning" name="Hard limit of 500 parts" %} + The maximum number of conversation parts that can be returned via the API is 500. If you have more than that we will return the 500 most recent conversation parts. + {% /admonition %} + + For AI agent conversation metadata, please note that you need to have the agent enabled in your workspace, which is a [paid feature](https://www.intercom.com/help/en/articles/8205718-fin-resolutions#h_97f8c2e671). + responses: + '200': + description: conversation found + content: + application/json: + examples: + conversation found: + value: + type: conversation + id: '1593' + created_at: 1715077863 + updated_at: 1715077863 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918917' + delivered_as: admin_initiated + subject: '' + body: "

    this is the message body

    " + author: + type: admin + id: '991271637' + name: Ciaran153 Lee + email: admin153@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 663a02e7262d16a19645ee57 + external_id: '70' + first_contact_reply: + admin_assignee_id: + team_assignee_id: + open: false + state: closed + read: false + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: [] + total_count: 0 + schema: + "$ref": "#/components/schemas/conversation" + '404': + description: Not found + content: + application/json: + examples: + Not found: + value: + type: error.list + request_id: e1a47341-3d20-4fc2-8c91-d09cb34399a6 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 2a17bfea-accd-43d8-965d-b5d0b07b168f + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: API plan restricted + content: + application/json: + examples: + API plan restricted: + value: + type: error.list + request_id: 013337cb-1e53-4b24-af23-ec2c9183b46b + errors: + - code: api_plan_restricted + message: Active subscription needed. + schema: + "$ref": "#/components/schemas/error" + put: + summary: Update a conversation + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The id of the conversation to target + example: 123 + schema: + type: integer + - name: display_as + in: query + required: false + description: Set to plaintext to retrieve conversation messages in plain text. + example: plaintext + schema: + type: string + tags: + - Conversations + operationId: updateConversation + description: |2+ + + You can update an existing conversation. + + {% admonition type="info" name="Replying and other actions" %} + If you want to reply to a coveration or take an action such as assign, unassign, open, close or snooze, take a look at the reply and manage endpoints. + {% /admonition %} + + responses: + '200': + description: conversation found + content: + application/json: + examples: + conversation found: + value: + type: conversation + id: '1597' + created_at: 1715077868 + updated_at: 1715077869 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918921' + delivered_as: admin_initiated + subject: '' + body: "

    this is the message body

    " + author: + type: admin + id: '991271645' + name: Ciaran157 Lee + email: admin157@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 663a02ec262d16a19645ee5b + external_id: '70' + first_contact_reply: + admin_assignee_id: + team_assignee_id: + open: false + state: closed + read: true + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: + issue_type: Billing + priority: High + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '359' + part_type: conversation_attribute_updated_by_admin + body: + created_at: 1715077869 + updated_at: 1715077869 + notified_at: 1715077869 + assigned_to: + author: + id: '991271646' + type: bot + name: Operator + email: operator+this_is_an_id310_that_should_be_at_least_@intercom.io + attachments: [] + external_id: + redacted: false + - type: conversation_part + id: '360' + part_type: conversation_attribute_updated_by_admin + body: + created_at: 1715077869 + updated_at: 1715077869 + notified_at: 1715077869 + assigned_to: + author: + id: '991271646' + type: bot + name: Operator + email: operator+this_is_an_id310_that_should_be_at_least_@intercom.io + attachments: [] + external_id: + redacted: false + total_count: 2 + schema: + "$ref": "#/components/schemas/conversation" + '404': + description: Not found + content: + application/json: + examples: + Not found: + value: + type: error.list + request_id: 9f1b9321-33ec-4d15-b58f-49488ba1bbf5 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: bafd476b-596f-4c63-9ee0-a4407bbfc7bc + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: API plan restricted + content: + application/json: + examples: + API plan restricted: + value: + type: error.list + request_id: 7ac4197b-c8a7-4dc9-9310-11d8c839905f + errors: + - code: api_plan_restricted + message: Active subscription needed. + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/update_conversation_request" + examples: + conversation_found: + summary: conversation found + value: + read: true + custom_attributes: + issue_type: Billing + priority: High + not_found: + summary: Not found + value: + read: true + custom_attributes: + issue_type: Billing + priority: High + "/conversations/search": + post: + summary: Search conversations + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Conversations + operationId: searchConversations + description: | + You can search for multiple conversations by the value of their attributes in order to fetch exactly which ones you want. + + To search for conversations, you need to send a `POST` request to `https://api.intercom.io/conversations/search`. + + This will accept a query object in the body which will define your filters in order to search for conversations. + {% admonition type="warning" name="Optimizing search queries" %} + Search queries can be complex, so optimizing them can help the performance of your search. + Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize + pagination to limit the number of results returned. The default is `20` results per page and maximum is `150`. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param. + {% /admonition %} + + ### Nesting & Limitations + + You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). + There are some limitations to the amount of multiple's there can be: + - There's a limit of max 2 nested filters + - There's a limit of max 15 filters for each AND or OR group + + ### Accepted Fields + + Most keys listed as part of the The conversation model is searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `"foorbar"`). + + | Field | Type | + | :---------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------- | + | id | String | + | created_at | Date (UNIX timestamp) | + | updated_at | Date (UNIX timestamp) | + | source.type | String
    Accepted fields are `conversation`, `email`, `facebook`, `instagram`, `phone_call`, `phone_switch`, `push`, `sms`, `twitter` and `whatsapp`. | + | source.id | String | + | source.delivered_as | String | + | source.subject | String | + | source.body | String | + | source.author.id | String | + | source.author.type | String | + | source.author.name | String | + | source.author.email | String | + | source.url | String | + | contact_ids | String | + | teammate_ids | String | + | admin_assignee_id | String | + | team_assignee_id | String | + | channel_initiated | String | + | open | Boolean | + | read | Boolean | + | state | String | + | waiting_since | Date (UNIX timestamp) | + | snoozed_until | Date (UNIX timestamp) | + | tag_ids | String | + | priority | String | + | statistics.time_to_assignment | Integer | + | statistics.time_to_admin_reply | Integer | + | statistics.time_to_first_close | Integer | + | statistics.time_to_last_close | Integer | + | statistics.median_time_to_reply | Integer | + | statistics.first_contact_reply_at | Date (UNIX timestamp) | + | statistics.first_assignment_at | Date (UNIX timestamp) | + | statistics.first_admin_reply_at | Date (UNIX timestamp) | + | statistics.first_close_at | Date (UNIX timestamp) | + | statistics.last_assignment_at | Date (UNIX timestamp) | + | statistics.last_assignment_admin_reply_at | Date (UNIX timestamp) | + | statistics.last_contact_reply_at | Date (UNIX timestamp) | + | statistics.last_admin_reply_at | Date (UNIX timestamp) | + | statistics.last_close_at | Date (UNIX timestamp) | + | statistics.last_closed_by_id | String | + | statistics.count_reopens | Integer | + | statistics.count_assignments | Integer | + | statistics.count_conversation_parts | Integer | + | conversation_rating.requested_at | Date (UNIX timestamp) | + | conversation_rating.replied_at | Date (UNIX timestamp) | + | conversation_rating.score | Integer | + | conversation_rating.remark | String | + | conversation_rating.contact_id | String | + | conversation_rating.admin_d | String | + | ai_agent_participated | Boolean | + | ai_agent.resolution_state | String | + | ai_agent.last_answer_type | String | + | ai_agent.rating | Integer | + | ai_agent.rating_remark | String | + | ai_agent.source_type | String | + | ai_agent.source_title | String | + + ### Accepted Operators + + The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`"="`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates). + + | Operator | Valid Types | Description | + | :------- | :----------------------------- | :----------------------------------------------------------- | + | = | All | Equals | + | != | All | Doesn't Equal | + | IN | All | In Shortcut for `OR` queries Values most be in Array | + | NIN | All | Not In Shortcut for `OR !` queries Values must be in Array | + | > | Integer Date (UNIX Timestamp) | Greater (or equal) than | + | < | Integer Date (UNIX Timestamp) | Lower (or equal) than | + | ~ | String | Contains | + | !~ | String | Doesn't Contain | + | ^ | String | Starts With | + | $ | String | Ends With | + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: conversation.list + pages: + type: pages + page: 1 + per_page: 150 + total_pages: 1 + total_count: 1 + conversations: + - type: conversation + id: '1604' + created_at: 1715077878 + updated_at: 1715077878 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918928' + delivered_as: admin_initiated + subject: '' + body: "

    this is the message body

    " + author: + type: admin + id: '991271675' + name: Ciaran180 Lee + email: admin180@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 663a02f6262d16a19645ee62 + external_id: '70' + first_contact_reply: + admin_assignee_id: + team_assignee_id: + open: false + state: closed + read: false + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + schema: + "$ref": "#/components/schemas/conversation_list" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/search_request" + examples: + successful: + summary: successful + value: + query: + operator: AND + value: + - field: id + operator: "=" + value: '1604' + - operator: OR + value: + - field: id + operator: "=" + value: '1604' + - field: id + operator: "=" + value: '1604' + "/conversations/{id}/reply": + post: + summary: Reply to a conversation + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The Intercom provisioned identifier for the conversation or the + string "last" to reply to the last part of the conversation + example: 123 or "last" + schema: + type: string + tags: + - Conversations + operationId: replyConversation + description: You can reply to a conversation with a message from an admin or + on behalf of a contact, or with a note for admins. + responses: + '200': + description: User last conversation reply + content: + application/json: + examples: + User reply: + value: + type: conversation + id: '1613' + created_at: 1715077884 + updated_at: 1715077885 + waiting_since: 1715077885 + snoozed_until: + source: + type: conversation + id: '403918931' + delivered_as: admin_initiated + subject: '' + body: "

    this is the message body

    " + author: + type: admin + id: '991271678' + name: Ciaran182 Lee + email: admin182@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 663a02fc262d16a19645ee6a + external_id: '70' + first_contact_reply: + created_at: 1715077885 + type: conversation + url: + admin_assignee_id: + team_assignee_id: + open: true + state: open + read: false + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '362' + part_type: open + body: "

    Thanks again :)

    " + created_at: 1715077885 + updated_at: 1715077885 + notified_at: 1715077885 + assigned_to: + author: + id: 663a02fc262d16a19645ee6a + type: user + name: Joe Bloggs + email: joe@bloggs.com + attachments: [] + external_id: + redacted: false + total_count: 1 + Admin note reply: + value: + type: conversation + id: '1614' + created_at: 1715077886 + updated_at: 1715077887 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918932' + delivered_as: admin_initiated + subject: '' + body: "

    this is the message body

    " + author: + type: admin + id: '991271680' + name: Ciaran183 Lee + email: admin183@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 663a02fe262d16a19645ee6b + external_id: '70' + first_contact_reply: + admin_assignee_id: + team_assignee_id: + open: false + state: closed + read: false + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '363' + part_type: note + body: |- +

    An Unordered HTML List

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

    An Ordered HTML List

    +
      +
    1. Coffee
      2. +
    2. Tea
      3. +
    3. Milk
      4. +
    + created_at: 1715077887 + updated_at: 1715077887 + notified_at: 1715077887 + assigned_to: + author: + id: '991271680' + type: admin + name: Ciaran183 Lee + email: admin183@email.com + attachments: [] + external_id: + redacted: false + total_count: 1 + User last conversation reply: + value: + type: conversation + id: '1616' + created_at: 1715077889 + updated_at: 1715077890 + waiting_since: 1715077890 + snoozed_until: + source: + type: conversation + id: '403918934' + delivered_as: admin_initiated + subject: '' + body: "

    this is the message body

    " + author: + type: admin + id: '991271684' + name: Ciaran185 Lee + email: admin185@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 663a0301262d16a19645ee6d + external_id: '70' + first_contact_reply: + created_at: 1715077890 + type: conversation + url: + admin_assignee_id: + team_assignee_id: + open: true + state: open + read: false + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '364' + part_type: open + body: "

    Thanks again :)

    " + created_at: 1715077890 + updated_at: 1715077890 + notified_at: 1715077890 + assigned_to: + author: + id: 663a0301262d16a19645ee6d + type: user + name: Joe Bloggs + email: joe@bloggs.com + attachments: [] + external_id: + redacted: false + total_count: 1 + schema: + "$ref": "#/components/schemas/conversation" + '404': + description: Not found + content: + application/json: + examples: + Not found: + value: + type: error.list + request_id: 5969a4be-e802-4be4-835d-8c9f9be042b1 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 167f32f3-0cc4-4cc4-90a6-240d913eb7f4 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: API plan restricted + content: + application/json: + examples: + API plan restricted: + value: + type: error.list + request_id: de7d41af-1f6c-4247-8c2f-a646c9801ca8 + errors: + - code: api_plan_restricted + message: Active subscription needed. + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/reply_conversation_request" + examples: + user_reply: + summary: User reply + value: + message_type: comment + type: user + intercom_user_id: 663a02fc262d16a19645ee6a + body: Thanks again :) + admin_note_reply: + summary: Admin note reply + value: + message_type: note + type: admin + admin_id: 991271680 + body: "

    An Unordered HTML List

    • Coffee
      • + \
    • Tea
    • Milk

    An Ordered HTML List

    + \
    1. Coffee
    2. Tea
    3. Milk
    + \ " + user_last_conversation_reply: + summary: User last conversation reply + value: + message_type: comment + type: user + intercom_user_id: 663a0301262d16a19645ee6d + body: Thanks again :) + not_found: + summary: Not found + value: + message_type: comment + type: user + intercom_user_id: 663a0303262d16a19645ee6e + body: Thanks again :) + "/conversations/{id}/parts": + post: + summary: Manage a conversation + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The identifier for the conversation as given by Intercom. + example: '123' + schema: + type: string + tags: + - Conversations + operationId: manageConversation + description: | + For managing conversations you can: + - Close a conversation + - Snooze a conversation to reopen on a future date + - Open a conversation which is `snoozed` or `closed` + - Assign a conversation to an admin and/or team. + responses: + '200': + description: Assign a conversation + content: + application/json: + examples: + Close a conversation: + value: + type: conversation + id: '1620' + created_at: 1715077895 + updated_at: 1715077895 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918938' + delivered_as: admin_initiated + subject: '' + body: "

    this is the message body

    " + author: + type: admin + id: '991271692' + name: Ciaran189 Lee + email: admin189@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 663a0307262d16a19645ee71 + external_id: '70' + first_contact_reply: + admin_assignee_id: + team_assignee_id: + open: false + state: closed + read: false + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '365' + part_type: close + body: "

    Goodbye :)

    " + created_at: 1715077895 + updated_at: 1715077895 + notified_at: 1715077895 + assigned_to: + author: + id: '991271692' + type: admin + name: Ciaran189 Lee + email: admin189@email.com + attachments: [] + external_id: + redacted: false + total_count: 1 + Snooze a conversation: + value: + type: conversation + id: '1621' + created_at: 1715077897 + updated_at: 1715077898 + waiting_since: + snoozed_until: 1715081497 + source: + type: conversation + id: '403918939' + delivered_as: admin_initiated + subject: '' + body: "

    this is the message body

    " + author: + type: admin + id: '991271694' + name: Ciaran190 Lee + email: admin190@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 663a0309262d16a19645ee72 + external_id: '70' + first_contact_reply: + admin_assignee_id: + team_assignee_id: + open: true + state: snoozed + read: false + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '366' + part_type: snoozed + body: + created_at: 1715077898 + updated_at: 1715077898 + notified_at: 1715077898 + assigned_to: + author: + id: '991271694' + type: admin + name: Ciaran190 Lee + email: admin190@email.com + attachments: [] + external_id: + redacted: false + total_count: 1 + Open a conversation: + value: + type: conversation + id: '1626' + created_at: 1715077896 + updated_at: 1715077904 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918940' + delivered_as: admin_initiated + subject: '' + body: "

    this is the message body

    " + author: + type: admin + id: '991271696' + name: Ciaran191 Lee + email: admin191@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 663a0308262d16a19645ee77 + external_id: '74' + first_contact_reply: + admin_assignee_id: + team_assignee_id: + open: true + state: open + read: true + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: '' + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '368' + part_type: open + body: + created_at: 1715077904 + updated_at: 1715077904 + notified_at: 1715077904 + assigned_to: + author: + id: '991271696' + type: admin + name: Ciaran191 Lee + email: admin191@email.com + attachments: [] + external_id: + redacted: false + total_count: 1 + Assign a conversation: + value: + type: conversation + id: '1631' + created_at: 1715077905 + updated_at: 1715077906 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918943' + delivered_as: admin_initiated + subject: '' + body: "

    this is the message body

    " + author: + type: admin + id: '991271699' + name: Ciaran193 Lee + email: admin193@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 663a0311262d16a19645ee7b + external_id: '70' + first_contact_reply: + admin_assignee_id: 991271699 + team_assignee_id: + open: true + state: open + read: false + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '369' + part_type: assign_and_reopen + body: + created_at: 1715077906 + updated_at: 1715077906 + notified_at: 1715077906 + assigned_to: + type: admin + id: '991271699' + author: + id: '991271699' + type: admin + name: Ciaran193 Lee + email: admin193@email.com + attachments: [] + external_id: + redacted: false + total_count: 1 + schema: + "$ref": "#/components/schemas/conversation" + '404': + description: Not found + content: + application/json: + examples: + Not found: + value: + type: error.list + request_id: 44a52d1d-3c0d-4f69-9f16-9e9033841324 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 92c13910-906f-4b24-b579-38f8bf1d1be4 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: API plan restricted + content: + application/json: + examples: + API plan restricted: + value: + type: error.list + request_id: a38ed331-3421-4cf8-832d-249edcf5ef99 + errors: + - code: api_plan_restricted + message: Active subscription needed. + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + oneOf: + - "$ref": "#/components/schemas/close_conversation_request" + - "$ref": "#/components/schemas/snooze_conversation_request" + - "$ref": "#/components/schemas/open_conversation_request" + - "$ref": "#/components/schemas/assign_conversation_request" + examples: + close_a_conversation: + summary: Close a conversation + value: + message_type: close + type: admin + admin_id: 991271692 + body: Goodbye :) + snooze_a_conversation: + summary: Snooze a conversation + value: + message_type: snoozed + admin_id: 991271694 + snoozed_until: 1715081497 + open_a_conversation: + summary: Open a conversation + value: + message_type: open + admin_id: 991271696 + assign_a_conversation: + summary: Assign a conversation + value: + message_type: assignment + type: admin + admin_id: 991271699 + assignee_id: 991271699 + not_found: + summary: Not found + value: + message_type: close + type: admin + admin_id: 991271701 + body: Goodbye :) + "/conversations/{id}/run_assignment_rules": + post: + summary: Run Assignment Rules on a conversation + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The identifier for the conversation as given by Intercom. + example: '123' + schema: + type: string + tags: + - Conversations + operationId: autoAssignConversation + description: | + You can let a conversation be automatically assigned following assignment rules. + {% admonition type="attention" name="When using workflows" %} + It is not possible to use this endpoint with Workflows. + {% /admonition %} + responses: + '200': + description: Assign a conversation using assignment rules + content: + application/json: + examples: + Assign a conversation using assignment rules: + value: + type: conversation + id: '1635' + created_at: 1715077911 + updated_at: 1715077911 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918947' + delivered_as: admin_initiated + subject: '' + body: "

    this is the message body

    " + author: + type: admin + id: '991271707' + name: Ciaran197 Lee + email: admin197@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 663a0317262d16a19645ee7f + external_id: '70' + first_contact_reply: + admin_assignee_id: + team_assignee_id: + open: false + state: closed + read: false + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '370' + part_type: default_assignment + body: + created_at: 1715077911 + updated_at: 1715077911 + notified_at: 1715077911 + assigned_to: + type: nobody_admin + id: + author: + id: '991271708' + type: bot + name: Operator + email: operator+this_is_an_id353_that_should_be_at_least_@intercom.io + attachments: [] + external_id: + redacted: false + total_count: 1 + schema: + "$ref": "#/components/schemas/conversation" + '404': + description: Not found + content: + application/json: + examples: + Not found: + value: + type: error.list + request_id: 32a0f9f4-bae8-41d4-8380-95ecc359fa68 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 395c48d7-8652-454e-9664-94c3dbf2aa43 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: API plan restricted + content: + application/json: + examples: + API plan restricted: + value: + type: error.list + request_id: 1e0547e8-1e92-40bf-bae5-2b567b05ca82 + errors: + - code: api_plan_restricted + message: Active subscription needed. + schema: + "$ref": "#/components/schemas/error" + "/conversations/{id}/customers": + post: + summary: Attach a contact to a conversation + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The identifier for the conversation as given by Intercom. + example: '123' + schema: + type: string + tags: + - Conversations + operationId: attachContactToConversation + description: |+ + You can add participants who are contacts to a conversation, on behalf of either another contact or an admin. + + {% admonition type="attention" name="Contacts without an email" %} + If you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with `role` set to `lead`. + {% /admonition %} + + responses: + '200': + description: Attach a contact to a conversation + content: + application/json: + examples: + Attach a contact to a conversation: + value: + customers: + - type: user + id: 663a031c262d16a19645ee83 + schema: + "$ref": "#/components/schemas/conversation" + '404': + description: Not found + content: + application/json: + examples: + Not found: + value: + type: error.list + request_id: f8f1e841-c0db-4bf1-9ca8-3334dc46b798 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 8e09f172-8795-4573-8abd-4680ec4bdb9d + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: API plan restricted + content: + application/json: + examples: + API plan restricted: + value: + type: error.list + request_id: 2888b4d4-93cc-4f8b-be93-075aa8d6d95a + errors: + - code: api_plan_restricted + message: Active subscription needed. + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/attach_contact_to_conversation_request" + examples: + attach_a_contact_to_a_conversation: + summary: Attach a contact to a conversation + value: + admin_id: 991271715 + customer: + intercom_user_id: 663a031c262d16a19645ee83 + not_found: + summary: Not found + value: + admin_id: 991271717 + customer: + intercom_user_id: 663a031e262d16a19645ee84 + "/conversations/{conversation_id}/customers/{contact_id}": + delete: + summary: Detach a contact from a group conversation + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: conversation_id + in: path + required: true + description: The identifier for the conversation as given by Intercom. + example: '123' + schema: + type: string + - name: contact_id + in: path + required: true + description: The identifier for the contact as given by Intercom. + example: '123' + schema: + type: string + tags: + - Conversations + operationId: detachContactFromConversation + description: |+ + You can add participants who are contacts to a conversation, on behalf of either another contact or an admin. + + {% admonition type="attention" name="Contacts without an email" %} + If you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with `role` set to `lead`. + {% /admonition %} + + responses: + '200': + description: Detach a contact from a group conversation + content: + application/json: + examples: + Detach a contact from a group conversation: + value: + customers: + - type: user + id: 663a0327262d16a19645ee8f + schema: + "$ref": "#/components/schemas/conversation" + '404': + description: Contact not found + content: + application/json: + examples: + Conversation not found: + value: + type: error.list + request_id: 102a22d1-b0f3-49c8-9def-9906c8cc7773 + errors: + - code: not_found + message: Resource Not Found + Contact not found: + value: + type: error.list + request_id: 6282a96e-bed1-4757-a723-efa00cd4328d + errors: + - code: not_found + message: User Not Found + schema: + "$ref": "#/components/schemas/error" + '422': + description: Last customer + content: + application/json: + examples: + Last customer: + value: + type: error.list + request_id: bdcb5128-b2ed-4a8c-8927-c3960e0d2f96 + errors: + - code: parameter_invalid + message: Removing the last customer is not allowed + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 7dd277e1-117f-46b0-8e11-884bf47a0e47 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: API plan restricted + content: + application/json: + examples: + API plan restricted: + value: + type: error.list + request_id: 3a9c6a9d-e213-4a95-b7ec-23d2c98d3064 + errors: + - code: api_plan_restricted + message: Active subscription needed. + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/detach_contact_from_conversation_request" + examples: + detach_a_contact_from_a_group_conversation: + summary: Detach a contact from a group conversation + value: + admin_id: 991271723 + customer: + intercom_user_id: 663a0322262d16a19645ee87 + conversation_not_found: + summary: Conversation not found + value: + admin_id: 991271726 + customer: + intercom_user_id: 663a0328262d16a19645ee90 + contact_not_found: + summary: Contact not found + value: + admin_id: 991271729 + customer: + intercom_user_id: 663a032e262d16a19645ee98 + last_customer: + summary: Last customer + value: + admin_id: 991271732 + customer: + intercom_user_id: 663a0335262d16a19645eea0 + "/conversations/redact": + post: + summary: Redact a conversation part + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Conversations + operationId: redactConversation + description: |+ + You can redact a conversation part or the source message of a conversation (as seen in the source object). + + {% admonition type="info" name="Redacting parts and messages" %} + If you are redacting a conversation part, it must have a `body`. If you are redacting a source message, it must have been created by a contact. We will return a `conversation_part_not_redactable` error if these criteria are not met. + {% /admonition %} + + responses: + '200': + description: Redact a conversation part + content: + application/json: + examples: + Redact a conversation part: + value: + type: conversation + id: '1697' + created_at: 1715077958 + updated_at: 1715077960 + waiting_since: 1715077959 + snoozed_until: + source: + type: conversation + id: '403918973' + delivered_as: admin_initiated + subject: '' + body: "

    this is the message body

    " + author: + type: admin + id: '991271741' + name: Ciaran217 Lee + email: admin217@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 663a0346262d16a19645eeb8 + external_id: '70' + first_contact_reply: + created_at: 1715077959 + type: conversation + url: + admin_assignee_id: + team_assignee_id: + open: true + state: open + read: true + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '378' + part_type: open + body: "

    This message was deleted

    " + created_at: 1715077959 + updated_at: 1715077960 + notified_at: 1715077959 + assigned_to: + author: + id: 663a0346262d16a19645eeb8 + type: user + name: Joe Bloggs + email: joe@bloggs.com + attachments: [] + external_id: + redacted: true + total_count: 1 + schema: + "$ref": "#/components/schemas/conversation" + '404': + description: Not found + content: + application/json: + examples: + Not found: + value: + type: error.list + request_id: 80dd99c0-904a-4056-9fe9-fe34960ba080 + errors: + - code: conversation_part_or_message_not_found + message: Conversation part or message not found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 47a1343c-a8cc-48ae-8f7a-350066088b0b + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/redact_conversation_request" + examples: + redact_a_conversation_part: + summary: Redact a conversation part + value: + type: conversation_part + conversation_id: 1697 + conversation_part_id: 378 + not_found: + summary: Not found + value: + type: conversation_part + conversation_id: really_123_doesnt_exist + conversation_part_id: really_123_doesnt_exist + "/conversations/{id}/convert": + post: + summary: Convert a conversation to a ticket + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The id of the conversation to target + example: 123 + schema: + type: integer + tags: + - Conversations + description: You can convert a conversation to a ticket. + operationId: convertConversationToTicket + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: ticket + id: '1700' + ticket_id: '81' + ticket_attributes: {} + ticket_state: submitted + ticket_state_internal_label: Submitted + ticket_state_external_label: Submitted + ticket_type: + type: ticket_type + id: '287' + name: my-ticket-type-1 + description: my ticket type description is awesome. + icon: "\U0001F981" + workspace_id: this_is_an_id393_that_should_be_at_least_ + archived: false + created_at: 1715077966 + updated_at: 1715077966 + is_internal: false + ticket_type_attributes: + type: list + data: [] + category: Customer + contacts: + type: contact.list + contacts: + - type: contact + id: 663a034c262d16a19645eebb + external_id: '70' + admin_assignee_id: '0' + team_assignee_id: '0' + created_at: 1715077964 + updated_at: 1715077967 + ticket_parts: + type: ticket_part.list + ticket_parts: + - type: ticket_part + id: '380' + part_type: comment + body: "

    Comment for message

    " + created_at: 1715077964 + updated_at: 1715077964 + author: + id: 663a034c262d16a19645eebb + type: user + name: Joe Bloggs + email: joe@bloggs.com + attachments: [] + redacted: false + - type: ticket_part + id: '381' + part_type: ticket_state_updated_by_admin + ticket_state: submitted + previous_ticket_state: submitted + created_at: 1715077967 + updated_at: 1715077967 + author: + id: '991271751' + type: bot + name: Operator + email: operator+this_is_an_id393_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false + total_count: 2 + open: true + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + category: Customer + is_shared: true + schema: + "$ref": "#/components/schemas/ticket" + '400': + description: Bad request + content: + application/json: + examples: + Bad request: + value: + type: error.list + request_id: 41ed3dc3-5335-4d5f-9194-516560c60fe5 + errors: + - code: parameter_invalid + message: Ticket type is not a customer ticket type + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/convert_conversation_to_ticket_request" + examples: + successful: + summary: successful + value: + ticket_type_id: '287' + bad_request: + summary: Bad request + value: + ticket_type_id: '288' + "/data_attributes": + get: + summary: List all data attributes + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: model + in: query + required: false + description: Specify the data attribute model to return. + schema: + type: string + enum: + - contact + - company + - conversation + example: company + - name: include_archived + in: query + required: false + description: Include archived attributes in the list. By default we return + only non archived data attributes. + example: false + schema: + type: boolean + tags: + - Data Attributes + operationId: lisDataAttributes + description: You can fetch a list of all data attributes belonging to a workspace + for contacts, companies or conversations. + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: list + data: + - type: data_attribute + name: name + full_name: name + label: Company name + description: The name of a company + data_type: string + api_writable: true + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: company_id + full_name: company_id + label: Company ID + description: A number identifying a company + data_type: string + api_writable: false + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: last_request_at + full_name: last_request_at + label: Company last seen + description: The last day anyone from a company visited your + site or app + data_type: date + api_writable: false + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: remote_created_at + full_name: remote_created_at + label: Company created at + description: The day a company was added to Intercom + data_type: date + api_writable: true + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: user_count + full_name: user_count + label: People + description: The number of people in a company + data_type: integer + api_writable: false + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: session_count + full_name: session_count + label: Company web sessions + description: All visits from anyone in a company to your product's + site or app + data_type: integer + api_writable: false + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: name + full_name: plan.name + label: Plan + description: A specific plan or level within your product that + companies have signed up to + data_type: string + api_writable: false + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: monthly_spend + full_name: monthly_spend + label: Monthly Spend + description: The monthly revenue you receive from a company + data_type: float + api_writable: true + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: size + full_name: size + label: Company size + description: The number of people employed in this company, + expressed as a single number + data_type: integer + api_writable: true + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: industry + full_name: industry + label: Company industry + description: The category or domain this company belongs to + e.g. 'ecommerce' or 'SaaS' + data_type: string + api_writable: true + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: website + full_name: website + label: Company website + description: The web address for the company's primary marketing + site + data_type: string + api_writable: true + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - id: 162 + type: data_attribute + name: The One Ring + full_name: custom_attributes.The One Ring + label: The One Ring + description: One ring to rule them all, one ring to find them, + One ring to bring them all and in the darkness bind them. + data_type: string + api_writable: true + ui_writable: false + messenger_writable: true + custom: true + archived: false + admin_id: '991271768' + created_at: 1715077972 + updated_at: 1715077972 + model: company + - type: data_attribute + name: id + full_name: id + label: ID + description: The Intercom defined id representing the company + data_type: string + api_writable: false + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: created_at + full_name: created_at + label: Created at + description: The time the company was added to Intercom + data_type: date + api_writable: false + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: updated_at + full_name: updated_at + label: Updated at + description: The last time the company was updated + data_type: date + api_writable: false + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: id + full_name: plan.id + label: Plan ID + description: The Intercom defined id representing the plan + data_type: string + api_writable: false + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: app_id + full_name: app_id + label: App ID + description: The Intercom defined id representing the app + data_type: string + api_writable: false + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + schema: + "$ref": "#/components/schemas/data_attribute_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: cec81bc1-9005-4164-a3db-89ab0d350d46 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + post: + summary: Create a data attribute + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Data Attributes + operationId: createDataAttribute + description: You can create a data attributes for a `contact` or a `company`. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + id: 165 + type: data_attribute + name: Mithril Shirt + full_name: custom_attributes.Mithril Shirt + label: Mithril Shirt + data_type: string + api_writable: true + ui_writable: false + messenger_writable: false + custom: true + archived: false + admin_id: '991271770' + created_at: 1715077973 + updated_at: 1715077973 + model: company + schema: + "$ref": "#/components/schemas/data_attribute" + '400': + description: Too few options for list + content: + application/json: + examples: + Same name already exists: + value: + type: error.list + request_id: f5ba3943-843c-42fb-afca-25c7151f15bb + errors: + - code: parameter_invalid + message: You already have 'The One Ring' in your company data. + To save this as new people data, use a different name. + Invalid name: + value: + type: error.list + request_id: 872b9115-77ab-401f-b5e6-1d7aac2f97cb + errors: + - code: parameter_invalid + message: Your name for this attribute must only contain alphanumeric + characters, currency symbols, and hyphens + Attribute already exists: + value: + type: error.list + request_id: d492a15c-6558-4b42-9283-71839aa18dc4 + errors: + - code: parameter_invalid + message: You already have 'The One Ring' in your company data. + To save this as new company data, use a different name. + Invalid Data Type: + value: + type: error.list + request_id: 67426f47-6b46-4818-926c-cb18ea660804 + errors: + - code: parameter_invalid + message: Data Type isn't an option + Too few options for list: + value: + type: error.list + request_id: a4d70f1a-412a-40d9-9a9e-1b8ccde17a1d + errors: + - code: parameter_invalid + message: The Data Attribute model field must be either contact + or company + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 44e17745-f6b2-4f17-8d67-44c005a4e578 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_data_attribute_request" + examples: + successful: + summary: Successful + value: + name: Mithril Shirt + model: company + data_type: string + same_name_already_exists: + summary: Same name already exists + value: + name: The One Ring + model: contact + data_type: integer + invalid_name: + summary: Invalid name + value: + name: "!nv@l!d n@me" + model: company + data_type: string + attribute_already_exists: + summary: Attribute already exists + value: + name: The One Ring + model: company + data_type: string + invalid_data_type: + summary: Invalid Data Type + value: + name: The Second Ring + model: company + data_type: mithril + too_few_options_for_list: + summary: Too few options for list + value: + description: Just a plain old ring + options: + - value: 1-10 + archived: false + "/data_attributes/{id}": + put: + summary: Update a data attribute + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The data attribute id + example: 1 + schema: + type: integer + tags: + - Data Attributes + operationId: updateDataAttribute + description: "\nYou can update a data attribute.\n\n> \U0001F6A7 Updating the + data type is not possible\n>\n> It is currently a dangerous action to execute + changing a data attribute's type via the API. You will need to update the + type via the UI instead.\n" + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + id: 172 + type: data_attribute + name: The One Ring + full_name: custom_attributes.The One Ring + label: The One Ring + description: Just a plain old ring + data_type: string + options: + - 1-10 + - 11-20 + api_writable: true + ui_writable: false + messenger_writable: true + custom: true + archived: false + admin_id: '991271777' + created_at: 1715077976 + updated_at: 1715077977 + model: company + schema: + "$ref": "#/components/schemas/data_attribute" + '400': + description: Too few options in list + content: + application/json: + examples: + Too few options in list: + value: + type: error.list + request_id: bdd80501-b994-4f0e-a5e4-26842fb1fcf0 + errors: + - code: parameter_invalid + message: Options isn't an array + schema: + "$ref": "#/components/schemas/error" + '404': + description: Attribute Not Found + content: + application/json: + examples: + Attribute Not Found: + value: + type: error.list + request_id: 829a80a6-d72a-4241-a02b-9d507c55d116 + errors: + - code: field_not_found + message: We couldn't find that data attribute to update + schema: + "$ref": "#/components/schemas/error" + '422': + description: Has Dependant Object + content: + application/json: + examples: + Has Dependant Object: + value: + type: error.list + request_id: 8f8ebca9-c3b6-433e-b9aa-b2ceb5c097ee + errors: + - code: data_invalid + message: The Data Attribute you are trying to archive has a + dependant object + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 9f03ec2d-5be6-4284-8f50-50916551b276 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/update_data_attribute_request" + examples: + successful: + summary: Successful + value: + description: Just a plain old ring + options: + - value: 1-10 + - value: 11-20 + archived: false + too_few_options_in_list: + summary: Too few options in list + value: + description: Too few options + options: + value: 1-10 + archived: false + attribute_not_found: + summary: Attribute Not Found + value: + description: Just a plain old ring + options: + - value: 1-10 + - value: 11-20 + archived: false + has_dependant_object: + summary: Has Dependant Object + value: + description: Trying to archieve + archived: true + "/events": + post: + summary: Submit a data event + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Data Events + operationId: createDataEvent + 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 + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 0a2ba79e-4ea0-4b4a-bc75-7c65c1fd0928 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_data_event_request" + get: + summary: List all data events + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - in: query + name: filter + required: true + style: form + explode: true + schema: + type: object + oneOf: + - title: user_id query parameter + properties: + user_id: + type: string + required: + - user_id + additionalProperties: false + - title: intercom_user_id query parameter + properties: + intercom_user_id: + type: string + required: + - intercom_user_id + additionalProperties: false + - title: email query parameter + properties: + email: + type: string + required: + - email + additionalProperties: false + - name: type + in: query + required: true + description: The value must be user + schema: + type: string + - name: summary + in: query + required: false + description: summary flag + schema: + type: boolean + tags: + - Data Events + operationId: lisDataEvents + description: "\n> \U0001F6A7\n>\n> Please note that you can only 'list' events + that are less than 90 days old. Event counts and summaries will still include + your events older than 90 days but you cannot 'list' these events individually + if they are older than 90 days\n\nThe events belonging to a customer can be + listed by sending a GET request to `https://api.intercom.io/events` with a + user or lead identifier along with a `type` parameter. The identifier parameter + can be one of `user_id`, `email` or `intercom_user_id`. The `type` parameter + value must be `user`.\n\n- `https://api.intercom.io/events?type=user&user_id={user_id}`\n- + `https://api.intercom.io/events?type=user&email={email}`\n- `https://api.intercom.io/events?type=user&intercom_user_id={id}` + (this call can be used to list leads)\n\nThe `email` parameter value should + be [url encoded](http://en.wikipedia.org/wiki/Percent-encoding) when sending.\n\nYou + can optionally define the result page size as well with the `per_page` parameter.\n" + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: event.summary + events: [] + pages: + next: http://api.intercom.test/events?next page + email: user26@email.com + intercom_user_id: 663a035c262d16a19645eec1 + user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 + schema: + "$ref": "#/components/schemas/data_event_summary" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 9179d600-4a9a-48be-a70f-e40227733bdc + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/events/summaries": + post: + summary: Create event summaries + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Data Events + operationId: dataEventSummaries + description: "Create event summaries for a user. Event summaries are used to + track the number of times an event has occurred, the first time it occurred + and the last time it occurred.\n\n" + responses: + '200': + description: successful + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 39295217-623e-43c0-b7d4-564140da28ff + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_data_event_summaries_request" + "/export/content/data": + post: + summary: Create content data export + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Data Export + operationId: createDataExport + description: "To create your export job, you need to send a `POST` request to + the export endpoint `https://api.intercom.io/export/content/data`.\n\nThe + only parameters you need to provide are the range of dates that you want exported.\n\n>\U0001F6A7 + Limit of one active job\n>\n> You can only have one active job per workspace. + You will receive a HTTP status code of 429 with the message Exceeded rate + limit of 1 pending message data export jobs if you attempt to create a second + concurrent job.\n\n>❗️ Updated_at not included\n>\n> It should be noted that + the timeframe only includes messages sent during the time period and not messages + that were only updated during this period. For example, if a message was updated + yesterday but sent two days ago, you would need to set the created_at_after + date before the message was sent to include that in your retrieval job.\n\n>\U0001F4D8 + Date ranges are inclusive\n>\n> Requesting data for 2018-06-01 until 2018-06-30 + will get all data for those days including those specified - e.g. 2018-06-01 + 00:00:00 until 2018-06-30 23:59:99.\n" + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + job_identifier: 5n65oa9161wkyetb + status: pending + download_url: '' + download_expires_at: '' + schema: + "$ref": "#/components/schemas/data_export" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_data_exports_request" + examples: + successful: + summary: successful + value: + created_at_after: 1715059983 + created_at_before: 1715077983 + "/export/content/data/{job_identifier}": + get: + summary: Show content data export + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: job_identifier + in: path + description: job_identifier + required: true + schema: + type: string + tags: + - Data Export + operationId: getDataExport + description: "You can view the status of your job by sending a `GET` request + to the URL\n`https://api.intercom.io/export/content/data/{job_identifier}` + - the `{job_identifier}` is the value returned in the response when you first + created the export job. More on it can be seen in the Export Job Model.\n\n> + \U0001F6A7 Jobs expire after two days\n> All jobs that have completed processing + (and are thus available to download from the provided URL) will have an expiry + limit of two days from when the export ob completed. After this, the data + will no longer be available.\n" + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + job_identifier: vx6ljp9fe5f2oeoe + status: pending + download_url: '' + download_expires_at: '' + schema: + "$ref": "#/components/schemas/data_export" + "/export/cancel/{job_identifier}": + post: + summary: Cancel content data export + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: job_identifier + in: path + description: job_identifier + required: true + schema: + type: string + tags: + - Data Export + operationId: cancelDataExport + description: You can cancel your job + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + job_identifier: z4s73cyw8a32ar47 + status: canceled + download_url: '' + download_expires_at: '' + schema: + "$ref": "#/components/schemas/data_export" + "/download/content/data/{job_identifier}": + get: + summary: Download content data export + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: job_identifier + in: path + description: job_identifier + required: true + schema: + type: string + tags: + - Data Export + operationId: downloadDataExport + description: "When a job has a status of complete, and thus a filled download_url, + you can download your data by hitting that provided URL, formatted like so: + https://api.intercom.io/download/content/data/xyz1234.\n\nYour exported message + data will be streamed continuously back down to you in a gzipped CSV format.\n\n> + \U0001F4D8 Octet header required\n>\n> You will have to specify the header + Accept: `application/octet-stream` when hitting this endpoint.\n" + responses: + '200': + description: successful + "/messages": + post: + summary: Create a message + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Messages + operationId: createMessage + description: "You can create a message that has been initiated by an admin. + The conversation can be either an in-app message or an email.\n\n> \U0001F6A7 + Sending for visitors\n>\n> There can be a short delay between when a contact + is created and when a contact becomes available to be messaged through the + API. A 404 Not Found error will be returned in this case.\n\nThis will return + the Message model that has been created.\n\n> \U0001F6A7 Retrieving Associated + Conversations\n>\n> As this is a message, there will be no conversation present + until the contact responds. Once they do, you will have to search for a contact's + conversations with the id of the message.\n" + responses: + '200': + description: admin message created + content: + application/json: + examples: + user message created: + value: + type: user_message + id: '403918978' + created_at: 1715077985 + body: heyy + message_type: inapp + conversation_id: '1702' + lead message created: + value: + type: user_message + id: '403918979' + created_at: 1715077986 + body: heyy + message_type: inapp + conversation_id: '1703' + admin message created: + value: + type: admin_message + id: '55' + created_at: 1715077988 + subject: heyy + body: heyy + message_type: inapp + owner: + type: admin + id: '991271800' + name: Ciaran269 Lee + email: admin269@email.com + away_mode_enabled: false + away_mode_reassign: false + schema: + "$ref": "#/components/schemas/message" + '400': + description: No body supplied for email message + content: + application/json: + examples: + No body supplied for message: + value: + type: error.list + request_id: 2914fab0-030b-4041-b1ae-a40ce2f998d3 + errors: + - code: parameter_invalid + message: Body is required + No body supplied for email message: + value: + type: error.list + request_id: 1b5c12ad-b81c-40eb-a6e5-46a37c144244 + errors: + - code: parameter_invalid + message: Body is required + schema: + "$ref": "#/components/schemas/error" + '422': + description: No subject supplied for email message + content: + application/json: + examples: + No subject supplied for email message: + value: + type: error.list + request_id: 2374c42e-ea4d-4fe3-8ebd-3b200b5d1f00 + errors: + - code: parameter_not_found + message: No subject supplied for email message + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 9e8801f4-5604-43c1-bcd8-35044f1b59ae + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: API plan restricted + content: + application/json: + examples: + API plan restricted: + value: + type: error.list + request_id: 6e297ae2-2697-44aa-a1d9-a34c9c62a537 + errors: + - code: api_plan_restricted + message: Active subscription needed. + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_message_request" + examples: + user_message_created: + summary: user message created + value: + from: + type: user + id: 663a0361262d16a19645eec6 + body: heyy + referer: https://twitter.com/bob + lead_message_created: + summary: lead message created + value: + from: + type: lead + id: 663a0362262d16a19645eec7 + body: heyy + referer: https://twitter.com/bob + admin_message_created: + summary: admin message created + value: + from: + type: admin + id: '991271800' + to: + type: user + id: 663a0363262d16a19645eec8 + message_type: conversation + body: heyy + no_body_supplied_for_message: + summary: No body supplied for message + value: + from: + type: admin + id: '991271802' + to: + type: user + id: 663a0364262d16a19645eec9 + message_type: inapp + body: + subject: heyy + no_subject_supplied_for_email_message: + summary: No subject supplied for email message + value: + from: + type: admin + id: '991271803' + to: + type: user + user_id: '70' + message_type: email + body: hey there + no_body_supplied_for_email_message: + summary: No body supplied for email message + value: + from: + type: admin + id: '991271804' + to: + type: user + id: 663a0365262d16a19645eecb + message_type: email + body: + subject: heyy + "/news/news_items": + get: + summary: List all news items + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - News + operationId: listNewsItems + description: You can fetch a list of all news items + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + pages: + page: 1 + per_page: 10 + total_pages: 1 + type: pages + data: + - id: '141' + type: news-item + workspace_id: this_is_an_id483_that_should_be_at_least_ + title: We have news + body: "

    Hello there,

    " + sender_id: 991271809 + state: draft + labels: [] + cover_image_url: + reactions: + - + - + - + - + deliver_silently: false + created_at: 1715077991 + updated_at: 1715077991 + newsfeed_assignments: [] + - id: '142' + type: news-item + workspace_id: this_is_an_id483_that_should_be_at_least_ + title: We have news + body: "

    Hello there,

    " + sender_id: 991271811 + state: draft + labels: [] + cover_image_url: + reactions: + - + - + - + - + deliver_silently: false + created_at: 1715077991 + updated_at: 1715077991 + newsfeed_assignments: [] + total_count: 2 + schema: + "$ref": "#/components/schemas/paginated_response" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 4514550c-f3f8-4423-9b22-67925e08f88d + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + post: + summary: Create a news item + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - News + operationId: createNewsItem + description: You can create a news item + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: '145' + type: news-item + workspace_id: this_is_an_id487_that_should_be_at_least_ + title: Halloween is here! + body: "

    New costumes in store for this spooky season

    " + sender_id: 991271818 + state: live + labels: + - New + - Product + - Update + cover_image_url: + reactions: + - "\U0001F606" + - "\U0001F605" + deliver_silently: true + created_at: 1715077992 + updated_at: 1715077992 + newsfeed_assignments: + - newsfeed_id: 253 + published_at: 1664638214 + schema: + "$ref": "#/components/schemas/news_item" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 7594efcb-d3fd-4bde-81db-561de0f87e6e + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/news_item_request" + examples: + successful: + summary: successful + value: + title: Halloween is here! + body: "

    New costumes in store for this spooky season

    " + labels: + - Product + - Update + - New + sender_id: 991271818 + deliver_silently: true + reactions: + - "\U0001F606" + - "\U0001F605" + state: live + newsfeed_assignments: + - newsfeed_id: 253 + published_at: 1664638214 + "/news/news_items/{id}": + get: + summary: Retrieve a news item + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the news item which is given by Intercom. + example: 123 + schema: + type: integer + tags: + - News + operationId: retrieveNewsItem + description: You can fetch the details of a single news item. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: '146' + type: news-item + workspace_id: this_is_an_id491_that_should_be_at_least_ + title: We have news + body: "

    Hello there,

    " + sender_id: 991271821 + state: live + labels: [] + cover_image_url: + reactions: + - + - + - + - + deliver_silently: false + created_at: 1715077993 + updated_at: 1715077993 + newsfeed_assignments: + - newsfeed_id: 255 + published_at: 1715077994 + schema: + "$ref": "#/components/schemas/news_item" + '404': + description: News Item Not Found + content: + application/json: + examples: + News Item Not Found: + value: + type: error.list + request_id: 5df85967-d363-4861-8028-ddf211c143db + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: e4da1766-8164-4851-b8fa-1fe832276699 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + put: + summary: Update a news item + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the news item which is given by Intercom. + example: 123 + schema: + type: integer + tags: + - News + operationId: updateNewsItem + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: '149' + type: news-item + workspace_id: this_is_an_id497_that_should_be_at_least_ + title: Christmas is here! + body: "

    New gifts in store for the jolly season

    " + sender_id: 991271829 + state: live + labels: [] + cover_image_url: + reactions: + - "\U0001F61D" + - "\U0001F602" + deliver_silently: false + created_at: 1715077995 + updated_at: 1715077996 + newsfeed_assignments: [] + schema: + "$ref": "#/components/schemas/news_item" + '404': + description: News Item Not Found + content: + application/json: + examples: + News Item Not Found: + value: + type: error.list + request_id: ddaccf0b-b881-4c0b-857e-8aaeeedbfb70 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: a2f94e3a-f112-43c8-ae1f-4951d0c2c928 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/news_item_request" + examples: + successful: + summary: successful + value: + title: Christmas is here! + body: "

    New gifts in store for the jolly season

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

    New gifts in store for the jolly season

    " + sender_id: 991271832 + reactions: + - "\U0001F61D" + - "\U0001F602" + delete: + summary: Delete a news item + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the news item which is given by Intercom. + example: 123 + schema: + type: integer + tags: + - News + operationId: deleteNewsItem + description: You can delete a single news item. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: '152' + object: news-item + deleted: true + schema: + "$ref": "#/components/schemas/deleted_object" + '404': + description: News Item Not Found + content: + application/json: + examples: + News Item Not Found: + value: + type: error.list + request_id: 481f314c-479d-4edb-8af2-73dbfbc058d5 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 25e60b77-970b-445b-8ef5-8d9da06dd33e + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/news/newsfeeds/{id}/items": + get: + summary: List all live newsfeed items + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the news feed item which is given by + Intercom. + example: '123' + schema: + type: string + tags: + - News + operationId: listLiveNewsfeedItems + description: You can fetch a list of all news items that are live on a given + newsfeed + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + pages: + page: 1 + per_page: 20 + total_pages: 0 + type: pages + data: [] + total_count: 0 + schema: + "$ref": "#/components/schemas/paginated_response" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 6b583fa0-5798-4e35-a904-be1d85725f9c + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/news/newsfeeds": + get: + summary: List all newsfeeds + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - News + operationId: listNewsfeeds + description: You can fetch a list of all newsfeeds + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + pages: + page: 1 + per_page: 10 + total_pages: 1 + type: pages + data: + - id: '268' + type: newsfeed + name: Visitor Feed + created_at: 1715078000 + updated_at: 1715078000 + - id: '269' + type: newsfeed + name: Visitor Feed + created_at: 1715078000 + updated_at: 1715078000 + total_count: 2 + schema: + "$ref": "#/components/schemas/paginated_response" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: ba37e181-8550-4b7d-806f-828dd1c56ac0 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/news/newsfeeds/{id}": + get: + summary: Retrieve a newsfeed + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the news feed item which is given by + Intercom. + example: '123' + schema: + type: string + tags: + - News + operationId: retrieveNewsfeed + description: You can fetch the details of a single newsfeed + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: '272' + type: newsfeed + name: Visitor Feed + created_at: 1715078001 + updated_at: 1715078001 + schema: + "$ref": "#/components/schemas/newsfeed" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 1d61b002-6951-44eb-a778-e9ca862edffb + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/notes/{id}": + get: + summary: Retrieve a note + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier of a given note + example: 1 + schema: + type: integer + tags: + - Notes + operationId: retrieveNote + description: You can fetch the details of a single note. + responses: + '200': + description: Note found + content: + application/json: + examples: + Note found: + value: + type: note + id: '141' + created_at: 1714386802 + contact: + type: contact + id: 663a0372262d16a19645eece + author: + type: admin + id: '991271848' + name: Ciaran316 Lee + email: admin316@email.com + away_mode_enabled: false + away_mode_reassign: false + body: "

    This is a note.

    " + schema: + "$ref": "#/components/schemas/note" + '404': + description: Note not found + content: + application/json: + examples: + Note not found: + value: + type: error.list + request_id: 5af17ae1-c7f3-41a2-9cd0-75920f57a18f + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 3e1c94b9-249b-42d9-93ee-0f5de34d2a18 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/segments": + get: + summary: List all segments + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: include_count + in: query + required: false + description: It includes the count of contacts that belong to each segment. + example: true + schema: + type: boolean + tags: + - Segments + operationId: listSegments + description: You can fetch a list of all segments. + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: segment.list + segments: + - type: segment + id: 663a0373262d16a19645eed1 + name: John segment + created_at: 1715078003 + updated_at: 1715078003 + person_type: user + - type: segment + id: 663a0373262d16a19645eed2 + name: Jane segment + created_at: 1715078003 + updated_at: 1715078003 + person_type: user + schema: + "$ref": "#/components/schemas/segment_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 5d7887e3-f154-4549-8ec2-f7edf2913627 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/segments/{id}": + get: + summary: Retrieve a segment + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identified of a given segment. + example: '123' + schema: + type: string + tags: + - Segments + operationId: retrieveSegment + description: You can fetch the details of a single segment. + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: segment + id: 663a0374262d16a19645eed5 + name: John segment + created_at: 1715078004 + updated_at: 1715078004 + person_type: user + schema: + "$ref": "#/components/schemas/segment" + '404': + description: Segment not found + content: + application/json: + examples: + Segment not found: + value: + type: error.list + request_id: cc8e54bc-6417-4fb0-9479-9e6c4fa7e0c3 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: ef0a1a11-d958-4dca-b0a8-412d01c8fc1e + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/subscription_types": + get: + summary: List subscription types + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Subscription Types + operationId: listSubscriptionTypes + description: You can list all subscription types. A list of subscription type + objects will be returned. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: list + data: + - type: subscription + id: '505' + state: live + consent_type: opt_out + default_translation: + name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + translations: + - name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + content_types: + - email + schema: + "$ref": "#/components/schemas/subscription_type_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 658a7215-c185-47bb-82d0-770680f86085 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/phone_call_redirects": + post: + summary: Create a phone Switch + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Switch + operationId: createPhoneSwitch + description: | + You can use the API to deflect phone calls to the Intercom Messenger. + Calling this endpoint will send an SMS with a link to the Messenger to the phone number specified. + + If custom attributes are specified, they will be added to the user or lead's custom data attributes. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + url: http://via.intercom.io/msgr/85e69424-423d-4917-8f91-03fb6848688a + type: phone_call_redirect + schema: + "$ref": "#/components/schemas/phone_switch" + '400': + description: bad request - invalid number + content: + application/json: + examples: + bad request - exception sending sms: + value: + error_key: sms_failed + message: SMS was not sent due to an unknown error + bad request - invalid number: + value: + error_key: invalid_phone_number + message: Invalid phone number + '422': + description: unprocessable entity + content: + application/json: + examples: + unprocessable entity: + value: + error_key: some_error + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: efcbfcc3-9701-44dc-9ced-4f552f6ed4dd + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_phone_switch_request" + examples: + successful: + summary: successful + value: + phone: "+353832345678" + custom_attributes: + issue_type: Billing + priority: High + bad_request_-_exception_sending_sms: + summary: bad request - exception sending sms + value: + phone: "+353832345678" + custom_attributes: + issue_type: Billing + priority: High + bad_request_-_invalid_number: + summary: bad request - invalid number + value: + phone: "+353832345678" + custom_attributes: + issue_type: Billing + priority: High + unprocessable_entity: + summary: unprocessable entity + value: + phone: "+40241100100" + custom_attributes: + issue_type: Billing + priority: High + "/tags": + get: + summary: List all tags + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Tags + operationId: listTags + description: "You can fetch a list of all tags for a given workspace.\n\n" + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + data: + - type: tag + id: '453' + name: Manual tag 1 + schema: + "$ref": "#/components/schemas/tag_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 6807969f-3331-4166-ae86-187baf5b9258 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + post: + summary: Create or update a tag, Tag or untag companies, Tag contacts + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Tags + operationId: createTag + description: | + You can use this endpoint to perform the following operations: + + **1. Create a new tag:** You can create a new tag by passing in the tag name as specified in "Create or Update Tag Request Payload" described below. + + **2. Update an existing tag:** You can update an existing tag by passing the id of the tag as specified in "Create or Update Tag Request Payload" described below. + + **3. Tag Companies:** You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in "Tag Company Request Payload" described below. Also, if the tag doesn't exist then a new one will be created automatically. + + **4. Untag Companies:** You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in "Untag Company Request Payload" described below. + + **5. Tag Multiple Users:** You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in "Tag Users Request Payload" described below. + + Each operation will return a tag object. + responses: + '200': + description: Action successful + content: + application/json: + examples: + Action successful: + value: + type: tag + id: '456' + name: test + schema: + "$ref": "#/components/schemas/tag" + '400': + description: Invalid parameters + content: + application/json: + examples: + Invalid parameters: + value: + type: error.list + request_id: 51dd8ecf-e292-491d-9e92-c89aabfbf7bf + errors: + - code: parameter_invalid + message: invalid tag parameters + schema: + "$ref": "#/components/schemas/error" + '404': + description: User not found + content: + application/json: + examples: + Company not found: + value: + type: error.list + request_id: 599695e2-176b-400e-86b3-a444bdcbd1df + errors: + - code: company_not_found + message: Company Not Found + User not found: + value: + type: error.list + request_id: 17a941ca-2416-4677-bd5a-98bd74459485 + errors: + - code: not_found + message: User Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 456f8183-dc1d-4354-a18d-17966b9d2031 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + oneOf: + - "$ref": "#/components/schemas/create_or_update_tag_request" + - "$ref": "#/components/schemas/tag_company_request" + - "$ref": "#/components/schemas/untag_company_request" + - "$ref": "#/components/schemas/tag_multiple_users_request" + examples: + action_successful: + summary: Action successful + value: + name: test + invalid_parameters: + summary: Invalid parameters + value: + test: invalid + company_not_found: + summary: Company not found + value: + name: test + companies: + - company_id: '123' + user_not_found: + summary: User not found + value: + name: test + users: + - id: '123' + "/tags/{id}": + get: + summary: Find a specific tag + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: The unique identifier of a given tag + example: '123' + required: true + schema: + type: string + tags: + - Tags + operationId: findTag + description: | + You can fetch the details of tags that are on the workspace by their id. + This will return a tag object. + responses: + '200': + description: Tag found + content: + application/json: + examples: + Tag found: + value: + type: tag + id: '464' + name: Manual tag + schema: + "$ref": "#/components/schemas/tag" + '404': + description: Tag not found + content: + application/json: + examples: + Tag not found: + value: + type: error.list + request_id: 19b93563-23f8-4d08-bc93-5985ce417791 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 699c8459-4142-4cb2-9a61-5341aa7fca2a + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + delete: + summary: Delete tag + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: The unique identifier of a given tag + example: '123' + required: true + schema: + type: string + tags: + - Tags + operationId: deleteTag + description: You can delete the details of tags that are on the workspace by + passing in the id. + responses: + '200': + description: Successful + '404': + description: Resource not found + content: + application/json: + examples: + Resource not found: + value: + type: error.list + request_id: 2fad07b3-a11f-46a2-bd15-80e7f740da13 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '400': + description: Tag has dependent objects + content: + application/json: + examples: + Tag has dependent objects: + value: + type: error.list + request_id: 8a14cc93-c527-4ee7-bf37-de90d27f38e1 + errors: + - code: tag_has_dependent_objects + message: 'Unable to delete Tag with dependent objects. Segments: + Seg 1.' + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: a7e14a96-4711-4d47-a66d-fb1e916acf22 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/teams": + get: + summary: List all teams + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Teams + operationId: listTeams + description: This will return a list of team objects for the App. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: team.list + teams: [] + schema: + "$ref": "#/components/schemas/team_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 143e0023-f018-4492-a51b-4bb8529e8fe1 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/teams/{id}": + get: + summary: Retrieve a team + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier of a given team. + example: '123' + schema: + type: string + tags: + - Teams + operationId: retrieveTeam + description: You can fetch the details of a single team, containing an array + of admins that belong to this team. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: team + id: '991271886' + name: team 1 + admin_ids: [] + schema: + "$ref": "#/components/schemas/team" + '404': + description: Team not found + content: + application/json: + examples: + Team not found: + value: + type: error.list + request_id: 031c3357-b2c2-4723-913c-680d7bda15d3 + errors: + - code: team_not_found + message: Team not found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 536d9e99-56af-441a-8b84-fe24c40a41ff + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/ticket_types/{ticket_type_id}/attributes": + post: + summary: Create a new attribute for a ticket type + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: ticket_type_id + in: path + required: true + description: The unique identifier for the ticket type which is given by Intercom. + schema: + type: string + tags: + - Ticket Type Attributes + description: You can create a new attribute for a ticket type. + operationId: createTicketTypeAttribute + responses: + '200': + description: Ticket Type Attribute created + content: + application/json: + examples: + Ticket Type Attribute created: + value: + type: ticket_type_attribute + id: '796' + workspace_id: this_is_an_id589_that_should_be_at_least_ + name: Attribute Title + description: Attribute Description + data_type: string + input_options: + multiline: false + 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: 289 + archived: false + created_at: 1715078021 + updated_at: 1715078021 + schema: + "$ref": "#/components/schemas/ticket_type_attribute" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 61f43605-a38c-4983-8a66-885aa12966c7 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_ticket_type_attribute_request" + examples: + ticket_type_attribute_created: + summary: Ticket Type Attribute created + value: + name: Attribute Title + description: Attribute Description + data_type: string + required_to_create: false + "/ticket_types/{ticket_type_id}/attributes/{id}": + put: + summary: Update an existing attribute for a ticket type + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: ticket_type_id + in: path + required: true + description: The unique identifier for the ticket type which is given by Intercom. + schema: + type: string + - name: id + in: path + required: true + description: The unique identifier for the ticket type attribute which is + given by Intercom. + schema: + type: string + tags: + - Ticket Type Attributes + description: You can update an existing attribute for a ticket type. + operationId: updateTicketTypeAttribute + responses: + '200': + description: Ticket Type Attribute updated + content: + application/json: + examples: + Ticket Type Attribute updated: + value: + type: ticket_type_attribute + id: '801' + workspace_id: this_is_an_id593_that_should_be_at_least_ + name: name + description: New Attribute Description + data_type: string + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: false + visible_to_contacts: false + default: false + ticket_type_id: 291 + archived: false + created_at: 1715078022 + updated_at: 1715078023 + schema: + "$ref": "#/components/schemas/ticket_type_attribute" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: f6cc4995-6c2b-4456-92d8-4a2d6b506ea7 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/update_ticket_type_attribute_request" + examples: + ticket_type_attribute_updated: + summary: Ticket Type Attribute updated + value: + description: New Attribute Description + "/ticket_types": + get: + summary: List all ticket types + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Ticket Types + operationId: listTicketTypes + description: You can get a list of all ticket types for a workspace. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + data: + - type: ticket_type + id: '293' + name: Bug Report + description: Bug Report Template + icon: "\U0001F39F️" + workspace_id: this_is_an_id597_that_should_be_at_least_ + archived: false + created_at: 1715078023 + updated_at: 1715078023 + is_internal: false + ticket_type_attributes: + type: list + data: + - type: ticket_type_attribute + id: '804' + 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: 293 + archived: false + created_at: 1715078023 + updated_at: 1715078023 + - type: ticket_type_attribute + id: '806' + workspace_id: this_is_an_id597_that_should_be_at_least_ + name: name + description: description + data_type: string + input_options: + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: false + visible_to_contacts: false + default: false + ticket_type_id: 293 + archived: false + created_at: 1715078024 + updated_at: 1715078024 + - type: ticket_type_attribute + id: '805' + 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: 293 + archived: false + created_at: 1715078024 + updated_at: 1715078024 + category: Customer + schema: + "$ref": "#/components/schemas/ticket_type_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: da4c6915-e23a-4c01-bf7b-e56eac8ac642 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + post: + summary: Create a ticket type + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Ticket Types + operationId: createTicketType + description: "You can create a new ticket type.\n> \U0001F4D8 Creating ticket + types.\n>\n> Every ticket type will be created with two default attributes: + _default_title_ and _default_description_.\n> For the `icon` propery, use + an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n" + responses: + '200': + description: Ticket type created + content: + application/json: + examples: + Ticket type created: + value: + type: ticket_type + id: '296' + name: Customer Issue + description: Customer Report Template + icon: "\U0001F39F️" + workspace_id: this_is_an_id601_that_should_be_at_least_ + archived: false + created_at: 1715078025 + updated_at: 1715078025 + is_internal: false + ticket_type_attributes: + type: list + data: + - type: ticket_type_attribute + id: '813' + 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: 296 + archived: false + created_at: 1715078025 + updated_at: 1715078025 + - type: ticket_type_attribute + id: '814' + 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: 296 + archived: false + created_at: 1715078025 + updated_at: 1715078025 + category: Customer + schema: + "$ref": "#/components/schemas/ticket_type" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 8b0f31c1-a182-481d-a287-cfaa4cb7e53e + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_ticket_type_request" + examples: + ticket_type_created: + summary: Ticket type created + value: + name: Customer Issue + description: Customer Report Template + icon: "\U0001F39F️" + category: Customer + "/ticket_types/{id}": + get: + summary: Retrieve a ticket type + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the ticket type which is given by Intercom. + schema: + type: string + tags: + - Ticket Types + operationId: getTicketType + description: You can fetch the details of a single ticket type. + responses: + '200': + description: Ticket type found + content: + application/json: + examples: + Ticket type found: + value: + type: ticket_type + id: '298' + name: Bug Report + description: Bug Report Template + icon: "\U0001F39F️" + workspace_id: this_is_an_id605_that_should_be_at_least_ + archived: false + created_at: 1715078026 + updated_at: 1715078026 + is_internal: false + ticket_type_attributes: + type: list + data: + - type: ticket_type_attribute + id: '818' + 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: 298 + archived: false + created_at: 1715078026 + updated_at: 1715078026 + - type: ticket_type_attribute + id: '820' + workspace_id: this_is_an_id605_that_should_be_at_least_ + name: name + description: description + data_type: string + input_options: + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: false + visible_to_contacts: false + default: false + ticket_type_id: 298 + archived: false + created_at: 1715078026 + updated_at: 1715078026 + - type: ticket_type_attribute + id: '819' + 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: 298 + archived: false + created_at: 1715078026 + updated_at: 1715078026 + category: Customer + schema: + "$ref": "#/components/schemas/ticket_type" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 58263d02-5eb2-4351-ad75-19e4f0fa86eb + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + put: + summary: Update a ticket type + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the ticket type which is given by Intercom. + schema: + type: string + tags: + - Ticket Types + operationId: updateTicketType + description: "\nYou can update a ticket type.\n\n> \U0001F4D8 Updating a ticket + type.\n>\n> For the `icon` propery, use an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n" + responses: + '200': + description: Ticket type updated + content: + application/json: + examples: + Ticket type updated: + value: + type: ticket_type + id: '300' + name: Bug Report 2 + description: Bug Report Template + icon: "\U0001F39F️" + workspace_id: this_is_an_id609_that_should_be_at_least_ + archived: false + created_at: 1715078027 + updated_at: 1715078027 + is_internal: false + ticket_type_attributes: + type: list + data: + - type: ticket_type_attribute + id: '824' + workspace_id: this_is_an_id609_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: 300 + archived: false + created_at: 1715078027 + updated_at: 1715078027 + - type: ticket_type_attribute + id: '826' + workspace_id: this_is_an_id609_that_should_be_at_least_ + name: name + description: description + data_type: string + input_options: + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: false + visible_to_contacts: false + default: false + ticket_type_id: 300 + archived: false + created_at: 1715078027 + updated_at: 1715078027 + - type: ticket_type_attribute + id: '825' + workspace_id: this_is_an_id609_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: 300 + archived: false + created_at: 1715078027 + updated_at: 1715078027 + category: Customer + schema: + "$ref": "#/components/schemas/ticket_type" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: a93aeb34-0f14-4361-bacf-cf6a694e6827 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/update_ticket_type_request" + examples: + ticket_type_updated: + summary: Ticket type updated + value: + name: Bug Report 2 + "/tickets/{id}/reply": + post: + summary: Reply to a ticket + operationId: replyTicket + description: You can reply to a ticket with a message from an admin or on behalf + of a contact, or with a note for admins. + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + schema: + title: Ticket ID + type: string + description: The id of the ticket to target. + example: '123' + tags: + - Tickets + responses: + '200': + description: Admin quick_reply reply + content: + application/json: + examples: + User reply: + value: + type: ticket_part + id: '384' + part_type: comment + body: "

    Thanks again :)

    " + created_at: 1715078029 + updated_at: 1715078029 + author: + id: 663a038d262d16a19645eef8 + type: user + name: + email: user30@email.com + attachments: [] + redacted: false + Admin note reply: + value: + type: ticket_part + id: '386' + part_type: note + body: |- +

    An Unordered HTML List

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

    An Ordered HTML List

    +
      +
    1. Coffee
      2. +
    2. Tea
      3. +
    3. Milk
      4. +
    + created_at: 1715078032 + updated_at: 1715078032 + author: + id: '991271913' + type: admin + name: Ciaran375 Lee + email: admin375@email.com + attachments: [] + redacted: false + Admin quick_reply reply: + value: + type: ticket_part + id: '388' + part_type: quick_reply + created_at: 1715078035 + updated_at: 1715078035 + author: + id: '991271918' + type: admin + name: Ciaran379 Lee + email: admin379@email.com + attachments: [] + redacted: false + schema: + "$ref": "#/components/schemas/ticket_reply" + '404': + description: Not found + content: + application/json: + examples: + Not found: + value: + type: error.list + request_id: c4573719-c6c4-4b93-869a-f6859f219b51 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: e5c93190-fdbd-45c2-9ed9-673bd412cd9e + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_ticket_reply_with_comment_request" + examples: + user_reply: + summary: User reply + value: + message_type: comment + type: user + intercom_user_id: 663a038d262d16a19645eef8 + body: Thanks again :) + admin_note_reply: + summary: Admin note reply + value: + message_type: note + type: admin + admin_id: 991271913 + body: "

    An Unordered HTML List

    • Coffee
      • + \
    • Tea
    • Milk

    An Ordered HTML List

    + \
    1. Coffee
    2. Tea
    3. Milk
    + \ " + admin_quick_reply_reply: + summary: Admin quick_reply reply + value: + message_type: quick_reply + type: admin + admin_id: 991271918 + reply_options: + - text: 'Yes' + uuid: 5e21678b-93f2-47a0-94c5-2ad422ec920b + - text: 'No' + uuid: 7be6474b-cb69-4d33-ba01-d7481187c8ed + not_found: + summary: Not found + value: + message_type: comment + type: user + intercom_user_id: 663a0394262d16a19645eefb + body: Thanks again :) + "/tickets/{ticket_id}/tags": + post: + summary: Add tag to a ticket + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: ticket_id + in: path + description: ticket_id + example: '64619700005694' + required: true + schema: + type: string + tags: + - Tags + - Tickets + operationId: attachTagToTicket + description: You can tag a specific ticket. This will return a tag object for + the tag that was added to the ticket. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: tag + id: '472' + name: Manual tag + schema: + "$ref": "#/components/schemas/tag" + '404': + description: Ticket not found + content: + application/json: + examples: + Ticket not found: + value: + type: error.list + request_id: f1c170ee-8f8b-4ebb-8f4f-839979f55346 + errors: + - code: ticket_not_found + message: Ticket not found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: d0cab400-3d72-4aff-a057-4ad735553eb5 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + type: object + required: + - id + - admin_id + properties: + id: + type: string + description: The unique identifier for the tag which is given by + Intercom + example: '7522907' + admin_id: + type: string + description: The unique identifier for the admin which is given + by Intercom. + example: '780' + examples: + successful: + summary: successful + value: + id: 472 + admin_id: 991271928 + ticket_not_found: + summary: Ticket not found + value: + id: 473 + admin_id: 991271931 + "/tickets/{ticket_id}/tags/{id}": + delete: + summary: Remove tag from a ticket + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: ticket_id + in: path + description: ticket_id + example: '64619700005694' + required: true + schema: + type: string + - name: id + in: path + description: The unique identifier for the tag which is given by Intercom + example: '7522907' + required: true + schema: + type: string + tags: + - Tags + - Tickets + operationId: detachTagFromTicket + description: You can remove tag from a specific ticket. This will return a tag + object for the tag that was removed from the ticket. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: tag + id: '475' + name: Manual tag + schema: + "$ref": "#/components/schemas/tag" + '404': + description: Tag not found + content: + application/json: + examples: + Ticket not found: + value: + type: error.list + request_id: 77b0a6bc-c23b-42dd-8b16-76f7255b6767 + errors: + - code: ticket_not_found + message: Ticket not found + Tag not found: + value: + type: error.list + request_id: c8ac5eb3-4fbe-4a27-a35a-fe9e23989984 + errors: + - code: tag_not_found + message: Tag not found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: a6583c8d-217d-49d6-b384-707aa12949b1 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + type: object + required: + - admin_id + properties: + admin_id: + type: string + description: The unique identifier for the admin which is given + by Intercom. + example: '123' + examples: + successful: + summary: successful + value: + admin_id: 991271937 + ticket_not_found: + summary: Ticket not found + value: + admin_id: 991271940 + tag_not_found: + summary: Tag not found + value: + admin_id: 991271943 + "/tickets": + post: + summary: Create a ticket + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Tickets + description: You can create a new ticket. + operationId: createTicket + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: ticket + id: '1715' + ticket_id: '92' + ticket_attributes: + title: example + description: there is a problem + ticket_state: submitted + ticket_state_internal_label: Submitted + ticket_state_external_label: Submitted + ticket_type: + type: ticket_type + id: '314' + name: my-ticket-type-15 + description: my ticket type description is awesome. + icon: "\U0001F981" + workspace_id: this_is_an_id637_that_should_be_at_least_ + archived: false + created_at: 1715078050 + updated_at: 1715078050 + is_internal: false + ticket_type_attributes: + type: list + data: + - type: ticket_type_attribute + id: '838' + workspace_id: this_is_an_id637_that_should_be_at_least_ + name: title + description: ola + data_type: string + input_options: + order: 0 + required_to_create: true + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: false + default: false + ticket_type_id: 314 + archived: false + created_at: 1715078050 + updated_at: 1715078050 + - type: ticket_type_attribute + id: '839' + workspace_id: this_is_an_id637_that_should_be_at_least_ + name: description + description: ola + data_type: string + input_options: + order: 0 + required_to_create: true + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: false + default: false + ticket_type_id: 314 + archived: false + created_at: 1715078050 + updated_at: 1715078050 + category: Back-office + contacts: + type: contact.list + contacts: + - type: contact + id: 663a03a2262d16a19645ef03 + external_id: '70' + admin_assignee_id: '0' + team_assignee_id: '0' + created_at: 1715078051 + updated_at: 1715078051 + ticket_parts: + type: ticket_part.list + ticket_parts: + - type: ticket_part + id: '389' + part_type: ticket_state_updated_by_admin + ticket_state: submitted + previous_ticket_state: submitted + created_at: 1715078051 + updated_at: 1715078051 + author: + id: '991271955' + type: bot + name: Operator + email: operator+this_is_an_id637_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false + total_count: 1 + open: true + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + category: Back-office + is_shared: false + schema: + "$ref": "#/components/schemas/ticket" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 30f46f48-3302-4c53-99d8-670626ddfd85 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_ticket_request" + examples: + successful_response: + summary: Successful response + value: + ticket_type_id: 314 + contacts: + - id: 663a03a2262d16a19645ef03 + ticket_attributes: + title: example + description: there is a problem + "/tickets/{id}": + put: + summary: Update a ticket + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the ticket which is given by Intercom + schema: + type: string + tags: + - Tickets + operationId: updateTicket + description: You can update a ticket. + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: ticket + id: '1716' + ticket_id: '93' + ticket_attributes: + title: example + description: there is a problem + ticket_state: in_progress + ticket_state_internal_label: In progress + ticket_state_external_label: In progress + ticket_type: + type: ticket_type + id: '316' + name: my-ticket-type-17 + description: my ticket type description is awesome. + icon: "\U0001F981" + workspace_id: this_is_an_id641_that_should_be_at_least_ + archived: false + created_at: 1715078052 + updated_at: 1715078052 + is_internal: false + ticket_type_attributes: + type: list + data: + - type: ticket_type_attribute + id: '843' + workspace_id: this_is_an_id641_that_should_be_at_least_ + name: title + description: ola + data_type: string + input_options: + order: 0 + required_to_create: true + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: false + default: false + ticket_type_id: 316 + archived: false + created_at: 1715078052 + updated_at: 1715078052 + - type: ticket_type_attribute + id: '844' + workspace_id: this_is_an_id641_that_should_be_at_least_ + name: description + description: ola + data_type: string + input_options: + order: 0 + required_to_create: true + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: false + default: false + ticket_type_id: 316 + archived: false + created_at: 1715078053 + updated_at: 1715078053 + category: Back-office + contacts: + type: contact.list + contacts: + - type: contact + id: 663a03a5262d16a19645ef04 + external_id: cff3ccbd-dda2-4b00-9382-fb9d42d70418 + admin_assignee_id: '991271969' + team_assignee_id: '0' + created_at: 1715078053 + updated_at: 1715078056 + ticket_parts: + type: ticket_part.list + ticket_parts: + - type: ticket_part + id: '390' + part_type: ticket_state_updated_by_admin + ticket_state: submitted + previous_ticket_state: submitted + created_at: 1715078053 + updated_at: 1715078053 + author: + id: '991271967' + type: admin + name: Ciaran419 Lee + email: admin419@email.com + attachments: [] + redacted: false + - type: ticket_part + id: '391' + part_type: ticket_attribute_updated_by_admin + created_at: 1715078054 + updated_at: 1715078054 + author: + id: '991271968' + type: bot + name: Operator + email: operator+this_is_an_id641_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false + - type: ticket_part + id: '392' + part_type: ticket_attribute_updated_by_admin + created_at: 1715078055 + updated_at: 1715078055 + author: + id: '991271968' + type: bot + name: Operator + email: operator+this_is_an_id641_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false + - type: ticket_part + id: '393' + part_type: ticket_state_updated_by_admin + ticket_state: in_progress + previous_ticket_state: submitted + created_at: 1715078055 + updated_at: 1715078055 + author: + id: '991271968' + type: bot + name: Operator + email: operator+this_is_an_id641_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false + - type: ticket_part + id: '394' + part_type: assignment + created_at: 1715078055 + updated_at: 1715078055 + assigned_to: + type: admin + id: '991271969' + author: + id: '991271967' + type: admin + name: Ciaran419 Lee + email: admin419@email.com + attachments: [] + redacted: false + - type: ticket_part + id: '395' + part_type: snoozed + created_at: 1715078056 + updated_at: 1715078056 + author: + id: '991271968' + type: bot + name: Operator + email: operator+this_is_an_id641_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false + total_count: 6 + open: true + snoozed_until: 1715184000 + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + category: Back-office + is_shared: false + schema: + "$ref": "#/components/schemas/ticket" + '404': + description: Assignee not found + content: + application/json: + examples: + Admin not found: + value: + type: error.list + request_id: 49adc398-d1d7-40a2-9578-1395f15e7e64 + errors: + - code: assignee_not_found + message: Assignee not found + Assignee not found: + value: + type: error.list + request_id: 1f3ecb9c-bfa1-4abb-991d-fb5214c51ea6 + errors: + - code: assignee_not_found + message: Assignee not found + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 23968cca-c0a2-44a2-9217-d74d655530e2 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/update_ticket_request" + examples: + successful_response: + summary: Successful response + value: + ticket_attributes: + title: example + description: there is a problem + state: in_progress + assignment: + admin_id: '991271967' + assignee_id: '991271969' + open: true + snoozed_until: 1673609604 + admin_not_found: + summary: Admin not found + value: + ticket_attributes: + title: example + description: there is a problem + state: in_progress + assignment: + admin_id: '123' + assignee_id: '991271977' + assignee_not_found: + summary: Assignee not found + value: + ticket_attributes: + title: example + description: there is a problem + state: in_progress + assignment: + admin_id: '991271983' + assignee_id: '456' + get: + summary: Retrieve a ticket + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the ticket which is given by Intercom. + schema: + type: string + tags: + - Tickets + operationId: getTicket + description: You can fetch the details of a single ticket. + responses: + '200': + description: Ticket found + content: + application/json: + examples: + Ticket found: + value: + type: ticket + id: '1719' + ticket_id: '96' + ticket_attributes: + title: attribute_value + description: + ticket_state: submitted + ticket_state_internal_label: Submitted + ticket_state_external_label: Submitted + ticket_type: + type: ticket_type + id: '320' + name: my-ticket-type-21 + description: my ticket type description is awesome. + icon: "\U0001F981" + workspace_id: this_is_an_id649_that_should_be_at_least_ + archived: false + created_at: 1715078062 + updated_at: 1715078062 + is_internal: false + ticket_type_attributes: + type: list + data: + - type: ticket_type_attribute + id: '854' + workspace_id: this_is_an_id649_that_should_be_at_least_ + name: title + description: ola + data_type: string + input_options: + order: 0 + required_to_create: true + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: false + default: false + ticket_type_id: 320 + archived: false + created_at: 1715078062 + updated_at: 1715078062 + - type: ticket_type_attribute + id: '855' + workspace_id: this_is_an_id649_that_should_be_at_least_ + name: description + description: ola + data_type: string + input_options: + order: 0 + required_to_create: true + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: false + default: false + ticket_type_id: 320 + archived: false + created_at: 1715078062 + updated_at: 1715078062 + category: Back-office + contacts: + type: contact.list + contacts: + - type: contact + id: 663a03ae262d16a19645ef07 + external_id: da33b10d-fa4d-4f09-bea6-dfc622d57b9f + admin_assignee_id: '0' + team_assignee_id: '0' + created_at: 1715078062 + updated_at: 1715078063 + ticket_parts: + type: ticket_part.list + ticket_parts: + - type: ticket_part + id: '398' + part_type: ticket_state_updated_by_admin + ticket_state: submitted + previous_ticket_state: submitted + created_at: 1715078063 + updated_at: 1715078063 + author: + id: '991271996' + type: admin + name: Ciaran445 Lee + email: admin445@email.com + attachments: [] + redacted: false + total_count: 1 + open: true + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + category: Back-office + is_shared: false + schema: + "$ref": "#/components/schemas/ticket" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 4d480a25-b854-43e9-95ce-71277fb15e40 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/tickets/search": + post: + summary: Search tickets + operationId: searchTickets + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Tickets + description: | + You can search for multiple tickets by the value of their attributes in order to fetch exactly which ones you want. + + To search for tickets, you send a `POST` request to `https://api.intercom.io/tickets/search`. + + This will accept a query object in the body which will define your filters. + {% admonition type="warning" name="Optimizing search queries" %} + Search queries can be complex, so optimizing them can help the performance of your search. + Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize + pagination to limit the number of results returned. The default is `20` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param. + {% /admonition %} + + ### Nesting & Limitations + + You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). + There are some limitations to the amount of multiples there can be: + - There's a limit of max 2 nested filters + - There's a limit of max 15 filters for each AND or OR group + + ### Accepted Fields + + Most keys listed as part of the Ticket model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `"foobar"`). + + | Field | Type | + | :---------------------------------------- | :--------------------------------------------------------------------------------------- | + | id | String | + | created_at | Date (UNIX timestamp) | + | updated_at | Date (UNIX timestamp) | + | title | String | + | description | String | + | category | String | + | ticket_type_id | String | + | contact_ids | String | + | teammate_ids | String | + | admin_assignee_id | String | + | team_assignee_id | String | + | open | Boolean | + | state | String | + | snoozed_until | Date (UNIX timestamp) | + | ticket_attribute.{id} | String or Boolean or Date (UNIX timestamp) or Float or Integer | + + ### Accepted Operators + + {% admonition type="info" name="Searching based on `created_at`" %} + You may use the `<=` or `>=` operators to search by `created_at`. + {% /admonition %} + + The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`"="`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates). + + | Operator | Valid Types | Description | + | :------- | :----------------------------- | :----------------------------------------------------------- | + | = | All | Equals | + | != | All | Doesn't Equal | + | IN | All | In Shortcut for `OR` queries Values most be in Array | + | NIN | All | Not In Shortcut for `OR !` queries Values must be in Array | + | > | Integer Date (UNIX Timestamp) | Greater (or equal) than | + | < | Integer Date (UNIX Timestamp) | Lower (or equal) than | + | ~ | String | Contains | + | !~ | String | Doesn't Contain | + | ^ | String | Starts With | + | $ | String | Ends With | + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: ticket.list + pages: + type: pages + page: 1 + per_page: 150 + total_pages: 1 + total_count: 1 + tickets: + - type: ticket + id: '1720' + ticket_id: '97' + ticket_attributes: + title: attribute_value + description: + ticket_state: submitted + ticket_state_internal_label: Submitted + ticket_state_external_label: Submitted + ticket_type: + type: ticket_type + id: '322' + name: my-ticket-type-23 + description: my ticket type description is awesome. + icon: "\U0001F981" + workspace_id: this_is_an_id653_that_should_be_at_least_ + archived: false + created_at: 1715078065 + updated_at: 1715078065 + is_internal: false + ticket_type_attributes: + type: list + data: + - type: ticket_type_attribute + id: '859' + workspace_id: this_is_an_id653_that_should_be_at_least_ + name: title + description: ola + data_type: string + input_options: + order: 0 + required_to_create: true + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: false + default: false + ticket_type_id: 322 + archived: false + created_at: 1715078065 + updated_at: 1715078065 + - type: ticket_type_attribute + id: '860' + workspace_id: this_is_an_id653_that_should_be_at_least_ + name: description + description: ola + data_type: string + input_options: + order: 0 + required_to_create: true + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: false + default: false + ticket_type_id: 322 + archived: false + created_at: 1715078065 + updated_at: 1715078065 + category: Back-office + contacts: + type: contact.list + contacts: + - type: contact + id: 663a03b1262d16a19645ef08 + external_id: bcca29e2-3d18-4da9-8ce0-fed5924a2514 + admin_assignee_id: '0' + team_assignee_id: '0' + created_at: 1715078065 + updated_at: 1715078066 + ticket_parts: + type: ticket_part.list + ticket_parts: + - type: ticket_part + id: '399' + part_type: ticket_state_updated_by_admin + ticket_state: submitted + previous_ticket_state: submitted + created_at: 1715078066 + updated_at: 1715078066 + author: + id: '991272009' + type: admin + name: Ciaran457 Lee + email: admin457@email.com + attachments: [] + redacted: false + total_count: 1 + open: true + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + category: Back-office + is_shared: false + schema: + "$ref": "#/components/schemas/ticket_list" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/search_request" + examples: + successful: + summary: successful + value: + query: + operator: AND + value: + - field: id + operator: "=" + value: '1720' + - operator: OR + value: + - field: id + operator: "=" + value: '1720' + - field: id + operator: "=" + value: '1720' + "/visitors": + put: + summary: Update a visitor + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Visitors + operationId: updateVisitor + description: | + Sending a PUT request to `/visitors` will result in an update of an existing Visitor. + + **Option 1.** You can update a visitor by passing in the `user_id` of the visitor in the Request body. + + **Option 2.** You can update a visitor by passing in the `id` of the visitor in the Request body. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: visitor + id: 663a03b4262d16a19645ef0b + user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 + anonymous: true + email: '' + phone: + name: Gareth Bale + pseudonym: Azure Balloon + avatar: + type: avatar + image_url: https://static.intercomassets.com/app/pseudonym_avatars_2019/azure-balloon.png + app_id: this_is_an_id657_that_should_be_at_least_ + companies: + type: company.list + companies: [] + location_data: {} + last_request_at: + created_at: 1715078068 + remote_created_at: 1715078068 + signed_up_at: 1715078068 + updated_at: 1715078068 + session_count: 0 + social_profiles: + type: social_profile.list + social_profiles: [] + owner_id: + unsubscribed_from_emails: false + marked_email_as_spam: false + has_hard_bounced: false + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + custom_attributes: {} + referrer: + utm_campaign: + utm_content: + utm_medium: + utm_source: + utm_term: + do_not_track: + schema: + "$ref": "#/components/schemas/visitor" + '404': + description: visitor Not Found + content: + application/json: + examples: + visitor Not Found: + value: + type: error.list + request_id: ef79b7f2-49f9-4db4-8451-310f9011fd2a + errors: + - code: not_found + message: Visitor Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: dd406638-eb7e-4bf7-8de3-6a9983cb5526 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/update_visitor_request" + examples: + successful: + summary: successful + value: + id: 663a03b4262d16a19645ef0b + name: Gareth Bale + visitor_not_found: + summary: visitor Not Found + value: + user_id: fail + name: Christian Fail + get: + summary: Retrieve a visitor with User ID + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: user_id + in: query + description: The user_id of the Visitor you want to retrieve. + required: true + schema: + type: string + tags: + - Visitors + operationId: retrieveVisitorWithUserId + description: You can fetch the details of a single visitor. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: visitor + id: 663a03b5262d16a19645ef11 + user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 + anonymous: true + email: '' + phone: + name: + pseudonym: + avatar: + type: avatar + image_url: + app_id: this_is_an_id663_that_should_be_at_least_ + companies: + type: company.list + companies: [] + location_data: {} + last_request_at: + created_at: 1715078069 + remote_created_at: 1715078069 + signed_up_at: 1715078069 + updated_at: 1715078069 + session_count: 0 + social_profiles: + type: social_profile.list + social_profiles: [] + owner_id: + unsubscribed_from_emails: false + marked_email_as_spam: false + has_hard_bounced: false + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + custom_attributes: {} + referrer: + utm_campaign: + utm_content: + utm_medium: + utm_source: + utm_term: + do_not_track: + schema: + "$ref": "#/components/schemas/visitor" + '404': + description: Visitor not found + content: + application/json: + examples: + Visitor not found: + value: + type: error.list + request_id: 991bc430-9860-4a03-9649-2418e8ca9ee1 + errors: + - code: not_found + message: Visitor Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 8dfc845c-0655-44f8-b60a-74c77b74f4e8 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/visitors/convert": + post: + summary: Convert a visitor + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Visitors + operationId: convertVisitor + description: "You can merge a Visitor to a Contact of role type `lead` or `user`.\n\n> + \U0001F4D8 What happens upon a visitor being converted?\n>\n> If the User + exists, then the Visitor will be merged into it, the Visitor deleted and the + User returned. If the User does not exist, the Visitor will be converted to + a User, with the User identifiers replacing it's Visitor identifiers.\n" + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: contact + id: 663a03b7262d16a19645ef18 + workspace_id: this_is_an_id669_that_should_be_at_least_ + external_id: + role: user + email: foo@bar.com + phone: + name: + avatar: + owner_id: + social_profiles: + type: list + data: [] + has_hard_bounced: false + marked_email_as_spam: false + unsubscribed_from_emails: false + created_at: 1715078071 + updated_at: 1715078071 + signed_up_at: 1715078071 + last_seen_at: + last_replied_at: + last_contacted_at: + last_email_opened_at: + last_email_clicked_at: + language_override: + browser: + browser_version: + browser_language: + os: + location: + type: location + country: + region: + city: + country_code: + continent_code: + android_app_name: + android_app_version: + android_device: + android_os_version: + android_sdk_version: + android_last_seen_at: + ios_app_name: + ios_app_version: + ios_device: + ios_os_version: + ios_sdk_version: + ios_last_seen_at: + custom_attributes: {} + tags: + type: list + data: [] + url: "/contacts/663a03b7262d16a19645ef18/tags" + total_count: 0 + has_more: false + notes: + type: list + data: [] + url: "/contacts/663a03b7262d16a19645ef18/notes" + total_count: 0 + has_more: false + companies: + type: list + data: [] + url: "/contacts/663a03b7262d16a19645ef18/companies" + total_count: 0 + has_more: false + opted_out_subscription_types: + type: list + data: [] + url: "/contacts/663a03b7262d16a19645ef18/subscriptions" + total_count: 0 + has_more: false + opted_in_subscription_types: + type: list + data: [] + url: "/contacts/663a03b7262d16a19645ef18/subscriptions" + total_count: 0 + has_more: false + utm_campaign: + utm_content: + utm_medium: + utm_source: + utm_term: + referrer: + schema: + "$ref": "#/components/schemas/contact" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 5764ad4d-339b-4a85-9989-ff73288921aa + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/convert_visitor_request" + examples: + successful: + summary: successful + value: + visitor: + user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 + user: + email: foo@bar.com + type: user +components: + schemas: + activity_log: + title: Activity Log + type: object + description: Activities performed by admins. + nullable: true + properties: + id: + type: string + description: The id representing the activity. + example: '6' + performed_by: + type: object + description: An object representing the admin who performed the activity. + properties: + type: + type: string + description: String representing the object's type. Always has the value + `admin`. + example: admin + id: + type: string + description: The id representing the admin. + example: '1295' + email: + type: string + description: The email of the admin. + example: john@example.com + ip: + type: string + description: The IP address of the admin. + example: 198.51.100.255 + metadata: + type: object + created_at: + type: integer + format: date-time + description: The time the activity was created. + example: 1671028894 + activity_type: + type: string + enum: + - admin_assignment_limit_change + - admin_away_mode_change + - admin_deletion + - admin_deprovisioned + - admin_impersonation_end + - admin_impersonation_start + - admin_invite_change + - admin_invite_creation + - admin_invite_deletion + - admin_login_failure + - admin_login_success + - admin_logout + - admin_password_reset_request + - admin_password_reset_success + - admin_permission_change + - admin_provisioned + - admin_two_factor_auth_change + - admin_unauthorized_sign_in_method + - app_admin_join + - app_authentication_method_change + - app_data_deletion + - app_data_export + - app_google_sso_domain_change + - app_identity_verification_change + - app_name_change + - app_outbound_address_change + - app_package_installation + - app_package_token_regeneration + - app_package_uninstallation + - app_team_creation + - app_team_deletion + - app_team_membership_modification + - app_timezone_change + - app_webhook_creation + - app_webhook_deletion + - articles_in_messenger_enabled_change + - bulk_delete + - bulk_export + - campaign_deletion + - campaign_state_change + - conversation_part_deletion + - conversation_topic_change + - conversation_topic_creation + - conversation_topic_deletion + - help_center_settings_change + - inbound_conversations_change + - inbox_access_change + - message_deletion + - message_state_change + - messenger_look_and_feel_change + - messenger_search_required_change + - messenger_spaces_change + - office_hours_change + - role_change + - role_creation + - role_deletion + - ruleset_activation_title_preview + - ruleset_creation + - ruleset_deletion + - search_browse_enabled_change + - search_browse_required_change + - seat_change + - seat_revoke + - security_settings_change + - temporary_expectation_change + - upfront_email_collection_change + - welcome_message_change + example: app_name_change + activity_description: + type: string + description: A sentence or two describing the activity. + example: Admin updated the app's name to "My App". + activity_log_list: + title: Paginated Response + type: object + description: A paginated list of activity logs. + properties: + type: + type: string + description: String representing the object's type. Always has the value + `activity_log.list`. + example: activity_log.list + pages: + "$ref": "#/components/schemas/cursor_pages" + activity_logs: + type: array + description: An array of activity logs + items: + "$ref": "#/components/schemas/activity_log" + addressable_list: + title: Addressable List + type: object + nullable: false + description: A list used to access other resources from a parent model. + properties: + type: + type: string + format: uri + description: The addressable object type + example: note + id: + type: string + description: The id of the addressable object + example: '123' + url: + type: string + format: uri + description: Url to get more company resources for this contact + example: "/contacts/5ba682d23d7cf92bef87bfd4/notes" + admin: + title: Admin + type: object + x-tags: + - Admins + description: Admins are teammate accounts that have access to a workspace. + nullable: true + properties: + type: + type: string + description: String representing the object's type. Always has the value + `admin`. + example: admin + id: + type: string + description: The id representing the admin. + example: '1295' + name: + type: string + description: The name of the admin. + example: Hoban Washburne + email: + type: string + description: The email of the admin. + example: wash@serenity.io + job_title: + type: string + description: The job title of the admin. + example: Philosopher + away_mode_enabled: + type: boolean + description: Identifies if this admin is currently set in away mode. + example: false + away_mode_reassign: + type: boolean + description: Identifies if this admin is set to automatically reassign new + conversations to the apps default inbox. + example: false + has_inbox_seat: + type: boolean + description: Identifies if this admin has a paid inbox seat to restrict/allow + features that require them. + example: true + team_ids: + type: array + description: This object represents the avatar associated with the admin. + example: + - 814865 + items: + type: integer + avatar: + type: string + format: uri + nullable: true + description: Image for the associated team or teammate + example: https://picsum.photos/200/300 + team_priority_level: + "$ref": "#/components/schemas/team_priority_level" + admin_list: + title: Admins + type: object + description: A list of admins associated with a given workspace. + properties: + type: + type: string + description: String representing the object's type. Always has the value + `admin.list`. + example: admin.list + admins: + type: array + description: A list of admins associated with a given workspace. + items: + "$ref": "#/components/schemas/admin" + admin_priority_level: + title: Admin Priority Level + type: object + nullable: true + description: Admin priority levels for the team + properties: + primary_admin_ids: + type: array + description: The primary admin ids for the team + nullable: true + example: + - 493881 + items: + type: integer + secondary_admin_ids: + type: array + description: The secondary admin ids for the team + nullable: true + example: + - 814865 + items: + type: integer + admin_reply_conversation_request: + title: Admin Reply + type: object + description: Payload of the request to reply on behalf of an admin + properties: + message_type: + type: string + enum: + - comment + - note + type: + type: string + enum: + - admin + example: admin + body: + type: string + description: The text body of the reply. Notes accept some HTML formatting. + Must be present for comment and note message types. + example: Hello there! + admin_id: + type: string + description: The id of the admin who is authoring the comment. + example: '3156780' + created_at: + type: integer + description: The time the reply was created. If not provided, the current + time will be used. + example: 1590000000 + attachment_urls: + type: array + description: A list of image URLs that will be added as attachments. You + can include up to 10 URLs. + items: + type: string + format: uri + maxItems: 10 + attachment_files: + type: array + description: A list of files that will be added as attachments. You can + include up to 10 files + items: + "$ref": "#/components/schemas/conversation_attachment_files" + maxItems: 10 + required: + - message_type + - type + - admin_id + admin_reply_ticket_request: + title: Admin Reply on ticket + type: object + description: Payload of the request to reply on behalf of an admin + properties: + message_type: + type: string + enum: + - comment + - note + - quick_reply + example: comment + type: + type: string + enum: + - admin + example: admin + body: + type: string + description: The text body of the reply. Notes accept some HTML formatting. + Must be present for comment and note message types. + example: Hello there! + admin_id: + type: string + description: The id of the admin who is authoring the comment. + example: '3156780' + created_at: + type: integer + description: The time the reply was created. If not provided, the current + time will be used. + example: 1590000000 + reply_options: + title: Quick Reply Options + type: array + description: The quick reply options to display. Must be present for quick_reply + message types. + items: + title: Quick Reply Option + type: object + properties: + text: + type: string + description: The text to display in this quick reply option. + uuid: + type: string + format: uuid + description: A unique identifier for this quick reply option. This + value will be available within the metadata of the comment ticket + part that is created when a user clicks on this reply option. + required: + - text + - uuid + attachment_urls: + type: array + description: A list of image URLs that will be added as attachments. You + can include up to 10 URLs. + items: + type: string + format: uri + maxItems: 10 + required: + - message_type + - type + - admin_id + admin_with_app: + title: Admin + type: object + description: Admins are the teammate accounts that have access to a workspace + nullable: true + properties: + type: + type: string + description: String representing the object's type. Always has the value + `admin`. + example: admin + id: + type: string + description: The id representing the admin. + example: '1295' + name: + type: string + description: The name of the admin. + example: Hoban Washburne + email: + type: string + description: The email of the admin. + example: wash@serenity.io + job_title: + type: string + description: The job title of the admin. + example: Philosopher + away_mode_enabled: + type: boolean + description: Identifies if this admin is currently set in away mode. + example: false + away_mode_reassign: + type: boolean + description: Identifies if this admin is set to automatically reassign new + conversations to the apps default inbox. + example: false + has_inbox_seat: + type: boolean + description: Identifies if this admin has a paid inbox seat to restrict/allow + features that require them. + example: true + team_ids: + type: array + description: This is a list of ids of the teams that this admin is part + of. + example: + - 814865 + items: + type: integer + avatar: + type: object + description: This object represents the avatar associated with the admin. + properties: + type: + type: string + description: This is a string that identifies the type of the object. + It will always have the value `avatar`. + default: avatar + example: avatar + image_url: + type: string + format: uri + nullable: true + description: This object represents the avatar associated with the admin. + example: https://example.com/avatar.png + email_verified: + type: boolean + description: Identifies if this admin's email is verified. + nullable: true + example: true + app: + "$ref": "#/components/schemas/app" + nullable: true + description: App that the admin belongs to. + ai_agent: + title: AI Agent + type: object + x-tags: + - Ai Agent + description: Data related to AI Agent involvement in the conversation. + properties: + source_type: + type: string + description: The type of the source that triggered AI Agent involvement + in the conversation. + enum: + - essentials_plan_setup + - profile + - workflow + - workflow_preview + - fin_preview + example: workflow + source_title: + type: string + description: The title of the source that triggered AI Agent involvement + in the conversation. If this is `essentials_plan_setup` then it will return + null. + example: My AI Workflow + nullable: true + last_answer_type: + type: string + description: The type of the last answer delviered by AI Agent. If no answer + was delivered then this will return null + enum: + - + - ai_answer + - custom_answer + example: ai_answer + resolution_state: + type: string + description: The resolution state of AI Agent. If no AI or custom answer + has been delivered then this will return `abandoned`. + enum: + - assumed_resolution + - confirmed_resolution + - routed_to_team + - abandoned + example: assumed_resolution + rating: + type: integer + description: The customer satisfaction rating given to AI Agent, from 1-5. + example: 4 + rating_remark: + type: string + description: The customer satisfaction rating remark given to AI Agent. + example: Very helpful! + content_sources: + "$ref": "#/components/schemas/content_sources_list" + app: + title: App + type: object + description: App is a workspace on Intercom + nullable: true + properties: + type: + type: string + description: '' + default: app + example: app + id_code: + type: string + description: The id of the app. + example: xyz789 + name: + type: string + description: The name of the app. + example: ACME + region: + type: string + description: The Intercom region the app is located in. + example: US + timezone: + type: string + description: The timezone of the region where the app is located. + example: America/Los_Angeles + created_at: + type: integer + description: When the app was created. + example: 1671465577 + identity_verification: + type: boolean + description: Whether or not the app uses identity verification. + example: false + article: + title: Article + type: object + x-tags: + - Articles + description: The Articles API is a central place to gather all information and + take actions on your articles. Articles can live within collections and sections, + or alternatively they can stand alone. + properties: + statistics: + nullable: true + "$ref": "#/components/schemas/article_statistics" + allOf: + - "$ref": "#/components/schemas/article_list_item" + article_content: + title: Article Content + type: object + description: The Content of an Article. + nullable: true + properties: + type: + type: string + description: The type of object - `article_content` . + enum: + - + - article_content + example: article_content + nullable: true + title: + type: string + description: The title of the article. + example: How to create a new article + description: + type: string + description: The description of the article. + example: This article will show you how to create a new article. + body: + type: string + description: The body of the article. + example: This is the body of the article. + author_id: + type: integer + description: The ID of the author of the article. + example: '5017691' + state: + type: string + description: Whether the article is `published` or is a `draft` . + enum: + - published + - draft + example: draft + created_at: + type: integer + format: date-time + description: The time when the article was created (seconds). + example: 1663597223 + updated_at: + type: integer + format: date-time + description: The time when the article was last updated (seconds). + example: 1663597260 + url: + type: string + description: The URL of the article. + example: http://intercom.test/help/en/articles/3-default-language + article_list: + title: Articles + type: object + description: This will return a list of articles for the App. + properties: + type: + type: string + description: The type of the object - `list`. + enum: + - list + example: list + pages: + "$ref": "#/components/schemas/cursor_pages" + total_count: + type: integer + description: A count of the total number of articles. + example: 1 + data: + type: array + description: An array of Article objects + items: + "$ref": "#/components/schemas/article_list_item" + article_list_item: + title: Articles + type: object + x-tags: + - Articles + description: The data returned about your articles when you list them. + properties: + type: + type: string + description: The type of object - `article`. + enum: + - article + default: article + example: article + id: + type: string + description: The unique identifier for the article which is given by Intercom. + example: '6871119' + workspace_id: + type: string + description: The id of the workspace which the article belongs to. + example: hfi1bx4l + title: + type: string + description: The title of the article. For multilingual articles, this will + be the title of the default language's content. + example: Default language title + description: + type: string + nullable: true + description: The description of the article. For multilingual articles, + this will be the description of the default language's content. + example: Default language description + body: + type: string + nullable: true + description: The body of the article in HTML. For multilingual articles, + this will be the body of the default language's content. + example: Default language body in html + author_id: + type: integer + description: The id of the author of the article. For multilingual articles, + this will be the id of the author of the default language's content. Must + be a teammate on the help center's workspace. + example: '5017691' + state: + type: string + description: Whether the article is `published` or is a `draft`. For multilingual + articles, this will be the state of the default language's content. + enum: + - published + - draft + default: draft + example: published + created_at: + type: integer + format: date-time + description: The time when the article was created. For multilingual articles, + this will be the timestamp of creation of the default language's content + in seconds. + example: 1672928359 + updated_at: + type: integer + format: date-time + description: The time when the article was last updated. For multilingual + articles, this will be the timestamp of last update of the default language's + content in seconds. + example: 1672928610 + url: + type: string + nullable: true + description: The URL of the article. For multilingual articles, this will + be the URL of the default language's content. + example: http://intercom.test/help/en/articles/3-default-language + parent_id: + type: integer + nullable: true + description: The id of the article's parent collection or section. An article + without this field stands alone. + example: '125685' + parent_ids: + type: array + description: The ids of the article's parent collections or sections. An + article without this field stands alone. + items: + type: integer + example: + - 18 + - 19 + parent_type: + type: string + nullable: true + description: The type of parent, which can either be a `collection` or `section`. + example: collection + default_locale: + type: string + description: The default locale of the help center. This field is only returned + for multilingual help centers. + example: en + translated_content: + nullable: true + "$ref": "#/components/schemas/article_translated_content" + article_search_highlights: + title: Article Search Highlights + type: object + x-tags: + - Articles + description: The highlighted results of an Article search. In the examples provided + my search query is always "my query". + properties: + article_id: + type: string + description: The ID of the corresponding article. + example: '123' + highlighted_title: + type: array + description: An Article title highlighted. + items: + type: object + description: A highlighted article title. + properties: + type: + type: string + description: The type of text - `highlight` or `plain`. + enum: + - highlight + - plain + example: 'The highlight is ' + text: + type: string + description: The text of the title. + example: my query + highlighted_summary: + type: array + description: An Article description and body text highlighted. + items: + type: array + description: An array containing the highlighted summary text split into + chunks of plain and highlighted text. + items: + type: object + description: An instance of highlighted summary text. + properties: + type: + type: string + description: The type of text - `highlight` or `plain`. + enum: + - highlight + - plain + example: 'How to highlight ' + text: + type: string + description: The text of the title. + example: my query + article_search_response: + title: Article Search Response + type: object + x-tags: + - Articles + description: The results of an Article search + properties: + type: + type: string + description: The type of the object - `list`. + enum: + - list + example: list + total_count: + type: integer + description: The total number of Articles matching the search query + example: 5 + data: + type: object + description: An object containing the results of the search. + properties: + articles: + type: array + description: An array of Article objects + items: + "$ref": "#/components/schemas/article" + highlights: + type: array + description: A corresponding array of highlighted Article content + items: + "$ref": "#/components/schemas/article_search_highlights" + pages: + "$ref": "#/components/schemas/cursor_pages" + article_statistics: + title: Article Statistics + type: object + description: The statistics of an article. + nullable: true + properties: + type: + type: string + description: The type of object - `article_statistics`. + enum: + - article_statistics + default: article_statistics + example: article_statistics + views: + type: integer + description: The number of total views the article has received. + example: 10 + conversions: + type: integer + description: The number of conversations started from the article. + example: 0 + reactions: + type: integer + description: The number of total reactions the article has received. + example: 10 + happy_reaction_percentage: + type: number + format: float + description: The percentage of happy reactions the article has received + against other types of reaction. + example: 40.0 + neutral_reaction_percentage: + type: number + format: float + description: The percentage of neutral reactions the article has received + against other types of reaction. + example: 40.0 + sad_reaction_percentage: + type: number + format: float + description: The percentage of sad reactions the article has received against + other types of reaction. + example: 20.0 + article_translated_content: + title: Article Translated Content + type: object + description: The Translated Content of an Article. The keys are the locale codes + and the values are the translated content of the article. + nullable: true + properties: + type: + type: string + description: The type of object - article_translated_content. + enum: + - + - article_translated_content + example: article_translated_content + nullable: true + ar: + description: The content of the article in Arabic + "$ref": "#/components/schemas/article_content" + bg: + description: The content of the article in Bulgarian + "$ref": "#/components/schemas/article_content" + bs: + description: The content of the article in Bosnian + "$ref": "#/components/schemas/article_content" + ca: + description: The content of the article in Catalan + "$ref": "#/components/schemas/article_content" + cs: + description: The content of the article in Czech + "$ref": "#/components/schemas/article_content" + da: + description: The content of the article in Danish + "$ref": "#/components/schemas/article_content" + de: + description: The content of the article in German + "$ref": "#/components/schemas/article_content" + el: + description: The content of the article in Greek + "$ref": "#/components/schemas/article_content" + en: + description: The content of the article in English + "$ref": "#/components/schemas/article_content" + es: + description: The content of the article in Spanish + "$ref": "#/components/schemas/article_content" + et: + description: The content of the article in Estonian + "$ref": "#/components/schemas/article_content" + fi: + description: The content of the article in Finnish + "$ref": "#/components/schemas/article_content" + fr: + description: The content of the article in French + "$ref": "#/components/schemas/article_content" + he: + description: The content of the article in Hebrew + "$ref": "#/components/schemas/article_content" + hr: + description: The content of the article in Croatian + "$ref": "#/components/schemas/article_content" + hu: + description: The content of the article in Hungarian + "$ref": "#/components/schemas/article_content" + id: + description: The content of the article in Indonesian + "$ref": "#/components/schemas/article_content" + it: + description: The content of the article in Italian + "$ref": "#/components/schemas/article_content" + ja: + description: The content of the article in Japanese + "$ref": "#/components/schemas/article_content" + ko: + description: The content of the article in Korean + "$ref": "#/components/schemas/article_content" + lt: + description: The content of the article in Lithuanian + "$ref": "#/components/schemas/article_content" + lv: + description: The content of the article in Latvian + "$ref": "#/components/schemas/article_content" + mn: + description: The content of the article in Mongolian + "$ref": "#/components/schemas/article_content" + nb: + description: The content of the article in Norwegian + "$ref": "#/components/schemas/article_content" + nl: + description: The content of the article in Dutch + "$ref": "#/components/schemas/article_content" + pl: + description: The content of the article in Polish + "$ref": "#/components/schemas/article_content" + pt: + description: The content of the article in Portuguese (Portugal) + "$ref": "#/components/schemas/article_content" + ro: + description: The content of the article in Romanian + "$ref": "#/components/schemas/article_content" + ru: + description: The content of the article in Russian + "$ref": "#/components/schemas/article_content" + sl: + description: The content of the article in Slovenian + "$ref": "#/components/schemas/article_content" + sr: + description: The content of the article in Serbian + "$ref": "#/components/schemas/article_content" + sv: + description: The content of the article in Swedish + "$ref": "#/components/schemas/article_content" + tr: + description: The content of the article in Turkish + "$ref": "#/components/schemas/article_content" + vi: + description: The content of the article in Vietnamese + "$ref": "#/components/schemas/article_content" + pt-BR: + description: The content of the article in Portuguese (Brazil) + "$ref": "#/components/schemas/article_content" + zh-CN: + description: The content of the article in Chinese (China) + "$ref": "#/components/schemas/article_content" + zh-TW: + description: The content of the article in Chinese (Taiwan) + "$ref": "#/components/schemas/article_content" + assign_conversation_request: + title: Assign Conversation Request + type: object + description: Payload of the request to assign a conversation + properties: + message_type: + type: string + enum: + - assignment + example: assignment + type: + type: string + enum: + - admin + - team + example: admin + admin_id: + type: string + description: The id of the admin who is performing the action. + example: '12345' + assignee_id: + type: string + description: The `id` of the `admin` or `team` which will be assigned the + conversation. A conversation can be assigned both an admin and a team.\nSet + `0` if you want this assign to no admin or team (ie. Unassigned). + example: '4324241' + body: + type: string + description: Optionally you can send a response in the conversation when + it is assigned. + example: Let me pass you over to one of my colleagues. + required: + - message_type + - type + - admin_id + - assignee_id + attach_contact_to_conversation_request: + title: Assign Conversation Request + type: object + description: Payload of the request to assign a conversation + properties: + admin_id: + type: string + description: The `id` of the admin who is adding the new participant. + example: '12345' + customer: + type: object + oneOf: + - title: Intercom User ID + properties: + intercom_user_id: + type: string + description: The identifier for the contact as given by Intercom. + example: 6329bd9ffe4e2e91dac76188 + customer: + "$ref": "#/components/schemas/customer_request" + required: + - intercom_user_id + - title: User ID + properties: + user_id: + type: string + description: The external_id you have defined for the contact who + is being added as a participant. + example: 6329bd9ffe4e2e91dac76188 + customer: + "$ref": "#/components/schemas/customer_request" + required: + - user_id + - title: Email + properties: + email: + type: string + description: The email you have defined for the contact who is being + added as a participant. + example: winstonsmith@truth.org + customer: + "$ref": "#/components/schemas/customer_request" + required: + - email + close_conversation_request: + title: Close Conversation Request + type: object + description: Payload of the request to close a conversation + properties: + message_type: + type: string + enum: + - close + example: close + type: + type: string + enum: + - admin + example: admin + admin_id: + type: string + description: The id of the admin who is performing the action. + example: '12345' + body: + type: string + description: Optionally you can leave a message in the conversation to provide + additional context to the user and other teammates. + example: " This conversation is now closed!" + required: + - message_type + - type + - admin_id + collection: + title: Collection + type: object + x-tags: + - Help Center + description: Collections are top level containers for Articles within the Help + Center. + properties: + id: + type: string + description: The unique identifier for the collection which is given by + Intercom. + example: '6871119' + workspace_id: + type: string + description: The id of the workspace which the collection belongs to. + example: hfi1bx4l + name: + type: string + description: The name of the collection. For multilingual collections, this + will be the name of the default language's content. + example: Default language name + description: + type: string + nullable: true + description: The description of the collection. For multilingual help centers, + this will be the description of the collection for the default language. + example: Default language description + created_at: + type: integer + format: date-time + description: The time when the article was created (seconds). For multilingual + articles, this will be the timestamp of creation of the default language's + content. + example: 1672928359 + updated_at: + type: integer + format: date-time + description: The time when the article was last updated (seconds). For multilingual + articles, this will be the timestamp of last update of the default language's + content. + example: 1672928610 + url: + type: string + nullable: true + description: The URL of the collection. For multilingual help centers, this + will be the URL of the collection for the default language. + example: http://intercom.test/help/collection/name + icon: + type: string + nullable: true + description: The icon of the collection. + example: book-bookmark + order: + type: integer + description: The order of the section in relation to others sections within + a collection. Values go from `0` upwards. `0` is the default if there's + no order. + example: '1' + default_locale: + type: string + description: The default locale of the help center. This field is only returned + for multilingual help centers. + example: en + translated_content: + nullable: true + "$ref": "#/components/schemas/group_translated_content" + parent_id: + type: string + nullable: true + description: The id of the parent collection. If `null` then it is the first + level collection. + example: '6871118' + help_center_id: + type: integer + nullable: true + description: The id of the help center the collection is in. + example: '123' + collection_list: + title: Collections + type: object + description: This will return a list of Collections for the App. + properties: + type: + type: string + description: The type of the object - `list`. + enum: + - list + example: list + pages: + "$ref": "#/components/schemas/cursor_pages" + total_count: + type: integer + description: A count of the total number of collections. + example: 1 + data: + type: array + description: An array of collection objects + items: + "$ref": "#/components/schemas/collection" + company: + title: Company + type: object + x-tags: + - Companies + description: Companies allow you to represent organizations using your product. + Each company will have its own description and be associated with contacts. + You can fetch, create, update and list companies. + properties: + type: + type: string + description: Value is `company` + enum: + - company + example: company + id: + type: string + description: The Intercom defined id representing the company. + example: 531ee472cce572a6ec000006 + name: + type: string + description: The name of the company. + example: Blue Sun + app_id: + type: string + description: The Intercom defined code of the workspace the company is associated + to. + example: ecahpwf5 + plan: + type: object + properties: + type: + type: string + description: Value is always "plan" + example: plan + id: + type: string + description: The id of the plan + example: '269315' + name: + type: string + description: The name of the plan + example: Pro + company_id: + type: string + description: The company id you have defined for the company. + example: '6' + remote_created_at: + type: integer + description: The time the company was created by you. + example: 1663597223 + created_at: + type: integer + description: The time the company was added in Intercom. + example: 1663597223 + updated_at: + type: integer + description: The last time the company was updated. + example: 1663597223 + last_request_at: + type: integer + description: The time the company last recorded making a request. + example: 1663597223 + size: + type: integer + description: The number of employees in the company. + example: 100 + website: + type: string + description: The URL for the company website. + example: https://www.intercom.com + industry: + type: string + description: The industry that the company operates in. + example: Software + monthly_spend: + type: integer + description: How much revenue the company generates for your business. + example: 100 + session_count: + type: integer + description: How many sessions the company has recorded. + example: 100 + user_count: + type: integer + description: The number of users in the company. + example: 100 + custom_attributes: + type: object + description: The custom attributes you have set on the company. + additionalProperties: + type: string + example: + paid_subscriber: true + monthly_spend: 155.5 + team_mates: 9 + tags: + type: object + description: The list of tags associated with the company + properties: + type: + type: string + description: The type of the object + enum: + - tag.list + tags: + type: array + items: + items: + "$ref": "#/components/schemas/tag" + segments: + type: object + description: The list of segments associated with the company + properties: + type: + type: string + description: The type of the object + enum: + - segment.list + segments: + type: array + items: + "$ref": "#/components/schemas/segment" + company_attached_contacts: + title: Company Attached Contacts + type: object + description: A list of Contact Objects + properties: + type: + type: string + description: The type of object - `list` + enum: + - list + example: list + data: + type: array + description: An array containing Contact Objects + items: + "$ref": "#/components/schemas/contact" + total_count: + type: integer + description: The total number of contacts + example: 100 + pages: + "$ref": "#/components/schemas/cursor_pages" + company_attached_segments: + title: Company Attached Segments + type: object + description: A list of Segment Objects + properties: + type: + type: string + description: The type of object - `list` + enum: + - list + example: list + data: + type: array + description: An array containing Segment Objects + items: + "$ref": "#/components/schemas/segment" + company_list: + title: Companies + type: object + description: This will return a list of companies for the App. + properties: + type: + type: string + description: The type of object - `list`. + enum: + - list + example: list + pages: + "$ref": "#/components/schemas/cursor_pages" + total_count: + type: integer + description: The total number of companies. + example: 100 + data: + type: array + description: An array containing Company Objects. + items: + "$ref": "#/components/schemas/company" + company_scroll: + title: Company Scroll + type: object + description: Companies allow you to represent organizations using your product. + Each company will have its own description and be associated with contacts. + You can fetch, create, update and list companies. + nullable: true + properties: + type: + type: string + description: The type of object - `list` + enum: + - list + example: list + data: + type: array + items: + "$ref": "#/components/schemas/company" + pages: + "$ref": "#/components/schemas/cursor_pages" + total_count: + type: integer + description: The total number of companies + nullable: true + example: 100 + scroll_param: + type: string + description: The scroll parameter to use in the next request to fetch the + next page of results. + example: 25b649f7-4d33-4ef6-88f5-60e5b8244309 + contact: + title: Contact + type: object + x-tags: + - Contacts + description: Contact are the objects that represent your leads and users in + Intercom. + properties: + type: + type: string + description: The type of object. + example: contact + id: + type: string + description: The unique identifier for the contact which is given by Intercom. + example: 5ba682d23d7cf92bef87bfd4 + external_id: + type: string + nullable: true + description: The unique identifier for the contact which is provided by + the Client. + example: f3b87a2e09d514c6c2e79b9a + workspace_id: + type: string + description: The id of the workspace which the contact belongs to. + example: ecahpwf5 + role: + type: string + description: The role of the contact. + example: user + email: + type: string + description: The contact's email. + example: joe@example.com + email_domain: + type: string + description: The contact's email domain. + example: example.com + phone: + type: string + nullable: true + description: The contacts phone. + example: "+1123456789" + formatted_phone: + type: string + nullable: true + description: The contacts phone number normalized to the E164 format + example: "+1123456789" + name: + type: string + nullable: true + description: The contacts name. + example: John Doe + owner_id: + type: integer + nullable: true + description: The id of an admin that has been assigned account ownership + of the contact. + example: 123 + has_hard_bounced: + type: boolean + description: Whether the contact has had an email sent to them hard bounce. + example: true + marked_email_as_spam: + type: boolean + description: Whether the contact has marked an email sent to them as spam. + example: true + unsubscribed_from_emails: + type: boolean + description: Whether the contact is unsubscribed from emails. + example: true + created_at: + type: integer + format: date-time + description: "(UNIX timestamp) The time when the contact was created." + example: 1571672154 + updated_at: + type: integer + format: date-time + description: "(UNIX timestamp) The time when the contact was last updated." + example: 1571672154 + signed_up_at: + type: integer + format: date-time + nullable: true + description: "(UNIX timestamp) The time specified for when a contact signed + up." + example: 1571672154 + last_seen_at: + type: integer + format: date-time + nullable: true + description: "(UNIX timestamp) The time when the contact was last seen (either + where the Intercom Messenger was installed or when specified manually)." + example: 1571672154 + last_replied_at: + type: integer + format: date-time + nullable: true + description: "(UNIX timestamp) The time when the contact last messaged in." + example: 1571672154 + last_contacted_at: + type: integer + format: date-time + nullable: true + description: "(UNIX timestamp) The time when the contact was last messaged." + example: 1571672154 + last_email_opened_at: + type: integer + format: date-time + nullable: true + description: "(UNIX timestamp) The time when the contact last opened an + email." + example: 1571672154 + last_email_clicked_at: + type: integer + format: date-time + nullable: true + description: "(UNIX timestamp) The time when the contact last clicked a + link in an email." + example: 1571672154 + language_override: + type: string + nullable: true + description: A preferred language setting for the contact, used by the Intercom + Messenger even if their browser settings change. + example: en + browser: + type: string + nullable: true + description: The name of the browser which the contact is using. + example: Chrome + browser_version: + type: string + nullable: true + description: The version of the browser which the contact is using. + example: 80.0.3987.132 + browser_language: + type: string + nullable: true + description: The language set by the browser which the contact is using. + example: en-US + os: + type: string + nullable: true + description: The operating system which the contact is using. + example: Mac OS X + android_app_name: + type: string + nullable: true + description: The name of the Android app which the contact is using. + example: Intercom + android_app_version: + type: string + nullable: true + description: The version of the Android app which the contact is using. + example: 5.0.0 + android_device: + type: string + nullable: true + description: The Android device which the contact is using. + example: Pixel 3 + android_os_version: + type: string + nullable: true + description: The version of the Android OS which the contact is using. + example: '10' + android_sdk_version: + type: string + nullable: true + description: The version of the Android SDK which the contact is using. + example: '28' + android_last_seen_at: + type: integer + nullable: true + format: date-time + description: "(UNIX timestamp) The time when the contact was last seen on + an Android device." + example: 1571672154 + ios_app_name: + type: string + nullable: true + description: The name of the iOS app which the contact is using. + example: Intercom + ios_app_version: + type: string + nullable: true + description: The version of the iOS app which the contact is using. + example: 5.0.0 + ios_device: + type: string + nullable: true + description: The iOS device which the contact is using. + example: iPhone 11 + ios_os_version: + type: string + nullable: true + description: The version of iOS which the contact is using. + example: 13.3.1 + ios_sdk_version: + type: string + nullable: true + description: The version of the iOS SDK which the contact is using. + example: 13.3.1 + ios_last_seen_at: + type: integer + nullable: true + format: date-time + description: "(UNIX timestamp) The last time the contact used the iOS app." + example: 1571672154 + custom_attributes: + type: object + description: The custom attributes which are set for the contact. + avatar: + type: object + nullable: true + properties: + type: + type: string + description: The type of object + example: avatar + image_url: + type: string + format: uri + nullable: true + description: An image URL containing the avatar of a contact. + example: https://example.org/128Wash.jpg + tags: + "$ref": "#/components/schemas/contact_tags" + notes: + "$ref": "#/components/schemas/contact_notes" + companies: + "$ref": "#/components/schemas/contact_companies" + location: + "$ref": "#/components/schemas/contact_location" + social_profiles: + "$ref": "#/components/schemas/contact_social_profiles" + contact_archived: + title: Contact Archived + type: object + description: archived contact object + properties: + type: + type: string + description: always contact + enum: + - contact + example: contact + id: + type: string + description: The unique identifier for the contact which is given by Intercom. + example: 5ba682d23d7cf92bef87bfd4 + external_id: + type: string + nullable: true + description: The unique identifier for the contact which is provided by + the Client. + example: f3b87a2e09d514c6c2e79b9a + archived: + type: boolean + description: Whether the contact is archived or not. + example: true + contact_attached_companies: + title: Contact Attached Companies + type: object + description: A list of Company Objects + properties: + type: + type: string + description: The type of object + enum: + - list + example: list + companies: + type: array + description: An array containing Company Objects + items: + "$ref": "#/components/schemas/company" + total_count: + type: integer + description: The total number of companies associated to this contact + example: 100 + pages: + "$ref": "#/components/schemas/pages_link" + contact_companies: + title: Contact companies + type: object + nullable: false + description: An object containing companies meta data about the companies that + a contact has. Up to 10 will be displayed here. Use the url to get more. + properties: + url: + type: string + format: uri + description: Url to get more company resources for this contact + example: "/contacts/5ba682d23d7cf92bef87bfd4/companies" + total_count: + type: integer + description: Int representing the total number of companyies attached to + this contact + example: 100 + has_more: + type: boolean + description: Whether there's more Addressable Objects to be viewed. If true, + use the url to view all + example: true + contact_deleted: + title: Contact Deleted + type: object + description: deleted contact object + properties: + type: + type: string + description: always contact + enum: + - contact + example: contact + id: + type: string + description: The unique identifier for the contact which is given by Intercom. + example: 5ba682d23d7cf92bef87bfd4 + external_id: + type: string + nullable: true + description: The unique identifier for the contact which is provided by + the Client. + example: f3b87a2e09d514c6c2e79b9a + deleted: + type: boolean + description: Whether the contact is deleted or not. + example: true + contact_list: + title: Contact List + type: object + description: Contacts are your users in Intercom. + properties: + type: + type: string + description: Always list + enum: + - list + example: list + data: + type: array + description: The list of contact objects + items: + "$ref": "#/components/schemas/contact" + total_count: + type: integer + description: A count of the total number of objects. + example: 100 + pages: + "$ref": "#/components/schemas/cursor_pages" + contact_location: + title: Contact Location + type: object + nullable: false + description: An object containing location meta data about a Intercom contact. + properties: + type: + type: string + nullable: true + description: Always location + example: location + country: + type: string + nullable: true + description: The country that the contact is located in + example: Ireland + region: + type: string + nullable: true + description: The overal region that the contact is located in + example: Dublin + city: + type: string + nullable: true + description: The city that the contact is located in + example: Dublin + contact_notes: + title: Contact notes + type: object + nullable: false + description: An object containing notes meta data about the notes that a contact + has. Up to 10 will be displayed here. Use the url to get more. + properties: + data: + type: array + description: This object represents the notes attached to a contact. + items: + "$ref": "#/components/schemas/addressable_list" + url: + type: string + format: uri + description: Url to get more company resources for this contact + example: "/contacts/5ba682d23d7cf92bef87bfd4/notes" + total_count: + type: integer + description: Int representing the total number of companyies attached to + this contact + example: 100 + has_more: + type: boolean + description: Whether there's more Addressable Objects to be viewed. If true, + use the url to view all + example: true + contact_reference: + title: Contact Reference + type: object + description: reference to contact object + properties: + type: + type: string + description: always contact + enum: + - contact + example: contact + id: + type: string + description: The unique identifier for the contact which is given by Intercom. + example: 5ba682d23d7cf92bef87bfd4 + external_id: + type: string + nullable: true + description: The unique identifier for the contact which is provided by + the Client. + example: f3b87a2e09d514c6c2e79b9a + contact_reply_base_request: + title: Contact Reply Base Object + type: object + properties: + message_type: + type: string + enum: + - comment + type: + type: string + enum: + - user + body: + type: string + description: The text body of the comment. + created_at: + type: integer + description: The time the reply was created. If not provided, the current + time will be used. + example: 1590000000 + attachment_urls: + title: Attachment URLs + type: array + description: A list of image URLs that will be added as attachments. You + can include up to 10 URLs. + items: + type: string + format: uri + maxItems: 10 + required: + - message_type + - type + - body + contact_reply_conversation_request: + title: Contact Reply + oneOf: + - "$ref": "#/components/schemas/contact_reply_intercom_user_id_request" + - "$ref": "#/components/schemas/contact_reply_email_request" + - "$ref": "#/components/schemas/contact_reply_user_id_request" + contact_reply_email_request: + title: Email + type: object + description: Payload of the request to reply on behalf of a contact using their + `email` + properties: + email: + type: string + description: The email you have defined for the user. + attachment_files: + type: array + description: A list of files that will be added as attachments. + items: + "$ref": "#/components/schemas/conversation_attachment_files" + allOf: + - "$ref": "#/components/schemas/contact_reply_base_request" + required: + - email + contact_reply_intercom_user_id_request: + title: Intercom User ID + type: object + description: Payload of the request to reply on behalf of a contact using their + `intercom_user_id` + allOf: + - "$ref": "#/components/schemas/contact_reply_base_request" + properties: + intercom_user_id: + type: string + description: The identifier for the contact as given by Intercom. + attachment_files: + type: array + description: A list of files that will be added as attachments. + items: + "$ref": "#/components/schemas/conversation_attachment_files" + required: + - intercom_user_id + contact_reply_ticket_email_request: + title: Email + type: object + description: Payload of the request to reply on behalf of a contact using their + `email` + properties: + email: + type: string + description: The email you have defined for the user. + allOf: + - "$ref": "#/components/schemas/contact_reply_base_request" + required: + - email + contact_reply_ticket_intercom_user_id_request: + title: Intercom User ID + type: object + description: Payload of the request to reply on behalf of a contact using their + `intercom_user_id` + allOf: + - "$ref": "#/components/schemas/contact_reply_base_request" + properties: + intercom_user_id: + type: string + description: The identifier for the contact as given by Intercom. + required: + - intercom_user_id + contact_reply_ticket_request: + title: Contact Reply on ticket + oneOf: + - "$ref": "#/components/schemas/contact_reply_ticket_intercom_user_id_request" + - "$ref": "#/components/schemas/contact_reply_ticket_user_id_request" + - "$ref": "#/components/schemas/contact_reply_ticket_email_request" + contact_reply_ticket_user_id_request: + title: User ID + type: object + description: Payload of the request to reply on behalf of a contact using their + `user_id` + allOf: + - "$ref": "#/components/schemas/contact_reply_base_request" + properties: + user_id: + type: string + description: The external_id you have defined for the contact. + required: + - user_id + contact_reply_user_id_request: + title: User ID + type: object + description: Payload of the request to reply on behalf of a contact using their + `user_id` + allOf: + - "$ref": "#/components/schemas/contact_reply_base_request" + properties: + user_id: + type: string + description: The external_id you have defined for the contact. + attachment_files: + type: array + description: A list of files that will be added as attachments. You can + include up to 10 files. + items: + "$ref": "#/components/schemas/conversation_attachment_files" + maxItems: 10 + required: + - user_id + contact_segments: + title: Segments + type: object + description: A list of segments objects attached to a specific contact. + properties: + type: + type: string + description: The type of the object + enum: + - list + example: list + data: + type: array + description: Segment objects associated with the contact. + items: + "$ref": "#/components/schemas/segment" + contact_social_profiles: + title: Social Profile + type: object + nullable: false + description: An object containing social profiles that a contact has. + properties: + data: + type: array + description: A list of social profiles objects associated with the contact. + items: + "$ref": "#/components/schemas/social_profile" + contact_subscription_types: + title: Contact Subscription Types + type: object + nullable: false + description: An object containing Subscription Types meta data about the SubscriptionTypes + that a contact has. + properties: + data: + type: array + description: This object represents the subscriptions attached to a contact. + items: + "$ref": "#/components/schemas/addressable_list" + url: + type: string + format: uri + description: Url to get more subscription type resources for this contact + example: "/contacts/5ba682d23d7cf92bef87bfd4/subscriptions" + total_count: + type: integer + description: Int representing the total number of subscription types attached + to this contact + example: 100 + has_more: + type: boolean + description: Whether there's more Addressable Objects to be viewed. If true, + use the url to view all + example: true + contact_tags: + title: Contact Tags + type: object + nullable: true + description: An object containing tags meta data about the tags that a contact + has. Up to 10 will be displayed here. Use the url to get more. + properties: + data: + type: array + description: This object represents the tags attached to a contact. + items: + "$ref": "#/components/schemas/addressable_list" + url: + type: string + format: uri + description: url to get more tag resources for this contact + example: "/contacts/5ba682d23d7cf92bef87bfd4/tags" + total_count: + type: integer + description: Int representing the total number of tags attached to this + contact + example: 100 + has_more: + type: boolean + description: Whether there's more Addressable Objects to be viewed. If true, + use the url to view all + example: true + contact_unarchived: + title: Contact Unarchived + type: object + description: unarchived contact object + properties: + type: + type: string + description: always contact + enum: + - contact + example: contact + id: + type: string + description: The unique identifier for the contact which is given by Intercom. + example: 5ba682d23d7cf92bef87bfd4 + external_id: + type: string + nullable: true + description: The unique identifier for the contact which is provided by + the Client. + example: f3b87a2e09d514c6c2e79b9a + archived: + type: boolean + description: Whether the contact is archived or not. + example: false + content_source: + title: Content Source + type: object + x-tags: + - AI Content Source + description: The content source used by AI Agent in the conversation. + properties: + content_type: + type: string + description: The type of the content source. + example: content_snippet + enum: + - file + - article + - external_content + - content_snippet + - workflow_connector_action + url: + type: string + description: The internal URL linking to the content source for teammates. + example: "/fin-ai-agent/content?content=content_snippet&id=3234924" + title: + type: string + description: The title of the content source. + example: My internal content snippet + locale: + type: string + description: The ISO 639 language code of the content source. + example: en + content_sources_list: + title: Content Source List + nullable: false + properties: + type: + type: string + enum: + - content_source.list + example: content_source.list + total_count: + type: integer + description: The total number of content sources used by AI Agent in the + conversation. + example: 1 + content_sources: + type: array + description: The content sources used by AI Agent in the conversation. + items: + "$ref": "#/components/schemas/content_source" + conversation: + title: Conversation + type: object + x-tags: + - Conversations + description: Conversations are how you can communicate with users in Intercom. + They are created when a contact replies to an outbound message, or when one + admin directly sends a message to a single contact. + properties: + type: + type: string + description: Always conversation. + example: conversation + id: + type: string + description: The id representing the conversation. + example: '1295' + title: + type: string + nullable: true + description: The title given to the conversation. + example: Conversation Title + created_at: + type: integer + format: date-time + description: The time the conversation was created. + example: 1663597223 + updated_at: + type: integer + format: date-time + description: The last time the conversation was updated. + example: 1663597260 + waiting_since: + type: integer + format: date-time + nullable: true + description: The last time a Contact responded to an Admin. In other words, + the time a customer started waiting for a response. Set to null if last + reply is from an Admin. + example: 1663597260 + snoozed_until: + type: integer + format: date-time + nullable: true + description: If set this is the time in the future when this conversation + will be marked as open. i.e. it will be in a snoozed state until this + time. i.e. it will be in a snoozed state until this time. + example: 1663597260 + open: + type: boolean + description: Indicates whether a conversation is open (true) or closed (false). + example: true + state: + type: string + enum: + - open + - closed + - snoozed + description: Can be set to "open", "closed" or "snoozed". + example: open + read: + type: boolean + description: Indicates whether a conversation has been read. + example: true + priority: + type: string + enum: + - priority + - not_priority + description: If marked as priority, it will return priority or else not_priority. + example: priority + admin_assignee_id: + type: integer + nullable: true + description: The id of the admin assigned to the conversation. If it's not + assigned to an admin it will return null. + example: 0 + team_assignee_id: + type: string + nullable: true + description: The id of the team assigned to the conversation. If it's not + assigned to a team it will return null. + example: '5017691' + tags: + "$ref": "#/components/schemas/tags" + conversation_rating: + "$ref": "#/components/schemas/conversation_rating" + source: + "$ref": "#/components/schemas/conversation_source" + contacts: + "$ref": "#/components/schemas/conversation_contacts" + teammates: + "$ref": "#/components/schemas/conversation_teammates" + custom_attributes: + "$ref": "#/components/schemas/custom_attributes" + first_contact_reply: + "$ref": "#/components/schemas/conversation_first_contact_reply" + sla_applied: + "$ref": "#/components/schemas/sla_applied" + statistics: + "$ref": "#/components/schemas/conversation_statistics" + conversation_parts: + "$ref": "#/components/schemas/conversation_parts" + linked_objects: + "$ref": "#/components/schemas/linked_object_list" + ai_agent_participated: + type: boolean + description: Indicates whether the AI Agent participated in the conversation. + example: true + ai_agent: + "$ref": "#/components/schemas/ai_agent" + nullable: true + conversation_attachment_files: + title: Conversation attachment files + type: object + description: Properties of the attachment files in a conversation part + properties: + content_type: + type: string + description: The content type of the file + example: application/json + data: + type: string + description: The base64 encoded file data. + example: ewogICJ0ZXN0IjogMQp9 + name: + type: string + description: The name of the file. + example: test.json + conversation_contacts: + title: Contacts + type: object + description: The list of contacts (users or leads) involved in this conversation. + This will only contain one customer unless more were added via the group conversation + feature. + properties: + type: + type: string + description: '' + enum: + - contact.list + example: contact.list + contacts: + type: array + description: The list of contacts (users or leads) involved in this conversation. + This will only contain one customer unless more were added via the group + conversation feature. + items: + "$ref": "#/components/schemas/contact_reference" + conversation_first_contact_reply: + title: First contact reply + type: object + nullable: true + description: An object containing information on the first users message. For + a contact initiated message this will represent the users original message. + properties: + created_at: + type: integer + format: date-time + description: '' + example: 1663597223 + type: + type: string + description: '' + example: conversation + url: + type: string + nullable: true + description: '' + example: https://developers.intercom.com/ + conversation_list: + title: Conversation List + type: object + description: Conversations are how you can communicate with users in Intercom. + They are created when a contact replies to an outbound message, or when one + admin directly sends a message to a single contact. + properties: + type: + type: string + description: Always conversation.list + enum: + - conversation.list + example: conversation.list + conversations: + type: array + description: The list of conversation objects + items: + "$ref": "#/components/schemas/conversation" + total_count: + type: integer + description: A count of the total number of objects. + example: 12345 + pages: + "$ref": "#/components/schemas/cursor_pages" + conversation_part: + title: Conversation Part + type: object + description: A Conversation Part represents a message in the conversation. + properties: + type: + type: string + description: Always conversation_part + example: conversation_part + id: + type: string + description: The id representing the conversation part. + example: '3' + part_type: + type: string + description: The type of conversation part. + example: comment + body: + type: string + nullable: true + description: The message body, which may contain HTML. For Twitter, this + will show a generic message regarding why the body is obscured. + example: "

    Okay!

    " + created_at: + type: integer + format: date-time + description: The time the conversation part was created. + example: 1663597223 + updated_at: + type: integer + format: date-time + description: The last time the conversation part was updated. + example: 1663597260 + notified_at: + type: integer + format: date-time + description: The time the user was notified with the conversation part. + example: 1663597260 + assigned_to: + "$ref": "#/components/schemas/reference" + nullable: true + description: The id of the admin that was assigned the conversation by this + conversation_part (null if there has been no change in assignment.) + author: + "$ref": "#/components/schemas/conversation_part_author" + attachments: + title: Conversation part attachments + type: array + description: A list of attachments for the part. + items: + "$ref": "#/components/schemas/part_attachment" + external_id: + type: string + nullable: true + description: The external id of the conversation part + example: abcd1234 + redacted: + type: boolean + description: Whether or not the conversation part has been redacted. + example: false + conversation_part_author: + title: Conversation part author + type: object + description: The object who initiated the conversation, which can be a Contact, + Admin or Team. Bots and campaigns send messages on behalf of Admins or Teams. + For Twitter, this will be blank. + properties: + type: + type: string + description: The type of the author + example: admin + id: + type: string + description: The id of the author + example: '274' + name: + type: string + description: The name of the author + example: Operator + email: + type: string + format: email + description: The email of the author + example: operator+abcd1234@intercom.io + conversation_parts: + title: Conversation Parts + type: object + description: A list of Conversation Part objects for each part message in the + conversation. This is only returned when Retrieving a Conversation, and ignored + when Listing all Conversations. There is a limit of 500 parts. + properties: + type: + type: string + description: '' + enum: + - conversation_part.list + example: conversation_part.list + conversation_parts: + title: Conversation Parts + type: array + description: A list of Conversation Part objects for each part message in + the conversation. This is only returned when Retrieving a Conversation, + and ignored when Listing all Conversations. There is a limit of 500 parts. + items: + "$ref": "#/components/schemas/conversation_part" + total_count: + type: integer + description: '' + example: 2 + conversation_rating: + title: Conversation Rating + type: object + nullable: true + description: The Conversation Rating object which contains information on the + rating and/or remark added by a Contact and the Admin assigned to the conversation. + properties: + rating: + type: integer + description: The rating, between 1 and 5, for the conversation. + example: 5 + remark: + type: string + description: An optional field to add a remark to correspond to the number + rating + example: '' + created_at: + type: integer + format: date-time + description: The time the rating was requested in the conversation being + rated. + example: 1671028894 + contact: + "$ref": "#/components/schemas/contact_reference" + teammate: + "$ref": "#/components/schemas/reference" + conversation_source: + title: Conversation source + type: object + description: The Conversation Part that originated this conversation, which + can be Contact, Admin, Campaign, Automated or Operator initiated. + properties: + type: + type: string + description: This includes conversation, email, facebook, instagram, phone_call, + phone_switch, push, sms, twitter and whatsapp. + example: conversation + id: + type: string + description: The id representing the message. + example: '3' + delivered_as: + type: string + description: The conversation's initiation type. Possible values are customer_initiated, + campaigns_initiated (legacy campaigns), operator_initiated (Custom bot), + automated (Series and other outbounds with dynamic audience message) and + admin_initiated (fixed audience message, ticket initiated by an admin, + group email). + example: operator_initiated + subject: + type: string + description: Optional. The message subject. For Twitter, this will show + a generic message regarding why the subject is obscured. + example: '' + body: + type: string + description: The message body, which may contain HTML. For Twitter, this + will show a generic message regarding why the body is obscured. + example: "

    Hey there!

    " + author: + "$ref": "#/components/schemas/conversation_part_author" + attachments: + type: array + description: A list of attachments for the part. + items: + "$ref": "#/components/schemas/part_attachment" + url: + type: string + nullable: true + description: The URL where the conversation was started. For Twitter, Email, + and Bots, this will be blank. + example: + redacted: + type: boolean + description: Whether or not the source message has been redacted. Only applicable + for contact initiated messages. + example: false + conversation_statistics: + title: Conversation statistics + type: object + nullable: true + description: A Statistics object containing all information required for reporting, + with timestamps and calculated metrics. + properties: + type: + type: string + description: '' + example: conversation_statistics + time_to_assignment: + type: integer + description: Duration until last assignment before first admin reply. In + seconds. + example: 2310 + time_to_admin_reply: + type: integer + description: Duration until first admin reply. Subtracts out of business + hours. In seconds. + example: 2310 + time_to_first_close: + type: integer + description: Duration until conversation was closed first time. Subtracts + out of business hours. In seconds. + example: 2310 + time_to_last_close: + type: integer + description: Duration until conversation was closed last time. Subtracts + out of business hours. In seconds. + example: 2310 + median_time_to_reply: + type: integer + description: Median based on all admin replies after a contact reply. Subtracts + out of business hours. In seconds. + example: 2310 + first_contact_reply_at: + type: integer + format: date-time + description: Time of first text conversation part from a contact. + example: 1663597233 + first_assignment_at: + type: integer + format: date-time + description: Time of first assignment after first_contact_reply_at. + example: 1663597233 + first_admin_reply_at: + type: integer + format: date-time + description: Time of first admin reply after first_contact_reply_at. + example: 1663597233 + first_close_at: + type: integer + format: date-time + description: Time of first close after first_contact_reply_at. + example: 1663597233 + last_assignment_at: + type: integer + format: date-time + description: Time of last assignment after first_contact_reply_at. + example: 1663597233 + last_assignment_admin_reply_at: + type: integer + format: date-time + description: Time of first admin reply since most recent assignment. + example: 1663597233 + last_contact_reply_at: + type: integer + format: date-time + description: Time of the last conversation part from a contact. + example: 1663597233 + last_admin_reply_at: + type: integer + format: date-time + description: Time of the last conversation part from an admin. + example: 1663597233 + last_close_at: + type: integer + format: date-time + description: Time of the last conversation close. + example: 1663597233 + last_closed_by_id: + type: string + description: The last admin who closed the conversation. Returns a reference + to an Admin object. + example: c3po + count_reopens: + type: integer + description: Number of reopens after first_contact_reply_at. + example: 1 + count_assignments: + type: integer + description: Number of assignments after first_contact_reply_at. + example: 1 + count_conversation_parts: + type: integer + description: Total number of conversation parts. + example: 1 + conversation_teammates: + title: Conversation teammates + type: object + nullable: true + description: The list of teammates who participated in the conversation (wrote + at least one conversation part). + properties: + type: + type: string + description: The type of the object - `admin.list`. + example: admin.list + teammates: + type: array + description: The list of teammates who participated in the conversation + (wrote at least one conversation part). + items: + "$ref": "#/components/schemas/reference" + convert_conversation_to_ticket_request: + description: You can convert a Conversation to a Ticket + type: object + title: Convert Ticket Request Payload + properties: + ticket_type_id: + type: string + description: The ID of the type of ticket you want to convert the conversation + to + example: '1234' + attributes: + "$ref": "#/components/schemas/ticket_request_custom_attributes" + required: + - ticket_type_id + convert_visitor_request: + description: You can merge a Visitor to a Contact of role type lead or user. + type: object + title: Convert Visitor Request Payload + properties: + type: + type: string + description: Represents the role of the Contact model. Accepts `lead` or + `user`. + example: user + user: + type: object + description: The unique identifiers retained after converting or merging. + properties: + id: + type: string + description: The unique identifier for the contact which is given by + Intercom. + example: 8a88a590-e1c3-41e2-a502-e0649dbf721c + user_id: + type: string + description: A unique identifier for the contact which is given to Intercom, + which will be represented as external_id. + example: 8a88a590-e1c3-41e2-a502-e0649dbf721c + email: + type: string + description: The contact's email, retained by default if one is present. + example: winstonsmith@truth.org + anyOf: + - required: + - id + - required: + - user_id + visitor: + type: object + description: The unique identifiers to convert a single Visitor. + properties: + id: + type: string + description: The unique identifier for the contact which is given by + Intercom. + example: 8a88a590-e1c3-41e2-a502-e0649dbf721c + user_id: + type: string + description: A unique identifier for the contact which is given to Intercom. + example: 8a88a590-e1c3-41e2-a502-e0649dbf721c + email: + type: string + description: The visitor's email. + example: winstonsmith@truth.org + anyOf: + - required: + - id + - required: + - user_id + - required: + - email + required: + - type + - user + - visitor + create_article_request: + description: You can create an Article + type: object + title: Create Article Request Payload + nullable: true + properties: + title: + type: string + description: The title of the article.For multilingual articles, this will + be the title of the default language's content. + example: Thanks for everything + description: + type: string + description: The description of the article. For multilingual articles, + this will be the description of the default language's content. + example: Description of the Article + body: + type: string + description: The content of the article. For multilingual articles, this + will be the body of the default language's content. + example: "

    This is the body in html

    " + author_id: + type: integer + description: The id of the author of the article. For multilingual articles, + this will be the id of the author of the default language's content. Must + be a teammate on the help center's workspace. + example: 1295 + state: + type: string + description: Whether the article will be `published` or will be a `draft`. + Defaults to draft. For multilingual articles, this will be the state of + the default language's content. + enum: + - published + - draft + example: draft + parent_id: + type: integer + description: The id of the article's parent collection or section. An article + without this field stands alone. + example: 18 + parent_type: + type: string + description: The type of parent, which can either be a `collection` or `section`. + example: collection + translated_content: + "$ref": "#/components/schemas/article_translated_content" + required: + - title + - author_id + create_collection_request: + description: You can create a collection + type: object + title: Create Collection Request Payload + properties: + name: + type: string + description: The name of the collection. For multilingual collections, this + will be the name of the default language's content. + example: collection 51 + description: + type: string + description: The description of the collection. For multilingual collections, + this will be the description of the default language's content. + example: English description + translated_content: + nullable: true + "$ref": "#/components/schemas/group_translated_content" + parent_id: + type: string + nullable: true + description: The id of the parent collection. If `null` then it will be + created as the first level collection. + example: '6871118' + help_center_id: + type: integer + nullable: true + description: The id of the help center where the collection will be created. + If `null` then it will be created in the default help center. + example: '123' + required: + - name + create_contact_request: + description: Payload to create a contact + type: object + title: Create Contact Request Payload + properties: + role: + type: string + description: The role of the contact. + external_id: + type: string + description: A unique identifier for the contact which is given to Intercom + email: + type: string + description: The contacts email + example: jdoe@example.com + phone: + type: string + nullable: true + description: The contacts phone + example: "+353871234567" + name: + type: string + nullable: true + description: The contacts name + example: John Doe + avatar: + type: string + nullable: true + description: An image URL containing the avatar of a contact + example: https://www.example.com/avatar_image.jpg + signed_up_at: + type: integer + format: date-time + nullable: true + description: The time specified for when a contact signed up + example: 1571672154 + last_seen_at: + type: integer + format: date-time + nullable: true + description: The time when the contact was last seen (either where the Intercom + Messenger was installed or when specified manually) + example: 1571672154 + owner_id: + type: integer + nullable: true + description: The id of an admin that has been assigned account ownership + of the contact + example: 123 + unsubscribed_from_emails: + type: boolean + nullable: true + description: Whether the contact is unsubscribed from emails + example: true + custom_attributes: + type: object + nullable: true + description: The custom attributes which are set for the contact + anyOf: + - required: + - email + title: Create contact with email + - required: + - external_id + title: Create contact with external_id + - required: + - role + title: Create contact with role + create_conversation_request: + description: Conversations are how you can communicate with users in Intercom. + They are created when a contact replies to an outbound message, or when one + admin directly sends a message to a single contact. + type: object + title: Create Conversation Request Payload + properties: + from: + type: object + properties: + type: + type: string + enum: + - lead + - user + - contact + description: The role associated to the contact - user or lead. + example: user + id: + type: string + description: The identifier for the contact which is given by Intercom. + format: uuid + minLength: 24 + maxLength: 24 + example: 536e564f316c83104c000020 + required: + - type + - id + body: + type: string + description: The content of the message. HTML is not supported. + example: Hello + required: + - from + - body + create_data_attribute_request: + description: '' + type: object + title: Create Data Attribute Request + properties: + name: + type: string + description: The name of the data attribute. + example: My Data Attribute + model: + type: string + description: The model that the data attribute belongs to. + enum: + - contact + - company + example: contact + data_type: + type: string + description: The type of data stored for this attribute. + enum: + - string + - integer + - float + - boolean + - datetime + - date + example: string + description: + type: string + description: The readable description you see in the UI for the attribute. + example: My Data Attribute Description + options: + type: array + description: To create list attributes. Provide a set of hashes with `value` + as the key of the options you want to make. `data_type` must be `string`. + items: + type: string + example: + - option1 + - option2 + messenger_writable: + type: boolean + description: Can this attribute be updated by the Messenger + example: false + required: + - name + - model + - data_type + create_data_event_request: + description: '' + type: object + title: Create Data Event Request + properties: + event_name: + type: string + description: The name of the event that occurred. This is presented to your + App's admins when filtering and creating segments - a good event name + is typically a past tense 'verb-noun' combination, to improve readability, + for example `updated-plan`. + example: invited-friend + created_at: + type: integer + format: date-time + description: The time the event occurred as a UTC Unix timestamp + example: 1671028894 + user_id: + type: string + description: Your identifier for the user. + example: '314159' + id: + type: string + description: The unique identifier for the contact (lead or user) which + is given by Intercom. + example: 8a88a590-e1c3-41e2-a502-e0649dbf721c + email: + type: string + description: An email address for your user. An email should only be used + where your application uses email to uniquely identify users. + example: frodo.baggins@example.com + metadata: + type: object + description: Optional metadata about the event. + additionalProperties: + type: string + example: + invite_code: ADDAFRIEND + anyOf: + - title: id required + required: + - event_name + - created_at + - id + - title: user_id required + required: + - event_name + - created_at + - user_id + - title: email required + required: + - event_name + - created_at + - email + create_data_event_summaries_request: + description: You can send a list of event summaries for a user. Each event summary + should contain the event name, the time the event occurred, and the number + of times the event occurred. The event name should be a past tense "verb-noun" + combination, to improve readability, for example `updated-plan`. + type: object + title: Create Data Event Summaries Request + properties: + user_id: + type: string + description: Your identifier for the user. + example: '314159' + event_summaries: + type: object + description: A list of event summaries for the user. Each event summary + should contain the event name, the time the event occurred, and the number + of times the event occurred. The event name should be a past tense 'verb-noun' + combination, to improve readability, for example `updated-plan`. + properties: + event_name: + type: string + description: The name of the event that occurred. A good event name + is typically a past tense 'verb-noun' combination, to improve readability, + for example `updated-plan`. + example: invited-friend + count: + type: integer + description: The number of times the event occurred. + example: 1 + first: + type: integer + format: date-time + description: The first time the event was sent + example: 1671028894 + last: + type: integer + format: date-time + description: The last time the event was sent + example: 1671028894 + create_data_exports_request: + description: Request for creating a data export + type: object + title: Create Data Export Request + properties: + created_at_after: + type: integer + description: The start date that you request data for. It must be formatted + as a unix timestamp. + example: 1527811200 + created_at_before: + type: integer + description: The end date that you request data for. It must be formatted + as a unix timestamp. + example: 1527811200 + required: + - created_at_after + - created_at_before + create_message_request: + description: You can create a message + type: object + title: Create Message Request Payload + nullable: true + properties: + message_type: + type: string + description: 'The kind of message being created. Values: `in_app` or `email`.' + enum: + - in_app + - email + example: in_app + subject: + type: string + description: The title of the email. + example: Thanks for everything + body: + type: string + description: The content of the message. HTML and plaintext are supported. + example: Hello there + template: + type: string + description: The style of the outgoing message. Possible values `plain` + or `personal`. + example: plain + from: + type: object + description: The sender of the message. If not provided, the default sender + will be used. + properties: + type: + type: string + description: Always `admin`. + enum: + - admin + example: admin + id: + type: integer + description: The identifier for the admin which is given by Intercom. + example: 394051 + required: + - type + - id + to: + type: object + description: The sender of the message. If not provided, the default sender + will be used. + properties: + type: + type: string + description: The role associated to the contact - `user` or `lead`. + enum: + - user + - lead + example: user + id: + type: string + description: The identifier for the contact which is given by Intercom. + example: 536e564f316c83104c000020 + required: + - type + - id + created_at: + type: integer + description: The time the message was created. If not provided, the current + time will be used. + example: 1590000000 + create_conversation_without_contact_reply: + type: boolean + description: Whether a conversation should be opened in the inbox for the + message without the contact replying. Defaults to false if not provided. + default: false + example: true + anyOf: + - title: 'message_type: `email`.' + required: + - message_type + - subject + - body + - template + - from + - to + - title: 'message_type: `inapp`.' + required: + - message_type + - body + - from + - to + create_or_update_company_request: + type: object + title: Create Or Update Company Request Payload + description: You can create or update a Company + nullable: true + properties: + name: + type: string + description: The name of the Company + example: Intercom + company_id: + type: string + description: The company id you have defined for the company. Can't be updated + example: 625e90fc55ab113b6d92175f + plan: + type: string + description: The name of the plan you have associated with the company. + example: Enterprise + size: + type: integer + description: The number of employees in this company. + example: '100' + website: + type: string + description: The URL for this company's website. Please note that the value + specified here is not validated. Accepts any string. + example: https://www.example.com + industry: + type: string + description: The industry that this company operates in. + example: Manufacturing + custom_attributes: + type: object + description: A hash of key/value pairs containing any other data about the + company you want Intercom to store. + additionalProperties: + type: string + example: + paid_subscriber: true + monthly_spend: 155.5 + team_mates: 9 + remote_created_at: + type: integer + description: The time the company was created by you. + example: 1394531169 + monthly_spend: + type: integer + description: How much revenue the company generates for your business. Note + that this will truncate floats. i.e. it only allow for whole integers, + 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_tag_request: + description: You can create or update an existing tag. + type: object + title: Create or Update Tag Request Payload + properties: + name: + type: string + description: The name of the tag, which will be created if not found, or + the new name for the tag if this is an update request. Names are case + insensitive. + example: Independent + id: + type: string + description: The id of tag to updates. + example: '656452352' + required: + - name + create_phone_switch_request: + description: You can create an phone switch + type: object + title: Create Phone Switch Request Payload + nullable: true + properties: + phone: + type: string + description: Phone number in E.164 format, that will receive the SMS to + continue the conversation in the Messenger. + example: "+1 1234567890" + custom_attributes: + "$ref": "#/components/schemas/custom_attributes" + required: + - phone + create_ticket_reply_with_comment_request: + title: Create Ticket Reply Request Payload + oneOf: + - "$ref": "#/components/schemas/contact_reply_ticket_request" + - "$ref": "#/components/schemas/admin_reply_ticket_request" + create_ticket_request: + description: You can create a Ticket + type: object + title: Create Ticket Request Payload + properties: + ticket_type_id: + type: string + description: The ID of the type of ticket you want to create + example: '1234' + contacts: + type: array + description: The list of contacts (users or leads) affected by this ticket. + Currently only one is allowed + items: + type: object + oneOf: + - title: ID + properties: + id: + type: string + description: The identifier for the contact as given by Intercom. + required: + - id + - title: External ID + properties: + external_id: + type: string + description: The external_id you have defined for the contact who + is being added as a participant. + required: + - external_id + - title: Email + properties: + email: + type: string + description: The email you have defined for the contact who is being + added as a participant. If a contact with this email does not + exist, one will be created. + required: + - email + example: + - id: '1234' + company_id: + type: string + description: The ID of the company that the ticket is associated with. The + ID that you set upon company creation. + example: '1234' + created_at: + type: integer + description: The time the ticket was created. If not provided, the current + time will be used. + example: 1590000000 + ticket_attributes: + "$ref": "#/components/schemas/ticket_request_custom_attributes" + required: + - ticket_type_id + - contacts + create_ticket_type_attribute_request: + description: You can create a Ticket Type Attribute + type: object + title: Create Ticket Type Attribute Request Payload + properties: + name: + type: string + description: The name of the ticket type attribute + example: Bug Priority + description: + type: string + description: The description of the attribute presented to the teammate + or contact + example: Priority level of the bug + data_type: + type: string + description: The data type of the attribute + enum: + - string + - list + - integer + - decimal + - boolean + - datetime + - files + example: string + required_to_create: + type: boolean + description: Whether the attribute is required to be filled in when teammates + are creating the ticket in Inbox. + default: false + example: false + required_to_create_for_contacts: + type: boolean + description: Whether the attribute is required to be filled in when contacts + are creating the ticket in Messenger. + default: false + example: false + visible_on_create: + type: boolean + description: Whether the attribute is visible to teammates when creating + a ticket in Inbox. + default: true + example: true + visible_to_contacts: + type: boolean + description: Whether the attribute is visible to contacts when creating + a ticket in Messenger. + default: true + example: true + multiline: + type: boolean + description: Whether the attribute allows multiple lines of text (only applicable + to string attributes) + example: false + list_items: + type: string + description: A comma delimited list of items for the attribute value (only + applicable to list attributes) + example: Low Priority,Medium Priority,High Priority + allow_multiple_values: + type: boolean + description: Whether the attribute allows multiple files to be attached + to it (only applicable to file attributes) + example: false + required: + - name + - description + - data_type + create_ticket_type_request: + description: | + The request payload for creating a ticket type. + You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/) + type: object + title: Create Ticket Type Request Payload + nullable: true + properties: + name: + type: string + description: The name of the ticket type. + example: Bug + description: + type: string + description: The description of the ticket type. + example: Used for tracking bugs + category: + type: string + description: Category of the Ticket Type. + enum: + - Customer + - Back-office + - Tracker + example: Customer + icon: + type: string + description: The icon of the ticket type. + example: "\U0001F41E" + default: "\U0001F39F️" + is_internal: + type: boolean + description: Whether the tickets associated with this ticket type are intended + for internal use only or will be shared with customers. This is currently + a limited attribute. + example: false + default: false + required: + - name + cursor_pages: + title: Cursor based pages + type: object + description: | + Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. + A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed. + nullable: true + properties: + type: + type: string + description: the type of object `pages`. + example: pages + enum: + - pages + page: + type: integer + description: The current page + example: 1 + next: + "$ref": "#/components/schemas/starting_after_paging" + per_page: + type: integer + description: Number of results per page + example: 2 + total_pages: + type: integer + description: Total number of pages + example: 13 + custom_attributes: + title: Custom Attributes + type: object + description: An object containing the different custom attributes associated + to the conversation as key-value pairs. For relationship attributes the value + will be a list of custom object instance models. + additionalProperties: + anyOf: + - type: string + - "$ref": "#/components/schemas/custom_object_instance" + custom_object_instance: + title: Custom Object Instance + type: object + x-tags: + - Custom Object Instances + nullable: true + description: A Custom Object Instance represents an instance of a custom object + type. This allows you to create and set custom attributes to store data about + your customers that is not already captured by Intercom. The parent object + includes recommended default attributes and you can add your own custom attributes. + 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 + oneOf: + - title: Intercom User ID + properties: + intercom_user_id: + type: string + description: The identifier for the contact as given by Intercom. + example: 6329bd9ffe4e2e91dac76188 + required: + - intercom_user_id + - title: User ID + properties: + user_id: + type: string + description: The external_id you have defined for the contact who is being + added as a participant. + example: 2e91dac761886329bd9ffe4e + required: + - user_id + - title: Email + properties: + email: + type: string + description: The email you have defined for the contact who is being added + as a participant. + example: sam.sung@example.com + required: + - email + data_attribute: + title: Data Attribute + type: object + x-tags: + - Data Attributes + description: Data Attributes are metadata used to describe your contact, company + and conversation models. These include standard and custom attributes. By + using the data attributes endpoint, you can get the global list of attributes + for your workspace, as well as create and archive custom attributes. + properties: + type: + type: string + description: Value is `data_attribute`. + enum: + - data_attribute + example: data_attribute + id: + type: integer + description: The unique identifier for the data attribute which is given + by Intercom. Only available for custom attributes. + example: 12878 + model: + type: string + description: Value is `contact` for user/lead attributes and `company` for + company attributes. + enum: + - contact + - company + example: contact + name: + type: string + description: Name of the attribute. + example: paid_subscriber + full_name: + type: string + description: Full name of the attribute. Should match the name unless it's + a nested attribute. We can split full_name on `.` to access nested user + object values. + example: custom_attributes.paid_subscriber + label: + type: string + description: Readable name of the attribute (i.e. name you see in the UI) + example: Paid Subscriber + description: + type: string + description: Readable description of the attribute. + example: Whether the user is a paid subscriber. + data_type: + type: string + description: The data type of the attribute. + enum: + - string + - integer + - float + - boolean + - date + example: boolean + options: + type: array + description: List of predefined options for attribute value. + items: + type: string + example: + - 'true' + - 'false' + api_writable: + type: boolean + description: Can this attribute be updated through API + example: true + messenger_writable: + type: boolean + description: Can this attribute be updated by the Messenger + example: false + ui_writable: + type: boolean + description: Can this attribute be updated in the UI + example: true + custom: + type: boolean + description: Set to true if this is a CDA + example: true + archived: + type: boolean + description: Is this attribute archived. (Only applicable to CDAs) + example: false + created_at: + type: integer + format: date-time + description: The time the attribute was created as a UTC Unix timestamp + example: 1671028894 + updated_at: + type: integer + format: date-time + description: The time the attribute was last updated as a UTC Unix timestamp + example: 1671028894 + admin_id: + type: string + description: Teammate who created the attribute. Only applicable to CDAs + example: '5712945' + data_attribute_list: + title: Data Attribute List + type: object + description: A list of all data attributes belonging to a workspace for contacts, + companies or conversations. + properties: + type: + type: string + description: The type of the object + enum: + - list + example: list + data: + type: array + description: A list of data attributes + items: + "$ref": "#/components/schemas/data_attribute" + data_event: + title: Data Event + type: object + x-tags: + - Data Events + description: Data events are used to notify Intercom of changes to your data. + properties: + type: + type: string + description: The type of the object + enum: + - event + example: event + event_name: + type: string + description: The name of the event that occurred. This is presented to your + App's admins when filtering and creating segments - a good event name + is typically a past tense 'verb-noun' combination, to improve readability, + for example `updated-plan`. + example: invited-friend + created_at: + type: integer + format: date-time + description: The time the event occurred as a UTC Unix timestamp + example: 1671028894 + user_id: + type: string + description: Your identifier for the user. + example: '314159' + id: + type: string + description: Your identifier for a lead or a user. + example: 8a88a590-e1c3-41e2-a502-e0649dbf721c + intercom_user_id: + type: string + description: The Intercom identifier for the user. + example: 63a0979a5eeebeaf28dd56ba + email: + type: string + description: An email address for your user. An email should only be used + where your application uses email to uniquely identify users. + example: frodo.baggins@example.com + metadata: + type: object + description: Optional metadata about the event. + additionalProperties: + type: string + example: + invite_code: ADDAFRIEND + required: + - event_name + - created_at + data_event_list: + title: Data Event List + type: object + description: This will return a list of data events for the App. + properties: + type: + type: string + description: The type of the object + enum: + - event.list + example: event.list + events: + type: array + description: A list of data events + items: + "$ref": "#/components/schemas/data_event" + pages: + type: object + description: Pagination + properties: + next: + type: string + example: https://api.intercom.io/events?per_page=2&before=1389913941064&intercom_user_id=63a0979a5eeebeaf28dd56ba&type=user" + since: + type: string + example: https://api.intercom.io/events?intercom_user_id=63a0979a5eeebeaf28dd56ba&type=user&since=1389913941065 + data_event_summary: + title: Data Event Summary + type: object + description: This will return a summary of data events for the App. + properties: + type: + type: string + description: The type of the object + enum: + - event.summary + example: event.summary + email: + type: string + description: The email address of the user + example: Sam.Sung@example.com + intercom_user_id: + type: string + description: The Intercom user ID of the user + example: 63a0979a5eeebeaf28dd56ba + user_id: + type: string + description: The user ID of the user + example: 62b997f288e14803c5006932 + events: + type: array + description: A summary of data events + items: + "$ref": "#/components/schemas/data_event_summary_item" + data_event_summary_item: + title: Data Event Summary Item + type: object + description: This will return a summary of a data event for the App. + nullable: true + properties: + name: + type: string + description: The name of the event + example: placed-order + first: + type: string + description: The first time the event was sent + example: '2014-01-16T23:12:21.000+00:00' + last: + type: string + description: The last time the event was sent + example: '2014-01-16T23:12:21.000+00:00 ' + count: + type: integer + description: The number of times the event was sent + example: 1 + description: + type: string + description: The description of the event + example: A user placed an order + data_export: + title: Data Export + type: object + x-tags: + - Data Export + description: The data export api is used to view all message sent & viewed in + a given timeframe. + properties: + job_identfier: + type: string + description: The identifier for your job. + example: orzzsbd7hk67xyu + status: + type: string + enum: + - pending + - in_progress + - failed + - completed + - no_data + - canceled + description: The current state of your job. + example: pending + download_expires_at: + type: string + description: The time after which you will not be able to access the data. + example: '1674917488' + download_url: + type: string + description: The location where you can download your data. + example: https://api.intercom.test/download/messages/data/example + data_export_csv: + title: Data Export CSV + type: object + description: A CSV output file + properties: + user_id: + type: string + description: The user_id of the user who was sent the message. + user_external_id: + type: string + description: The external_user_id of the user who was sent the message + company_id: + type: string + description: The company ID of the user in relation to the message that + was sent. Will return -1 if no company is present. + email: + type: string + description: The users email who was sent the message. + name: + type: string + description: The full name of the user receiving the message + ruleset_id: + type: string + description: The id of the message. + content_id: + type: string + description: The specific content that was received. In an A/B test each + version has its own Content ID. + content_type: + type: string + description: Email, Chat, Post etc. + content_title: + type: string + description: The title of the content you see in your Intercom workspace. + ruleset_version_id: + type: string + description: As you edit content we record new versions. This ID can help + you determine which version of a piece of content that was received. + receipt_id: + type: string + description: ID for this receipt. Will be included with any related stats + in other files to identify this specific delivery of a message. + received_at: + type: integer + description: Timestamp for when the receipt was recorded. + series_id: + type: string + description: The id of the series that this content is part of. Will return + -1 if not part of a series. + series_title: + type: string + description: The title of the series that this content is part of. + node_id: + type: string + description: The id of the series node that this ruleset is associated with. + Each block in a series has a corresponding node_id. + first_reply: + type: integer + description: The first time a user replied to this message if the content + was able to receive replies. + first_completion: + type: integer + description: The first time a user completed this message if the content + was able to be completed e.g. Tours, Surveys. + first_series_completion: + type: integer + description: The first time the series this message was a part of was completed + by the user. + first_series_disengagement: + type: integer + description: The first time the series this message was a part of was disengaged + by the user. + first_series_exit: + type: integer + description: The first time the series this message was a part of was exited + by the user. + first_goal_success: + type: integer + description: The first time the user met this messages associated goal if + one exists. + first_open: + type: integer + description: The first time the user opened this message. + first_click: + type: integer + description: The first time the series the user clicked on a link within + this message. + first_dismisall: + type: integer + description: The first time the series the user dismissed this message. + first_unsubscribe: + type: integer + description: The first time the user unsubscribed from this message. + first_hard_bounce: + type: integer + description: The first time this message hard bounced for this user + deleted_article_object: + title: Deleted Article Object + type: object + description: Response returned when an object is deleted + properties: + id: + type: string + description: The unique identifier for the article which you provided in + the URL. + example: '6890762' + object: + type: string + description: The type of object which was deleted. - article + enum: + - article + example: article + deleted: + type: boolean + description: Whether the article was deleted successfully or not. + example: true + deleted_collection_object: + title: Deleted Collection Object + type: object + description: Response returned when an object is deleted + properties: + id: + type: string + description: The unique identifier for the collection which you provided + in the URL. + example: '6890762' + object: + type: string + description: The type of object which was deleted. - `collection` + enum: + - collection + example: collection + deleted: + type: boolean + description: Whether the collection was deleted successfully or not. + example: true + deleted_company_object: + title: Deleted Company Object + type: object + description: Response returned when an object is deleted + properties: + id: + type: string + description: The unique identifier for the company which is given by Intercom. + example: 5b7e8b2f-7a1a-4e6c-8e1b-4f9d4f4c4d4f + object: + type: string + description: The type of object which was deleted. - `company` + enum: + - company + example: company + deleted: + type: boolean + description: Whether the company was deleted successfully or not. + example: true + deleted_object: + title: Deleted Object + type: object + description: Response returned when an object is deleted + properties: + id: + type: string + description: The unique identifier for the news item which you provided + in the URL. + example: '6890762' + object: + type: string + description: The type of object which was deleted - news-item. + enum: + - news-item + example: news-item + deleted: + type: boolean + description: Whether the news item was deleted successfully or not. + example: true + detach_contact_from_conversation_request: + properties: + admin_id: + type: string + description: The `id` of the admin who is performing the action. + example: '5017690' + required: + - admin_id + error: + type: object + title: Error + description: The API will return an Error List for a failed request, which will + contain one or more Error objects. + properties: + type: + type: string + description: The type is error.list + example: error.list + request_id: + type: string + nullable: true + format: uuid + description: '' + example: f93ecfa8-d08a-4325-8694-89aeb89c8f85 + errors: + type: array + description: An array of one or more error objects + items: + properties: + code: + type: string + description: A string indicating the kind of error, used to further + qualify the HTTP response code + example: unauthorized + message: + type: string + nullable: true + description: Optional. Human readable description of the error. + example: Access Token Invalid + field: + type: string + nullable: true + description: Optional. Used to identify a particular field or query + parameter that was in error. + example: email + required: + - code + required: + - type + - errors + file_attribute: + title: File + type: object + description: The value describing a file upload set for a custom attribute + properties: + type: + type: string + example: upload + name: + type: string + description: The name of the file + example: Screenshot.png + url: + type: string + description: The url of the file. This is a temporary URL and will expire + after 30 minutes. + example: https://intercom-attachments-1.com/.../Screenshot.png + content_type: + type: string + description: The type of file + example: image/png + filesize: + type: integer + description: The size of the file in bytes + example: 11308309 + width: + type: integer + description: The width of the file in pixels, if applicable + example: 3024 + height: + type: integer + description: The height of the file in pixels, if applicable + example: 1964 + group_content: + title: Group Content + type: object + description: The Content of a Group. + nullable: true + properties: + type: + type: string + description: The type of object - `group_content` . + enum: + - + - group_content + example: group_content + nullable: true + name: + type: string + description: The name of the collection or section. + example: Collection name + description: + type: string + description: The description of the collection. Only available for collections. + example: " Collection description" + group_translated_content: + title: Group Translated Content + type: object + description: The Translated Content of an Group. The keys are the locale codes + and the values are the translated content of the Group. + nullable: true + properties: + type: + type: string + description: The type of object - group_translated_content. + nullable: true + enum: + - + - group_translated_content + example: group_translated_content + ar: + description: The content of the group in Arabic + "$ref": "#/components/schemas/group_content" + bg: + description: The content of the group in Bulgarian + "$ref": "#/components/schemas/group_content" + bs: + description: The content of the group in Bosnian + "$ref": "#/components/schemas/group_content" + ca: + description: The content of the group in Catalan + "$ref": "#/components/schemas/group_content" + cs: + description: The content of the group in Czech + "$ref": "#/components/schemas/group_content" + da: + description: The content of the group in Danish + "$ref": "#/components/schemas/group_content" + de: + description: The content of the group in German + "$ref": "#/components/schemas/group_content" + el: + description: The content of the group in Greek + "$ref": "#/components/schemas/group_content" + en: + description: The content of the group in English + "$ref": "#/components/schemas/group_content" + es: + description: The content of the group in Spanish + "$ref": "#/components/schemas/group_content" + et: + description: The content of the group in Estonian + "$ref": "#/components/schemas/group_content" + fi: + description: The content of the group in Finnish + "$ref": "#/components/schemas/group_content" + fr: + description: The content of the group in French + "$ref": "#/components/schemas/group_content" + he: + description: The content of the group in Hebrew + "$ref": "#/components/schemas/group_content" + hr: + description: The content of the group in Croatian + "$ref": "#/components/schemas/group_content" + hu: + description: The content of the group in Hungarian + "$ref": "#/components/schemas/group_content" + id: + description: The content of the group in Indonesian + "$ref": "#/components/schemas/group_content" + it: + description: The content of the group in Italian + "$ref": "#/components/schemas/group_content" + ja: + description: The content of the group in Japanese + "$ref": "#/components/schemas/group_content" + ko: + description: The content of the group in Korean + "$ref": "#/components/schemas/group_content" + lt: + description: The content of the group in Lithuanian + "$ref": "#/components/schemas/group_content" + lv: + description: The content of the group in Latvian + "$ref": "#/components/schemas/group_content" + mn: + description: The content of the group in Mongolian + "$ref": "#/components/schemas/group_content" + nb: + description: The content of the group in Norwegian + "$ref": "#/components/schemas/group_content" + nl: + description: The content of the group in Dutch + "$ref": "#/components/schemas/group_content" + pl: + description: The content of the group in Polish + "$ref": "#/components/schemas/group_content" + pt: + description: The content of the group in Portuguese (Portugal) + "$ref": "#/components/schemas/group_content" + ro: + description: The content of the group in Romanian + "$ref": "#/components/schemas/group_content" + ru: + description: The content of the group in Russian + "$ref": "#/components/schemas/group_content" + sl: + description: The content of the group in Slovenian + "$ref": "#/components/schemas/group_content" + sr: + description: The content of the group in Serbian + "$ref": "#/components/schemas/group_content" + sv: + description: The content of the group in Swedish + "$ref": "#/components/schemas/group_content" + tr: + description: The content of the group in Turkish + "$ref": "#/components/schemas/group_content" + vi: + description: The content of the group in Vietnamese + "$ref": "#/components/schemas/group_content" + pt-BR: + description: The content of the group in Portuguese (Brazil) + "$ref": "#/components/schemas/group_content" + zh-CN: + description: The content of the group in Chinese (China) + "$ref": "#/components/schemas/group_content" + zh-TW: + description: The content of the group in Chinese (Taiwan) + "$ref": "#/components/schemas/group_content" + help_center: + title: Help Center + type: object + x-tags: + - Help Center + description: Help Centers contain collections + properties: + id: + type: string + description: The unique identifier for the Help Center which is given by + Intercom. + example: '123' + workspace_id: + type: string + description: The id of the workspace which the Help Center belongs to. + example: hfi1bx4l + created_at: + type: integer + format: date-time + description: The time when the Help Center was created. + example: 1672928359 + updated_at: + type: integer + format: date-time + description: The time when the Help Center was last updated. + example: 1672928610 + identifier: + type: string + description: The identifier of the Help Center. This is used in the URL + of the Help Center. + example: intercom + website_turned_on: + type: boolean + description: Whether the Help Center is turned on or not. This is controlled + in your Help Center settings. + example: true + display_name: + type: string + description: The display name of the Help Center only seen by teammates. + example: Intercom Help Center + help_center_list: + title: Help Centers + type: object + x-tags: + - Help Center + description: A list of Help Centers belonging to the App + properties: + type: + type: string + description: The type of the object - `list`. + enum: + - list + example: list + data: + type: array + description: An array of Help Center objects + items: + "$ref": "#/components/schemas/help_center" + intercom_version: + description: Intercom API version.
    By default, it's equal to the version + set in the app package. + type: string + example: '2.11' + default: '2.11' + enum: + - '1.0' + - '1.1' + - '1.2' + - '1.3' + - '1.4' + - '2.0' + - '2.1' + - '2.2' + - '2.3' + - '2.4' + - '2.5' + - '2.6' + - '2.7' + - '2.8' + - '2.9' + - '2.10' + - '2.11' + - Unstable + linked_object: + title: Linked Object + type: object + description: A linked conversation or ticket. + properties: + type: + type: string + description: ticket or conversation + enum: + - ticket + - conversation + example: ticket + id: + type: string + description: The ID of the linked object + example: '7583' + category: + type: string + description: Category of the Linked Ticket Object. + enum: + - Customer + - Back-office + - Tracker + - + example: Customer + nullable: true + linked_object_list: + title: Linked Objects + type: object + description: An object containing metadata about linked conversations and linked + tickets. Up to 1000 can be returned. + properties: + type: + type: string + description: Always list. + enum: + - list + example: list + total_count: + type: integer + description: The total number of linked objects. + example: 100 + has_more: + type: boolean + description: Whether or not there are more linked objects than returned. + example: false + data: + type: array + description: An array containing the linked conversations and linked tickets. + items: + "$ref": "#/components/schemas/linked_object" + merge_contacts_request: + description: Merge contact data. + type: object + title: Merge contact data + properties: + from: + type: string + description: The unique identifier for the contact to merge away from. Must + be a lead. + example: 5d70dd30de4efd54f42fd526 + into: + type: string + description: The unique identifier for the contact to merge into. Must be + a user. + example: 5ba682d23d7cf92bef87bfd4 + message: + type: object + title: Message + x-tags: + - Messages + description: Message are how you reach out to contacts in Intercom. They are + created when an admin sends an outbound message to a contact. + properties: + type: + type: string + description: The type of the message + example: user_message + id: + type: string + description: The id representing the message. + example: '1488971108' + created_at: + type: integer + format: date-time + description: The time the conversation was created. + example: 1667560812 + subject: + type: string + description: 'The subject of the message. Only present if message_type: + email.' + example: Greetings + body: + type: string + description: The message body, which may contain HTML. + example: Hello + message_type: + type: string + enum: + - email + - inapp + - facebook + - twitter + description: The type of message that was sent. Can be email, inapp, facebook + or twitter. + example: inapp + conversation_id: + type: string + description: The associated conversation_id + example: '64619700005570' + required: + - type + - id + - created_at + - body + - message_type + multiple_filter_search_request: + title: Multiple Filter Search Request + description: Search using Intercoms Search APIs with more than one filter. + type: object + properties: + operator: + type: string + enum: + - AND + - OR + description: An operator to allow boolean inspection between multiple fields. + example: AND + value: + oneOf: + - type: array + description: Add mutiple filters. + title: multiple filter search request + items: + "$ref": "#/components/schemas/multiple_filter_search_request" + - type: array + description: Add a single filter field. + title: single filter search request + items: + "$ref": "#/components/schemas/single_filter_search_request" + news_item: + title: News Item + type: object + x-tags: + - News + description: A News Item is a content type in Intercom enabling you to announce + product updates, company news, promotions, events and more with your customers. + properties: + type: + type: string + description: The type of object. + enum: + - news-item + example: news-item + id: + type: string + description: The unique identifier for the news item which is given by Intercom. + example: '141' + workspace_id: + type: string + description: The id of the workspace which the news item belongs to. + example: t74hdn32 + title: + type: string + description: The title of the news item. + example: 'New feature: News Items' + body: + type: string + description: The news item body, which may contain HTML. + example: We are excited to announce the launch of News Items, a new content + type in Intercom enabling you to announce product updates, company news, + promotions, events and more with your customers. + sender_id: + type: integer + description: The id of the sender of the news item. Must be a teammate on + the workspace. + example: 123 + state: + type: string + description: News items will not be visible to your users in the assigned + newsfeeds until they are set live. + enum: + - draft + - live + example: live + newsfeed_assignments: + type: array + description: A list of newsfeed_assignments to assign to the specified newsfeed. + items: + "$ref": "#/components/schemas/newsfeed_assignment" + labels: + type: array + description: Label names displayed to users to categorize the news item. + items: + type: string + nullable: true + description: The label name. + example: Product Update + cover_image_url: + type: string + format: uri + nullable: true + description: URL of the image used as cover. Must have .jpg or .png extension. + example: https://example.com/cover.jpg + reactions: + type: array + description: Ordered list of emoji reactions to the news item. When empty, + reactions are disabled. + items: + type: string + nullable: true + description: The emoji reaction to the news item. + example: "\U0001F44D" + deliver_silently: + type: boolean + description: When set to true, the news item will appear in the messenger + newsfeed without showing a notification badge. + example: true + created_at: + type: integer + format: timestamp + description: Timestamp for when the news item was created. + example: 1610589632 + updated_at: + type: integer + format: timestamp + description: Timestamp for when the news item was last updated. + example: 1610589632 + news_item_request: + description: A News Item is a content type in Intercom enabling you to announce + product updates, company news, promotions, events and more with your customers. + type: object + title: Create News Item Request + properties: + title: + type: string + description: The title of the news item. + example: Halloween is here! + body: + type: string + description: The news item body, which may contain HTML. + example: "

    New costumes in store for this spooky season

    " + sender_id: + type: integer + description: The id of the sender of the news item. Must be a teammate on + the workspace. + example: 123 + state: + type: string + description: News items will not be visible to your users in the assigned + newsfeeds until they are set live. + enum: + - draft + - live + example: live + deliver_silently: + type: boolean + description: When set to `true`, the news item will appear in the messenger + newsfeed without showing a notification badge. + example: true + labels: + type: array + description: Label names displayed to users to categorize the news item. + items: + type: string + example: + - Product + - Update + - New + reactions: + type: array + description: Ordered list of emoji reactions to the news item. When empty, + reactions are disabled. + items: + type: string + nullable: true + example: + - "\U0001F606" + - "\U0001F605" + newsfeed_assignments: + type: array + description: A list of newsfeed_assignments to assign to the specified newsfeed. + items: + "$ref": "#/components/schemas/newsfeed_assignment" + required: + - title + - sender_id + newsfeed: + title: Newsfeed + type: object + x-tags: + - News + description: | + A newsfeed is a collection of news items, targeted to a specific audience. + + Newsfeeds currently cannot be edited through the API, please refer to [this article](https://www.intercom.com/help/en/articles/6362267-getting-started-with-news) to set up your newsfeeds in Intercom. + properties: + id: + type: string + description: The unique identifier for the newsfeed which is given by Intercom. + example: '12312' + type: + type: string + description: The type of object. + enum: + - newsfeed + example: newsfeed + name: + type: string + description: The name of the newsfeed. This name will never be visible to + your users. + example: My Newsfeed + created_at: + type: integer + format: timestamp + description: Timestamp for when the newsfeed was created. + example: 1674917488 + updated_at: + type: integer + format: timestamp + description: Timestamp for when the newsfeed was last updated. + example: 1674917488 + newsfeed_assignment: + title: Newsfeed Assignment + type: object + x-tags: + - News + description: Assigns a news item to a newsfeed. + properties: + newsfeed_id: + type: integer + description: The unique identifier for the newsfeed which is given by Intercom. + Publish dates cannot be in the future, to schedule news items use the + dedicated feature in app (see this article). + example: 198313 + published_at: + type: integer + format: timestamp + description: Publish date of the news item on the newsfeed, use this field + if you want to set a publish date in the past (e.g. when importing existing + news items). On write, this field will be ignored if the news item state + is "draft". + example: 1674917488 + note: + title: Note + type: object + x-tags: + - Notes + description: Notes allow you to annotate and comment on your contacts. + properties: + type: + type: string + description: String representing the object's type. Always has the value + `note`. + example: note + id: + type: string + description: The id of the note. + example: '17495962' + created_at: + type: integer + format: timestamp + description: The time the note was created. + example: 1674589321 + contact: + type: object + description: Represents the contact that the note was created about. + nullable: true + properties: + type: + type: string + description: String representing the object's type. Always has the value + `contact`. + id: + type: string + description: The id of the contact. + example: 214656d0c743eafcfde7f248 + author: + "$ref": "#/components/schemas/admin" + description: Optional. Represents the Admin that created the note. + body: + type: string + description: The body text of the note. + example: "

    Text for the note.

    " + note_list: + title: Paginated Response + type: object + description: A paginated list of notes associated with a contact. + properties: + type: + type: string + description: String representing the object's type. Always has the value + `list`. + example: list + data: + type: array + description: An array of notes. + items: + "$ref": "#/components/schemas/note" + total_count: + type: integer + description: A count of the total number of notes. + example: 1 + pages: + "$ref": "#/components/schemas/cursor_pages" + open_conversation_request: + title: Open Conversation Request + type: object + description: Payload of the request to open a conversation + properties: + message_type: + type: string + enum: + - open + example: open + admin_id: + type: string + description: The id of the admin who is performing the action. + example: '5017690' + required: + - message_type + - admin_id + pages_link: + title: Pagination Object + type: object + description: | + The majority of list resources in the API are paginated to allow clients to traverse data over multiple requests. + + Their responses are likely to contain a pages object that hosts pagination links which a client can use to paginate through the data without having to construct a query. The link relations for the pages field are as follows. + properties: + type: + type: string + example: pages + enum: + - pages + page: + type: integer + example: 1 + next: + type: string + format: uri + description: A link to the next page of results. A response that does not + contain a next link does not have further data to fetch. + nullable: true + per_page: + type: integer + example: 50 + total_pages: + type: integer + example: 1 + paginated_response: + title: Paginated Response + type: object + description: Paginated Response + properties: + type: + type: string + description: The type of object + enum: + - list + - conversation.list + example: list + pages: + "$ref": "#/components/schemas/cursor_pages" + total_count: + type: integer + description: A count of the total number of objects. + example: 1 + data: + type: array + description: An array of Objects + items: + anyOf: + - "$ref": "#/components/schemas/news_item" + - "$ref": "#/components/schemas/newsfeed" + part_attachment: + title: Part attachment + type: object + description: The file attached to a part + properties: + type: + type: string + description: The type of attachment + example: upload + name: + type: string + description: The name of the attachment + example: example.png + url: + type: string + description: The URL of the attachment + example: https://picsum.photos/200/300 + content_type: + type: string + description: The content type of the attachment + example: image/png + filesize: + type: integer + description: The size of the attachment + example: 100 + width: + type: integer + description: The width of the attachment + example: 100 + height: + type: integer + description: The height of the attachment + example: 100 + phone_switch: + title: Phone Switch + type: object + description: Phone Switch Response + nullable: true + properties: + type: + type: string + description: '' + enum: + - phone_call_redirect + default: phone_call_redirect + example: phone_call_redirect + phone: + type: string + description: Phone number in E.164 format, that has received the SMS to + continue the conversation in the Messenger. + example: "+1 1234567890" + redact_conversation_request: + oneOf: + - title: Redact Conversation Part Request + type: object + description: Payload of the request to redact a conversation part + properties: + type: + type: string + enum: + - conversation_part + description: The type of resource being redacted. + example: conversation_part + conversation_id: + type: string + description: The id of the conversation. + example: '19894788788' + conversation_part_id: + type: string + description: The id of the conversation_part. + example: '19381789428' + required: + - type + - conversation_id + - conversation_part_id + - title: Redact Conversation Source Request + type: object + description: Payload of the request to redact a conversation source + properties: + type: + type: string + enum: + - source + description: The type of resource being redacted. + example: source + conversation_id: + type: string + description: The id of the conversation. + example: '19894788788' + source_id: + type: string + description: The id of the source. + example: '19894781231' + required: + - type + - conversation_id + - source_id + reference: + title: Reference + type: object + description: reference to another object + properties: + type: + type: string + description: '' + example: contact + id: + type: string + nullable: true + description: '' + example: 1a2b3c + reply_conversation_request: + oneOf: + - "$ref": "#/components/schemas/contact_reply_conversation_request" + - "$ref": "#/components/schemas/admin_reply_conversation_request" + search_request: + description: Search using Intercoms Search APIs. + type: object + title: Search data + properties: + query: + oneOf: + - "$ref": "#/components/schemas/single_filter_search_request" + title: Single filter search request + - "$ref": "#/components/schemas/multiple_filter_search_request" + title: multiple filter search request + pagination: + "$ref": "#/components/schemas/starting_after_paging" + required: + - query + segment: + title: Segment + type: object + x-tags: + - Segments + description: A segment is a group of your contacts defined by the rules that + you set. + properties: + type: + type: string + description: The type of object. + enum: + - segment + example: segment + id: + type: string + description: The unique identifier representing the segment. + example: 56203d253cba154d39010062 + name: + type: string + description: The name of the segment. + example: Active + created_at: + type: integer + description: The time the segment was created. + example: 1394621988 + updated_at: + type: integer + description: The time the segment was updated. + example: 1394622004 + person_type: + type: string + description: 'Type of the contact: contact (lead) or user.' + enum: + - contact + - user + example: contact + count: + type: integer + description: The number of items in the user segment. It's returned when + `include_count=true` is included in the request. + example: 3 + nullable: true + segment_list: + title: Segment List + type: object + description: This will return a list of Segment Objects. The result may also + have a pages object if the response is paginated. + properties: + type: + type: string + description: The type of the object + enum: + - segment.list + example: segment.list + segments: + type: array + description: A list of Segment objects + items: + "$ref": "#/components/schemas/segment" + pages: + type: object + description: A pagination object, which may be empty, indicating no further + pages to fetch. + single_filter_search_request: + title: Single Filter Search Request + description: Search using Intercoms Search APIs with a single filter. + type: object + properties: + field: + type: string + description: The accepted field that you want to search on. + example: created_at + operator: + type: string + enum: + - "=" + - "!=" + - IN + - NIN + - "<" + - ">" + - "~" + - "!~" + - "^" + - "$" + description: The accepted operators you can use to define how you want to + search for the value. + example: ">" + value: + type: string + description: The value that you want to search on. + example: '73732934' + sla_applied: + title: Applied SLA + type: object + nullable: true + description: | + The SLA Applied object contains the details for which SLA has been applied to this conversation. + Important: if there are any canceled sla_events for the conversation - meaning an SLA has been manually removed from a conversation, the sla_status will always be returned as null. + properties: + type: + type: string + description: object type + example: conversation_sla_summary + sla_name: + type: string + description: The name of the SLA as given by the teammate when it was created. + example: '' + sla_status: + type: string + enum: + - hit + - missed + - cancelled + - active + description: |- + SLA statuses: + - `hit`: If there’s at least one hit event in the underlying sla_events table, and no “missed” or “canceled” events for the conversation. + - `missed`: If there are any missed sla_events for the conversation and no canceled events. If there’s even a single missed sla event, the status will always be missed. A missed status is not applied when the SLA expires, only the next time a teammate replies. + - `active`: An SLA has been applied to a conversation, but has not yet been fulfilled. SLA status is active only if there are no “hit, “missed”, or “canceled” events. + example: hit + snooze_conversation_request: + title: Snooze Conversation Request + type: object + description: Payload of the request to snooze a conversation + properties: + message_type: + type: string + enum: + - snoozed + example: snoozed + admin_id: + type: string + description: The id of the admin who is performing the action. + example: '5017691' + snoozed_until: + type: integer + format: timestamp + description: The time you want the conversation to reopen. + example: 1673609604 + required: + - message_type + - admin_id + - snoozed_until + social_profile: + title: Social Profile + type: object + description: A Social Profile allows you to label your contacts, companies, + and conversations and list them using that Social Profile. + properties: + type: + type: string + description: value is "social_profile" + example: social_profile + name: + type: string + description: The name of the Social media profile + example: Facebook + url: + type: string + format: uri + description: The name of the Social media profile + example: http://twitter.com/th1sland + starting_after_paging: + title: 'Pagination: Starting After' + type: object + nullable: true + properties: + per_page: + type: integer + description: The number of results to fetch per page. + example: 2 + starting_after: + type: string + description: The cursor to use in the next request to get the next page + of results. + nullable: true + example: your-cursor-from-response + subscription_type: + title: Subscription Types + type: object + x-tags: + - Subscription Types + description: A subscription type lets customers easily opt out of non-essential + communications without missing what's important to them. + properties: + type: + type: string + description: The type of the object - subscription + example: subscription + id: + type: string + description: The unique identifier representing the subscription type. + example: '123456' + state: + type: string + description: The state of the subscription type. + enum: + - live + - draft + - archived + example: live + default_translation: + "$ref": "#/components/schemas/translation" + translations: + type: array + description: An array of translations objects with the localised version + of the subscription type in each available locale within your translation + settings. + items: + "$ref": "#/components/schemas/translation" + consent_type: + type: string + description: Describes the type of consent. + enum: + - opt_out + - opt_in + example: opt_in + content_types: + type: array + description: The message types that this subscription supports - can contain + `email` or `sms_message`. + items: + type: string + enum: + - email + - sms_message + example: email + subscription_type_list: + title: Subscription Types + type: object + description: A list of subscription type objects. + properties: + type: + type: string + description: The type of the object + enum: + - list + example: list + data: + type: array + description: A list of subscription type objects associated with the workspace + . + items: + "$ref": "#/components/schemas/subscription_type" + tag: + title: Tag + type: object + x-tags: + - Tags + description: A tag allows you to label your contacts, companies, and conversations + and list them using that tag. + properties: + type: + type: string + description: value is "tag" + example: tag + id: + type: string + description: The id of the tag + example: '123456' + name: + type: string + description: The name of the tag + example: Test tag + applied_at: + type: integer + format: date-time + description: The time when the tag was applied to the object + example: 1663597223 + applied_by: + "$ref": "#/components/schemas/reference" + tag_company_request: + description: You can tag a single company or a list of companies. + type: object + title: Tag Company Request Payload + properties: + name: + type: string + description: The name of the tag, which will be created if not found. + example: Independent + companies: + type: array + items: + properties: + id: + type: string + description: The Intercom defined id representing the company. + example: 531ee472cce572a6ec000006 + company_id: + type: string + description: The company id you have defined for the company. + example: '6' + description: The id or company_id of the company can be passed as input + parameters. + required: + - name + - companies + tag_list: + title: Tags + type: object + description: A list of tags objects in the workspace. + properties: + type: + type: string + description: The type of the object + enum: + - list + example: list + data: + type: array + description: A list of tags objects associated with the workspace . + items: + "$ref": "#/components/schemas/tag" + tag_multiple_users_request: + description: You can tag a list of users. + type: object + title: Tag Users Request Payload + properties: + name: + type: string + description: The name of the tag, which will be created if not found. + example: Independent + users: + type: array + items: + properties: + id: + type: string + description: The Intercom defined id representing the user. + example: 5f7f0d217289f8d2f4262080 + required: + - name + - users + tags: + title: Tags + type: object + description: A list of tags objects associated with a conversation + properties: + type: + type: string + description: The type of the object + enum: + - tag.list + example: tag.list + tags: + type: array + description: A list of tags objects associated with the conversation. + items: + "$ref": "#/components/schemas/tag" + team: + title: Team + type: object + x-tags: + - Teams + description: Teams are groups of admins in Intercom. + properties: + type: + type: string + description: Value is always "team" + example: team + id: + type: string + description: The id of the team + example: '814865' + name: + type: string + description: The name of the team + example: Example Team + admin_ids: + type: array + description: The list of admin IDs that are a part of the team. + example: + - 493881 + items: + type: integer + admin_priority_level: + "$ref": "#/components/schemas/admin_priority_level" + team_list: + title: Team List + type: object + description: This will return a list of team objects for the App. + properties: + type: + type: string + description: The type of the object + enum: + - team.list + example: team.list + teams: + type: array + description: A list of team objects + items: + "$ref": "#/components/schemas/team" + team_priority_level: + title: Team Priority Level + type: object + nullable: true + description: Admin priority levels for teams + properties: + primary_team_ids: + type: array + description: The primary team ids for the team + nullable: true + example: + - 814865 + items: + type: integer + secondary_team_ids: + type: array + description: The secondary team ids for the team + nullable: true + example: + - 493881 + items: + type: integer + ticket: + title: Ticket + type: object + x-tags: + - Tickets + description: Tickets are how you track requests from your users. + nullable: true + properties: + type: + type: string + description: Always ticket + enum: + - ticket + default: ticket + example: ticket + id: + type: string + description: The unique identifier for the ticket which is given by Intercom. + example: '1295' + ticket_id: + type: string + description: The ID of the Ticket used in the Intercom Inbox and Messenger. + Do not use ticket_id for API queries. + example: '1390' + category: + type: string + description: Category of the Ticket. + enum: + - Customer + - Back-office + - Tracker + example: Customer + ticket_attributes: + "$ref": "#/components/schemas/ticket_custom_attributes" + ticket_state: + type: string + description: The state the ticket is currenly in + enum: + - submitted + - in_progress + - waiting_on_customer + - resolved + example: submitted + ticket_state_internal_label: + type: string + description: The state the ticket is currently in, in a human readable form + - visible in Intercom + ticket_state_external_label: + type: string + description: The state the ticket is currently in, in a human readable form + - visible to customers, in the messenger, email and tickets portal. + ticket_type: + "$ref": "#/components/schemas/ticket_type" + contacts: + "$ref": "#/components/schemas/ticket_contacts" + admin_assignee_id: + type: string + description: The id representing the admin assigned to the ticket. + example: '1295' + team_assignee_id: + type: string + description: The id representing the team assigned to the ticket. + example: '1295' + created_at: + type: integer + format: date-time + description: The time the ticket was created as a UTC Unix timestamp. + example: 1663597223 + updated_at: + type: integer + format: date-time + description: The last time the ticket was updated as a UTC Unix timestamp. + example: 1663597260 + open: + type: boolean + description: Whether or not the ticket is open. If false, the ticket is + closed. + example: true + snoozed_until: + type: integer + format: date-time + description: The time the ticket will be snoozed until as a UTC Unix timestamp. + If null, the ticket is not currently snoozed. + example: 1663597260 + linked_objects: + "$ref": "#/components/schemas/linked_object_list" + ticket_parts: + "$ref": "#/components/schemas/ticket_parts" + is_shared: + type: boolean + description: Whether or not the ticket is shared with the customer. + example: true + ticket_contacts: + title: Contacts + type: object + x-tags: + - Tickets + description: The list of contacts affected by a ticket. + properties: + type: + type: string + description: always contact.list + enum: + - contact.list + example: contact.list + contacts: + type: array + description: The list of contacts affected by this ticket. + items: + "$ref": "#/components/schemas/contact_reference" + ticket_custom_attributes: + title: Ticket Attributes + type: object + description: An object containing the different attributes associated to the + ticket as key-value pairs. For the default title and description attributes, + the keys are `_default_title_` and `_default_description_`. + additionalProperties: + anyOf: + - type: string + nullable: true + - type: number + - type: boolean + - type: array + - "$ref": "#/components/schemas/file_attribute" + example: + _default_title_: Found a bug + _default_description_: The button's not working + ticket_list: + title: Ticket List + type: object + description: Tickets are how you track requests from your users. + properties: + type: + type: string + description: Always ticket.list + enum: + - ticket.list + example: ticket.list + tickets: + type: array + description: The list of ticket objects + items: + "$ref": "#/components/schemas/ticket" + total_count: + type: integer + description: A count of the total number of objects. + example: 12345 + pages: + "$ref": "#/components/schemas/cursor_pages" + ticket_part: + title: Ticket Part + type: object + x-tags: + - Tickets + description: A Ticket Part represents a message in the ticket. + properties: + type: + type: string + description: Always ticket_part + example: ticket_part + id: + type: string + description: The id representing the ticket part. + example: '3' + part_type: + type: string + description: The type of ticket part. + example: comment + body: + type: string + nullable: true + description: The message body, which may contain HTML. + example: "

    Okay!

    " + previous_ticket_state: + type: string + enum: + - submitted + - in_progress + - waiting_on_customer + - resolved + description: The previous state of the ticket. + example: submitted + ticket_state: + type: string + enum: + - submitted + - in_progress + - waiting_on_customer + - resolved + description: The state of the ticket. + example: submitted + created_at: + type: integer + format: date-time + description: The time the ticket part was created. + example: 1663597223 + updated_at: + type: integer + format: date-time + description: The last time the ticket part was updated. + example: 1663597260 + assigned_to: + "$ref": "#/components/schemas/reference" + nullable: true + description: The id of the admin that was assigned the ticket by this ticket_part + (null if there has been no change in assignment.) + author: + "$ref": "#/components/schemas/ticket_part_author" + attachments: + title: Ticket part attachments + type: array + description: A list of attachments for the part. + items: + "$ref": "#/components/schemas/part_attachment" + external_id: + type: string + nullable: true + description: The external id of the ticket part + example: abcd1234 + redacted: + type: boolean + description: Whether or not the ticket part has been redacted. + example: false + ticket_part_author: + title: Ticket part author + type: object + description: The author that wrote or triggered the part. Can be a bot, admin, + team or user. + properties: + type: + type: string + description: The type of the author + example: admin + enum: + - admin + - bot + - team + - user + id: + type: string + description: The id of the author + example: '274' + name: + type: string + nullable: true + description: The name of the author + example: Operator + email: + type: string + format: email + description: The email of the author + example: operator+abcd1234@intercom.io + ticket_parts: + title: Ticket Parts + type: object + description: A list of Ticket Part objects for each note and event in the ticket. + There is a limit of 500 parts. + properties: + type: + type: string + description: '' + enum: + - ticket_part.list + example: ticket_part.list + ticket_parts: + title: Tickt Parts + type: array + description: A list of Ticket Part objects for each ticket. There is a limit + of 500 parts. + items: + "$ref": "#/components/schemas/ticket_part" + total_count: + type: integer + description: '' + example: 2 + ticket_reply: + title: A Ticket Part representing a note, comment, or quick_reply on a ticket + type: object + description: A Ticket Part representing a note, comment, or quick_reply on a + ticket + properties: + type: + type: string + description: Always ticket_part + example: ticket_part + enum: + - ticket_part + id: + type: string + description: The id representing the part. + example: '3' + part_type: + type: string + description: Type of the part + example: note + enum: + - note + - comment + - quick_reply + body: + type: string + nullable: true + description: The message body, which may contain HTML. + example: "

    Okay!

    " + created_at: + type: integer + format: date-time + description: The time the note was created. + example: 1663597223 + updated_at: + type: integer + format: date-time + description: The last time the note was updated. + example: 1663597260 + author: + "$ref": "#/components/schemas/ticket_part_author" + attachments: + title: Ticket part attachments + type: array + description: A list of attachments for the part. + items: + "$ref": "#/components/schemas/part_attachment" + redacted: + type: boolean + description: Whether or not the ticket part has been redacted. + example: false + ticket_request_custom_attributes: + title: Ticket Attributes + type: object + description: The attributes set on the ticket. When setting the default title + and description attributes, the attribute keys that should be used are `_default_title_` + and `_default_description_`. When setting ticket type attributes of the list + attribute type, the key should be the attribute name and the value of the + attribute should be the list item id, obtainable by [listing the ticket type](ref:get_ticket-types). + For example, if the ticket type has an attribute called `priority` of type + `list`, the key should be `priority` and the value of the attribute should + be the guid of the list item (e.g. `de1825a0-0164-4070-8ca6-13e22462fa7e`). + additionalProperties: + anyOf: + - type: string + nullable: true + - type: number + - type: boolean + - type: array + example: + _default_title_: Found a bug + _default_description_: The button is not working + ticket_type: + title: Ticket Type + type: object + x-tags: + - Tickets + description: A ticket type, used to define the data fields to be captured in + a ticket. + nullable: true + properties: + type: + type: string + description: String representing the object's type. Always has the value + `ticket_type`. + example: ticket_type + id: + type: string + description: The id representing the ticket type. + example: '1295' + category: + type: string + description: Category of the Ticket Type. + enum: + - Customer + - Back-office + - Tracker + example: Customer + name: + type: string + description: The name of the ticket type + example: Bug + description: + type: string + description: The description of the ticket type + example: A bug that has been reported. + icon: + type: string + description: The icon of the ticket type + example: "\U0001F41E" + workspace_id: + type: string + description: The id of the workspace that the ticket type belongs to. + example: ecahpwf5 + ticket_type_attributes: + "$ref": "#/components/schemas/ticket_type_attribute_list" + archived: + type: boolean + description: Whether the ticket type is archived or not. + example: false + created_at: + type: integer + format: timestamp + description: The date and time the ticket type was created. + updated_at: + type: integer + format: timestamp + description: The date and time the ticket type was last updated. + ticket_type_attribute: + title: Ticket Type Attribute + type: object + description: Ticket type attribute, used to define each data field to be captured + in a ticket. + nullable: true + properties: + type: + type: string + description: String representing the object's type. Always has the value + `ticket_type_attribute`. + example: ticket_type_attribute + id: + type: string + description: The id representing the ticket type attribute. + example: '1' + workspace_id: + type: string + description: The id of the workspace that the ticket type attribute belongs + to. + example: ecahpwf5 + name: + type: string + description: The name of the ticket type attribute + example: Title + description: + type: string + description: The description of the ticket type attribute + example: Bug title. + data_type: + type: string + description: 'The type of the data attribute (allowed values: "string list + integer decimal boolean datetime files")' + example: string + input_options: + type: object + description: Input options for the attribute + example: 'multiline: true' + order: + type: integer + description: The order of the attribute against other attributes + example: 1 + required_to_create: + type: boolean + description: Whether the attribute is required or not for teammates. + default: false + example: false + required_to_create_for_contacts: + type: boolean + description: Whether the attribute is required or not for contacts. + default: false + example: false + visible_on_create: + type: boolean + description: Whether the attribute is visible or not to teammates. + default: true + example: false + visible_to_contacts: + type: boolean + description: Whether the attribute is visible or not to contacts. + default: true + example: false + default: + type: boolean + description: Whether the attribute is built in or not. + example: true + ticket_type_id: + type: integer + description: The id of the ticket type that the attribute belongs to. + example: 42 + archived: + type: boolean + description: Whether the ticket type attribute is archived or not. + example: false + created_at: + type: integer + format: timestamp + description: The date and time the ticket type attribute was created. + updated_at: + type: integer + format: timestamp + description: The date and time the ticket type attribute was last updated. + ticket_type_attribute_list: + title: Ticket Type Attributes + type: object + description: A list of attributes associated with a given ticket type. + properties: + type: + type: string + description: String representing the object's type. Always has the value + `ticket_type_attributes.list`. + ticket_type_attributes: + type: array + description: A list of ticket type attributes associated with a given ticket + type. + items: + "$ref": "#/components/schemas/ticket_type_attribute" + ticket_type_list: + title: Ticket Types + type: object + description: A list of ticket types associated with a given workspace. + properties: + type: + type: string + description: String representing the object's type. Always has the value + `ticket_type.list`. + ticket_types: + type: array + description: A list of ticket_types associated with a given workspace. + items: + "$ref": "#/components/schemas/ticket_type" + translation: + title: Translation + type: object + description: A translation object contains the localised details of a subscription + type. + properties: + name: + type: string + description: The localised name of the subscription type. + example: Announcements + description: + type: string + description: The localised description of the subscription type. + example: Offers, product and feature announcements + locale: + type: string + description: The two character identifier for the language of the translation + object. + example: en + untag_company_request: + description: You can tag a single company or a list of companies. + type: object + title: Untag Company Request Payload + properties: + name: + type: string + description: The name of the tag which will be untagged from the company + example: Independent + companies: + type: array + items: + properties: + id: + type: string + description: The Intercom defined id representing the company. + example: 531ee472cce572a6ec000006 + company_id: + type: string + description: The company id you have defined for the company. + example: '6' + untag: + type: boolean + description: Always set to true + example: 'true' + description: The id or company_id of the company can be passed as input + parameters. + required: + - name + - companies + update_article_request: + description: You can Update an Article + type: object + title: Update Article Request Payload + nullable: true + properties: + title: + type: string + description: The title of the article.For multilingual articles, this will + be the title of the default language's content. + example: Thanks for everything + description: + type: string + description: The description of the article. For multilingual articles, + this will be the description of the default language's content. + example: Description of the Article + body: + type: string + description: The content of the article. For multilingual articles, this + will be the body of the default language's content. + example: "

    This is the body in html

    " + author_id: + type: integer + description: The id of the author of the article. For multilingual articles, + this will be the id of the author of the default language's content. Must + be a teammate on the help center's workspace. + example: 1295 + state: + type: string + description: Whether the article will be `published` or will be a `draft`. + Defaults to draft. For multilingual articles, this will be the state of + the default language's content. + enum: + - published + - draft + example: draft + parent_id: + type: string + description: The id of the article's parent collection or section. An article + without this field stands alone. + example: '18' + parent_type: + type: string + description: The type of parent, which can either be a `collection` or `section`. + example: collection + translated_content: + "$ref": "#/components/schemas/article_translated_content" + update_collection_request: + description: You can update a collection + type: object + title: Update Collection Request Payload + properties: + name: + type: string + description: The name of the collection. For multilingual collections, this + will be the name of the default language's content. + example: collection 51 + description: + type: string + description: The description of the collection. For multilingual collections, + this will be the description of the default language's content. + example: English description + translated_content: + nullable: true + "$ref": "#/components/schemas/group_translated_content" + parent_id: + type: string + nullable: true + description: The id of the parent collection. If `null` then it will be + updated as the first level collection. + example: '6871118' + update_contact_request: + description: You can update a contact + type: object + title: Update Contact Request Payload + properties: + role: + type: string + description: The role of the contact. + external_id: + type: string + description: A unique identifier for the contact which is given to Intercom + email: + type: string + description: The contacts email + example: jdoe@example.com + phone: + type: string + nullable: true + description: The contacts phone + example: "+353871234567" + name: + type: string + nullable: true + description: The contacts name + example: John Doe + avatar: + type: string + nullable: true + description: An image URL containing the avatar of a contact + example: https://www.example.com/avatar_image.jpg + signed_up_at: + type: integer + format: date-time + nullable: true + description: The time specified for when a contact signed up + example: 1571672154 + last_seen_at: + type: integer + format: date-time + nullable: true + description: The time when the contact was last seen (either where the Intercom + Messenger was installed or when specified manually) + example: 1571672154 + owner_id: + type: integer + nullable: true + description: The id of an admin that has been assigned account ownership + of the contact + example: 123 + unsubscribed_from_emails: + type: boolean + nullable: true + description: Whether the contact is unsubscribed from emails + example: true + custom_attributes: + type: object + nullable: true + description: The custom attributes which are set for the contact + update_conversation_request: + title: Update Conversation Request + type: object + description: Payload of the request to update a conversation + properties: + read: + type: boolean + description: Mark a conversation as read within Intercom. + example: true + custom_attributes: + "$ref": "#/components/schemas/custom_attributes" + update_data_attribute_request: + description: '' + type: object + title: Update Data Attribute Request + properties: + archived: + type: boolean + description: Whether the attribute is to be archived or not. + example: false + description: + type: string + description: The readable description you see in the UI for the attribute. + example: My Data Attribute Description + options: + type: array + description: To create list attributes. Provide a set of hashes with `value` + as the key of the options you want to make. `data_type` must be `string`. + items: + type: string + example: + - option1 + - option2 + messenger_writable: + type: boolean + description: Can this attribute be updated by the Messenger + example: false + update_ticket_request: + description: You can update a Ticket + type: object + title: Update Ticket Request Payload + properties: + ticket_attributes: + type: object + description: The attributes set on the ticket. + example: + title: example + description: having a problem + state: + type: string + enum: + - in_progress + - waiting_on_customer + - resolved + description: The state of the ticket. + example: submitted + open: + type: boolean + description: Specify if a ticket is open. Set to false to close a ticket. + Closing a ticket will also unsnooze it. + example: true + is_shared: + type: boolean + description: Specify whether the ticket is visible to users. + example: true + snoozed_until: + type: integer + format: timestamp + description: The time you want the ticket to reopen. + example: 1673609604 + assignment: + type: object + properties: + admin_id: + type: string + description: The ID of the admin performing the action. + example: '123' + assignee_id: + type: string + description: The ID of the admin or team to which the ticket is assigned. + Set this 0 to unassign it. + example: '123' + update_ticket_type_attribute_request: + description: You can update a Ticket Type Attribute + type: object + title: Update Ticket Type Attribute Request Payload + properties: + name: + type: string + description: The name of the ticket type attribute + example: Bug Priority + description: + type: string + description: The description of the attribute presented to the teammate + or contact + example: Priority level of the bug + required_to_create: + type: boolean + description: Whether the attribute is required to be filled in when teammates + are creating the ticket in Inbox. + default: false + example: false + required_to_create_for_contacts: + type: boolean + description: Whether the attribute is required to be filled in when contacts + are creating the ticket in Messenger. + default: false + example: false + visible_on_create: + type: boolean + description: Whether the attribute is visible to teammates when creating + a ticket in Inbox. + default: true + example: true + visible_to_contacts: + type: boolean + description: Whether the attribute is visible to contacts when creating + a ticket in Messenger. + default: true + example: true + multiline: + type: boolean + description: Whether the attribute allows multiple lines of text (only applicable + to string attributes) + example: false + list_items: + type: string + description: A comma delimited list of items for the attribute value (only + applicable to list attributes) + example: Low Priority,Medium Priority,High Priority + allow_multiple_values: + type: boolean + description: Whether the attribute allows multiple files to be attached + to it (only applicable to file attributes) + example: false + archived: + type: boolean + description: Whether the attribute should be archived and not shown during + creation of the ticket (it will still be present on previously created + tickets) + example: false + update_ticket_type_request: + description: | + The request payload for updating a ticket type. + You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/) + type: object + title: Update Ticket Type Request Payload + nullable: true + properties: + name: + type: string + description: The name of the ticket type. + example: Bug + description: + type: string + description: The description of the ticket type. + example: A bug has been occured + category: + type: string + description: Category of the Ticket Type. + enum: + - Customer + - Back-office + - Tracker + example: Customer + icon: + type: string + description: The icon of the ticket type. + example: "\U0001F41E" + default: "\U0001F39F️" + archived: + type: boolean + description: The archived status of the ticket type. + example: false + is_internal: + type: boolean + description: Whether the tickets associated with this ticket type are intended + for internal use only or will be shared with customers. This is currently + a limited attribute. + example: false + default: false + update_visitor_request: + description: Update an existing visitor. + type: object + title: Update Visitor Request Payload + properties: + id: + type: string + description: A unique identified for the visitor which is given by Intercom. + example: 8a88a590-e + user_id: + type: string + description: A unique identified for the visitor which is given by you. + example: '123' + name: + type: string + description: The visitor's name. + example: Christian Bale + custom_attributes: + type: object + description: The custom attributes which are set for the visitor. + additionalProperties: + type: string + example: + paid_subscriber: true + monthly_spend: 155.5 + team_mates: 9 + anyOf: + - required: + - id + - required: + - user_id + visitor: + title: Visitor + type: object + description: Visitors are useful for representing anonymous people that have + not yet been identified. They usually represent website visitors. Visitors + are not visible in Intercom platform. The Visitors resource provides methods + to fetch, update, convert and delete. + nullable: true + properties: + type: + type: string + description: Value is 'visitor' + default: visitor + example: visitor + id: + type: string + description: The Intercom defined id representing the Visitor. + example: 530370b477ad7120001d + user_id: + type: string + description: Automatically generated identifier for the Visitor. + example: 8a88a590-e1c3-41e2-a502-e0649dbf721c + anonymous: + type: boolean + description: Identifies if this visitor is anonymous. + example: false + email: + type: string + format: email + description: The email of the visitor. + example: jane.doe@example.com + phone: + type: string + nullable: true + description: The phone number of the visitor. + example: 555-555-5555 + name: + type: string + nullable: true + description: The name of the visitor. + example: Jane Doe + pseudonym: + type: string + nullable: true + description: The pseudonym of the visitor. + example: Red Duck from Dublin + avatar: + type: object + properties: + type: + type: string + description: '' + default: avatar + example: avatar + image_url: + type: string + format: uri + nullable: true + description: This object represents the avatar associated with the visitor. + example: https://example.com/avatar.png + app_id: + type: string + description: The id of the app the visitor is associated with. + example: hfi1bx4l + companies: + type: object + properties: + type: + type: string + description: The type of the object + enum: + - company.list + example: company.list + companies: + type: array + items: + "$ref": "#/components/schemas/company" + location_data: + type: object + properties: + type: + type: string + description: '' + default: location_data + example: location_data + city_name: + type: string + description: The city name of the visitor. + example: Dublin + continent_code: + type: string + description: The continent code of the visitor. + example: EU + country_code: + type: string + description: The country code of the visitor. + example: IRL + country_name: + type: string + description: The country name of the visitor. + example: Ireland + postal_code: + type: string + description: The postal code of the visitor. + example: D02 N960 + region_name: + type: string + description: The region name of the visitor. + example: Leinster + timezone: + type: string + description: The timezone of the visitor. + example: Europe/Dublin + las_request_at: + type: integer + description: The time the Lead last recorded making a request. + example: 1663597260 + created_at: + type: integer + description: The time the Visitor was added to Intercom. + example: 1663597223 + remote_created_at: + type: integer + description: The time the Visitor was added to Intercom. + example: 1663597223 + signed_up_at: + type: integer + description: The time the Visitor signed up for your product. + example: 1663597223 + updated_at: + type: integer + description: The last time the Visitor was updated. + example: 1663597260 + session_count: + type: integer + description: The number of sessions the Visitor has had. + example: 1 + social_profiles: + type: object + properties: + type: + type: string + description: The type of the object + enum: + - social_profile.list + example: social_profile.list + social_profiles: + type: array + items: + type: string + owner_id: + type: string + nullable: true + description: The id of the admin that owns the Visitor. + example: '5169261' + unsubscribed_from_emails: + type: boolean + description: Whether the Visitor is unsubscribed from emails. + example: false + marked_email_as_spam: + type: boolean + description: Identifies if this visitor has marked an email as spam. + example: false + has_hard_bounced: + type: boolean + description: Identifies if this visitor has had a hard bounce. + example: false + tags: + type: object + properties: + type: + type: string + description: The type of the object + enum: + - tag.list + example: tag.list + tags: + type: array + items: + properties: + type: + type: string + description: The type of the object + enum: + - tag + example: tag + id: + type: string + description: The id of the tag. + example: '8482' + name: + type: string + description: The name of the tag. + example: tag_name + segments: + type: object + properties: + type: + type: string + description: The type of the object + enum: + - segment.list + example: segment.list + segments: + type: array + items: + type: string + custom_attributes: + type: object + description: The custom attributes you have set on the Visitor. + additionalProperties: + type: string + referrer: + type: string + nullable: true + description: The referer of the visitor. + example: https://www.google.com/ + utm_campaign: + type: string + nullable: true + description: The utm_campaign of the visitor. + example: intercom-link + utm_content: + type: string + nullable: true + description: The utm_content of the visitor. + example: banner + utm_medium: + type: string + nullable: true + description: The utm_medium of the visitor. + example: email + utm_source: + type: string + nullable: true + description: The utm_source of the visitor. + example: Intercom + utm_term: + type: string + nullable: true + description: The utm_term of the visitor. + example: messenger + do_not_track: + type: boolean + nullable: true + description: Identifies if this visitor has do not track enabled. + example: false + visitor_deleted_object: + title: Visitor Deleted Object + type: object + description: Response returned when an object is deleted + properties: + id: + type: string + description: The unique identifier for the visitor which is given by Intercom. + example: 530370b477ad7120001d + type: + type: string + description: The type of object which was deleted + enum: + - visitor + example: visitor + user_id: + type: string + description: Automatically generated identifier for the Visitor. + example: 8a88a590-e1c3-41e2-a502-e0649dbf721c + securitySchemes: + bearerAuth: + type: http + scheme: bearer +servers: +- url: https://api.intercom.io + description: The production API server +- url: https://api.eu.intercom.io + description: The european API server +- url: https://api.au.intercom.io + description: The australian API server +security: +- bearerAuth: [] +tags: +- name: Admins + description: Everything about your Admins +- name: Articles + description: Everything about your Articles +- name: Companies + description: Everything about your Companies +- name: Contacts + description: Everything about your contacts +- name: Conversations + description: Everything about your Conversations + externalDocs: + description: What is a conversation? + url: https://www.intercom.com/help/en/articles/4323904-what-is-a-conversation +- name: Data Attributes + description: Everything about your Data Attributes +- name: Data Events + description: Everything about your Data Events +- name: Data Export + description: Everything about your Data Exports +- name: Help Center + description: Everything about your Help Center +- name: Messages + description: Everything about your messages +- name: News + description: Everything about your News + externalDocs: + description: News explained + url: https://www.intercom.com/help/en/articles/6362251-news-explained +- name: Notes + description: Everything about your Notes +- name: Segments + description: Everything about your Segments +- name: Subscription Types + description: Everything about subscription types +- name: Switch + description: Everything about Switch + externalDocs: + description: 'Meet Switch: from on hold to messaging in just a few taps' + url: https://www.intercom.com/switch +- name: Tags + description: Everything about tags +- name: Teams + description: Everything about your Teams +- name: Ticket Type Attributes + description: Everything about your ticket type attributes +- name: Ticket Types + description: Everything about your ticket types +- name: Tickets + description: Everything about your tickets +- name: Visitors + description: Everything about your Visitors diff --git a/descriptions/2.7/api.intercom.io.yaml b/descriptions/2.7/api.intercom.io.yaml index df92c2f..6dcccc4 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: '991280867' + id: '991269402' 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: 1712221889 + created_at: 1715076481 secure: false identity_verification: false timezone: America/Los_Angeles @@ -83,7 +83,7 @@ paths: Successful response: value: type: admin - id: '991280868' + id: '991269403' 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: 5cdbeff7-c7d5-416d-adf8-598b2ab31cfe + request_id: 5fb7a206-1d6c-4dc7-9727-1e7079b70bc5 errors: - code: admin_not_found message: Admin for admin_id not found @@ -114,7 +114,7 @@ paths: Unauthorized: value: type: error.list - request_id: b8d75e99-5518-4b84-ab63-375a9f790760 + request_id: b2028b2f-f118-4348-9af9-c5d355f1caa2 errors: - code: unauthorized message: Access Token Invalid @@ -201,10 +201,10 @@ paths: per_page: 20 total_pages: 1 activity_logs: - - id: 330482ee-36c8-41b3-a418-30c5d8cea1c2 + - id: e541acec-e122-4316-8fd8-8ef07fe37eb8 performed_by: type: admin - id: '991280871' + id: '991269407' email: admin5@email.com ip: 127.0.0.1 metadata: @@ -213,21 +213,21 @@ paths: title: Initial message title before: Initial message title after: Eventual message title - created_at: 1712221894 + created_at: 1715076487 activity_type: message_state_change activity_description: Ciaran5 Lee changed your Initial message title message from Initial message title to Eventual message title. - - id: f6723283-b187-4d96-b099-1bffae692b96 + - id: db413bdb-77b4-4d79-9ba9-05d06783ddd4 performed_by: type: admin - id: '991280871' + id: '991269407' email: admin5@email.com ip: 127.0.0.1 metadata: before: before after: after - created_at: 1712221894 + created_at: 1715076487 activity_type: app_name_change activity_description: Ciaran5 Lee changed your app name from before to after. @@ -241,7 +241,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9f7a1e99-09bf-47bb-a4ac-095f96626de3 + request_id: e72e2d73-797f-4c1d-9671-4a55db168a99 errors: - code: unauthorized message: Access Token Invalid @@ -271,7 +271,7 @@ paths: admins: - type: admin email: admin7@email.com - id: '991280873' + id: '991269409' name: Ciaran7 Lee away_mode_enabled: false away_mode_reassign: false @@ -287,7 +287,7 @@ paths: Unauthorized: value: type: error.list - request_id: ee0436fa-0896-4261-925b-7390376ca2d3 + request_id: 14798f99-16e6-4b72-891c-3f14773a03fa errors: - code: unauthorized message: Access Token Invalid @@ -321,7 +321,7 @@ paths: Admin found: value: type: admin - id: '991280875' + id: '991269411' 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: c6a920b7-4a63-4b8e-8467-092bb0b05156 + request_id: d67207b5-3866-4d31-abff-34a2750889d2 errors: - code: admin_not_found message: Admin not found @@ -352,7 +352,7 @@ paths: Unauthorized: value: type: error.list - request_id: 42f9f731-be0c-487a-92ab-9d5b62f5a827 + request_id: c7556a14-d8aa-46eb-8dbe-2fca75a5d02a errors: - code: unauthorized message: Access Token Invalid @@ -390,20 +390,20 @@ paths: total_pages: 1 total_count: 1 data: - - id: '569' + - id: '109' type: article workspace_id: this_is_an_id22_that_should_be_at_least_4 - parent_id: 2298 + parent_id: 430 parent_type: collection parent_ids: [] title: This is the article title description: '' body: '' - author_id: 991280878 + author_id: 991269414 state: published - created_at: 1712221899 - updated_at: 1712221899 - url: http://help-center.test/myapp-22/en/articles/569-this-is-the-article-title + created_at: 1715076492 + updated_at: 1715076492 + url: http://help-center.test/myapp-22/en/articles/109-this-is-the-article-title schema: "$ref": "#/components/schemas/article_list" '401': @@ -414,7 +414,7 @@ paths: Unauthorized: value: type: error.list - request_id: a1fc70ec-ec28-4524-b57a-85dcbd197715 + request_id: b6a13eaf-905b-442e-b663-cd622442621d errors: - code: unauthorized message: Access Token Invalid @@ -439,10 +439,10 @@ paths: examples: article created: value: - id: '572' + id: '112' type: article workspace_id: this_is_an_id26_that_should_be_at_least_4 - parent_id: 2300 + parent_id: 432 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: 991280883 + author_id: 991269419 state: published - created_at: 1712221902 - updated_at: 1712221902 - url: http://help-center.test/myapp-26/en/articles/572-thanks-for-everything + created_at: 1715076494 + updated_at: 1715076494 + url: http://help-center.test/myapp-26/en/articles/112-thanks-for-everything schema: "$ref": "#/components/schemas/article" '400': @@ -471,7 +471,7 @@ paths: Bad Request: value: type: error.list - request_id: ea1dcf01-6efb-4495-b70a-48ebafee25e8 + request_id: '08b07eff-b4b1-456c-a4b7-60a593fceb8c' 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: aea56747-8242-46f4-8b6d-bca4d3f22a0b + request_id: 9932c8b5-d50c-4523-86c5-c5ce399baa53 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: 991280883 + author_id: 991269419 state: published - parent_id: 2300 + parent_id: 432 parent_type: collection translated_content: fr: title: Merci pour tout description: Description de l'article body: Corps de l'article - author_id: 991280883 + author_id: 991269419 state: published bad_request: summary: Bad Request @@ -550,10 +550,10 @@ paths: examples: Article found: value: - id: '575' + id: '115' type: article workspace_id: this_is_an_id32_that_should_be_at_least_4 - parent_id: 2303 + parent_id: 435 parent_type: collection parent_ids: [] statistics: @@ -567,11 +567,11 @@ paths: title: This is the article title description: '' body: '' - author_id: 991280888 + author_id: 991269424 state: published - created_at: 1712221903 - updated_at: 1712221903 - url: http://help-center.test/myapp-32/en/articles/575-this-is-the-article-title + created_at: 1715076496 + updated_at: 1715076496 + url: http://help-center.test/myapp-32/en/articles/115-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: 0b5c883c-b235-44c0-acf3-76a6120b45c1 + request_id: a5767900-97d4-4de7-ae76-a1409ff22950 errors: - code: not_found message: Resource Not Found @@ -596,7 +596,7 @@ paths: Unauthorized: value: type: error.list - request_id: 5fe8cc2e-fbe5-4a48-93c9-f26b12ed5821 + request_id: a736b646-9229-4cd4-8d12-1d293a83beb0 errors: - code: unauthorized message: Access Token Invalid @@ -629,10 +629,10 @@ paths: examples: successful: value: - id: '578' + id: '118' type: article workspace_id: this_is_an_id38_that_should_be_at_least_4 - parent_id: 2306 + parent_id: 438 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: 991280894 + author_id: 991269430 state: published - created_at: 1712221906 - updated_at: 1712221906 - url: http://help-center.test/myapp-38/en/articles/578-christmas-is-here + created_at: 1715076498 + updated_at: 1715076499 + url: http://help-center.test/myapp-38/en/articles/118-christmas-is-here schema: "$ref": "#/components/schemas/article" '404': @@ -661,7 +661,7 @@ paths: Article Not Found: value: type: error.list - request_id: 82558eda-cb73-4eb9-8e4a-67b8e1fd618c + request_id: c930e5e6-c8c8-4db6-a513-2455812629ca errors: - code: not_found message: Resource Not Found @@ -675,7 +675,7 @@ paths: Unauthorized: value: type: error.list - request_id: 4907bc86-6b73-4407-974e-e0d1969f0887 + request_id: 4bf559b1-cc23-49e2-be34-9a01090db040 errors: - code: unauthorized message: Access Token Invalid @@ -723,7 +723,7 @@ paths: examples: successful: value: - id: '581' + id: '121' object: article deleted: true schema: @@ -736,7 +736,7 @@ paths: Article Not Found: value: type: error.list - request_id: 55f43e66-3ba4-4c36-92e6-f6223a4f72e8 + request_id: 030f3be0-385f-4d77-9613-b1b31b0c2a87 errors: - code: not_found message: Resource Not Found @@ -750,7 +750,7 @@ paths: Unauthorized: value: type: error.list - request_id: 40aded55-5c0e-4016-b343-a316e4763f7e + request_id: d2e5a4fc-eeb0-49de-a264-88ba819a8310 errors: - code: unauthorized message: Access Token Invalid @@ -781,16 +781,16 @@ paths: value: type: list data: - - id: '2314' + - id: '446' 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: 1712221911 - updated_at: 1712221911 + created_at: 1715076503 + updated_at: 1715076503 description: english collection description icon: bookmark - help_center_id: 1122 + help_center_id: 218 type: collection total_count: 1 pages: @@ -808,7 +808,7 @@ paths: Unauthorized: value: type: error.list - request_id: e448f2c7-cdbb-4abc-b925-ae439481a056 + request_id: e0a8b2c5-1f22-4a4c-92b7-5042e4c52ba2 errors: - code: unauthorized message: Access Token Invalid @@ -833,16 +833,16 @@ paths: examples: collection created: value: - id: '2320' + id: '452' 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: 1712221913 - updated_at: 1712221913 + created_at: 1715076504 + updated_at: 1715076504 description: '' icon: book-bookmark - help_center_id: 1124 + help_center_id: 220 type: collection schema: "$ref": "#/components/schemas/collection" @@ -854,7 +854,7 @@ paths: Bad Request: value: type: error.list - request_id: 9f39a12b-ed8a-4bcb-897e-c30ced61133a + request_id: 504437d1-4195-49f2-9df1-b197111695eb errors: - code: parameter_not_found message: Name is a required parameter. @@ -868,7 +868,7 @@ paths: Unauthorized: value: type: error.list - request_id: 6833c726-42e1-44bd-998e-281ddfb9598e + request_id: d016ba9a-301a-448e-98ec-fab5e1cfb417 errors: - code: unauthorized message: Access Token Invalid @@ -916,16 +916,16 @@ paths: examples: Collection found: value: - id: '2325' + id: '457' 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: 1712221914 - updated_at: 1712221914 + created_at: 1715076505 + updated_at: 1715076505 description: english collection description icon: bookmark - help_center_id: 1127 + help_center_id: 223 type: collection schema: "$ref": "#/components/schemas/collection" @@ -937,7 +937,7 @@ paths: Collection not found: value: type: error.list - request_id: 95cb13e7-2b7e-4b09-9159-ca8bed5de1df + request_id: fa3902b6-6600-4d1c-92cb-52e7cfbfd7b1 errors: - code: not_found message: Resource Not Found @@ -951,7 +951,7 @@ paths: Unauthorized: value: type: error.list - request_id: d1c89e3d-5b72-45b6-93ed-58336a34f0d7 + request_id: e4a11df6-cf92-4f28-af47-bb80c913aa06 errors: - code: unauthorized message: Access Token Invalid @@ -984,16 +984,16 @@ paths: examples: successful: value: - id: '2331' + id: '463' 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: 1712221915 - updated_at: 1712221916 + created_at: 1715076507 + updated_at: 1715076507 description: english collection description icon: folder - help_center_id: 1130 + help_center_id: 226 type: collection schema: "$ref": "#/components/schemas/collection" @@ -1005,7 +1005,7 @@ paths: Collection Not Found: value: type: error.list - request_id: d660e3c0-7f8f-4fc4-9287-dc141f3e3d90 + request_id: 9dd899eb-f53c-4bb1-aba4-f0630b208e13 errors: - code: not_found message: Resource Not Found @@ -1019,7 +1019,7 @@ paths: Unauthorized: value: type: error.list - request_id: d432b763-901f-4bbc-991c-13f581ced48f + request_id: 2062d54f-49f0-4e15-a4ce-303b538738f8 errors: - code: unauthorized message: Access Token Invalid @@ -1066,7 +1066,7 @@ paths: examples: successful: value: - id: '2337' + id: '469' object: collection deleted: true schema: @@ -1079,7 +1079,7 @@ paths: collection Not Found: value: type: error.list - request_id: 79f14725-faf1-41c0-8617-758da35b0cd7 + request_id: 87cc0800-3a56-48a8-b9df-59bff1faf4d5 errors: - code: not_found message: Resource Not Found @@ -1093,7 +1093,7 @@ paths: Unauthorized: value: type: error.list - request_id: 7d97cf99-744b-47f0-b98d-11ec7238515a + request_id: 7c2564f7-c8d2-4976-814c-6e19fb66fb01 errors: - code: unauthorized message: Access Token Invalid @@ -1127,10 +1127,10 @@ paths: examples: Collection found: value: - id: '1136' + id: '232' workspace_id: this_is_an_id80_that_should_be_at_least_4 - created_at: 1712221919 - updated_at: 1712221919 + created_at: 1715076510 + updated_at: 1715076510 identifier: help-center-1 website_turned_on: false display_name: Intercom Help Center @@ -1144,7 +1144,7 @@ paths: Collection not found: value: type: error.list - request_id: 9aabac9b-4f06-4c63-8730-fba4483c19e0 + request_id: 922a325a-17c6-410d-89b3-c0b6fcd9280a errors: - code: not_found message: Resource Not Found @@ -1158,7 +1158,7 @@ paths: Unauthorized: value: type: error.list - request_id: 78f7775c-0a24-4dfc-8501-c4ed8363e3e4 + request_id: 52f49638-4a4e-45f8-b0dd-4e0225e7a380 errors: - code: unauthorized message: Access Token Invalid @@ -1196,7 +1196,7 @@ paths: Unauthorized: value: type: error.list - request_id: 4002e0bd-f4c3-45f7-b5f2-27e3faca3715 + request_id: 547f9167-d8ca-4bc2-a9ee-915daf40d9ad errors: - code: unauthorized message: Access Token Invalid @@ -1228,15 +1228,15 @@ paths: value: type: list data: - - id: '2344' + - id: '476' 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: 1712221921 - updated_at: 1712221921 + created_at: 1715076512 + updated_at: 1715076512 type: section - parent_id: 2343 + parent_id: 475 total_count: 1 pages: type: pages @@ -1253,7 +1253,7 @@ paths: Unauthorized: value: type: error.list - request_id: fd502070-8233-4ec4-828e-10fac0b1ffe8 + request_id: ef27fe20-ac67-441f-b6d1-827ed863d35d errors: - code: unauthorized message: Access Token Invalid @@ -1278,15 +1278,15 @@ paths: examples: section created: value: - id: '2349' + id: '481' 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: 1712221922 - updated_at: 1712221922 + created_at: 1715076514 + updated_at: 1715076514 type: section - parent_id: '2347' + parent_id: '479' schema: "$ref": "#/components/schemas/section" '401': @@ -1297,7 +1297,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2e180986-0d5b-45dc-aa32-31d8311c9bf3 + request_id: ad8694c3-3641-4187-ba99-0e27b9df6f22 errors: - code: unauthorized message: Access Token Invalid @@ -1313,7 +1313,7 @@ paths: summary: section created value: name: Thanks for everything - parent_id: 2347 + parent_id: 479 "/help_center/sections/{id}": get: summary: Retrieve a section @@ -1342,15 +1342,15 @@ paths: examples: Section found: value: - id: '2353' + id: '485' 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: 1712221923 - updated_at: 1712221923 + created_at: 1715076514 + updated_at: 1715076514 type: section - parent_id: 2352 + parent_id: 484 schema: "$ref": "#/components/schemas/section" '404': @@ -1361,7 +1361,7 @@ paths: Section not found: value: type: error.list - request_id: 31d3c912-3fa2-45a0-9a6a-929fe99c5678 + request_id: e5b20df7-4798-4d43-9797-739bf7dc65ac errors: - code: not_found message: Resource Not Found @@ -1375,7 +1375,7 @@ paths: Unauthorized: value: type: error.list - request_id: affd19c2-543e-44ba-a628-3c9faf562955 + request_id: 2bee41a2-25ac-4553-a3d8-bc5edf412dc6 errors: - code: unauthorized message: Access Token Invalid @@ -1408,15 +1408,15 @@ paths: examples: successful: value: - id: '2359' + id: '491' 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: 1712221924 - updated_at: 1712221925 + created_at: 1715076515 + updated_at: 1715076516 type: section - parent_id: '2358' + parent_id: '490' schema: "$ref": "#/components/schemas/section" '404': @@ -1427,7 +1427,7 @@ paths: Section Not Found: value: type: error.list - request_id: 6c32989f-233f-4bf2-b76c-a0087e152988 + request_id: 011bc095-d8f9-4a87-980c-f8315778fd3e errors: - code: not_found message: Resource Not Found @@ -1441,7 +1441,7 @@ paths: Unauthorized: value: type: error.list - request_id: 90875c08-4275-4f72-ac4a-734f93a6a7d8 + request_id: 3e3654b2-53f4-4427-b6ad-54266cc799e7 errors: - code: unauthorized message: Access Token Invalid @@ -1457,12 +1457,12 @@ paths: summary: successful value: name: Update section name - parent_id: 2358 + parent_id: 490 section_not_found: summary: Section Not Found value: name: Update section name - parent_id: 2360 + parent_id: 492 delete: summary: Delete a section parameters: @@ -1489,7 +1489,7 @@ paths: examples: successful: value: - id: '2365' + id: '497' object: section deleted: true schema: @@ -1502,7 +1502,7 @@ paths: section Not Found: value: type: error.list - request_id: '052419d7-e6a1-4481-9243-91a71678c0cf' + request_id: cb9d9b7f-d986-409a-9db8-efac4beee37e errors: - code: not_found message: Resource Not Found @@ -1516,7 +1516,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9c9a6410-60f4-41f1-ad0b-e0fcbc9da2b3 + request_id: bac3de86-2c42-4a05-bfcc-ff8fcfbc43fa errors: - code: unauthorized message: Access Token Invalid @@ -1553,12 +1553,12 @@ paths: value: type: company company_id: company_remote_id - id: 660e6ee86abd01b859dcb272 + id: 6639fda72d114e004ff1215d app_id: this_is_an_id116_that_should_be_at_least_ name: my company remote_created_at: 1374138000 - created_at: 1712221928 - updated_at: 1712221928 + created_at: 1715076519 + updated_at: 1715076519 monthly_spend: 0 session_count: 0 user_count: 0 @@ -1595,7 +1595,7 @@ paths: Unauthorized: value: type: error.list - request_id: f2cfc59c-bbda-4310-b62e-7f9db6b36f40 + request_id: '03780eef-8d73-4480-9d6c-5aef182fd1e1' errors: - code: unauthorized message: Access Token Invalid @@ -1693,12 +1693,12 @@ paths: data: - type: company company_id: remote_companies_scroll_2 - id: 660e6ee96abd01b859dcb27a + id: 6639fda92d114e004ff12165 app_id: this_is_an_id122_that_should_be_at_least_ name: IntercomQATest1 - remote_created_at: 1712221929 - created_at: 1712221929 - updated_at: 1712221929 + remote_created_at: 1715076521 + created_at: 1715076521 + updated_at: 1715076521 monthly_spend: 0 session_count: 0 user_count: 4 @@ -1727,7 +1727,7 @@ paths: Company Not Found: value: type: error.list - request_id: 3aa9666e-719b-4c37-82bc-9e32b5498335 + request_id: 22d1e80b-93ac-4911-98c5-5996801fdb1f errors: - code: company_not_found message: Company Not Found @@ -1741,7 +1741,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9c0ddced-a2d1-4572-8f3c-cb23b740a49d + request_id: d889d1fa-c0aa-4de3-828b-c071ed0305c0 errors: - code: unauthorized message: Access Token Invalid @@ -1776,12 +1776,12 @@ paths: value: type: company company_id: '1' - id: 660e6eec6abd01b859dcb285 + id: 6639fdab2d114e004ff12170 app_id: this_is_an_id128_that_should_be_at_least_ name: company1 - remote_created_at: 1712221932 - created_at: 1712221932 - updated_at: 1712221932 + remote_created_at: 1715076523 + created_at: 1715076523 + updated_at: 1715076523 monthly_spend: 0 session_count: 0 user_count: 1 @@ -1803,7 +1803,7 @@ paths: Company Not Found: value: type: error.list - request_id: 7324d870-6c70-4758-bf93-b42c0e6c4fb2 + request_id: ef609f5a-b6f6-4529-bbed-a0b0db0d7880 errors: - code: company_not_found message: Company Not Found @@ -1817,7 +1817,7 @@ paths: Unauthorized: value: type: error.list - request_id: f68d389c-a42f-4e28-9264-52ad065f896e + request_id: 9dca773c-2074-4c52-97e6-e16696dc90d6 errors: - code: unauthorized message: Access Token Invalid @@ -1856,12 +1856,12 @@ paths: value: type: company company_id: '1' - id: 660e6eee6abd01b859dcb28f + id: 6639fdad2d114e004ff1217a app_id: this_is_an_id134_that_should_be_at_least_ name: company2 - remote_created_at: 1712221934 - created_at: 1712221934 - updated_at: 1712221934 + remote_created_at: 1715076525 + created_at: 1715076525 + updated_at: 1715076525 monthly_spend: 0 session_count: 0 user_count: 1 @@ -1883,7 +1883,7 @@ paths: Company Not Found: value: type: error.list - request_id: e4279688-56d5-4b9d-ae32-95923208c258 + request_id: 51f06f2d-359d-407a-9fa9-df532b9626f7 errors: - code: company_not_found message: Company Not Found @@ -1897,7 +1897,7 @@ paths: Unauthorized: value: type: error.list - request_id: b8f63a27-68ba-4e83-86f8-a312de0155af + request_id: 3638e48a-94ed-4d57-afd9-8f169bb2db62 errors: - code: unauthorized message: Access Token Invalid @@ -1929,7 +1929,7 @@ paths: examples: Successful: value: - id: 660e6ef06abd01b859dcb299 + id: 6639fdb02d114e004ff12184 object: company deleted: true schema: @@ -1942,7 +1942,7 @@ paths: Company Not Found: value: type: error.list - request_id: 2999afe9-b052-47b2-b087-bf2ad311a124 + request_id: f9b8cdab-7965-4b46-be1f-f55bfafc9020 errors: - code: company_not_found message: Company Not Found @@ -1956,7 +1956,7 @@ paths: Unauthorized: value: type: error.list - request_id: 159cb39e-d64d-4f49-a10f-781e16acdb2b + request_id: 53eeb8e8-803e-468b-80c7-a83ea00c2839 errors: - code: unauthorized message: Access Token Invalid @@ -2008,7 +2008,7 @@ paths: Company Not Found: value: type: error.list - request_id: 003b2787-636f-4181-ab18-e7a65930912e + request_id: ee1dd6aa-50c8-4a6f-8572-a3d6b1f3a274 errors: - code: company_not_found message: Company Not Found @@ -2022,7 +2022,7 @@ paths: Unauthorized: value: type: error.list - request_id: 1e37dad4-c633-4746-acd7-1708267f5a3b + request_id: 30faac12-9ea9-4234-8242-18430cbdedf6 errors: - code: unauthorized message: Access Token Invalid @@ -2067,7 +2067,7 @@ paths: Company Not Found: value: type: error.list - request_id: 4c1d2d40-d80f-40d3-b9f8-137f7983742d + request_id: 6cc19072-97a2-4db9-aa5f-a5bd9b8b309d errors: - code: company_not_found message: Company Not Found @@ -2081,7 +2081,7 @@ paths: Unauthorized: value: type: error.list - request_id: 99b23413-13e5-4c6c-bda7-9a0a1477839c + request_id: 4cb0855d-35b4-4cce-bcb1-ece1e89e3a50 errors: - code: unauthorized message: Access Token Invalid @@ -2098,14 +2098,14 @@ paths: - name: page in: query required: false - description: what page of results to fetch. Defaults to first page + description: The page of results to fetch. Defaults to first page example: 1 schema: type: integer - name: per_page in: query required: false - description: how many results per page. Defaults to 15 + description: How many results to return per page. Defaults to 15 example: 15 schema: type: integer @@ -2126,6 +2126,10 @@ paths: Note that the API does not include companies who have no associated users in list responses. When using the Companies endpoint and the pages object to iterate through the returned companies, there is a limit of 10,000 Companies that can be returned. If you need to list or iterate on more than 10,000 Companies, please use the [Scroll API](https://developers.intercom.com/reference#iterating-over-all-companies). + {% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `20` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. + {% /admonition %} responses: '200': description: Successful @@ -2138,12 +2142,12 @@ paths: data: - type: company company_id: remote_companies_scroll_2 - id: 660e6ef66abd01b859dcb2b5 + id: 6639fdb62d114e004ff121a0 app_id: this_is_an_id158_that_should_be_at_least_ name: IntercomQATest1 - remote_created_at: 1712221942 - created_at: 1712221942 - updated_at: 1712221942 + remote_created_at: 1715076534 + created_at: 1715076534 + updated_at: 1715076534 monthly_spend: 0 session_count: 0 user_count: 4 @@ -2172,7 +2176,7 @@ paths: Unauthorized: value: type: error.list - request_id: ac45f115-6732-4399-81d7-5a67cfffadf6 + request_id: 6932c0cc-ac62-4188-8c79-193dfb0efc3b errors: - code: unauthorized message: Access Token Invalid @@ -2195,23 +2199,22 @@ paths: tags: - Companies operationId: scrollOverAllCompanies - description: " The `list all companies` functionality does not work well - for huge datasets, and can result in errors and performance problems when - paging deeply. The Scroll API provides an efficient mechanism for iterating - over all companies in a dataset.\n\n- Each app can only have 1 scroll open - at a time. You'll get an error message if you try to have more than one open - per app.\n- If the scroll isn't used for 1 minute, it expires and calls with - that scroll param will fail\n- If the end of the scroll is reached, \"companies\" - will be empty and the scroll parameter will expire\n\n> \U0001F4D8 Scroll - Parameter\n>\n> You can get the first page of companies by simply sending - a GET request to the scroll endpoint. For subsequent requests you will need - to use the scroll parameter from the response.\n\n> ❗️ Scroll network timeouts\n>\n> - Since scroll is often used on large datasets network errors such as timeouts - can be encountered. When this occurs you will need to restart your scroll - query as it is not possible to continue from a specific point when using scroll.\n>\n> - When this occurs you will see a HTTP 500 error with the following message:\n> - \"Request failed due to an internal network error. Please restart the scroll - operation.\"\n" + description: |2 + The `list all companies` functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. The Scroll API provides an efficient mechanism for iterating over all companies in a dataset. + + - Each app can only have 1 scroll open at a time. You'll get an error message if you try to have more than one open per app. + - If the scroll isn't used for 1 minute, it expires and calls with that scroll param will fail + - If the end of the scroll is reached, "companies" will be empty and the scroll parameter will expire + + {% admonition type="info" name="Scroll Parameter" %} + You can get the first page of companies by simply sending a GET request to the scroll endpoint. + For subsequent requests you will need to use the scroll parameter from the response. + {% /admonition %} + {% admonition type="danger" name="Scroll network timeouts" %} + Since scroll is often used on large datasets network errors such as timeouts can be encountered. When this occurs you will see a HTTP 500 error with the following message: + "Request failed due to an internal network error. Please restart the scroll operation." + If this happens, you will need to restart your scroll query: It is not possible to continue from a specific point when using scroll. + {% /admonition %} responses: '200': description: Successful @@ -2224,12 +2227,12 @@ paths: data: - type: company company_id: remote_companies_scroll_2 - id: 660e6ef86abd01b859dcb2bb + id: 6639fdb72d114e004ff121a6 app_id: this_is_an_id162_that_should_be_at_least_ name: IntercomQATest1 - remote_created_at: 1712221944 - created_at: 1712221944 - updated_at: 1712221944 + remote_created_at: 1715076535 + created_at: 1715076535 + updated_at: 1715076535 monthly_spend: 0 session_count: 0 user_count: 4 @@ -2243,7 +2246,7 @@ paths: custom_attributes: {} pages: total_count: - scroll_param: 7ba83bc6-60f9-4362-abd5-a6e6b86d01fd + scroll_param: 5f2cd945-3b4b-4897-a354-249f23961fe8 schema: "$ref": "#/components/schemas/company_scroll" '401': @@ -2254,7 +2257,7 @@ paths: Unauthorized: value: type: error.list - request_id: 70753609-dcd3-4992-aa09-49f1316bea37 + request_id: 0f3d471d-40c3-4c36-9c10-c5b3d2c0655c errors: - code: unauthorized message: Access Token Invalid @@ -2289,12 +2292,12 @@ paths: value: type: company company_id: '1' - id: 660e6efa6abd01b859dcb2c4 + id: 6639fdb92d114e004ff121af app_id: this_is_an_id166_that_should_be_at_least_ name: company6 - remote_created_at: 1712221946 - created_at: 1712221946 - updated_at: 1712221946 + remote_created_at: 1715076537 + created_at: 1715076537 + updated_at: 1715076537 monthly_spend: 0 session_count: 0 user_count: 1 @@ -2316,7 +2319,7 @@ paths: Bad Request: value: type: error.list - request_id: 3daa256c-6611-42d4-9a60-9a8431f1ce61 + request_id: 17a28844-6507-4de9-b864-5f5f483ce809 errors: - code: parameter_not_found message: company not specified @@ -2330,7 +2333,7 @@ paths: Company Not Found: value: type: error.list - request_id: a2696230-8b00-4223-ad8a-20f43cca6c69 + request_id: '0489daa7-b20b-4883-b10c-cb19b6642268' errors: - code: company_not_found message: Company Not Found @@ -2344,7 +2347,7 @@ paths: Unauthorized: value: type: error.list - request_id: 719bfebf-adca-4154-b247-b9ee6ff559da + request_id: 541b67ff-0cab-40b2-a593-5e7be623e9cd errors: - code: unauthorized message: Access Token Invalid @@ -2367,7 +2370,7 @@ paths: successful: summary: Successful value: - id: 660e6efa6abd01b859dcb2c4 + id: 6639fdb92d114e004ff121af bad_request: summary: Bad Request value: @@ -2406,13 +2409,13 @@ paths: data: - type: company company_id: '1' - id: 660e6f006abd01b859dcb2e5 + id: 6639fdbf2d114e004ff121d0 app_id: this_is_an_id182_that_should_be_at_least_ name: company12 - remote_created_at: 1712221952 - created_at: 1712221952 - updated_at: 1712221952 - last_request_at: 1712049152 + remote_created_at: 1715076543 + created_at: 1715076543 + updated_at: 1715076543 + last_request_at: 1714903743 monthly_spend: 0 session_count: 0 user_count: 1 @@ -2441,7 +2444,7 @@ paths: Contact not found: value: type: error.list - request_id: b2ad5884-3875-408b-9a43-bd2d20fea7ee + request_id: dc4d73e9-4bba-4ee8-a309-4f1632dd4a27 errors: - code: not_found message: User Not Found @@ -2455,7 +2458,7 @@ paths: Unauthorized: value: type: error.list - request_id: ec98b8bb-42ca-4aa9-a82a-2f0527457655 + request_id: 2599ff69-f3f8-4c7d-bb90-2813686fa032 errors: - code: unauthorized message: Access Token Invalid @@ -2498,12 +2501,12 @@ paths: value: type: company company_id: '1' - id: 660e6efc6abd01b859dcb2d4 + id: 6639fdbc2d114e004ff121bf app_id: this_is_an_id174_that_should_be_at_least_ name: company8 - remote_created_at: 1712221948 - created_at: 1712221949 - updated_at: 1712221949 + remote_created_at: 1715076540 + created_at: 1715076540 + updated_at: 1715076540 monthly_spend: 0 session_count: 0 user_count: 0 @@ -2525,14 +2528,14 @@ paths: Company Not Found: value: type: error.list - request_id: ae937d78-7d4d-4dc1-a56c-d86264a4c663 + request_id: 233d74ae-be5a-4d3e-8282-6a5254a5bfb7 errors: - code: company_not_found message: Company Not Found Contact Not Found: value: type: error.list - request_id: fda7ba7c-052d-4496-a433-070e8d0ee2e8 + request_id: 588c0609-b51e-4422-a0a9-ab2320b28bde errors: - code: not_found message: User Not Found @@ -2546,7 +2549,7 @@ paths: Unauthorized: value: type: error.list - request_id: be1d7e27-05ac-469a-bd4a-230c45c1cc3a + request_id: 19d9db4e-af57-4d38-a461-ea1149118978 errors: - code: unauthorized message: Access Token Invalid @@ -2582,42 +2585,42 @@ paths: type: list data: - type: note - id: '400' - created_at: 1711617154 + id: '81' + created_at: 1714471745 contact: type: contact - id: 660e6f026abd01b859dcb2f0 + id: 6639fdc12d114e004ff121db author: type: admin - id: '991280976' + id: '991269512' name: Ciaran110 Lee email: admin110@email.com away_mode_enabled: false away_mode_reassign: false body: "

    This is a note.

    " - type: note - id: '399' - created_at: 1711530754 + id: '80' + created_at: 1714385345 contact: type: contact - id: 660e6f026abd01b859dcb2f0 + id: 6639fdc12d114e004ff121db author: type: admin - id: '991280976' + id: '991269512' name: Ciaran110 Lee email: admin110@email.com away_mode_enabled: false away_mode_reassign: false body: "

    This is a note.

    " - type: note - id: '398' - created_at: 1711530754 + id: '79' + created_at: 1714385345 contact: type: contact - id: 660e6f026abd01b859dcb2f0 + id: 6639fdc12d114e004ff121db author: type: admin - id: '991280976' + id: '991269512' name: Ciaran110 Lee email: admin110@email.com away_mode_enabled: false @@ -2640,7 +2643,7 @@ paths: Contact not found: value: type: error.list - request_id: '097ed6a1-4bb9-48a7-bd74-053694eaf356' + request_id: 73ddaf27-67d6-4579-a4f9-3ef4ae155e79 errors: - code: not_found message: User Not Found @@ -2674,14 +2677,14 @@ paths: Successful response: value: type: note - id: '405' - created_at: 1712221956 + id: '86' + created_at: 1715076547 contact: type: contact - id: 660e6f036abd01b859dcb2f2 + id: 6639fdc22d114e004ff121dd author: type: admin - id: '991280978' + id: '991269514' name: Ciaran112 Lee email: admin112@email.com away_mode_enabled: false @@ -2697,14 +2700,14 @@ paths: Admin not found: value: type: error.list - request_id: 808075e9-c7f5-4800-aa54-a5ca30008409 + request_id: f4974a42-bb06-4b12-b49e-938a148baab5 errors: - code: not_found message: Resource Not Found Contact not found: value: type: error.list - request_id: 37e7afd3-fe34-48ea-91e2-54ea883db115 + request_id: e90f0abd-5dff-4337-a8a2-d5f0f637357d errors: - code: not_found message: User Not Found @@ -2734,20 +2737,20 @@ paths: successful_response: summary: Successful response value: - contact_id: 660e6f036abd01b859dcb2f2 - admin_id: 991280978 + contact_id: 6639fdc22d114e004ff121dd + admin_id: 991269514 body: Hello admin_not_found: summary: Admin not found value: - contact_id: 660e6f046abd01b859dcb2f3 + contact_id: 6639fdc32d114e004ff121de admin_id: 123 body: Hello contact_not_found: summary: Contact not found value: contact_id: 123 - admin_id: 991280980 + admin_id: 991269516 body: Hello "/contacts/{contact_id}/segments": get: @@ -2780,10 +2783,10 @@ paths: type: list data: - type: segment - id: 660e6f056abd01b859dcb2f5 + id: 6639fdc42d114e004ff121e0 name: segment - created_at: 1712221957 - updated_at: 1712221957 + created_at: 1715076548 + updated_at: 1715076548 person_type: user schema: "$ref": "#/components/schemas/contact_segments" @@ -2795,7 +2798,7 @@ paths: Contact not found: value: type: error.list - request_id: 971982e0-192e-49f2-852c-afa32b6a8b28 + request_id: 905f9a8e-41bb-435f-840f-36215f83b1ea errors: - code: not_found message: User Not Found @@ -2809,7 +2812,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8272b3f6-52b3-48c5-8bd4-4ed3a19f18ab + request_id: e48e5326-1956-48e0-a690-369a83e1c1d2 errors: - code: unauthorized message: Access Token Invalid @@ -2853,7 +2856,7 @@ paths: type: list data: - type: subscription - id: '1423' + id: '277' state: live consent_type: opt_out default_translation: @@ -2867,7 +2870,7 @@ paths: content_types: - email - type: subscription - id: '1425' + id: '279' state: live consent_type: opt_in default_translation: @@ -2890,7 +2893,7 @@ paths: Contact not found: value: type: error.list - request_id: d7f348ca-f89e-4c5b-96d3-d0dc1691dcdd + request_id: 55b12862-12bb-40fe-a3cf-73a7a059b2dc errors: - code: not_found message: User Not Found @@ -2904,7 +2907,7 @@ paths: Unauthorized: value: type: error.list - request_id: 264dced2-0a64-4b47-a131-8b2e41d80cf9 + request_id: 1f82a60a-2d3c-4d77-a636-afe3ebed7f70 errors: - code: unauthorized message: Access Token Invalid @@ -2945,7 +2948,7 @@ paths: Successful: value: type: subscription - id: '1438' + id: '292' state: live consent_type: opt_in default_translation: @@ -2968,14 +2971,14 @@ paths: Contact not found: value: type: error.list - request_id: '099883b3-5a2f-48df-85ef-bbab57a78612' + request_id: c1320f2c-22d2-4133-9c99-76eae8e15196 errors: - code: not_found message: User Not Found Resource not found: value: type: error.list - request_id: 49f21d14-a37c-4c41-b158-5e7342507056 + request_id: 7f4144e2-ece6-40ad-90c2-d4bd53f03f3c errors: - code: not_found message: Resource Not Found @@ -2989,7 +2992,7 @@ paths: Unauthorized: value: type: error.list - request_id: 934b137b-7288-4d42-b6da-123862dcd73b + request_id: 5cebf2e0-9667-4509-8656-08f769f7cfac errors: - code: unauthorized message: Access Token Invalid @@ -3017,12 +3020,12 @@ paths: successful: summary: Successful value: - id: 1438 + id: 292 consent_type: opt_in contact_not_found: summary: Contact not found value: - id: 1442 + id: 296 consent_type: opt_in resource_not_found: summary: Resource not found @@ -3068,7 +3071,7 @@ paths: Successful: value: type: subscription - id: '1454' + id: '308' state: live consent_type: opt_in default_translation: @@ -3091,14 +3094,14 @@ paths: Contact not found: value: type: error.list - request_id: e258dd33-bf7c-4ce4-b8a5-eab21998fb15 + request_id: 56cf765c-419d-4fff-b7e9-7c84e3be582b errors: - code: not_found message: User Not Found Resource not found: value: type: error.list - request_id: 5fef7bb5-83bd-4cf2-aaa9-fcb735121841 + request_id: 6ee21f68-a6d6-47b3-9343-c4e30900e5f9 errors: - code: not_found message: Resource Not Found @@ -3112,7 +3115,7 @@ paths: Unauthorized: value: type: error.list - request_id: f74ed841-c03d-4aef-9bd5-15a971641d6d + request_id: 42834ec7-c68e-4b13-ad14-9a6355a275f9 errors: - code: unauthorized message: Access Token Invalid @@ -3150,7 +3153,7 @@ paths: type: list data: - type: tag - id: '1276' + id: '262' name: Manual tag schema: "$ref": "#/components/schemas/tag_list" @@ -3162,7 +3165,7 @@ paths: Contact not found: value: type: error.list - request_id: 1bf3e8f2-aa1b-4831-ba9c-27cae6793010 + request_id: f0989726-7261-4d22-bd53-c533fe9ae8e6 errors: - code: not_found message: User Not Found @@ -3176,7 +3179,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2ce4f165-fd0c-479e-8747-70df326d71ab + request_id: 0df1dccf-7310-418b-80ed-9553476f4b89 errors: - code: unauthorized message: Access Token Invalid @@ -3211,7 +3214,7 @@ paths: successful: value: type: tag - id: '1277' + id: '263' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -3223,14 +3226,14 @@ paths: Contact not found: value: type: error.list - request_id: 5b4b9cae-e027-4597-97da-4cdc27624f95 + request_id: 8c24674c-0e65-4120-833c-1f6f74b7e6ca errors: - code: not_found message: User Not Found Tag not found: value: type: error.list - request_id: 050d2808-138b-4b8e-9244-4384558b0104 + request_id: 536903f3-cb2d-4afe-b565-83c68ef573bf errors: - code: not_found message: Resource Not Found @@ -3244,7 +3247,7 @@ paths: Unauthorized: value: type: error.list - request_id: c8fd481a-504c-4f38-b2cd-fabfb653a916 + request_id: 5b164ff5-56a2-48ed-8571-f19577d92b7f errors: - code: unauthorized message: Access Token Invalid @@ -3267,11 +3270,11 @@ paths: successful: summary: successful value: - id: 1277 + id: 263 contact_not_found: summary: Contact not found value: - id: 1278 + id: 264 tag_not_found: summary: Tag not found value: @@ -3313,7 +3316,7 @@ paths: successful: value: type: tag - id: '1280' + id: '266' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -3325,14 +3328,14 @@ paths: Contact not found: value: type: error.list - request_id: 30ca5d8a-2fe5-46e1-a3a3-78042fcf8410 + request_id: 434cde61-43ce-411f-9713-e3e248815f67 errors: - code: not_found message: User Not Found Tag not found: value: type: error.list - request_id: cb77bf40-0122-424e-a1d0-3b782bcb8b95 + request_id: 18a95952-5a7c-4f34-b003-c0b63db2149e errors: - code: not_found message: Resource Not Found @@ -3346,7 +3349,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9d2be5fa-581a-4906-b770-7ade86bd7d5a + request_id: b7694cfa-bb30-4078-8937-9d7dc3087907 errors: - code: unauthorized message: Access Token Invalid @@ -3380,7 +3383,7 @@ paths: successful: value: type: contact - id: 660e6f126abd01b859dcb30c + id: 6639fdd12d114e004ff121f7 workspace_id: this_is_an_id248_that_should_be_at_least_ external_id: '70' role: user @@ -3395,9 +3398,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1712221970 - updated_at: 1712221970 - signed_up_at: 1712221970 + created_at: 1715076561 + updated_at: 1715076562 + signed_up_at: 1715076561 last_seen_at: last_replied_at: last_contacted_at: @@ -3431,31 +3434,31 @@ paths: tags: type: list data: [] - url: "/contacts/660e6f126abd01b859dcb30c/tags" + url: "/contacts/6639fdd12d114e004ff121f7/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/660e6f126abd01b859dcb30c/notes" + url: "/contacts/6639fdd12d114e004ff121f7/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/660e6f126abd01b859dcb30c/companies" + url: "/contacts/6639fdd12d114e004ff121f7/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/660e6f126abd01b859dcb30c/subscriptions" + url: "/contacts/6639fdd12d114e004ff121f7/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/660e6f126abd01b859dcb30c/subscriptions" + url: "/contacts/6639fdd12d114e004ff121f7/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3474,7 +3477,7 @@ paths: Unauthorized: value: type: error.list - request_id: 37582e6a-f85e-4b47-ab3e-389edae08c6a + request_id: 2fa4349a-0ec8-4c03-9923-cd8b5c6c76e9 errors: - code: unauthorized message: Access Token Invalid @@ -3519,7 +3522,7 @@ paths: successful: value: type: contact - id: 660e6f136abd01b859dcb30d + id: 6639fdd32d114e004ff121f8 workspace_id: this_is_an_id252_that_should_be_at_least_ external_id: '70' role: user @@ -3534,9 +3537,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1712221971 - updated_at: 1712221971 - signed_up_at: 1712221971 + created_at: 1715076563 + updated_at: 1715076563 + signed_up_at: 1715076563 last_seen_at: last_replied_at: last_contacted_at: @@ -3570,31 +3573,31 @@ paths: tags: type: list data: [] - url: "/contacts/660e6f136abd01b859dcb30d/tags" + url: "/contacts/6639fdd32d114e004ff121f8/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/660e6f136abd01b859dcb30d/notes" + url: "/contacts/6639fdd32d114e004ff121f8/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/660e6f136abd01b859dcb30d/companies" + url: "/contacts/6639fdd32d114e004ff121f8/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/660e6f136abd01b859dcb30d/subscriptions" + url: "/contacts/6639fdd32d114e004ff121f8/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/660e6f136abd01b859dcb30d/subscriptions" + url: "/contacts/6639fdd32d114e004ff121f8/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3613,7 +3616,7 @@ paths: Unauthorized: value: type: error.list - request_id: d86c6fe8-8a3b-435c-a838-0fe2cab3de35 + request_id: e65cc3ee-589d-447d-8785-7c7f514a59a1 errors: - code: unauthorized message: Access Token Invalid @@ -3644,7 +3647,7 @@ paths: examples: successful: value: - id: 660e6f156abd01b859dcb30e + id: 6639fdd42d114e004ff121f9 object: contact deleted: true schema: @@ -3657,7 +3660,7 @@ paths: Unauthorized: value: type: error.list - request_id: d5cc3dfb-62c1-4a66-bfed-5173aa842efe + request_id: 368440bd-4557-439e-b3cb-a9e3d7473569 errors: - code: unauthorized message: Access Token Invalid @@ -3685,7 +3688,7 @@ paths: successful: value: type: contact - id: 660e6f166abd01b859dcb310 + id: 6639fdd52d114e004ff121fb workspace_id: this_is_an_id260_that_should_be_at_least_ external_id: '70' role: user @@ -3700,9 +3703,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1712221974 - updated_at: 1712221974 - signed_up_at: 1712221974 + created_at: 1715076565 + updated_at: 1715076566 + signed_up_at: 1715076565 last_seen_at: last_replied_at: last_contacted_at: @@ -3736,31 +3739,31 @@ paths: tags: type: list data: [] - url: "/contacts/660e6f166abd01b859dcb310/tags" + url: "/contacts/6639fdd52d114e004ff121fb/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/660e6f166abd01b859dcb310/notes" + url: "/contacts/6639fdd52d114e004ff121fb/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/660e6f166abd01b859dcb310/companies" + url: "/contacts/6639fdd52d114e004ff121fb/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/660e6f166abd01b859dcb310/subscriptions" + url: "/contacts/6639fdd52d114e004ff121fb/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/660e6f166abd01b859dcb310/subscriptions" + url: "/contacts/6639fdd52d114e004ff121fb/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3779,7 +3782,7 @@ paths: Unauthorized: value: type: error.list - request_id: 3c22a9cc-a0aa-402c-9eb3-367ca4d1d288 + request_id: 48777e0d-99c6-4972-b9cc-a79f80c312ec errors: - code: unauthorized message: Access Token Invalid @@ -3794,8 +3797,8 @@ paths: successful: summary: successful value: - from: 660e6f166abd01b859dcb30f - into: 660e6f166abd01b859dcb310 + from: 6639fdd52d114e004ff121fa + into: 6639fdd52d114e004ff121fb "/contacts/search": post: summary: Search contacts @@ -3814,6 +3817,12 @@ paths: This will accept a query object in the body which will define your filters in order to search for contacts. + {% admonition type="warning" name="Optimizing search queries" %} + Search queries can be complex, so optimizing them can help the performance of your search. + Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize + pagination to limit the number of results returned. The default is `50` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param. + {% /admonition %} ### Contact Creation Delay If a contact has recently been created, there is a possibility that it will not yet be available when searching. This means that it may not appear in the response. This delay can take a few minutes. If you need to be instantly notified it is recommended to use webhooks and iterate to see if they match your search filters. @@ -3928,7 +3937,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2984bcc4-d779-44a6-a576-5e8e9b12c65a + request_id: bd9e47ad-d4d3-4eb1-afe1-85051db259de errors: - code: unauthorized message: Access Token Invalid @@ -3948,15 +3957,15 @@ paths: value: - field: id operator: "=" - value: 660e6f186abd01b859dcb313 + value: 6639fdd72d114e004ff121fe - operator: OR value: - field: id operator: "=" - value: 660e6f186abd01b859dcb313 + value: 6639fdd72d114e004ff121fe - field: id operator: "=" - value: 660e6f186abd01b859dcb313 + value: 6639fdd72d114e004ff121fe "/contacts": get: summary: List all contacts @@ -3968,7 +3977,12 @@ paths: tags: - Contacts operationId: ListContacts - description: You can fetch a list of all contacts. + description: | + You can fetch a list of all contacts (ie. users or leads) in your workspace. + {% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `50` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. + {% /admonition %} responses: '200': description: successful @@ -3995,7 +4009,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8156c5c1-4ea2-4f1b-96cc-07a4d0d567e9 + request_id: 8ba805cf-d8f1-4300-a439-878bf1fa04d8 errors: - code: unauthorized message: Access Token Invalid @@ -4021,7 +4035,7 @@ paths: successful: value: type: contact - id: 660e6f1a6abd01b859dcb315 + id: 6639fdda2d114e004ff12200 workspace_id: this_is_an_id272_that_should_be_at_least_ external_id: role: user @@ -4036,8 +4050,8 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1712221978 - updated_at: 1712221978 + created_at: 1715076570 + updated_at: 1715076570 signed_up_at: last_seen_at: last_replied_at: @@ -4072,31 +4086,31 @@ paths: tags: type: list data: [] - url: "/contacts/660e6f1a6abd01b859dcb315/tags" + url: "/contacts/6639fdda2d114e004ff12200/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/660e6f1a6abd01b859dcb315/notes" + url: "/contacts/6639fdda2d114e004ff12200/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/660e6f1a6abd01b859dcb315/companies" + url: "/contacts/6639fdda2d114e004ff12200/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/660e6f1a6abd01b859dcb315/subscriptions" + url: "/contacts/6639fdda2d114e004ff12200/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/660e6f1a6abd01b859dcb315/subscriptions" + url: "/contacts/6639fdda2d114e004ff12200/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -4115,7 +4129,7 @@ paths: Unauthorized: value: type: error.list - request_id: bd1a3ed1-a8d3-4ae0-88d1-b962067b9b8d + request_id: c23a4efd-21b5-4fca-b359-28e19515a41e errors: - code: unauthorized message: Access Token Invalid @@ -4159,7 +4173,7 @@ paths: examples: successful: value: - id: 660e6f1c6abd01b859dcb316 + id: 6639fddc2d114e004ff12201 object: contact archived: true schema: @@ -4191,7 +4205,7 @@ paths: examples: successful: value: - id: 660e6f1d6abd01b859dcb317 + id: 6639fddc2d114e004ff12202 object: contact archived: false schema: @@ -4226,7 +4240,7 @@ paths: successful: value: type: tag - id: '1282' + id: '268' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -4238,7 +4252,7 @@ paths: Conversation not found: value: type: error.list - request_id: 979f393c-194f-44c9-9f53-93704ae7e0bc + request_id: fcadede0-9c17-48ef-a279-ac4134224d38 errors: - code: not_found message: Conversation not found @@ -4252,7 +4266,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8938b86f-1a73-44b6-95f0-6199e3fcecec + request_id: 30c1607b-a0d4-4f0c-adac-001467210b2c errors: - code: unauthorized message: Access Token Invalid @@ -4281,13 +4295,13 @@ paths: successful: summary: successful value: - id: 1282 - admin_id: 991281011 + id: 268 + admin_id: 991269547 conversation_not_found: summary: Conversation not found value: - id: 1283 - admin_id: 991281013 + id: 269 + admin_id: 991269549 "/conversations/{conversation_id}/tags/{id}": delete: summary: Remove tag from a conversation @@ -4325,7 +4339,7 @@ paths: successful: value: type: tag - id: '1285' + id: '271' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -4337,14 +4351,14 @@ paths: Conversation not found: value: type: error.list - request_id: 9c9a6ea7-84a6-4280-8c24-208aaf0c7d2e + request_id: 0a00b22a-dba4-40e5-b9b5-4135f2b973fe errors: - code: not_found message: Conversation not found Tag not found: value: type: error.list - request_id: 1b043fba-dfc4-42da-8943-d9a4820c3860 + request_id: 9275c664-342a-4067-a064-58fbfe609350 errors: - code: tag_not_found message: Tag not found @@ -4358,7 +4372,7 @@ paths: Unauthorized: value: type: error.list - request_id: c97e9eca-081d-4b7f-8fd9-23e42b6fbae8 + request_id: 4a428242-b489-410d-9cfd-c05eba657daf errors: - code: unauthorized message: Access Token Invalid @@ -4381,15 +4395,15 @@ paths: successful: summary: successful value: - admin_id: 991281015 + admin_id: 991269551 conversation_not_found: summary: Conversation not found value: - admin_id: 991281017 + admin_id: 991269553 tag_not_found: summary: Tag not found value: - admin_id: 991281018 + admin_id: 991269554 "/conversations": get: summary: List all conversations @@ -4418,7 +4432,11 @@ paths: description: | You can fetch a list of all conversations. - You can optionally request the result page size and the cursor to start after to fetch the result + You can optionally request the result page size and the cursor to start after to fetch the result. + {% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `20` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. + {% /admonition %} responses: '200': description: successful @@ -4436,20 +4454,20 @@ paths: total_count: 1 conversations: - type: conversation - id: '4338' - created_at: 1712221989 - updated_at: 1712221989 + id: '947' + created_at: 1715076581 + updated_at: 1715076581 waiting_since: snoozed_until: source: type: conversation - id: '403920584' + id: '403918572' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991281021' + id: '991269557' name: Ciaran152 Lee email: admin152@email.com attachments: [] @@ -4459,7 +4477,7 @@ paths: type: contact.list contacts: - type: contact - id: 660e6f256abd01b859dcb31b + id: 6639fde42d114e004ff12206 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -4487,7 +4505,7 @@ paths: Unauthorized: value: type: error.list - request_id: 72c76d69-3e92-4823-ba32-ed012ea5695d + request_id: 409e2158-9787-4205-9498-7ab09ccd368e errors: - code: unauthorized message: Access Token Invalid @@ -4501,7 +4519,7 @@ paths: API plan restricted: value: type: error.list - request_id: 5c766923-3fdc-45e2-8c7e-991f0eb2e7f1 + request_id: 562ea66b-757d-4548-bf24-f50fbb1cea4f errors: - code: api_plan_restricted message: Active subscription needed. @@ -4537,11 +4555,11 @@ paths: conversation created: value: type: user_message - id: '403920594' - created_at: 1712222007 + id: '403918582' + created_at: 1715076600 body: Hello there message_type: inapp - conversation_id: '4363' + conversation_id: '975' schema: "$ref": "#/components/schemas/message" '404': @@ -4552,7 +4570,7 @@ paths: Contact Not Found: value: type: error.list - request_id: b7310fdb-b93f-477c-9004-e554f4e81bdc + request_id: 54702241-664c-4642-91e1-40b0324b2d61 errors: - code: not_found message: User Not Found @@ -4566,7 +4584,7 @@ paths: Unauthorized: value: type: error.list - request_id: 651c1a40-b6f8-4574-9675-8de229b96dc0 + request_id: eb177d83-efe3-41a9-a1b4-4f1f084b57cd errors: - code: unauthorized message: Access Token Invalid @@ -4580,7 +4598,7 @@ paths: API plan restricted: value: type: error.list - request_id: 56e58121-2a90-4069-8876-9a0a92e26a4b + request_id: 46a997a6-6ffe-4220-84a2-2e5ae3593954 errors: - code: api_plan_restricted message: Active subscription needed. @@ -4597,7 +4615,7 @@ paths: value: from: type: user - id: 660e6f366abd01b859dcb330 + id: 6639fdf72d114e004ff1221e body: Hello there contact_not_found: summary: Contact Not Found @@ -4641,11 +4659,7 @@ paths: The maximum number of conversation parts that can be returned via the API is 500. If you have more than that we will return the 500 most recent conversation parts. {% /admonition %} - ### Bot Name in Conversation Parts - - For conversation parts generated by a bot, bot name will depend on the following: - - Customers that never turned on AI answers will have `operator` as the bot name - - Customers that have turned on AI answers at some point will have `fin` as the bot name + For AI agent conversation metadata, please note that you need to have the agent enabled in your workspace, which is a [paid feature](https://www.intercom.com/help/en/articles/8205718-fin-resolutions#h_97f8c2e671). responses: '200': description: conversation found @@ -4655,22 +4669,22 @@ paths: conversation found: value: type: conversation - id: '4367' - created_at: 1712222012 - updated_at: 1712222012 + id: '979' + created_at: 1715076605 + updated_at: 1715076605 waiting_since: snoozed_until: source: type: conversation - id: '403920598' + id: '403918586' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991281032' - name: Ciaran159 Lee - email: admin159@email.com + id: '991269574' + name: Ciaran162 Lee + email: admin162@email.com attachments: [] url: redacted: false @@ -4678,7 +4692,7 @@ paths: type: contact.list contacts: - type: contact - id: 660e6f3c6abd01b859dcb334 + id: 6639fdfd2d114e004ff12222 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -4710,7 +4724,7 @@ paths: Not found: value: type: error.list - request_id: 87fb4cff-7c52-489d-81aa-c196aafcc360 + request_id: 521d7da3-fa38-44c9-8f4f-e787b9785e10 errors: - code: not_found message: Resource Not Found @@ -4724,7 +4738,7 @@ paths: Unauthorized: value: type: error.list - request_id: 7e4711fa-96e8-4a14-83f2-f6d311ab8de1 + request_id: c4b58c3f-df48-4190-8b02-e72f240c0b9d errors: - code: unauthorized message: Access Token Invalid @@ -4738,7 +4752,7 @@ paths: API plan restricted: value: type: error.list - request_id: ec37de37-dac2-439d-87f1-ed1b97ae4bb3 + request_id: 7e0c4898-b8d9-4aab-9385-7f4731f407a4 errors: - code: api_plan_restricted message: Active subscription needed. @@ -4785,22 +4799,22 @@ paths: conversation found: value: type: conversation - id: '4371' - created_at: 1712222017 - updated_at: 1712222018 + id: '983' + created_at: 1715076609 + updated_at: 1715076611 waiting_since: snoozed_until: source: type: conversation - id: '403920602' + id: '403918590' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991281036' - name: Ciaran163 Lee - email: admin163@email.com + id: '991269582' + name: Ciaran166 Lee + email: admin166@email.com attachments: [] url: redacted: false @@ -4808,7 +4822,7 @@ paths: type: contact.list contacts: - type: contact - id: 660e6f406abd01b859dcb338 + id: 6639fe012d114e004ff12226 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -4832,34 +4846,34 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '1025' + id: '226' part_type: conversation_attribute_updated_by_admin body: - created_at: 1712222018 - updated_at: 1712222018 - notified_at: 1712222018 + created_at: 1715076610 + updated_at: 1715076610 + notified_at: 1715076610 assigned_to: author: - id: '991281041' + id: '991269583' type: bot name: Operator - email: operator+this_is_an_id318_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id321_that_should_be_at_least_@intercom.io attachments: [] external_id: redacted: false - type: conversation_part - id: '1026' + id: '227' part_type: conversation_attribute_updated_by_admin body: - created_at: 1712222018 - updated_at: 1712222018 - notified_at: 1712222018 + created_at: 1715076611 + updated_at: 1715076611 + notified_at: 1715076611 assigned_to: author: - id: '991281041' + id: '991269583' type: bot name: Operator - email: operator+this_is_an_id318_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id321_that_should_be_at_least_@intercom.io attachments: [] external_id: redacted: false @@ -4874,7 +4888,7 @@ paths: Not found: value: type: error.list - request_id: e971088c-6a3c-4ada-bad8-efdc46b7e9a6 + request_id: b117c598-adae-4c2f-a7a6-0b8320384273 errors: - code: not_found message: Resource Not Found @@ -4888,7 +4902,7 @@ paths: Unauthorized: value: type: error.list - request_id: f33e1d42-a49b-469b-91e8-4015ed638534 + request_id: 1a0b3fcb-3280-4a5b-b8ae-5617eb8d3f78 errors: - code: unauthorized message: Access Token Invalid @@ -4902,7 +4916,7 @@ paths: API plan restricted: value: type: error.list - request_id: 6a0de040-a842-4ea6-8034-4da3cec8c862 + request_id: 67d57a21-a1c4-46d1-852b-dc75b0a71631 errors: - code: api_plan_restricted message: Active subscription needed. @@ -4945,6 +4959,12 @@ paths: To search for conversations, you need to send a `POST` request to `https://api.intercom.io/conversations/search`. This will accept a query object in the body which will define your filters in order to search for conversations. + {% admonition type="warning" name="Optimizing search queries" %} + Search queries can be complex, so optimizing them can help the performance of your search. + Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize + pagination to limit the number of results returned. The default is `20` results per page and maximum is `150`. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param. + {% /admonition %} ### Nesting & Limitations @@ -5008,6 +5028,13 @@ paths: | conversation_rating.remark | String | | conversation_rating.contact_id | String | | conversation_rating.admin_d | String | + | ai_agent_participated | Boolean | + | ai_agent.resolution_state | String | + | ai_agent.last_answer_type | String | + | ai_agent.rating | Integer | + | ai_agent.rating_remark | String | + | ai_agent.source_type | String | + | ai_agent.source_title | String | ### Accepted Operators @@ -5042,22 +5069,22 @@ paths: total_count: 1 conversations: - type: conversation - id: '4378' - created_at: 1712222026 - updated_at: 1712222026 + id: '990' + created_at: 1715076619 + updated_at: 1715076619 waiting_since: snoozed_until: source: type: conversation - id: '403920609' + id: '403918597' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991281060' - name: Ciaran186 Lee - email: admin186@email.com + id: '991269612' + name: Ciaran189 Lee + email: admin189@email.com attachments: [] url: redacted: false @@ -5065,7 +5092,7 @@ paths: type: contact.list contacts: - type: contact - id: 660e6f4a6abd01b859dcb33f + id: 6639fe0a2d114e004ff1222d first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5099,15 +5126,15 @@ paths: value: - field: id operator: "=" - value: '4378' + value: '990' - operator: OR value: - field: id operator: "=" - value: '4378' + value: '990' - field: id operator: "=" - value: '4378' + value: '990' "/conversations/{id}/reply": post: summary: Reply to a conversation @@ -5138,22 +5165,22 @@ paths: User reply: value: type: conversation - id: '4386' - created_at: 1712222032 - updated_at: 1712222033 - waiting_since: 1712222033 + id: '999' + created_at: 1715076626 + updated_at: 1715076626 + waiting_since: 1715076626 snoozed_until: source: type: conversation - id: '403920612' + id: '403918600' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991281062' - name: Ciaran187 Lee - email: admin187@email.com + id: '991269615' + name: Ciaran191 Lee + email: admin191@email.com attachments: [] url: redacted: false @@ -5161,9 +5188,9 @@ paths: type: contact.list contacts: - type: contact - id: 660e6f506abd01b859dcb346 + id: 6639fe112d114e004ff12235 first_contact_reply: - created_at: 1712222033 + created_at: 1715076626 type: conversation url: admin_assignee_id: @@ -5186,15 +5213,15 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '1028' + id: '229' part_type: open body: "

    Thanks again :)

    " - created_at: 1712222033 - updated_at: 1712222033 - notified_at: 1712222033 + created_at: 1715076626 + updated_at: 1715076626 + notified_at: 1715076626 assigned_to: author: - id: 660e6f506abd01b859dcb346 + id: 6639fe112d114e004ff12235 type: user name: Joe Bloggs email: joe@bloggs.com @@ -5205,22 +5232,22 @@ paths: Admin note reply: value: type: conversation - id: '4387' - created_at: 1712222034 - updated_at: 1712222034 + id: '1000' + created_at: 1715076628 + updated_at: 1715076628 waiting_since: snoozed_until: source: type: conversation - id: '403920613' + id: '403918601' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991281064' - name: Ciaran188 Lee - email: admin188@email.com + id: '991269617' + name: Ciaran192 Lee + email: admin192@email.com attachments: [] url: redacted: false @@ -5228,7 +5255,7 @@ paths: type: contact.list contacts: - type: contact - id: 660e6f526abd01b859dcb347 + id: 6639fe132d114e004ff12236 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5250,7 +5277,7 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '1029' + id: '230' part_type: note body: |-

    An Unordered HTML List

    @@ -5265,15 +5292,15 @@ paths:
  • Tea
  • Milk
    • - created_at: 1712222034 - updated_at: 1712222034 - notified_at: 1712222034 + created_at: 1715076628 + updated_at: 1715076628 + notified_at: 1715076628 assigned_to: author: - id: '991281064' + id: '991269617' type: admin - name: Ciaran188 Lee - email: admin188@email.com + name: Ciaran192 Lee + email: admin192@email.com attachments: [] external_id: redacted: false @@ -5281,22 +5308,22 @@ paths: User last conversation reply: value: type: conversation - id: '4389' - created_at: 1712222037 - updated_at: 1712222037 - waiting_since: 1712222037 + id: '1002' + created_at: 1715076630 + updated_at: 1715076631 + waiting_since: 1715076631 snoozed_until: source: type: conversation - id: '403920615' + id: '403918603' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991281066' - name: Ciaran190 Lee - email: admin190@email.com + id: '991269621' + name: Ciaran194 Lee + email: admin194@email.com attachments: [] url: redacted: false @@ -5304,9 +5331,9 @@ paths: type: contact.list contacts: - type: contact - id: 660e6f546abd01b859dcb349 + id: 6639fe162d114e004ff12238 first_contact_reply: - created_at: 1712222037 + created_at: 1715076631 type: conversation url: admin_assignee_id: @@ -5329,15 +5356,15 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '1030' + id: '231' part_type: open body: "

    Thanks again :)

    " - created_at: 1712222037 - updated_at: 1712222037 - notified_at: 1712222037 + created_at: 1715076631 + updated_at: 1715076631 + notified_at: 1715076631 assigned_to: author: - id: 660e6f546abd01b859dcb349 + id: 6639fe162d114e004ff12238 type: user name: Joe Bloggs email: joe@bloggs.com @@ -5355,7 +5382,7 @@ paths: Not found: value: type: error.list - request_id: ab5e8e06-ce9e-4888-91ca-c1b5ed2fc3c8 + request_id: 303a40d1-f12e-4d1c-9bb7-e0fd819ad72f errors: - code: not_found message: Resource Not Found @@ -5369,7 +5396,7 @@ paths: Unauthorized: value: type: error.list - request_id: 7d3d6dce-97cc-44cc-82b4-d9ca582d83aa + request_id: 44c64a00-131d-4209-b4ee-06daebc9e963 errors: - code: unauthorized message: Access Token Invalid @@ -5383,7 +5410,7 @@ paths: API plan restricted: value: type: error.list - request_id: c8145dda-c2a9-4316-9e0a-70a02058f39c + request_id: b003f7a9-12d4-47e2-8f3f-d413ccf25d08 errors: - code: api_plan_restricted message: Active subscription needed. @@ -5400,14 +5427,14 @@ paths: value: message_type: comment type: user - intercom_user_id: 660e6f506abd01b859dcb346 + intercom_user_id: 6639fe112d114e004ff12235 body: Thanks again :) admin_note_reply: summary: Admin note reply value: message_type: note type: admin - admin_id: 991281064 + admin_id: 991269617 body: "

    An Unordered HTML List

    • Coffee
      • \
    • Tea
    • Milk

    An Ordered HTML List

    \
    1. Coffee
    2. Tea
    3. Milk
    @@ -5417,14 +5444,14 @@ paths: value: message_type: comment type: user - intercom_user_id: 660e6f546abd01b859dcb349 + intercom_user_id: 6639fe162d114e004ff12238 body: Thanks again :) not_found: summary: Not found value: message_type: comment type: user - intercom_user_id: 660e6f566abd01b859dcb34a + intercom_user_id: 6639fe182d114e004ff12239 body: Thanks again :) "/conversations/{id}/parts": post: @@ -5459,22 +5486,22 @@ paths: Close a conversation: value: type: conversation - id: '4393' - created_at: 1712222042 - updated_at: 1712222043 + id: '1006' + created_at: 1715076636 + updated_at: 1715076637 waiting_since: snoozed_until: source: type: conversation - id: '403920619' + id: '403918607' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991281071' - name: Ciaran194 Lee - email: admin194@email.com + id: '991269629' + name: Ciaran198 Lee + email: admin198@email.com attachments: [] url: redacted: false @@ -5482,7 +5509,7 @@ paths: type: contact.list contacts: - type: contact - id: 660e6f5a6abd01b859dcb34d + id: 6639fe1c2d114e004ff1223c first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5504,18 +5531,18 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '1031' + id: '232' part_type: close body: "

    Goodbye :)

    " - created_at: 1712222043 - updated_at: 1712222043 - notified_at: 1712222043 + created_at: 1715076637 + updated_at: 1715076637 + notified_at: 1715076637 assigned_to: author: - id: '991281071' + id: '991269629' type: admin - name: Ciaran194 Lee - email: admin194@email.com + name: Ciaran198 Lee + email: admin198@email.com attachments: [] external_id: redacted: false @@ -5523,22 +5550,22 @@ paths: Snooze a conversation: value: type: conversation - id: '4394' - created_at: 1712222044 - updated_at: 1712222045 + id: '1007' + created_at: 1715076638 + updated_at: 1715076639 waiting_since: - snoozed_until: 1712225645 + snoozed_until: 1715080239 source: type: conversation - id: '403920620' + id: '403918608' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991281072' - name: Ciaran195 Lee - email: admin195@email.com + id: '991269631' + name: Ciaran199 Lee + email: admin199@email.com attachments: [] url: redacted: false @@ -5546,7 +5573,7 @@ paths: type: contact.list contacts: - type: contact - id: 660e6f5c6abd01b859dcb34e + id: 6639fe1e2d114e004ff1223d first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5568,18 +5595,18 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '1032' + id: '233' part_type: snoozed body: - created_at: 1712222045 - updated_at: 1712222045 - notified_at: 1712222045 + created_at: 1715076639 + updated_at: 1715076639 + notified_at: 1715076639 assigned_to: author: - id: '991281072' + id: '991269631' type: admin - name: Ciaran195 Lee - email: admin195@email.com + name: Ciaran199 Lee + email: admin199@email.com attachments: [] external_id: redacted: false @@ -5587,22 +5614,22 @@ paths: Open a conversation: value: type: conversation - id: '4399' - created_at: 1712222044 - updated_at: 1712222052 + id: '1012' + created_at: 1715076637 + updated_at: 1715076646 waiting_since: snoozed_until: source: type: conversation - id: '403920621' + id: '403918609' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991281073' - name: Ciaran196 Lee - email: admin196@email.com + id: '991269633' + name: Ciaran200 Lee + email: admin200@email.com attachments: [] url: redacted: false @@ -5610,7 +5637,7 @@ paths: type: contact.list contacts: - type: contact - id: 660e6f606abd01b859dcb353 + id: 6639fe1d2d114e004ff12242 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5632,18 +5659,18 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '1034' + id: '235' part_type: open body: - created_at: 1712222052 - updated_at: 1712222052 - notified_at: 1712222052 + created_at: 1715076646 + updated_at: 1715076646 + notified_at: 1715076646 assigned_to: author: - id: '991281073' + id: '991269633' type: admin - name: Ciaran196 Lee - email: admin196@email.com + name: Ciaran200 Lee + email: admin200@email.com attachments: [] external_id: redacted: false @@ -5651,22 +5678,22 @@ paths: Assign a conversation: value: type: conversation - id: '4403' - created_at: 1712222053 - updated_at: 1712222053 + id: '1017' + created_at: 1715076647 + updated_at: 1715076647 waiting_since: snoozed_until: source: type: conversation - id: '403920624' + id: '403918612' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991281075' - name: Ciaran197 Lee - email: admin197@email.com + id: '991269636' + name: Ciaran202 Lee + email: admin202@email.com attachments: [] url: redacted: false @@ -5674,9 +5701,9 @@ paths: type: contact.list contacts: - type: contact - id: 660e6f656abd01b859dcb356 + id: 6639fe272d114e004ff12246 first_contact_reply: - admin_assignee_id: 991281075 + admin_assignee_id: 991269636 team_assignee_id: open: true state: open @@ -5696,20 +5723,20 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '1035' + id: '236' part_type: assign_and_reopen body: - created_at: 1712222054 - updated_at: 1712222054 - notified_at: 1712222054 + created_at: 1715076647 + updated_at: 1715076647 + notified_at: 1715076647 assigned_to: type: admin - id: '991281075' + id: '991269636' author: - id: '991281075' + id: '991269636' type: admin - name: Ciaran197 Lee - email: admin197@email.com + name: Ciaran202 Lee + email: admin202@email.com attachments: [] external_id: redacted: false @@ -5724,7 +5751,7 @@ paths: Not found: value: type: error.list - request_id: 4a8d9c02-8407-42ec-99a8-5de7347ee839 + request_id: d9590147-2ace-4591-b1b4-198e74a5177b errors: - code: not_found message: Resource Not Found @@ -5738,7 +5765,7 @@ paths: Unauthorized: value: type: error.list - request_id: f79bc653-4c3f-4b6c-8cfa-23bbe04b4514 + request_id: 8df88436-e602-41b9-8284-d28cbf8d3282 errors: - code: unauthorized message: Access Token Invalid @@ -5752,7 +5779,7 @@ paths: API plan restricted: value: type: error.list - request_id: d4b13f4c-176a-4cf8-9709-1aaa7ac3eefd + request_id: 205b7e36-8ee3-463f-967a-e53a51152c96 errors: - code: api_plan_restricted message: Active subscription needed. @@ -5773,32 +5800,32 @@ paths: value: message_type: close type: admin - admin_id: 991281071 + admin_id: 991269629 body: Goodbye :) snooze_a_conversation: summary: Snooze a conversation value: message_type: snoozed - admin_id: 991281072 - snoozed_until: 1712225645 + admin_id: 991269631 + snoozed_until: 1715080239 open_a_conversation: summary: Open a conversation value: message_type: open - admin_id: 991281073 + admin_id: 991269633 assign_a_conversation: summary: Assign a conversation value: message_type: assignment type: admin - admin_id: 991281075 - assignee_id: 991281075 + admin_id: 991269636 + assignee_id: 991269636 not_found: summary: Not found value: message_type: close type: admin - admin_id: 991281077 + admin_id: 991269638 body: Goodbye :) "/conversations/{id}/run_assignment_rules": post: @@ -5832,22 +5859,22 @@ paths: Assign a conversation using assignment rules: value: type: conversation - id: '4407' - created_at: 1712222058 - updated_at: 1712222059 + id: '1021' + created_at: 1715076652 + updated_at: 1715076653 waiting_since: snoozed_until: source: type: conversation - id: '403920628' + id: '403918616' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991281080' - name: Ciaran201 Lee - email: admin201@email.com + id: '991269644' + name: Ciaran206 Lee + email: admin206@email.com attachments: [] url: redacted: false @@ -5855,7 +5882,7 @@ paths: type: contact.list contacts: - type: contact - id: 660e6f6a6abd01b859dcb35a + id: 6639fe2c2d114e004ff1224a first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5877,20 +5904,20 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '1036' + id: '237' part_type: default_assignment body: - created_at: 1712222059 - updated_at: 1712222059 - notified_at: 1712222059 + created_at: 1715076653 + updated_at: 1715076653 + notified_at: 1715076653 assigned_to: type: nobody_admin id: author: - id: '991281081' + id: '991269645' type: bot name: Operator - email: operator+this_is_an_id359_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id364_that_should_be_at_least_@intercom.io attachments: [] external_id: redacted: false @@ -5905,7 +5932,7 @@ paths: Not found: value: type: error.list - request_id: 596c44bd-18f7-4609-aa84-db926f369e3b + request_id: d9c31605-2b19-4d1f-816f-4c4e7310624d errors: - code: not_found message: Resource Not Found @@ -5919,7 +5946,7 @@ paths: Unauthorized: value: type: error.list - request_id: 6472f2ac-cf32-4713-8e50-cb704f7dac52 + request_id: 49c81372-1f7a-4f87-8036-66047d8f6df2 errors: - code: unauthorized message: Access Token Invalid @@ -5933,7 +5960,7 @@ paths: API plan restricted: value: type: error.list - request_id: c09bed48-5bf4-478a-882b-84c5a8efe159 + request_id: 42e49892-0643-4bc0-b8c0-97b0a770acd2 errors: - code: api_plan_restricted message: Active subscription needed. @@ -5974,7 +6001,7 @@ paths: value: customers: - type: user - id: 660e6f6f6abd01b859dcb35e + id: 6639fe312d114e004ff1224e schema: "$ref": "#/components/schemas/conversation" '404': @@ -5985,7 +6012,7 @@ paths: Not found: value: type: error.list - request_id: c76cca2f-b1ea-4b4a-bef0-fc4615517c40 + request_id: 1f1ed99e-83ae-4f87-a23e-7ed263627fae errors: - code: not_found message: Resource Not Found @@ -5999,7 +6026,7 @@ paths: Unauthorized: value: type: error.list - request_id: 43b3667f-69d3-4f4a-b4b7-c40fa54a0dd6 + request_id: 2344a91a-b0ef-4075-9abb-a3b859a5af6b errors: - code: unauthorized message: Access Token Invalid @@ -6013,7 +6040,7 @@ paths: API plan restricted: value: type: error.list - request_id: ec136075-7e8a-4cac-bc91-ce5e79accc94 + request_id: e79df06b-187c-41fd-bf90-863a39c8deb4 errors: - code: api_plan_restricted message: Active subscription needed. @@ -6028,15 +6055,15 @@ paths: attach_a_contact_to_a_conversation: summary: Attach a contact to a conversation value: - admin_id: 991281085 + admin_id: 991269652 customer: - intercom_user_id: 660e6f6f6abd01b859dcb35e + intercom_user_id: 6639fe312d114e004ff1224e not_found: summary: Not found value: - admin_id: 991281086 + admin_id: 991269654 customer: - intercom_user_id: 660e6f716abd01b859dcb35f + intercom_user_id: 6639fe332d114e004ff1224f "/conversations/{conversation_id}/customers/{contact_id}": delete: summary: Detach a contact from a group conversation @@ -6079,7 +6106,7 @@ paths: value: customers: - type: user - id: 660e6f7a6abd01b859dcb369 + id: 6639fe3c2d114e004ff1225a schema: "$ref": "#/components/schemas/conversation" '404': @@ -6090,14 +6117,14 @@ paths: Conversation not found: value: type: error.list - request_id: 2ec4c5b6-a280-4e1b-a57b-6d18e0f3ed43 + request_id: ebbb1d09-624f-4a1e-860c-4b60735b0262 errors: - code: not_found message: Resource Not Found Contact not found: value: type: error.list - request_id: 4f4d7f2f-2eac-45f4-a960-26a19a73283e + request_id: 28958f8f-30ab-44d1-81d0-498481db5546 errors: - code: not_found message: User Not Found @@ -6111,7 +6138,7 @@ paths: Last customer: value: type: error.list - request_id: 61d24d08-aade-40a7-8cac-5c84a45f00e0 + request_id: 1d1585eb-75a8-4415-9a5b-3753728c1ff1 errors: - code: parameter_invalid message: Removing the last customer is not allowed @@ -6125,7 +6152,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8907da0c-2af8-4ef9-a4a9-956a2ae002a0 + request_id: 022312a8-6c25-4cff-ac4b-940320db4208 errors: - code: unauthorized message: Access Token Invalid @@ -6139,7 +6166,7 @@ paths: API plan restricted: value: type: error.list - request_id: c7d4766d-032e-4a0b-aa0e-c4e9deef2138 + request_id: e5dabc55-37b1-43c7-812d-690c219d7d2d errors: - code: api_plan_restricted message: Active subscription needed. @@ -6154,27 +6181,27 @@ paths: detach_a_contact_from_a_group_conversation: summary: Detach a contact from a group conversation value: - admin_id: 991281089 + admin_id: 991269660 customer: - intercom_user_id: 660e6f746abd01b859dcb362 + intercom_user_id: 6639fe372d114e004ff12252 conversation_not_found: summary: Conversation not found value: - admin_id: 991281091 + admin_id: 991269663 customer: - intercom_user_id: 660e6f7b6abd01b859dcb36a + intercom_user_id: 6639fe3d2d114e004ff1225b contact_not_found: summary: Contact not found value: - admin_id: 991281093 + admin_id: 991269666 customer: - intercom_user_id: 660e6f816abd01b859dcb371 + intercom_user_id: 6639fe422d114e004ff12263 last_customer: summary: Last customer value: - admin_id: 991281095 + admin_id: 991269669 customer: - intercom_user_id: 660e6f876abd01b859dcb378 + intercom_user_id: 6639fe482d114e004ff1226b "/conversations/redact": post: summary: Redact a conversation part @@ -6202,22 +6229,22 @@ paths: Redact a conversation part: value: type: conversation - id: '4463' - created_at: 1712222104 - updated_at: 1712222106 - waiting_since: 1712222105 + id: '1083' + created_at: 1715076698 + updated_at: 1715076700 + waiting_since: 1715076699 snoozed_until: source: type: conversation - id: '403920654' + id: '403918642' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991281101' - name: Ciaran215 Lee - email: admin215@email.com + id: '991269678' + name: Ciaran226 Lee + email: admin226@email.com attachments: [] url: redacted: false @@ -6225,9 +6252,9 @@ paths: type: contact.list contacts: - type: contact - id: 660e6f986abd01b859dcb38d + id: 6639fe5a2d114e004ff12283 first_contact_reply: - created_at: 1712222105 + created_at: 1715076699 type: conversation url: admin_assignee_id: @@ -6250,15 +6277,15 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '1044' + id: '245' part_type: open body: "

    This message was deleted

    " - created_at: 1712222105 - updated_at: 1712222106 - notified_at: 1712222105 + created_at: 1715076699 + updated_at: 1715076700 + notified_at: 1715076699 assigned_to: author: - id: 660e6f986abd01b859dcb38d + id: 6639fe5a2d114e004ff12283 type: user name: Joe Bloggs email: joe@bloggs.com @@ -6276,7 +6303,7 @@ paths: Not found: value: type: error.list - request_id: 64cfe8ce-0a41-429b-840f-b3668df386de + request_id: 5867020e-e06e-4c65-a585-a474b2829e6a errors: - code: conversation_part_or_message_not_found message: Conversation part or message not found @@ -6290,7 +6317,7 @@ paths: Unauthorized: value: type: error.list - request_id: 17e9517f-f012-4871-ae14-8d98fc7f1274 + request_id: f4804b38-1124-4a1a-9922-b5f46757e5de errors: - code: unauthorized message: Access Token Invalid @@ -6306,8 +6333,8 @@ paths: summary: Redact a conversation part value: type: conversation_part - conversation_id: 4463 - conversation_part_id: 1044 + conversation_id: 1083 + conversation_part_id: 245 not_found: summary: Not found value: @@ -6494,7 +6521,7 @@ paths: custom: false archived: false model: company - - id: 469 + - id: 98 type: data_attribute name: The One Ring full_name: custom_attributes.The One Ring @@ -6507,9 +6534,9 @@ paths: messenger_writable: true custom: true archived: false - admin_id: '991281125' - created_at: 1712222118 - updated_at: 1712222118 + admin_id: '991269703' + created_at: 1715076710 + updated_at: 1715076710 model: company - type: data_attribute name: id @@ -6581,7 +6608,7 @@ paths: Unauthorized: value: type: error.list - request_id: dfa3811b-1a07-45b6-8141-23aca295fea1 + request_id: 6858370f-0e67-45a6-a2c2-98862a6beab5 errors: - code: unauthorized message: Access Token Invalid @@ -6606,7 +6633,7 @@ paths: examples: Successful: value: - id: 472 + id: 101 type: data_attribute name: Mithril Shirt full_name: custom_attributes.Mithril Shirt @@ -6617,9 +6644,9 @@ paths: messenger_writable: true custom: true archived: false - admin_id: '991281127' - created_at: 1712222119 - updated_at: 1712222119 + admin_id: '991269705' + created_at: 1715076712 + updated_at: 1715076712 model: company schema: "$ref": "#/components/schemas/data_attribute" @@ -6631,7 +6658,7 @@ paths: Same name already exists: value: type: error.list - request_id: a77c0680-fb5a-414d-97e5-068058e5a55b + request_id: 88cd6893-f00b-4553-8132-13d3280f136e errors: - code: parameter_invalid message: You already have 'The One Ring' in your company data. @@ -6639,7 +6666,7 @@ paths: Invalid name: value: type: error.list - request_id: 0daa4789-662a-42e2-ae2e-745a8597f511 + request_id: 54172b84-8a4b-430b-9e99-f09556aab613 errors: - code: parameter_invalid message: Your name for this attribute must only contain alphanumeric @@ -6647,7 +6674,7 @@ paths: Attribute already exists: value: type: error.list - request_id: 9a9d710d-ddbe-4cd4-b7a9-7d2efabc3712 + request_id: 2ab37f4e-77dc-46d8-8b8c-85b7e9db1837 errors: - code: parameter_invalid message: You already have 'The One Ring' in your company data. @@ -6655,14 +6682,14 @@ paths: Invalid Data Type: value: type: error.list - request_id: 5fdbd3ae-7175-4c5b-9e87-35df0d94da48 + request_id: 0e2e7f97-3e70-4068-b093-23567e6e2d9e errors: - code: parameter_invalid message: Data Type isn't an option Too few options for list: value: type: error.list - request_id: 94233919-c58f-440d-8793-694bca0f21ac + request_id: 5693b2f4-653d-4dcb-8aab-6fe98026f5c7 errors: - code: parameter_invalid message: The Data Attribute model field must be either contact @@ -6677,7 +6704,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9634b010-ea23-4aae-8d5c-29bcdc84e7bb + request_id: 2ee3eb01-08b3-4a77-b868-31799164edb0 errors: - code: unauthorized message: Access Token Invalid @@ -6756,7 +6783,7 @@ paths: examples: Successful: value: - id: 479 + id: 108 type: data_attribute name: The One Ring full_name: custom_attributes.The One Ring @@ -6771,9 +6798,9 @@ paths: messenger_writable: true custom: true archived: false - admin_id: '991281134' - created_at: 1712222122 - updated_at: 1712222122 + admin_id: '991269712' + created_at: 1715076715 + updated_at: 1715076715 model: company schema: "$ref": "#/components/schemas/data_attribute" @@ -6785,7 +6812,7 @@ paths: Too few options in list: value: type: error.list - request_id: eb4a9508-e9fe-483a-a2cb-0a220d27ac44 + request_id: 38ea93a3-b2a5-4f59-9639-fd1a17abe98e errors: - code: parameter_invalid message: Options isn't an array @@ -6799,7 +6826,7 @@ paths: Attribute Not Found: value: type: error.list - request_id: 8b2825ce-4f26-49d7-8c5a-f7e75f58803b + request_id: 9ce74170-a622-4b3a-bc30-0193bc921ecb errors: - code: field_not_found message: We couldn't find that data attribute to update @@ -6813,7 +6840,7 @@ paths: Has Dependant Object: value: type: error.list - request_id: 90653633-a98c-4201-8dd2-874c2155fc5f + request_id: 4f0b1d82-e838-4d4a-a1a2-b98779006d45 errors: - code: data_invalid message: The Data Attribute you are trying to archive has a @@ -6828,7 +6855,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8858a980-bef0-4e95-855f-aa525cb64147 + request_id: 4e1fc1ac-9a1a-47c6-825a-8e9c7fd28467 errors: - code: unauthorized message: Access Token Invalid @@ -6933,7 +6960,7 @@ paths: Unauthorized: value: type: error.list - request_id: cdb3e56f-ac8c-4a1f-ac06-e7dfcc3be56d + request_id: 6080433c-e865-4477-81b4-6587bac80a2b errors: - code: unauthorized message: Access Token Invalid @@ -7020,7 +7047,7 @@ paths: pages: next: http://api.intercom.test/events?next page email: user26@email.com - intercom_user_id: 660e6faf6abd01b859dcb396 + intercom_user_id: 6639fe6f2d114e004ff1228c user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 schema: "$ref": "#/components/schemas/data_event_summary" @@ -7032,7 +7059,7 @@ paths: Unauthorized: value: type: error.list - request_id: c4b4f4dd-e4d5-44ec-aa75-2317671107e5 + request_id: 0acf6102-8ce6-4b3a-b241-c84ee7c506aa errors: - code: unauthorized message: Access Token Invalid @@ -7063,7 +7090,7 @@ paths: Unauthorized: value: type: error.list - request_id: 836de418-a204-4361-a09a-f03a9676e127 + request_id: df8e4bcb-62a4-4ee4-b7b5-2b91205ccb57 errors: - code: unauthorized message: Access Token Invalid @@ -7107,7 +7134,7 @@ paths: examples: successful: value: - job_identifier: bme13qaypyxcuaqn + job_identifier: 2a4ngu8am2ea98v8 status: pending download_url: '' download_expires_at: '' @@ -7122,8 +7149,8 @@ paths: successful: summary: successful value: - created_at_after: 1712204129 - created_at_before: 1712222129 + created_at_after: 1715058722 + created_at_before: 1715076722 "/export/content/data/{job_identifier}": get: summary: Show content data export @@ -7157,7 +7184,7 @@ paths: examples: successful: value: - job_identifier: e5v3i9fj0kngok9o + job_identifier: 26qa8h9yb09m5ky5 status: pending download_url: '' download_expires_at: '' @@ -7189,7 +7216,7 @@ paths: examples: successful: value: - job_identifier: b7co01h7voyoinko + job_identifier: ggeghvx3o2yg8co8 status: canceled download_url: '' download_expires_at: '' @@ -7250,32 +7277,32 @@ paths: user message created: value: type: user_message - id: '403920659' - created_at: 1712222131 + id: '403918647' + created_at: 1715076724 body: heyy message_type: inapp - conversation_id: '4468' + conversation_id: '1088' lead message created: value: type: user_message - id: '403920660' - created_at: 1712222133 + id: '403918648' + created_at: 1715076725 body: heyy message_type: inapp - conversation_id: '4469' + conversation_id: '1089' admin message created: value: type: admin_message - id: '150' - created_at: 1712222134 + id: '35' + created_at: 1715076727 subject: heyy body: heyy message_type: inapp owner: type: admin - id: '991281157' - name: Ciaran265 Lee - email: admin265@email.com + id: '991269735' + name: Ciaran276 Lee + email: admin276@email.com away_mode_enabled: false away_mode_reassign: false schema: @@ -7288,14 +7315,14 @@ paths: No body supplied for message: value: type: error.list - request_id: 37e2d24d-2bea-43e1-8906-2c8d54596d0b + request_id: ca6896eb-1b5a-4a2e-b075-5973deb4b3d7 errors: - code: parameter_invalid message: Body is required No body supplied for email message: value: type: error.list - request_id: 8f9f78e2-660a-469c-830b-0ec5f5951e2a + request_id: 0b004eff-fad9-4d44-b336-8a784889a2d3 errors: - code: parameter_invalid message: Body is required @@ -7309,7 +7336,7 @@ paths: No subject supplied for email message: value: type: error.list - request_id: e17bdb28-c692-41f3-a02a-b97b135e6fbc + request_id: d7930765-afaf-4511-87bb-07662b523aab errors: - code: parameter_not_found message: No subject supplied for email message @@ -7323,7 +7350,7 @@ paths: Unauthorized: value: type: error.list - request_id: ac1f8dd0-7e1a-4f41-8325-40dff7b0aa6a + request_id: 30ad3fd1-8d85-416d-bbf7-5fe38b10111a errors: - code: unauthorized message: Access Token Invalid @@ -7337,7 +7364,7 @@ paths: API plan restricted: value: type: error.list - request_id: ee63f6a2-e5bc-4c71-a987-0407909fea3e + request_id: fc41ce6a-346c-4e52-b25d-5f670d4e73f1 errors: - code: api_plan_restricted message: Active subscription needed. @@ -7354,7 +7381,7 @@ paths: value: from: type: user - id: 660e6fb36abd01b859dcb39b + id: 6639fe742d114e004ff12291 body: heyy referer: https://twitter.com/bob lead_message_created: @@ -7362,7 +7389,7 @@ paths: value: from: type: lead - id: 660e6fb46abd01b859dcb39c + id: 6639fe752d114e004ff12292 body: heyy referer: https://twitter.com/bob admin_message_created: @@ -7370,10 +7397,10 @@ paths: value: from: type: admin - id: '991281157' + id: '991269735' to: type: user - id: 660e6fb66abd01b859dcb39d + id: 6639fe762d114e004ff12293 message_type: conversation body: heyy no_body_supplied_for_message: @@ -7381,10 +7408,10 @@ paths: value: from: type: admin - id: '991281159' + id: '991269737' to: type: user - id: 660e6fb76abd01b859dcb39e + id: 6639fe772d114e004ff12294 message_type: inapp body: subject: heyy @@ -7393,7 +7420,7 @@ paths: value: from: type: admin - id: '991281160' + id: '991269738' to: type: user user_id: '70' @@ -7404,10 +7431,10 @@ paths: value: from: type: admin - id: '991281161' + id: '991269739' to: type: user - id: 660e6fb86abd01b859dcb3a0 + id: 6639fe782d114e004ff12296 message_type: email body: subject: heyy @@ -7438,12 +7465,12 @@ paths: total_pages: 1 type: pages data: - - id: '407' + - id: '85' type: news-item - workspace_id: this_is_an_id481_that_should_be_at_least_ + workspace_id: this_is_an_id492_that_should_be_at_least_ title: We have news body: "

    Hello there,

    " - sender_id: 991281166 + sender_id: 991269744 state: draft labels: [] cover_image_url: @@ -7453,15 +7480,15 @@ paths: - - deliver_silently: false - created_at: 1712222137 - updated_at: 1712222137 + created_at: 1715076730 + updated_at: 1715076730 newsfeed_assignments: [] - - id: '408' + - id: '86' type: news-item - workspace_id: this_is_an_id481_that_should_be_at_least_ + workspace_id: this_is_an_id492_that_should_be_at_least_ title: We have news body: "

    Hello there,

    " - sender_id: 991281168 + sender_id: 991269746 state: draft labels: [] cover_image_url: @@ -7471,8 +7498,8 @@ paths: - - deliver_silently: false - created_at: 1712222137 - updated_at: 1712222137 + created_at: 1715076730 + updated_at: 1715076730 newsfeed_assignments: [] total_count: 2 schema: @@ -7485,7 +7512,7 @@ paths: Unauthorized: value: type: error.list - request_id: a410752a-5e96-45c1-9612-e87510f94969 + request_id: 44e895be-2591-496a-96cf-e11fafdd211a errors: - code: unauthorized message: Access Token Invalid @@ -7510,12 +7537,12 @@ paths: examples: successful: value: - id: '411' + id: '89' type: news-item - workspace_id: this_is_an_id485_that_should_be_at_least_ + workspace_id: this_is_an_id496_that_should_be_at_least_ title: Halloween is here! body: "

    New costumes in store for this spooky season

    " - sender_id: 991281175 + sender_id: 991269753 state: live labels: - New @@ -7526,10 +7553,10 @@ paths: - "\U0001F606" - "\U0001F605" deliver_silently: true - created_at: 1712222139 - updated_at: 1712222139 + created_at: 1715076732 + updated_at: 1715076732 newsfeed_assignments: - - newsfeed_id: 728 + - newsfeed_id: 153 published_at: 1664638214 schema: "$ref": "#/components/schemas/news_item" @@ -7541,7 +7568,7 @@ paths: Unauthorized: value: type: error.list - request_id: 48e5c1ec-0daa-47cd-b7a3-7681db8468c8 + request_id: 8455930d-eafc-4b43-8cfe-58fbb61eb407 errors: - code: unauthorized message: Access Token Invalid @@ -7562,14 +7589,14 @@ paths: - Product - Update - New - sender_id: 991281175 + sender_id: 991269753 deliver_silently: true reactions: - "\U0001F606" - "\U0001F605" state: live newsfeed_assignments: - - newsfeed_id: 728 + - newsfeed_id: 153 published_at: 1664638214 "/news/news_items/{id}": get: @@ -7598,12 +7625,12 @@ paths: examples: successful: value: - id: '412' + id: '90' type: news-item - workspace_id: this_is_an_id489_that_should_be_at_least_ + workspace_id: this_is_an_id500_that_should_be_at_least_ title: We have news body: "

    Hello there,

    " - sender_id: 991281178 + sender_id: 991269756 state: live labels: [] cover_image_url: @@ -7613,11 +7640,11 @@ paths: - - deliver_silently: false - created_at: 1712222140 - updated_at: 1712222140 + created_at: 1715076733 + updated_at: 1715076733 newsfeed_assignments: - - newsfeed_id: 730 - published_at: 1712222140 + - newsfeed_id: 155 + published_at: 1715076733 schema: "$ref": "#/components/schemas/news_item" '404': @@ -7628,7 +7655,7 @@ paths: News Item Not Found: value: type: error.list - request_id: beb0d6e5-3a55-4803-a4c9-f7a7bb6da014 + request_id: 89a4b16c-51fb-4cb3-be48-ad9fa39aa6de errors: - code: not_found message: Resource Not Found @@ -7642,7 +7669,7 @@ paths: Unauthorized: value: type: error.list - request_id: 03ac4e41-2a47-4880-bbca-a4f920f7ec4a + request_id: b6203f32-d723-4af0-bc02-0b385b6e3470 errors: - code: unauthorized message: Access Token Invalid @@ -7673,12 +7700,12 @@ paths: examples: successful: value: - id: '415' + id: '93' type: news-item - workspace_id: this_is_an_id495_that_should_be_at_least_ + workspace_id: this_is_an_id506_that_should_be_at_least_ title: Christmas is here! body: "

    New gifts in store for the jolly season

    " - sender_id: 991281186 + sender_id: 991269764 state: live labels: [] cover_image_url: @@ -7686,8 +7713,8 @@ paths: - "\U0001F61D" - "\U0001F602" deliver_silently: false - created_at: 1712222142 - updated_at: 1712222143 + created_at: 1715076735 + updated_at: 1715076736 newsfeed_assignments: [] schema: "$ref": "#/components/schemas/news_item" @@ -7699,7 +7726,7 @@ paths: News Item Not Found: value: type: error.list - request_id: 8d3b5b61-5606-47e0-afc5-ace58ecaac68 + request_id: 9bec5ce3-08df-4d8a-9959-81e7b45b15c7 errors: - code: not_found message: Resource Not Found @@ -7713,7 +7740,7 @@ paths: Unauthorized: value: type: error.list - request_id: 463c2478-a07c-4e26-8ffe-664046f352cf + request_id: 31d56c70-926f-41a8-aa39-11dbe65fb2a0 errors: - code: unauthorized message: Access Token Invalid @@ -7730,7 +7757,7 @@ paths: value: title: Christmas is here! body: "

    New gifts in store for the jolly season

    " - sender_id: 991281186 + sender_id: 991269764 reactions: - "\U0001F61D" - "\U0001F602" @@ -7739,7 +7766,7 @@ paths: value: title: Christmas is here! body: "

    New gifts in store for the jolly season

    " - sender_id: 991281189 + sender_id: 991269767 reactions: - "\U0001F61D" - "\U0001F602" @@ -7769,7 +7796,7 @@ paths: examples: successful: value: - id: '418' + id: '96' object: news-item deleted: true schema: @@ -7782,7 +7809,7 @@ paths: News Item Not Found: value: type: error.list - request_id: 3ad45670-25f9-42e4-9829-d025a27e7405 + request_id: c6db651b-3782-4f5d-8d3c-938f1ee360b0 errors: - code: not_found message: Resource Not Found @@ -7796,7 +7823,7 @@ paths: Unauthorized: value: type: error.list - request_id: 1cd35ae7-cd52-4503-91d1-f89277a022e3 + request_id: 9ddeb720-825f-4b21-b328-f47129f3106d errors: - code: unauthorized message: Access Token Invalid @@ -7849,7 +7876,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0d8de92d-20de-4058-a5b2-dbbb9cbc3e1c + request_id: 3b5dd2e7-45b6-41c3-b63d-f60678a71b9f errors: - code: unauthorized message: Access Token Invalid @@ -7882,16 +7909,16 @@ paths: total_pages: 1 type: pages data: - - id: '743' + - id: '168' type: newsfeed name: Visitor Feed - created_at: 1712222147 - updated_at: 1712222147 - - id: '744' + created_at: 1715076740 + updated_at: 1715076740 + - id: '169' type: newsfeed name: Visitor Feed - created_at: 1712222147 - updated_at: 1712222147 + created_at: 1715076740 + updated_at: 1715076740 total_count: 2 schema: "$ref": "#/components/schemas/paginated_response" @@ -7903,7 +7930,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8934211a-07fa-4d31-9b9b-b02a40c8cbc4 + request_id: 482e6d0e-24ff-46af-a5fa-1d2da4c4cca3 errors: - code: unauthorized message: Access Token Invalid @@ -7937,11 +7964,11 @@ paths: examples: successful: value: - id: '747' + id: '172' type: newsfeed name: Visitor Feed - created_at: 1712222148 - updated_at: 1712222148 + created_at: 1715076740 + updated_at: 1715076740 schema: "$ref": "#/components/schemas/newsfeed" '401': @@ -7952,7 +7979,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0bf1c732-6996-41b4-8c82-5a82f03241b2 + request_id: 1423c5ec-1328-418f-b7ae-03c6cf5f0f83 errors: - code: unauthorized message: Access Token Invalid @@ -7986,16 +8013,16 @@ paths: Note found: value: type: note - id: '408' - created_at: 1711530949 + id: '89' + created_at: 1714385541 contact: type: contact - id: 660e6fc56abd01b859dcb3a3 + id: 6639fe852d114e004ff12299 author: type: admin - id: '991281205' - name: Ciaran312 Lee - email: admin312@email.com + id: '991269783' + name: Ciaran323 Lee + email: admin323@email.com away_mode_enabled: false away_mode_reassign: false body: "

    This is a note.

    " @@ -8009,7 +8036,7 @@ paths: Note not found: value: type: error.list - request_id: a51d66f3-b7a6-41f2-a5dc-ad6e55ab8179 + request_id: ea95f389-ba98-4583-95ca-417607de17d7 errors: - code: not_found message: Resource Not Found @@ -8023,7 +8050,7 @@ paths: Unauthorized: value: type: error.list - request_id: 231a2236-0f05-403d-a878-edc350caf313 + request_id: 1feb977d-91fb-4bc9-b652-dfdc57047d95 errors: - code: unauthorized message: Access Token Invalid @@ -8059,16 +8086,16 @@ paths: type: segment.list segments: - type: segment - id: 660e6fc66abd01b859dcb3a6 + id: 6639fe882d114e004ff1229c name: John segment - created_at: 1712222150 - updated_at: 1712222150 + created_at: 1715076744 + updated_at: 1715076744 person_type: user - type: segment - id: 660e6fc66abd01b859dcb3a7 + id: 6639fe882d114e004ff1229d name: Jane segment - created_at: 1712222150 - updated_at: 1712222150 + created_at: 1715076744 + updated_at: 1715076744 person_type: user schema: "$ref": "#/components/schemas/segment_list" @@ -8080,7 +8107,7 @@ paths: Unauthorized: value: type: error.list - request_id: e8b29b81-4468-4777-80d0-8cbbb186b714 + request_id: 96af3cad-7c45-444e-8799-5456be1bdf0b errors: - code: unauthorized message: Access Token Invalid @@ -8114,10 +8141,10 @@ paths: Successful response: value: type: segment - id: 660e6fc76abd01b859dcb3aa + id: 6639fe892d114e004ff122a0 name: John segment - created_at: 1712222151 - updated_at: 1712222151 + created_at: 1715076745 + updated_at: 1715076745 person_type: user schema: "$ref": "#/components/schemas/segment" @@ -8129,7 +8156,7 @@ paths: Segment not found: value: type: error.list - request_id: c8b37c13-31d0-44b4-b456-b03fa66729d9 + request_id: 5b692390-9db5-404d-ad85-1efb8dfe1735 errors: - code: not_found message: Resource Not Found @@ -8143,7 +8170,7 @@ paths: Unauthorized: value: type: error.list - request_id: 93fe62ac-5123-4451-93b8-58f23a063e07 + request_id: fbd7cebc-6c3a-4674-b12e-1f7df2362cb5 errors: - code: unauthorized message: Access Token Invalid @@ -8173,7 +8200,7 @@ paths: type: list data: - type: subscription - id: '1467' + id: '321' state: live consent_type: opt_out default_translation: @@ -8196,7 +8223,7 @@ paths: Unauthorized: value: type: error.list - request_id: df87e240-b206-435d-9f35-505781eef9a9 + request_id: d759bc9e-6e82-4850-84ff-0c5c0dc78416 errors: - code: unauthorized message: Access Token Invalid @@ -8226,7 +8253,7 @@ paths: examples: successful: value: - url: http://via.intercom.io/msgr/695c21ab-d51a-49d8-9a80-fdc86373478a + url: http://via.intercom.io/msgr/ebd0cd6d-c666-48a8-baa5-c4e5ab4c6c55 type: phone_call_redirect schema: "$ref": "#/components/schemas/phone_switch" @@ -8259,7 +8286,7 @@ paths: Unauthorized: value: type: error.list - request_id: 564a7f23-24f1-4dff-b853-564e37acf0c3 + request_id: d6431f68-b2d7-4a73-a6d5-8807dc302de3 errors: - code: unauthorized message: Access Token Invalid @@ -8322,7 +8349,7 @@ paths: type: list data: - type: tag - id: '1298' + id: '284' name: Manual tag 1 schema: "$ref": "#/components/schemas/tag_list" @@ -8334,7 +8361,7 @@ paths: Unauthorized: value: type: error.list - request_id: e4bb2306-432d-40fd-a0d1-0d70d1a951c5 + request_id: 95a08969-4760-4694-8790-a8bf1588c00f errors: - code: unauthorized message: Access Token Invalid @@ -8373,7 +8400,7 @@ paths: Action successful: value: type: tag - id: '1301' + id: '287' name: test schema: "$ref": "#/components/schemas/tag" @@ -8385,7 +8412,7 @@ paths: Invalid parameters: value: type: error.list - request_id: 7a4797d2-9220-4b5c-bb8e-fa39ba839bd7 + request_id: 1ced3806-e717-4dbb-a088-9c60e12580d3 errors: - code: parameter_invalid message: invalid tag parameters @@ -8399,14 +8426,14 @@ paths: Company not found: value: type: error.list - request_id: 5fb87673-b4cf-441b-9d3f-13258dc165e4 + request_id: bbbfef2f-9584-48f4-80be-2e8d815e92b0 errors: - code: company_not_found message: Company Not Found User not found: value: type: error.list - request_id: 0450ca25-8a54-462b-a50e-2abff458d07d + request_id: 9070ab46-870c-4d86-88a4-7684cf6d20c9 errors: - code: not_found message: User Not Found @@ -8420,7 +8447,7 @@ paths: Unauthorized: value: type: error.list - request_id: c237beca-ffa3-4f7b-97b8-675f26e66489 + request_id: c3808862-ef01-4a85-ba43-6523bca68c33 errors: - code: unauthorized message: Access Token Invalid @@ -8486,7 +8513,7 @@ paths: Tag found: value: type: tag - id: '1309' + id: '295' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -8498,7 +8525,7 @@ paths: Tag not found: value: type: error.list - request_id: 4ba4474c-4ab1-4905-9156-1b9834e788df + request_id: 01a0ce95-7def-4a2e-ba85-01f925e852e6 errors: - code: not_found message: Resource Not Found @@ -8512,7 +8539,7 @@ paths: Unauthorized: value: type: error.list - request_id: df8eb76c-98fc-4907-ba4b-006d4259f073 + request_id: 11c9245b-c075-4f47-947b-451fc876cb90 errors: - code: unauthorized message: Access Token Invalid @@ -8548,7 +8575,7 @@ paths: Resource not found: value: type: error.list - request_id: c9ae47bd-5623-4cba-8bf9-9a78cbfba42e + request_id: cbaaf1e1-b323-4a20-a42d-ec692b74d208 errors: - code: not_found message: Resource Not Found @@ -8562,7 +8589,7 @@ paths: Tag has dependent objects: value: type: error.list - request_id: eee5a6c7-c5cb-47b0-8248-f62723c0b3eb + request_id: b2818836-ff6e-4623-8775-d70b2f791017 errors: - code: tag_has_dependent_objects message: 'Unable to delete Tag with dependent objects. Segments: @@ -8577,7 +8604,7 @@ paths: Unauthorized: value: type: error.list - request_id: 145c8f95-71b0-49bf-bc10-a20f040a633f + request_id: e1298654-ebae-4adc-87fc-983ed205001a errors: - code: unauthorized message: Access Token Invalid @@ -8615,7 +8642,7 @@ paths: Unauthorized: value: type: error.list - request_id: 1196ca15-ce03-4561-af29-dfcd9c36280c + request_id: 36c5ab24-0d9f-4d4c-8f6c-2990a481029c errors: - code: unauthorized message: Access Token Invalid @@ -8650,7 +8677,7 @@ paths: successful: value: type: team - id: '991281243' + id: '991269821' name: team 1 admin_ids: [] schema: @@ -8663,7 +8690,7 @@ paths: Team not found: value: type: error.list - request_id: 5e18f354-4852-4184-90a6-6cee71569d21 + request_id: bb6bcc55-3a64-48bd-ac1a-2ba49aa68300 errors: - code: team_not_found message: Team not found @@ -8677,7 +8704,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9a511189-f61c-4f76-9a29-419d72e2a58e + request_id: c556823e-26e0-4d4f-a201-b1b018e5fdf9 errors: - code: unauthorized message: Access Token Invalid @@ -8709,26 +8736,26 @@ paths: successful: value: type: visitor - id: 660e6fe46abd01b859dcb3ce + id: 6639fea52d114e004ff122c4 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' phone: name: Gareth Bale - pseudonym: Turquoise Fish + pseudonym: Pink Bottle avatar: type: avatar - image_url: https://static.intercomassets.com/app/pseudonym_avatars_2019/turquoise-fish.png - app_id: this_is_an_id611_that_should_be_at_least_ + image_url: https://static.intercomassets.com/app/pseudonym_avatars_2019/pink-bottle.png + app_id: this_is_an_id622_that_should_be_at_least_ companies: type: company.list companies: [] location_data: {} last_request_at: - created_at: 1712222181 - remote_created_at: 1712222180 - signed_up_at: 1712222180 - updated_at: 1712222181 + created_at: 1715076773 + remote_created_at: 1715076773 + signed_up_at: 1715076773 + updated_at: 1715076773 session_count: 0 social_profiles: type: social_profile.list @@ -8761,7 +8788,7 @@ paths: visitor Not Found: value: type: error.list - request_id: e4df64a4-a1ab-408a-81e1-3a643ed70100 + request_id: 288845ee-f5a9-411d-a633-591e569b928c errors: - code: not_found message: Visitor Not Found @@ -8775,7 +8802,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2a21f992-ac5c-486d-a602-98ef9f8d3b6f + request_id: 98d2166b-d421-4d4a-91df-05f8b865f92f errors: - code: unauthorized message: Access Token Invalid @@ -8790,7 +8817,7 @@ paths: successful: summary: successful value: - id: 660e6fe46abd01b859dcb3ce + id: 6639fea52d114e004ff122c4 name: Gareth Bale visitor_not_found: summary: visitor Not Found @@ -8823,7 +8850,7 @@ paths: successful: value: type: visitor - id: 660e6fe66abd01b859dcb3d4 + id: 6639fea72d114e004ff122ca user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' @@ -8833,16 +8860,16 @@ paths: avatar: type: avatar image_url: - app_id: this_is_an_id617_that_should_be_at_least_ + app_id: this_is_an_id628_that_should_be_at_least_ companies: type: company.list companies: [] location_data: {} last_request_at: - created_at: 1712222182 - remote_created_at: 1712222182 - signed_up_at: 1712222182 - updated_at: 1712222182 + created_at: 1715076775 + remote_created_at: 1715076775 + signed_up_at: 1715076775 + updated_at: 1715076775 session_count: 0 social_profiles: type: social_profile.list @@ -8875,7 +8902,7 @@ paths: Visitor not found: value: type: error.list - request_id: e05c1872-31bc-487e-9c03-cee6a538f7f1 + request_id: 3ba4615b-a5ed-4e5d-83de-75bb5912d3ae errors: - code: not_found message: Visitor Not Found @@ -8889,206 +8916,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2f639294-b68f-4560-9ac6-dffa66e30fee - errors: - - code: unauthorized - message: Access Token Invalid - schema: - "$ref": "#/components/schemas/error" - "/visitors/{id}": - get: - summary: Retrieve a visitor with ID - parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - - name: id - in: path - required: true - description: Id provided by Intercom. - example: 5e1c4c1c-7b1e-4b5d-8c1c-5e1c4c1c7b1e - schema: - type: string - tags: - - Visitors - operationId: retrieveVisitor - description: You can fetch the details of a single visitor. - responses: - '200': - description: successful - content: - application/json: - examples: - successful: - value: - type: visitor - id: 660e6fe86abd01b859dcb3da - user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 - anonymous: true - email: '' - phone: - name: - pseudonym: - avatar: - type: avatar - image_url: - app_id: this_is_an_id623_that_should_be_at_least_ - companies: - type: company.list - companies: [] - location_data: {} - last_request_at: - created_at: 1712222184 - remote_created_at: 1712222184 - signed_up_at: 1712222184 - updated_at: 1712222184 - session_count: 0 - social_profiles: - type: social_profile.list - social_profiles: [] - owner_id: - unsubscribed_from_emails: false - marked_email_as_spam: false - has_hard_bounced: false - tags: - type: tag.list - tags: [] - segments: - type: segment.list - segments: [] - custom_attributes: {} - referrer: - utm_campaign: - utm_content: - utm_medium: - utm_source: - utm_term: - do_not_track: - schema: - "$ref": "#/components/schemas/visitor" - '404': - description: Visitor not found - content: - application/json: - examples: - Visitor not found: - value: - type: error.list - request_id: de5b8625-5bd8-408a-9ca4-add9c077fa12 - errors: - - code: not_found - message: Visitor Not Found - schema: - "$ref": "#/components/schemas/error" - '401': - description: Unauthorized - content: - application/json: - examples: - Unauthorized: - value: - type: error.list - request_id: 7993d9ca-a46a-400b-89c5-71a6a057ee81 - errors: - - code: unauthorized - message: Access Token Invalid - schema: - "$ref": "#/components/schemas/error" - delete: - summary: Delete a visitor - parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - - name: id - in: path - required: true - description: Id provided by Intercom. - example: 5e1c4c1c-7b1e-4b5d-8c1c-5e1c4c1c7b1e - schema: - type: string - tags: - - Visitors - operationId: deleteVisitor - description: You can delete a single visitor. - responses: - '200': - description: successful - content: - application/json: - examples: - successful: - value: - type: visitor - id: 660e6fea6abd01b859dcb3e0 - user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 - anonymous: true - email: '' - phone: - name: - pseudonym: - avatar: - type: avatar - image_url: - app_id: this_is_an_id629_that_should_be_at_least_ - companies: - type: company.list - companies: [] - location_data: {} - last_request_at: - created_at: 1712222186 - remote_created_at: 1712222186 - signed_up_at: 1712222186 - updated_at: 1712222186 - session_count: 0 - social_profiles: - type: social_profile.list - social_profiles: [] - owner_id: - unsubscribed_from_emails: false - marked_email_as_spam: false - has_hard_bounced: false - tags: - type: tag.list - tags: [] - segments: - type: segment.list - segments: [] - custom_attributes: {} - referrer: - utm_campaign: - utm_content: - utm_medium: - utm_source: - utm_term: - do_not_track: - schema: - "$ref": "#/components/schemas/visitor_deleted_object" - '404': - description: Visitor Not Found - content: - application/json: - examples: - Visitor Not Found: - value: - type: error.list - request_id: ce8db3cc-eb16-4311-ad18-2541d85a74e0 - errors: - - code: not_found - message: User Not Found - schema: - "$ref": "#/components/schemas/error" - '401': - description: Unauthorized - content: - application/json: - examples: - Unauthorized: - value: - type: error.list - request_id: 12cf66e4-a550-447e-abf3-6cb5073c8fc9 + request_id: 813b2b40-10f3-4bb6-8ef5-f3377f2ef064 errors: - code: unauthorized message: Access Token Invalid @@ -9119,8 +8947,8 @@ paths: successful: value: type: contact - id: 660e6fec6abd01b859dcb3e7 - workspace_id: this_is_an_id635_that_should_be_at_least_ + id: 6639fea82d114e004ff122d1 + workspace_id: this_is_an_id634_that_should_be_at_least_ external_id: role: user email: foo@bar.com @@ -9134,9 +8962,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1712222188 - updated_at: 1712222188 - signed_up_at: 1712222188 + created_at: 1715076776 + updated_at: 1715076777 + signed_up_at: 1715076776 last_seen_at: last_replied_at: last_contacted_at: @@ -9170,31 +8998,31 @@ paths: tags: type: list data: [] - url: "/contacts/660e6fec6abd01b859dcb3e7/tags" + url: "/contacts/6639fea82d114e004ff122d1/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/660e6fec6abd01b859dcb3e7/notes" + url: "/contacts/6639fea82d114e004ff122d1/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/660e6fec6abd01b859dcb3e7/companies" + url: "/contacts/6639fea82d114e004ff122d1/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/660e6fec6abd01b859dcb3e7/subscriptions" + url: "/contacts/6639fea82d114e004ff122d1/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/660e6fec6abd01b859dcb3e7/subscriptions" + url: "/contacts/6639fea82d114e004ff122d1/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -9213,7 +9041,7 @@ paths: Unauthorized: value: type: error.list - request_id: 6d075a87-09e0-4121-b95a-12aea70268c3 + request_id: a616fa55-784a-4f4e-82fc-cc985e1a56ce errors: - code: unauthorized message: Access Token Invalid @@ -13011,6 +12839,7 @@ components: - '2.8' - '2.9' - '2.10' + - '2.11' - Unstable merge_contacts_request: description: Merge contact data. @@ -13078,6 +12907,8 @@ components: - body - message_type multiple_filter_search_request: + title: Multiple Filter Search Request + description: Search using Intercoms Search APIs with more than one filter. type: object properties: operator: @@ -13725,12 +13556,14 @@ components: description: A pagination object, which may be empty, indicating no further pages to fetch. single_filter_search_request: + title: Single Filter Search Request + description: Search using Intercoms Search APIs with a single filter. type: object properties: field: type: string - description: The Intercom defined id representing the company. - example: custom_attributes.social_network + description: The accepted field that you want to search on. + example: created_at operator: type: string enum: @@ -13744,12 +13577,13 @@ components: - "!~" - "^" - "$" - description: The Intercom defined id representing the company. - example: "=" + description: The accepted operators you can use to define how you want to + search for the value. + example: ">" value: type: string - description: The Intercom defined id representing the company. - example: facebook + description: The value that you want to search on. + example: '73732934' sla_applied: title: Applied SLA type: object @@ -13822,16 +13656,20 @@ components: description: The name of the Social media profile example: http://twitter.com/th1sland starting_after_paging: - title: StartingAfterPaging + title: 'Pagination: Starting After' type: object nullable: true properties: - page: + per_page: type: integer + description: The number of results to fetch per page. example: 2 starting_after: type: string - example: 1HaSB+xrOyyMXAkS/c1RteCL7BzOzTvYjmjakgTergIH31eoe2v4/sbLsJWP\nIncfQLD3ouPkZlCwJ86F\n + description: The cursor to use in the next request to get the next page + of results. + nullable: true + example: your-cursor-from-response subscription_type: title: Subscription Types type: object diff --git a/descriptions/2.8/api.intercom.io.yaml b/descriptions/2.8/api.intercom.io.yaml index c30c56b..037220e 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: '991281329' + id: '991269901' 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: 1712222201 + created_at: 1715076787 secure: false identity_verification: false timezone: America/Los_Angeles @@ -83,7 +83,7 @@ paths: Successful response: value: type: admin - id: '991281330' + id: '991269902' 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: 5c81e207-3b1a-441c-bba5-2212a62b8cd4 + request_id: a70b9689-487c-4af1-a0a7-9a9f17242f1a errors: - code: admin_not_found message: Admin for admin_id not found @@ -114,7 +114,7 @@ paths: Unauthorized: value: type: error.list - request_id: cfd875ca-3d90-48c8-99d2-b214bd8caea3 + request_id: 72f75ea2-5979-4dad-a912-796bbada766d errors: - code: unauthorized message: Access Token Invalid @@ -201,10 +201,10 @@ paths: per_page: 20 total_pages: 1 activity_logs: - - id: b9bbe5d7-c2e9-4d0a-9a0d-54672f7e4f40 + - id: 2bdd9b22-c0e9-4c01-88fb-e4f8237f1b4b performed_by: type: admin - id: '991281333' + id: '991269906' email: admin5@email.com ip: 127.0.0.1 metadata: @@ -213,21 +213,21 @@ paths: title: Initial message title before: Initial message title after: Eventual message title - created_at: 1712222206 + created_at: 1715076792 activity_type: message_state_change activity_description: Ciaran5 Lee changed your Initial message title message from Initial message title to Eventual message title. - - id: 3cdbf50e-9f33-4d3b-9a4f-03bd5a6c53d7 + - id: a8f3b27f-678d-4b22-a9d5-26141f45445c performed_by: type: admin - id: '991281333' + id: '991269906' email: admin5@email.com ip: 127.0.0.1 metadata: before: before after: after - created_at: 1712222206 + created_at: 1715076792 activity_type: app_name_change activity_description: Ciaran5 Lee changed your app name from before to after. @@ -241,7 +241,7 @@ paths: Unauthorized: value: type: error.list - request_id: fe3c7f67-d93e-4ca0-bf8d-03436498e315 + request_id: c9eb80cc-f1d7-4d89-a80f-1648d06d6ea7 errors: - code: unauthorized message: Access Token Invalid @@ -271,7 +271,7 @@ paths: admins: - type: admin email: admin7@email.com - id: '991281335' + id: '991269908' name: Ciaran7 Lee away_mode_enabled: false away_mode_reassign: false @@ -287,7 +287,7 @@ paths: Unauthorized: value: type: error.list - request_id: 83c4d0c8-a1ff-44dd-adce-5dce4596fbc6 + request_id: 4b598ae6-6071-4c8f-abd2-934c83dceec8 errors: - code: unauthorized message: Access Token Invalid @@ -321,7 +321,7 @@ paths: Admin found: value: type: admin - id: '991281337' + id: '991269910' 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: 51cbf73d-b868-4230-96e7-3f8d2c59d946 + request_id: 56de2fa5-2258-4e19-a411-c87b979829db errors: - code: admin_not_found message: Admin not found @@ -352,7 +352,7 @@ paths: Unauthorized: value: type: error.list - request_id: 239ef863-71e5-4ec9-a173-624e48e619b3 + request_id: 967cb0a2-5182-4690-889e-933647bfe6a5 errors: - code: unauthorized message: Access Token Invalid @@ -390,20 +390,20 @@ paths: total_pages: 1 total_count: 1 data: - - id: '586' + - id: '126' type: article workspace_id: this_is_an_id22_that_should_be_at_least_4 - parent_id: 2370 + parent_id: 502 parent_type: collection parent_ids: [] title: This is the article title description: '' body: '' - author_id: 991281340 + author_id: 991269913 state: published - created_at: 1712222211 - updated_at: 1712222211 - url: http://help-center.test/myapp-22/en/articles/586-this-is-the-article-title + created_at: 1715076797 + updated_at: 1715076797 + 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: a08db2a7-d468-41c5-aed5-0893f598c984 + request_id: 8d090058-f6c4-42e3-83c8-4ae61de110ae errors: - code: unauthorized message: Access Token Invalid @@ -439,10 +439,10 @@ paths: examples: article created: value: - id: '589' + id: '129' type: article workspace_id: this_is_an_id26_that_should_be_at_least_4 - parent_id: 2372 + 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: 991281345 + author_id: 991269918 state: published - created_at: 1712222213 - updated_at: 1712222213 - url: http://help-center.test/myapp-26/en/articles/589-thanks-for-everything + created_at: 1715076799 + updated_at: 1715076799 + 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: 60119000-28e1-460a-8151-ff350b1cb4ca + request_id: 4c2752e8-44a8-4a19-9b1d-6c48021838eb 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: 16edaf99-20a4-470c-b2c0-84903cf6dce0 + request_id: 8370c7d2-35dc-4e51-a4b7-29da60ccad64 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: 991281345 + author_id: 991269918 state: published - parent_id: 2372 + 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: 991281345 + author_id: 991269918 state: published bad_request: summary: Bad Request @@ -550,10 +550,10 @@ paths: examples: Article found: value: - id: '592' + id: '132' type: article workspace_id: this_is_an_id32_that_should_be_at_least_4 - parent_id: 2375 + parent_id: 507 parent_type: collection parent_ids: [] statistics: @@ -567,11 +567,11 @@ paths: title: This is the article title description: '' body: '' - author_id: 991281350 + author_id: 991269923 state: published - created_at: 1712222215 - updated_at: 1712222215 - url: http://help-center.test/myapp-32/en/articles/592-this-is-the-article-title + created_at: 1715076801 + updated_at: 1715076801 + 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: 669f240f-2056-4548-bdbf-744edfcffab5 + request_id: d595f9aa-d149-4176-9518-c38906f6af00 errors: - code: not_found message: Resource Not Found @@ -596,7 +596,7 @@ paths: Unauthorized: value: type: error.list - request_id: a0022723-b102-4440-bd72-79e820a51397 + request_id: df6f976c-3a8e-4bce-910e-4bc14412530e errors: - code: unauthorized message: Access Token Invalid @@ -629,10 +629,10 @@ paths: examples: successful: value: - id: '595' + id: '135' type: article workspace_id: this_is_an_id38_that_should_be_at_least_4 - parent_id: 2378 + 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: 991281356 + author_id: 991269929 state: published - created_at: 1712222218 - updated_at: 1712222218 - url: http://help-center.test/myapp-38/en/articles/595-christmas-is-here + created_at: 1715076803 + updated_at: 1715076803 + 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: 3d6a702c-2ec4-4a23-a242-23d7c343b08f + request_id: 04f1bf4b-69cc-44b1-83d1-8ef72cee1852 errors: - code: not_found message: Resource Not Found @@ -675,7 +675,7 @@ paths: Unauthorized: value: type: error.list - request_id: 3c847647-4324-42d4-9a43-961fdbd20e20 + request_id: cb57a2f3-8364-4e84-a261-89a9ac0db115 errors: - code: unauthorized message: Access Token Invalid @@ -723,7 +723,7 @@ paths: examples: successful: value: - id: '598' + id: '138' object: article deleted: true schema: @@ -736,7 +736,7 @@ paths: Article Not Found: value: type: error.list - request_id: 34d5e1a8-0ea7-4717-9ff3-85590e5621a9 + request_id: 10e176bf-1717-436d-8e53-68766763029e errors: - code: not_found message: Resource Not Found @@ -750,7 +750,7 @@ paths: Unauthorized: value: type: error.list - request_id: 1a3d0287-30f8-4e20-ae74-2c76578e20fa + request_id: 0c926f1c-09e0-4733-8429-29375bfe7170 errors: - code: unauthorized message: Access Token Invalid @@ -781,16 +781,16 @@ paths: value: type: list data: - - id: '2386' + - 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: 1712222223 - updated_at: 1712222223 + created_at: 1715076808 + updated_at: 1715076808 description: english collection description icon: bookmark - help_center_id: 1158 + help_center_id: 254 type: collection total_count: 1 pages: @@ -808,7 +808,7 @@ paths: Unauthorized: value: type: error.list - request_id: 69bfabf4-4b0d-459d-8be3-2a9ef6beda53 + request_id: 674ff899-977f-4392-9dc8-21b238d8e8a7 errors: - code: unauthorized message: Access Token Invalid @@ -833,16 +833,16 @@ paths: examples: collection created: value: - id: '2392' + 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: 1712222224 - updated_at: 1712222224 + created_at: 1715076809 + updated_at: 1715076809 description: '' icon: book-bookmark - help_center_id: 1160 + help_center_id: 256 type: collection schema: "$ref": "#/components/schemas/collection" @@ -854,7 +854,7 @@ paths: Bad Request: value: type: error.list - request_id: 91f62e51-ab70-4743-b801-863560a2456c + request_id: ca8dafe8-5dbf-4791-bdc5-05b2f4fdb9e7 errors: - code: parameter_not_found message: Name is a required parameter. @@ -868,7 +868,7 @@ paths: Unauthorized: value: type: error.list - request_id: 7c2679c6-6c2b-445e-abe9-8f4752fe5a83 + request_id: 990726c0-6ff1-4353-b79f-ee8f4d1c42a1 errors: - code: unauthorized message: Access Token Invalid @@ -916,16 +916,16 @@ paths: examples: Collection found: value: - id: '2397' + 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: 1712222225 - updated_at: 1712222225 + created_at: 1715076810 + updated_at: 1715076810 description: english collection description icon: bookmark - help_center_id: 1163 + help_center_id: 259 type: collection schema: "$ref": "#/components/schemas/collection" @@ -937,7 +937,7 @@ paths: Collection not found: value: type: error.list - request_id: 58ee59cc-b192-4789-a5a6-7d56e93f7d87 + request_id: 30de3af6-aede-484a-946b-2c55ef100741 errors: - code: not_found message: Resource Not Found @@ -951,7 +951,7 @@ paths: Unauthorized: value: type: error.list - request_id: 75911995-6985-4969-ac7e-405913d48385 + request_id: 24c904a2-94fa-45a8-8196-0885e1b2ff45 errors: - code: unauthorized message: Access Token Invalid @@ -984,16 +984,16 @@ paths: examples: successful: value: - id: '2403' + 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: 1712222226 - updated_at: 1712222227 + created_at: 1715076812 + updated_at: 1715076812 description: english collection description icon: folder - help_center_id: 1166 + help_center_id: 262 type: collection schema: "$ref": "#/components/schemas/collection" @@ -1005,7 +1005,7 @@ paths: Collection Not Found: value: type: error.list - request_id: a73e14e0-0135-488a-b2dc-e06545893d21 + request_id: 562991e1-a8e8-43fb-b864-93a1f7e0bea3 errors: - code: not_found message: Resource Not Found @@ -1019,7 +1019,7 @@ paths: Unauthorized: value: type: error.list - request_id: 1f68efe3-410f-4612-a614-a1e8575a53d8 + request_id: b92eccbb-f16a-4f4c-a422-2b235ede3354 errors: - code: unauthorized message: Access Token Invalid @@ -1066,7 +1066,7 @@ paths: examples: successful: value: - id: '2409' + id: '541' object: collection deleted: true schema: @@ -1079,7 +1079,7 @@ paths: collection Not Found: value: type: error.list - request_id: f6beb537-c461-4f43-87cb-6ac18d848d75 + request_id: 28441b24-e8a3-438f-afab-ee4c53a4f0cf errors: - code: not_found message: Resource Not Found @@ -1093,7 +1093,7 @@ paths: Unauthorized: value: type: error.list - request_id: 4a019b9f-0781-453c-b94d-b621ec9c56e8 + request_id: a9e484cf-f3d2-4093-a5e6-699b517eb335 errors: - code: unauthorized message: Access Token Invalid @@ -1127,10 +1127,10 @@ paths: examples: Collection found: value: - id: '1172' + id: '268' workspace_id: this_is_an_id80_that_should_be_at_least_4 - created_at: 1712222230 - updated_at: 1712222230 + created_at: 1715076815 + updated_at: 1715076815 identifier: help-center-1 website_turned_on: false display_name: Intercom Help Center @@ -1144,7 +1144,7 @@ paths: Collection not found: value: type: error.list - request_id: 157a994d-6746-4be2-a417-b181e12f183e + request_id: 5f65b97d-14df-43f4-9195-e51d34dbe582 errors: - code: not_found message: Resource Not Found @@ -1158,7 +1158,7 @@ paths: Unauthorized: value: type: error.list - request_id: b63cbd94-c7e2-4aa6-a655-faede3cc8bb2 + request_id: 1ddd1daa-0e08-44bd-9117-480110abb04a errors: - code: unauthorized message: Access Token Invalid @@ -1196,7 +1196,7 @@ paths: Unauthorized: value: type: error.list - request_id: c5931917-593a-4a04-aadd-72aa7eeda20d + request_id: ebfa90f8-1898-4ab2-b979-794f7b98b6f8 errors: - code: unauthorized message: Access Token Invalid @@ -1228,15 +1228,15 @@ paths: value: type: list data: - - id: '2416' + - 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: 1712222232 - updated_at: 1712222232 + created_at: 1715076817 + updated_at: 1715076817 type: section - parent_id: 2415 + parent_id: 547 total_count: 1 pages: type: pages @@ -1253,7 +1253,7 @@ paths: Unauthorized: value: type: error.list - request_id: 00d36d3c-5565-477f-8588-a4f95fa36883 + request_id: 954402f3-a5f7-4cd6-9421-92033f814778 errors: - code: unauthorized message: Access Token Invalid @@ -1278,15 +1278,15 @@ paths: examples: section created: value: - id: '2421' + 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: 1712222233 - updated_at: 1712222233 + created_at: 1715076818 + updated_at: 1715076818 type: section - parent_id: '2419' + parent_id: '551' schema: "$ref": "#/components/schemas/section" '401': @@ -1297,7 +1297,7 @@ paths: Unauthorized: value: type: error.list - request_id: bec0ead8-d7a4-4d92-ad30-11b8b2a34981 + request_id: 47c8b989-0600-40a7-9ac8-db09369c734b errors: - code: unauthorized message: Access Token Invalid @@ -1313,7 +1313,7 @@ paths: summary: section created value: name: Thanks for everything - parent_id: 2419 + parent_id: 551 "/help_center/sections/{id}": get: summary: Retrieve a section @@ -1342,15 +1342,15 @@ paths: examples: Section found: value: - id: '2425' + 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: 1712222233 - updated_at: 1712222233 + created_at: 1715076818 + updated_at: 1715076818 type: section - parent_id: 2424 + parent_id: 556 schema: "$ref": "#/components/schemas/section" '404': @@ -1361,7 +1361,7 @@ paths: Section not found: value: type: error.list - request_id: b70a05db-bfc5-4369-a440-abead9724567 + request_id: fd3c11b1-95ca-41d0-a1ee-7efc5f7cb9e0 errors: - code: not_found message: Resource Not Found @@ -1375,7 +1375,7 @@ paths: Unauthorized: value: type: error.list - request_id: 29ca63c2-769a-45c5-992a-f0cc8808e349 + request_id: 77a54aec-796b-4870-95f4-2317a9f2c112 errors: - code: unauthorized message: Access Token Invalid @@ -1408,15 +1408,15 @@ paths: examples: successful: value: - id: '2431' + 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: 1712222235 - updated_at: 1712222235 + created_at: 1715076820 + updated_at: 1715076820 type: section - parent_id: '2430' + parent_id: '562' schema: "$ref": "#/components/schemas/section" '404': @@ -1427,7 +1427,7 @@ paths: Section Not Found: value: type: error.list - request_id: fcd3f377-ede6-43c4-9627-fe4ef591bf48 + request_id: 7723a640-c521-4828-af41-2fb433d9a08d errors: - code: not_found message: Resource Not Found @@ -1441,7 +1441,7 @@ paths: Unauthorized: value: type: error.list - request_id: acfb2441-34c9-4ddd-a227-8fa5d4db2e79 + request_id: c40e15af-a2fb-4cfb-91ad-05ab065b4bee errors: - code: unauthorized message: Access Token Invalid @@ -1457,12 +1457,12 @@ paths: summary: successful value: name: Update section name - parent_id: 2430 + parent_id: 562 section_not_found: summary: Section Not Found value: name: Update section name - parent_id: 2432 + parent_id: 564 delete: summary: Delete a section parameters: @@ -1489,7 +1489,7 @@ paths: examples: successful: value: - id: '2437' + id: '569' object: section deleted: true schema: @@ -1502,7 +1502,7 @@ paths: section Not Found: value: type: error.list - request_id: 016ff62a-bf5f-4046-838d-3b4719a9f397 + request_id: ade3774f-3597-45fb-a730-e4632aca0f97 errors: - code: not_found message: Resource Not Found @@ -1516,7 +1516,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2d5151db-c718-44ac-8eb9-e142fae99e57 + request_id: 4eba5ea0-2be9-4c95-8249-97250b07b567 errors: - code: unauthorized message: Access Token Invalid @@ -1553,12 +1553,12 @@ paths: value: type: company company_id: company_remote_id - id: 660e701e6abd01b9d190427b + id: 6639fed8c2ba3caea1b55841 app_id: this_is_an_id116_that_should_be_at_least_ name: my company remote_created_at: 1374138000 - created_at: 1712222238 - updated_at: 1712222238 + created_at: 1715076824 + updated_at: 1715076824 monthly_spend: 0 session_count: 0 user_count: 0 @@ -1595,7 +1595,7 @@ paths: Unauthorized: value: type: error.list - request_id: 69aa4d6b-3a87-49ac-a0df-a22d1ad98b96 + request_id: '039a4f38-a278-4a92-ac8a-7868e04020a1' errors: - code: unauthorized message: Access Token Invalid @@ -1693,12 +1693,12 @@ paths: data: - type: company company_id: remote_companies_scroll_2 - id: 660e70206abd01b9d1904283 + id: 6639fed9c2ba3caea1b55849 app_id: this_is_an_id122_that_should_be_at_least_ name: IntercomQATest1 - remote_created_at: 1712222240 - created_at: 1712222240 - updated_at: 1712222240 + remote_created_at: 1715076825 + created_at: 1715076825 + updated_at: 1715076825 monthly_spend: 0 session_count: 0 user_count: 4 @@ -1727,7 +1727,7 @@ paths: Company Not Found: value: type: error.list - request_id: a3b7541c-f2d4-4c87-9a91-0aa6b1715345 + request_id: e0ce78f7-ed61-4d69-9c40-71b833ef1520 errors: - code: company_not_found message: Company Not Found @@ -1741,7 +1741,7 @@ paths: Unauthorized: value: type: error.list - request_id: 485e9fee-ab06-4f4f-ab34-dfc8e2296d58 + request_id: cc60da11-2035-4578-9d74-8bc88219f0fd errors: - code: unauthorized message: Access Token Invalid @@ -1776,12 +1776,12 @@ paths: value: type: company company_id: '1' - id: 660e70226abd01b9d190428e + id: 6639fedbc2ba3caea1b55854 app_id: this_is_an_id128_that_should_be_at_least_ name: company1 - remote_created_at: 1712222242 - created_at: 1712222242 - updated_at: 1712222242 + remote_created_at: 1715076827 + created_at: 1715076827 + updated_at: 1715076827 monthly_spend: 0 session_count: 0 user_count: 1 @@ -1803,7 +1803,7 @@ paths: Company Not Found: value: type: error.list - request_id: dda2644d-c7a4-43e9-8f63-c98436ffac65 + request_id: 8240054c-6e6a-48a3-8edb-45260f36cae7 errors: - code: company_not_found message: Company Not Found @@ -1817,7 +1817,7 @@ paths: Unauthorized: value: type: error.list - request_id: ce6c1dde-515c-4609-9660-9f238d54d985 + request_id: edc6a08d-cfa9-4a14-92f0-f233245bcd0c errors: - code: unauthorized message: Access Token Invalid @@ -1856,12 +1856,12 @@ paths: value: type: company company_id: '1' - id: 660e70246abd01b9d1904298 + id: 6639feddc2ba3caea1b5585e app_id: this_is_an_id134_that_should_be_at_least_ name: company2 - remote_created_at: 1712222244 - created_at: 1712222244 - updated_at: 1712222244 + remote_created_at: 1715076829 + created_at: 1715076829 + updated_at: 1715076829 monthly_spend: 0 session_count: 0 user_count: 1 @@ -1883,7 +1883,7 @@ paths: Company Not Found: value: type: error.list - request_id: ad55e899-1285-4b8d-ac72-a6bb367a4860 + request_id: 5d1c3f3b-de26-4412-98d9-4b0bb3dca816 errors: - code: company_not_found message: Company Not Found @@ -1897,7 +1897,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2047742e-5ef4-4438-b584-aa8b2b95e351 + request_id: e2793bf7-2601-4bf5-81fc-9fdf0477d99f errors: - code: unauthorized message: Access Token Invalid @@ -1929,7 +1929,7 @@ paths: examples: Successful: value: - id: 660e70276abd01b9d19042a2 + id: 6639fedfc2ba3caea1b55868 object: company deleted: true schema: @@ -1942,7 +1942,7 @@ paths: Company Not Found: value: type: error.list - request_id: 19fc5bb9-a0a3-44e6-9a5d-6e2ba7dfdb9b + request_id: da4efa2b-1c68-4a1e-b5dc-8c58ac7ed872 errors: - code: company_not_found message: Company Not Found @@ -1956,7 +1956,7 @@ paths: Unauthorized: value: type: error.list - request_id: 36d20d57-3051-4efd-b82f-973361142f57 + request_id: b86f8190-9e3c-4509-8d36-a52424b9c8e7 errors: - code: unauthorized message: Access Token Invalid @@ -2008,7 +2008,7 @@ paths: Company Not Found: value: type: error.list - request_id: 32e3f819-1079-4aaf-82df-770ff81eb8f5 + request_id: bbedd582-d1ed-40a4-b7d2-7b3a6e6f2843 errors: - code: company_not_found message: Company Not Found @@ -2022,7 +2022,7 @@ paths: Unauthorized: value: type: error.list - request_id: fa4cb680-2c24-47de-81de-ec7dddda7f5b + request_id: a524f805-37f7-4115-9cd3-c521154f0d90 errors: - code: unauthorized message: Access Token Invalid @@ -2067,7 +2067,7 @@ paths: Company Not Found: value: type: error.list - request_id: 0244c6eb-aea2-45f6-9a99-9d8ee3ecd2ed + request_id: d5cfa085-f979-4f63-afdf-fac53ea47337 errors: - code: company_not_found message: Company Not Found @@ -2081,7 +2081,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9bb3261d-35f6-4827-ac60-9723ef907e2c + request_id: '0946399c-9244-4e49-9c6d-1946e70ec22d' errors: - code: unauthorized message: Access Token Invalid @@ -2098,14 +2098,14 @@ paths: - name: page in: query required: false - description: what page of results to fetch. Defaults to first page + description: The page of results to fetch. Defaults to first page example: 1 schema: type: integer - name: per_page in: query required: false - description: how many results per page. Defaults to 15 + description: How many results to return per page. Defaults to 15 example: 15 schema: type: integer @@ -2126,6 +2126,10 @@ paths: Note that the API does not include companies who have no associated users in list responses. When using the Companies endpoint and the pages object to iterate through the returned companies, there is a limit of 10,000 Companies that can be returned. If you need to list or iterate on more than 10,000 Companies, please use the [Scroll API](https://developers.intercom.com/reference#iterating-over-all-companies). + {% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `20` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. + {% /admonition %} responses: '200': description: Successful @@ -2138,12 +2142,12 @@ paths: data: - type: company company_id: remote_companies_scroll_2 - id: 660e702d6abd01b9d19042be + id: 6639fee5c2ba3caea1b55884 app_id: this_is_an_id158_that_should_be_at_least_ name: IntercomQATest1 - remote_created_at: 1712222253 - created_at: 1712222253 - updated_at: 1712222253 + remote_created_at: 1715076837 + created_at: 1715076837 + updated_at: 1715076837 monthly_spend: 0 session_count: 0 user_count: 4 @@ -2172,7 +2176,7 @@ paths: Unauthorized: value: type: error.list - request_id: edd00a43-2310-48f8-a67c-d7e2aa921592 + request_id: ed02cd92-5e9b-4f21-99c0-6d2e17064c03 errors: - code: unauthorized message: Access Token Invalid @@ -2195,23 +2199,22 @@ paths: tags: - Companies operationId: scrollOverAllCompanies - description: " The `list all companies` functionality does not work well - for huge datasets, and can result in errors and performance problems when - paging deeply. The Scroll API provides an efficient mechanism for iterating - over all companies in a dataset.\n\n- Each app can only have 1 scroll open - at a time. You'll get an error message if you try to have more than one open - per app.\n- If the scroll isn't used for 1 minute, it expires and calls with - that scroll param will fail\n- If the end of the scroll is reached, \"companies\" - will be empty and the scroll parameter will expire\n\n> \U0001F4D8 Scroll - Parameter\n>\n> You can get the first page of companies by simply sending - a GET request to the scroll endpoint. For subsequent requests you will need - to use the scroll parameter from the response.\n\n> ❗️ Scroll network timeouts\n>\n> - Since scroll is often used on large datasets network errors such as timeouts - can be encountered. When this occurs you will need to restart your scroll - query as it is not possible to continue from a specific point when using scroll.\n>\n> - When this occurs you will see a HTTP 500 error with the following message:\n> - \"Request failed due to an internal network error. Please restart the scroll - operation.\"\n" + description: |2 + The `list all companies` functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. The Scroll API provides an efficient mechanism for iterating over all companies in a dataset. + + - Each app can only have 1 scroll open at a time. You'll get an error message if you try to have more than one open per app. + - If the scroll isn't used for 1 minute, it expires and calls with that scroll param will fail + - If the end of the scroll is reached, "companies" will be empty and the scroll parameter will expire + + {% admonition type="info" name="Scroll Parameter" %} + You can get the first page of companies by simply sending a GET request to the scroll endpoint. + For subsequent requests you will need to use the scroll parameter from the response. + {% /admonition %} + {% admonition type="danger" name="Scroll network timeouts" %} + Since scroll is often used on large datasets network errors such as timeouts can be encountered. When this occurs you will see a HTTP 500 error with the following message: + "Request failed due to an internal network error. Please restart the scroll operation." + If this happens, you will need to restart your scroll query: It is not possible to continue from a specific point when using scroll. + {% /admonition %} responses: '200': description: Successful @@ -2224,12 +2227,12 @@ paths: data: - type: company company_id: remote_companies_scroll_2 - id: 660e702e6abd01b9d19042c4 + id: 6639fee6c2ba3caea1b5588a app_id: this_is_an_id162_that_should_be_at_least_ name: IntercomQATest1 - remote_created_at: 1712222254 - created_at: 1712222254 - updated_at: 1712222254 + remote_created_at: 1715076838 + created_at: 1715076838 + updated_at: 1715076838 monthly_spend: 0 session_count: 0 user_count: 4 @@ -2243,7 +2246,7 @@ paths: custom_attributes: {} pages: total_count: - scroll_param: 8f5c81a7-835d-438f-9153-6f3a4c39d5ba + scroll_param: 66004422-da47-44bf-bf90-f9175a62d02e schema: "$ref": "#/components/schemas/company_scroll" '401': @@ -2254,7 +2257,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8b6145eb-66ab-48c6-8385-73b122d2b7be + request_id: b7de5ded-8164-4039-ae27-108ad90d36d8 errors: - code: unauthorized message: Access Token Invalid @@ -2289,12 +2292,12 @@ paths: value: type: company company_id: '1' - id: 660e70306abd01b9d19042cd + id: 6639fee8c2ba3caea1b55893 app_id: this_is_an_id166_that_should_be_at_least_ name: company6 - remote_created_at: 1712222256 - created_at: 1712222256 - updated_at: 1712222256 + remote_created_at: 1715076840 + created_at: 1715076840 + updated_at: 1715076840 monthly_spend: 0 session_count: 0 user_count: 1 @@ -2316,7 +2319,7 @@ paths: Bad Request: value: type: error.list - request_id: 9582b03e-8cc1-48cc-a752-f8e83ae0f01b + request_id: bd44cec6-e482-45e1-895f-9a7870af59d5 errors: - code: parameter_not_found message: company not specified @@ -2330,7 +2333,7 @@ paths: Company Not Found: value: type: error.list - request_id: ed2415d0-d151-422d-9151-79527ab83967 + request_id: ad050719-50f9-4cdf-847b-02c8f15bcdf5 errors: - code: company_not_found message: Company Not Found @@ -2344,7 +2347,7 @@ paths: Unauthorized: value: type: error.list - request_id: dbbeab9b-64fe-47c4-8f4a-da9e65d0fabe + request_id: a4f1ab9e-7157-4154-b3ab-4b09e44c5484 errors: - code: unauthorized message: Access Token Invalid @@ -2367,7 +2370,7 @@ paths: successful: summary: Successful value: - id: 660e70306abd01b9d19042cd + id: 6639fee8c2ba3caea1b55893 bad_request: summary: Bad Request value: @@ -2406,13 +2409,13 @@ paths: data: - type: company company_id: '1' - id: 660e70366abd01b9d19042ee + id: 6639feeec2ba3caea1b558b4 app_id: this_is_an_id182_that_should_be_at_least_ name: company12 - remote_created_at: 1712222262 - created_at: 1712222262 - updated_at: 1712222262 - last_request_at: 1712049462 + remote_created_at: 1715076846 + created_at: 1715076846 + updated_at: 1715076846 + last_request_at: 1714904046 monthly_spend: 0 session_count: 0 user_count: 1 @@ -2441,7 +2444,7 @@ paths: Contact not found: value: type: error.list - request_id: d81c2b78-a154-4d83-9f84-2e70a1af5acc + request_id: eeb1450e-ba6f-4054-a11d-bbf33a402b31 errors: - code: not_found message: User Not Found @@ -2455,7 +2458,7 @@ paths: Unauthorized: value: type: error.list - request_id: b371d841-5651-4f61-9bd1-9640f43d67ef + request_id: 75806e00-dc35-4d70-ba23-57a8682b41f8 errors: - code: unauthorized message: Access Token Invalid @@ -2498,12 +2501,12 @@ paths: value: type: company company_id: '1' - id: 660e70336abd01b9d19042dd + id: 6639feebc2ba3caea1b558a3 app_id: this_is_an_id174_that_should_be_at_least_ name: company8 - remote_created_at: 1712222259 - created_at: 1712222259 - updated_at: 1712222259 + remote_created_at: 1715076843 + created_at: 1715076843 + updated_at: 1715076843 monthly_spend: 0 session_count: 0 user_count: 0 @@ -2525,14 +2528,14 @@ paths: Company Not Found: value: type: error.list - request_id: b6f05246-733d-4fea-927b-82b7e461cda8 + request_id: fb45ee62-32c2-41d3-bb7c-a9ff5b5dc421 errors: - code: company_not_found message: Company Not Found Contact Not Found: value: type: error.list - request_id: 0b8684b1-49e7-4af2-a52c-5f89d3e3e50d + request_id: d0237dba-8a3d-482a-9139-fb056b103dd0 errors: - code: not_found message: User Not Found @@ -2546,7 +2549,7 @@ paths: Unauthorized: value: type: error.list - request_id: c208adf7-7049-47ed-8b62-bdb780fb3368 + request_id: 225950e5-f7a8-429b-8ff7-0c8d7ac7edc4 errors: - code: unauthorized message: Access Token Invalid @@ -2582,42 +2585,42 @@ paths: type: list data: - type: note - id: '413' - created_at: 1711617464 + id: '94' + created_at: 1714472048 contact: type: contact - id: 660e70386abd01b9d19042f9 + id: 6639fef0c2ba3caea1b558bf author: type: admin - id: '991281438' + id: '991270011' name: Ciaran110 Lee email: admin110@email.com away_mode_enabled: false away_mode_reassign: false body: "

    This is a note.

    " - type: note - id: '412' - created_at: 1711531064 + id: '93' + created_at: 1714385648 contact: type: contact - id: 660e70386abd01b9d19042f9 + id: 6639fef0c2ba3caea1b558bf author: type: admin - id: '991281438' + id: '991270011' name: Ciaran110 Lee email: admin110@email.com away_mode_enabled: false away_mode_reassign: false body: "

    This is a note.

    " - type: note - id: '411' - created_at: 1711531064 + id: '92' + created_at: 1714385648 contact: type: contact - id: 660e70386abd01b9d19042f9 + id: 6639fef0c2ba3caea1b558bf author: type: admin - id: '991281438' + id: '991270011' name: Ciaran110 Lee email: admin110@email.com away_mode_enabled: false @@ -2640,7 +2643,7 @@ paths: Contact not found: value: type: error.list - request_id: 92196629-e3b0-420a-974b-e63358cb212e + request_id: beda1e45-be6e-4839-904c-3bf208df04be errors: - code: not_found message: User Not Found @@ -2674,14 +2677,14 @@ paths: Successful response: value: type: note - id: '418' - created_at: 1712222266 + id: '99' + created_at: 1715076849 contact: type: contact - id: 660e70396abd01b9d19042fb + id: 6639fef1c2ba3caea1b558c1 author: type: admin - id: '991281440' + id: '991270013' name: Ciaran112 Lee email: admin112@email.com away_mode_enabled: false @@ -2697,14 +2700,14 @@ paths: Admin not found: value: type: error.list - request_id: 95ea745f-62fb-4d25-8156-0965f329fc7f + request_id: 6d6473e9-705b-44b8-9106-54e35c35b027 errors: - code: not_found message: Resource Not Found Contact not found: value: type: error.list - request_id: 1ad380bf-756e-4afd-97d1-855b8ed3f852 + request_id: 24123e8b-db42-4c9e-bcc2-fb2806a358b5 errors: - code: not_found message: User Not Found @@ -2734,20 +2737,20 @@ paths: successful_response: summary: Successful response value: - contact_id: 660e70396abd01b9d19042fb - admin_id: 991281440 + contact_id: 6639fef1c2ba3caea1b558c1 + admin_id: 991270013 body: Hello admin_not_found: summary: Admin not found value: - contact_id: 660e703a6abd01b9d19042fc + contact_id: 6639fef1c2ba3caea1b558c2 admin_id: 123 body: Hello contact_not_found: summary: Contact not found value: contact_id: 123 - admin_id: 991281442 + admin_id: 991270015 body: Hello "/contacts/{contact_id}/segments": get: @@ -2780,10 +2783,10 @@ paths: type: list data: - type: segment - id: 660e703b6abd01b9d19042fe + id: 6639fef3c2ba3caea1b558c4 name: segment - created_at: 1712222267 - updated_at: 1712222267 + created_at: 1715076851 + updated_at: 1715076851 person_type: user schema: "$ref": "#/components/schemas/contact_segments" @@ -2795,7 +2798,7 @@ paths: Contact not found: value: type: error.list - request_id: d80e241b-f614-4f36-ab58-778d331cb335 + request_id: 578bf880-72d1-4d1c-928e-71acfad5ef3a errors: - code: not_found message: User Not Found @@ -2809,7 +2812,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0e703a88-744f-4ab1-aabc-336496422297 + request_id: 3023f93f-164b-4017-bed8-dbf8295f6be5 errors: - code: unauthorized message: Access Token Invalid @@ -2853,7 +2856,7 @@ paths: type: list data: - type: subscription - id: '1469' + id: '323' state: live consent_type: opt_out default_translation: @@ -2867,7 +2870,7 @@ paths: content_types: - email - type: subscription - id: '1471' + id: '325' state: live consent_type: opt_in default_translation: @@ -2890,7 +2893,7 @@ paths: Contact not found: value: type: error.list - request_id: b09327f9-e7f4-47e8-8589-45283d06e5bb + request_id: 75edaa13-1625-4232-a195-3d17c085150c errors: - code: not_found message: User Not Found @@ -2904,7 +2907,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2b375369-ef9d-4695-859b-d8d2451ebe89 + request_id: f76eb568-a138-489f-a860-44a696ec0316 errors: - code: unauthorized message: Access Token Invalid @@ -2945,7 +2948,7 @@ paths: Successful: value: type: subscription - id: '1484' + id: '338' state: live consent_type: opt_in default_translation: @@ -2968,14 +2971,14 @@ paths: Contact not found: value: type: error.list - request_id: d34f81e7-bc3c-4e33-b6be-3b73505dcb75 + request_id: 18c62c50-4765-45b5-992d-93990c3f0097 errors: - code: not_found message: User Not Found Resource not found: value: type: error.list - request_id: 60d42cc3-443e-4341-ae5b-d3d9f7a23c70 + request_id: ded8be31-f602-4b2c-9523-f4b8fabe6c7b errors: - code: not_found message: Resource Not Found @@ -2989,7 +2992,7 @@ paths: Unauthorized: value: type: error.list - request_id: d9e2de02-d114-40e6-b11e-71f7c336d3df + request_id: de9b0c05-8b8e-4064-b83e-894dbd440869 errors: - code: unauthorized message: Access Token Invalid @@ -3017,12 +3020,12 @@ paths: successful: summary: Successful value: - id: 1484 + id: 338 consent_type: opt_in contact_not_found: summary: Contact not found value: - id: 1488 + id: 342 consent_type: opt_in resource_not_found: summary: Resource not found @@ -3068,7 +3071,7 @@ paths: Successful: value: type: subscription - id: '1500' + id: '354' state: live consent_type: opt_in default_translation: @@ -3091,14 +3094,14 @@ paths: Contact not found: value: type: error.list - request_id: a9db6326-c5d1-4d1f-8c2f-cfe0c73748ba + request_id: 239320af-cd4a-4865-9a51-1085e4b7c347 errors: - code: not_found message: User Not Found Resource not found: value: type: error.list - request_id: d66a2a6f-9099-4f16-8c84-79c11832df48 + request_id: 29f4249f-c178-4f44-9026-1df6188dd0d6 errors: - code: not_found message: Resource Not Found @@ -3112,7 +3115,7 @@ paths: Unauthorized: value: type: error.list - request_id: 967b9180-03c9-4cf8-b5a8-af3b13a2a70c + request_id: b405e27f-401f-40fd-961a-3bfef3fa5482 errors: - code: unauthorized message: Access Token Invalid @@ -3150,7 +3153,7 @@ paths: type: list data: - type: tag - id: '1317' + id: '303' name: Manual tag schema: "$ref": "#/components/schemas/tag_list" @@ -3162,7 +3165,7 @@ paths: Contact not found: value: type: error.list - request_id: d2138791-d60f-42f6-8f4c-8c146d243377 + request_id: 358b880a-72cc-4ab4-a2e1-2f87fc473456 errors: - code: not_found message: User Not Found @@ -3176,7 +3179,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2bc59912-e70f-4aef-92cf-75313363ce2b + request_id: 1d64c9ab-f1f2-429e-8de5-af35782eb009 errors: - code: unauthorized message: Access Token Invalid @@ -3211,7 +3214,7 @@ paths: successful: value: type: tag - id: '1318' + id: '304' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -3223,14 +3226,14 @@ paths: Contact not found: value: type: error.list - request_id: 5295dc47-1c6d-4d65-95ad-486c3eb4a98e + request_id: 8fc014ac-73a0-4328-9f80-e11012aa5981 errors: - code: not_found message: User Not Found Tag not found: value: type: error.list - request_id: e2d7a875-ef16-4aed-aa87-5781f3829967 + request_id: 22004c2a-fe4b-4f94-965f-8497ee0a5ea1 errors: - code: not_found message: Resource Not Found @@ -3244,7 +3247,7 @@ paths: Unauthorized: value: type: error.list - request_id: 66586d13-1002-48b1-8ce0-58f4483c63e0 + request_id: 96923557-f479-4a9d-a20d-4aee56eca061 errors: - code: unauthorized message: Access Token Invalid @@ -3267,11 +3270,11 @@ paths: successful: summary: successful value: - id: 1318 + id: 304 contact_not_found: summary: Contact not found value: - id: 1319 + id: 305 tag_not_found: summary: Tag not found value: @@ -3313,7 +3316,7 @@ paths: successful: value: type: tag - id: '1321' + id: '307' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -3325,14 +3328,14 @@ paths: Contact not found: value: type: error.list - request_id: '03346029-d4a1-45a2-a14e-b9a9687db72e' + request_id: 3de04308-1811-42b2-b03a-256b188f3afe errors: - code: not_found message: User Not Found Tag not found: value: type: error.list - request_id: 1891cc99-938d-417c-b10e-f8fb975f32fd + request_id: d543d7b8-914e-4e4b-8ef6-a8374d543bbc errors: - code: not_found message: Resource Not Found @@ -3346,7 +3349,7 @@ paths: Unauthorized: value: type: error.list - request_id: 316948d2-6c47-4940-86b2-a66724f27343 + request_id: 97f603a3-a3ad-4569-a7f7-6d898f13696d errors: - code: unauthorized message: Access Token Invalid @@ -3380,7 +3383,7 @@ paths: successful: value: type: contact - id: 660e704a6abd01b9d1904315 + id: 6639ff00c2ba3caea1b558db workspace_id: this_is_an_id248_that_should_be_at_least_ external_id: '70' role: user @@ -3395,9 +3398,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1712222282 - updated_at: 1712222282 - signed_up_at: 1712222282 + created_at: 1715076864 + updated_at: 1715076864 + signed_up_at: 1715076864 last_seen_at: last_replied_at: last_contacted_at: @@ -3431,31 +3434,31 @@ paths: tags: type: list data: [] - url: "/contacts/660e704a6abd01b9d1904315/tags" + url: "/contacts/6639ff00c2ba3caea1b558db/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/660e704a6abd01b9d1904315/notes" + url: "/contacts/6639ff00c2ba3caea1b558db/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/660e704a6abd01b9d1904315/companies" + url: "/contacts/6639ff00c2ba3caea1b558db/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/660e704a6abd01b9d1904315/subscriptions" + url: "/contacts/6639ff00c2ba3caea1b558db/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/660e704a6abd01b9d1904315/subscriptions" + url: "/contacts/6639ff00c2ba3caea1b558db/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3474,7 +3477,7 @@ paths: Unauthorized: value: type: error.list - request_id: e88dd45f-e186-46e7-8dc0-b198b7226ae0 + request_id: 49b4cc58-4895-43ac-b336-1d816de53fce errors: - code: unauthorized message: Access Token Invalid @@ -3519,7 +3522,7 @@ paths: successful: value: type: contact - id: 660e704b6abd01b9d1904316 + id: 6639ff01c2ba3caea1b558dc workspace_id: this_is_an_id252_that_should_be_at_least_ external_id: '70' role: user @@ -3534,9 +3537,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1712222283 - updated_at: 1712222283 - signed_up_at: 1712222283 + created_at: 1715076865 + updated_at: 1715076865 + signed_up_at: 1715076865 last_seen_at: last_replied_at: last_contacted_at: @@ -3570,31 +3573,31 @@ paths: tags: type: list data: [] - url: "/contacts/660e704b6abd01b9d1904316/tags" + url: "/contacts/6639ff01c2ba3caea1b558dc/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/660e704b6abd01b9d1904316/notes" + url: "/contacts/6639ff01c2ba3caea1b558dc/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/660e704b6abd01b9d1904316/companies" + url: "/contacts/6639ff01c2ba3caea1b558dc/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/660e704b6abd01b9d1904316/subscriptions" + url: "/contacts/6639ff01c2ba3caea1b558dc/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/660e704b6abd01b9d1904316/subscriptions" + url: "/contacts/6639ff01c2ba3caea1b558dc/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3613,7 +3616,7 @@ paths: Unauthorized: value: type: error.list - request_id: e2d43e82-aa25-47ad-a4d6-beaebbf95367 + request_id: e37861bb-ab46-49e4-9f12-10984b69dced errors: - code: unauthorized message: Access Token Invalid @@ -3644,7 +3647,7 @@ paths: examples: successful: value: - id: 660e704c6abd01b9d1904317 + id: 6639ff02c2ba3caea1b558dd object: contact deleted: true schema: @@ -3657,7 +3660,7 @@ paths: Unauthorized: value: type: error.list - request_id: 73e68e79-c3de-48b4-8f8b-36d6e2eee0af + request_id: 1ffa2c52-d7cb-43eb-b37d-c362dd766ec2 errors: - code: unauthorized message: Access Token Invalid @@ -3685,7 +3688,7 @@ paths: successful: value: type: contact - id: 660e704d6abd01b9d1904319 + id: 6639ff04c2ba3caea1b558df workspace_id: this_is_an_id260_that_should_be_at_least_ external_id: '70' role: user @@ -3700,9 +3703,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1712222285 - updated_at: 1712222286 - signed_up_at: 1712222285 + created_at: 1715076868 + updated_at: 1715076868 + signed_up_at: 1715076868 last_seen_at: last_replied_at: last_contacted_at: @@ -3736,31 +3739,31 @@ paths: tags: type: list data: [] - url: "/contacts/660e704d6abd01b9d1904319/tags" + url: "/contacts/6639ff04c2ba3caea1b558df/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/660e704d6abd01b9d1904319/notes" + url: "/contacts/6639ff04c2ba3caea1b558df/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/660e704d6abd01b9d1904319/companies" + url: "/contacts/6639ff04c2ba3caea1b558df/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/660e704d6abd01b9d1904319/subscriptions" + url: "/contacts/6639ff04c2ba3caea1b558df/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/660e704d6abd01b9d1904319/subscriptions" + url: "/contacts/6639ff04c2ba3caea1b558df/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3779,7 +3782,7 @@ paths: Unauthorized: value: type: error.list - request_id: 923d3f0b-c575-4b95-b2d8-dd85e94d9b8e + request_id: 9eb727c8-c402-4587-a79a-f9905ea971fc errors: - code: unauthorized message: Access Token Invalid @@ -3794,8 +3797,8 @@ paths: successful: summary: successful value: - from: 660e704d6abd01b9d1904318 - into: 660e704d6abd01b9d1904319 + from: 6639ff04c2ba3caea1b558de + into: 6639ff04c2ba3caea1b558df "/contacts/search": post: summary: Search contacts @@ -3814,6 +3817,12 @@ paths: This will accept a query object in the body which will define your filters in order to search for contacts. + {% admonition type="warning" name="Optimizing search queries" %} + Search queries can be complex, so optimizing them can help the performance of your search. + Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize + pagination to limit the number of results returned. The default is `50` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param. + {% /admonition %} ### Contact Creation Delay If a contact has recently been created, there is a possibility that it will not yet be available when searching. This means that it may not appear in the response. This delay can take a few minutes. If you need to be instantly notified it is recommended to use webhooks and iterate to see if they match your search filters. @@ -3928,7 +3937,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8fc58b49-9744-45ba-a470-548ec4d6970d + request_id: 3149edac-851c-44d9-8802-52d70937c864 errors: - code: unauthorized message: Access Token Invalid @@ -3948,15 +3957,15 @@ paths: value: - field: id operator: "=" - value: 660e704f6abd01b9d190431c + value: 6639ff05c2ba3caea1b558e2 - operator: OR value: - field: id operator: "=" - value: 660e704f6abd01b9d190431c + value: 6639ff05c2ba3caea1b558e2 - field: id operator: "=" - value: 660e704f6abd01b9d190431c + value: 6639ff05c2ba3caea1b558e2 "/contacts": get: summary: List all contacts @@ -3968,7 +3977,12 @@ paths: tags: - Contacts operationId: ListContacts - description: You can fetch a list of all contacts. + description: | + You can fetch a list of all contacts (ie. users or leads) in your workspace. + {% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `50` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. + {% /admonition %} responses: '200': description: successful @@ -3995,7 +4009,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2737c07d-204d-49a3-ad45-479131995171 + request_id: b2b3a56b-1dd1-4516-861e-68d206cecd26 errors: - code: unauthorized message: Access Token Invalid @@ -4021,7 +4035,7 @@ paths: successful: value: type: contact - id: 660e70526abd01b9d190431e + id: 6639ff08c2ba3caea1b558e4 workspace_id: this_is_an_id272_that_should_be_at_least_ external_id: role: user @@ -4036,8 +4050,8 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1712222290 - updated_at: 1712222290 + created_at: 1715076872 + updated_at: 1715076872 signed_up_at: last_seen_at: last_replied_at: @@ -4072,31 +4086,31 @@ paths: tags: type: list data: [] - url: "/contacts/660e70526abd01b9d190431e/tags" + url: "/contacts/6639ff08c2ba3caea1b558e4/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/660e70526abd01b9d190431e/notes" + url: "/contacts/6639ff08c2ba3caea1b558e4/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/660e70526abd01b9d190431e/companies" + url: "/contacts/6639ff08c2ba3caea1b558e4/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/660e70526abd01b9d190431e/subscriptions" + url: "/contacts/6639ff08c2ba3caea1b558e4/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/660e70526abd01b9d190431e/subscriptions" + url: "/contacts/6639ff08c2ba3caea1b558e4/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -4115,7 +4129,7 @@ paths: Unauthorized: value: type: error.list - request_id: c9caa4e1-5e80-4308-bb96-63c292dacbd2 + request_id: b230e4bc-5f61-4873-a650-605e0994516c errors: - code: unauthorized message: Access Token Invalid @@ -4159,7 +4173,7 @@ paths: examples: successful: value: - id: 660e70536abd01b9d190431f + id: 6639ff09c2ba3caea1b558e5 object: contact archived: true schema: @@ -4191,7 +4205,7 @@ paths: examples: successful: value: - id: 660e70546abd01b9d1904320 + id: 6639ff0ac2ba3caea1b558e6 object: contact archived: false schema: @@ -4226,7 +4240,7 @@ paths: successful: value: type: tag - id: '1323' + id: '309' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -4238,7 +4252,7 @@ paths: Conversation not found: value: type: error.list - request_id: 8cd2dfbd-ea95-488b-87b2-f55b15e36938 + request_id: e33fe0e8-e86b-4cae-98f5-ea5a9df75436 errors: - code: not_found message: Conversation not found @@ -4252,7 +4266,7 @@ paths: Unauthorized: value: type: error.list - request_id: 027473db-8710-4e91-a2b5-ed09ef622622 + request_id: 7617cd7f-4fc6-44a6-993d-8dedd18fa661 errors: - code: unauthorized message: Access Token Invalid @@ -4281,13 +4295,13 @@ paths: successful: summary: successful value: - id: 1323 - admin_id: 991281473 + id: 309 + admin_id: 991270046 conversation_not_found: summary: Conversation not found value: - id: 1324 - admin_id: 991281475 + id: 310 + admin_id: 991270048 "/conversations/{conversation_id}/tags/{id}": delete: summary: Remove tag from a conversation @@ -4325,7 +4339,7 @@ paths: successful: value: type: tag - id: '1326' + id: '312' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -4337,14 +4351,14 @@ paths: Conversation not found: value: type: error.list - request_id: d0a7985b-18cf-45e9-a6fb-8980db7d88a1 + request_id: ea84894e-1f12-45c2-ada8-ffb098466e4c errors: - code: not_found message: Conversation not found Tag not found: value: type: error.list - request_id: 184de95c-5ee7-44ea-a10b-d96859c0a5a3 + request_id: 47253538-29fd-4e0b-9d69-4a97a3704615 errors: - code: tag_not_found message: Tag not found @@ -4358,7 +4372,7 @@ paths: Unauthorized: value: type: error.list - request_id: 550f64ee-502f-422b-aafb-f16ad4cfdcd7 + request_id: 9fcfaed3-aab5-4f86-b97b-1bcf72cf03ab errors: - code: unauthorized message: Access Token Invalid @@ -4381,15 +4395,15 @@ paths: successful: summary: successful value: - admin_id: 991281477 + admin_id: 991270050 conversation_not_found: summary: Conversation not found value: - admin_id: 991281479 + admin_id: 991270052 tag_not_found: summary: Tag not found value: - admin_id: 991281480 + admin_id: 991270053 "/conversations": get: summary: List all conversations @@ -4418,7 +4432,11 @@ paths: description: | You can fetch a list of all conversations. - You can optionally request the result page size and the cursor to start after to fetch the result + You can optionally request the result page size and the cursor to start after to fetch the result. + {% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `20` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. + {% /admonition %} responses: '200': description: successful @@ -4436,20 +4454,20 @@ paths: total_count: 1 conversations: - type: conversation - id: '4475' - created_at: 1712222301 - updated_at: 1712222301 + id: '1095' + created_at: 1715076882 + updated_at: 1715076882 waiting_since: snoozed_until: source: type: conversation - id: '403920665' + id: '403918653' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991281483' + id: '991270056' name: Ciaran152 Lee email: admin152@email.com attachments: [] @@ -4459,7 +4477,7 @@ paths: type: contact.list contacts: - type: contact - id: 660e705d6abd01b9d1904324 + id: 6639ff12c2ba3caea1b558ea first_contact_reply: admin_assignee_id: team_assignee_id: @@ -4487,7 +4505,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2a4dfaa9-40f8-42a5-9d47-f93a2a22aba2 + request_id: cbe7afc8-26f9-48ce-b0a2-8f151dfc1887 errors: - code: unauthorized message: Access Token Invalid @@ -4501,7 +4519,7 @@ paths: API plan restricted: value: type: error.list - request_id: 19349505-882d-4de4-99f5-53144c7bfa34 + request_id: 1dcb1b48-b473-4717-b1d8-3495d57e3d86 errors: - code: api_plan_restricted message: Active subscription needed. @@ -4537,11 +4555,11 @@ paths: conversation created: value: type: user_message - id: '403920675' - created_at: 1712222319 + id: '403918663' + created_at: 1715076901 body: Hello there message_type: inapp - conversation_id: '4500' + conversation_id: '1123' schema: "$ref": "#/components/schemas/message" '404': @@ -4552,7 +4570,7 @@ paths: Contact Not Found: value: type: error.list - request_id: cfe4cb04-fa63-406e-ac39-602a66448a7d + request_id: d118e287-586d-46f1-96a3-3bf4976fe793 errors: - code: not_found message: User Not Found @@ -4566,7 +4584,7 @@ paths: Unauthorized: value: type: error.list - request_id: c008639e-13bc-4d70-8e07-1224155e56f3 + request_id: 814b0690-426e-433a-bc40-7c138d3cf092 errors: - code: unauthorized message: Access Token Invalid @@ -4580,7 +4598,7 @@ paths: API plan restricted: value: type: error.list - request_id: 057f2c4c-8b02-4d8d-bd8f-c2faef68f35e + request_id: 4868e05a-3c65-49e6-a646-d97616d416e9 errors: - code: api_plan_restricted message: Active subscription needed. @@ -4597,7 +4615,7 @@ paths: value: from: type: user - id: 660e706f6abd01b9d1904339 + id: 6639ff24c2ba3caea1b55902 body: Hello there contact_not_found: summary: Contact Not Found @@ -4641,11 +4659,7 @@ paths: The maximum number of conversation parts that can be returned via the API is 500. If you have more than that we will return the 500 most recent conversation parts. {% /admonition %} - ### Bot Name in Conversation Parts - - For conversation parts generated by a bot, bot name will depend on the following: - - Customers that never turned on AI answers will have `operator` as the bot name - - Customers that have turned on AI answers at some point will have `fin` as the bot name + For AI agent conversation metadata, please note that you need to have the agent enabled in your workspace, which is a [paid feature](https://www.intercom.com/help/en/articles/8205718-fin-resolutions#h_97f8c2e671). responses: '200': description: conversation found @@ -4655,22 +4669,22 @@ paths: conversation found: value: type: conversation - id: '4504' - created_at: 1712222324 - updated_at: 1712222324 + id: '1127' + created_at: 1715076905 + updated_at: 1715076905 waiting_since: snoozed_until: source: type: conversation - id: '403920679' + id: '403918667' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991281494' - name: Ciaran159 Lee - email: admin159@email.com + id: '991270073' + name: Ciaran162 Lee + email: admin162@email.com attachments: [] url: redacted: false @@ -4678,7 +4692,7 @@ paths: type: contact.list contacts: - type: contact - id: 660e70746abd01b9d190433d + id: 6639ff29c2ba3caea1b55906 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -4710,7 +4724,7 @@ paths: Not found: value: type: error.list - request_id: 0544e553-4221-48b4-abd2-01e7aa65819d + request_id: d5e2a5c1-84a3-4272-bf73-40127d406015 errors: - code: not_found message: Resource Not Found @@ -4724,7 +4738,7 @@ paths: Unauthorized: value: type: error.list - request_id: 604769a3-ccc5-43bb-8108-a81e4037ad24 + request_id: cba921e3-cf59-468f-be7d-241d341ad063 errors: - code: unauthorized message: Access Token Invalid @@ -4738,7 +4752,7 @@ paths: API plan restricted: value: type: error.list - request_id: 89806ed3-791e-46a6-97e9-7ba165c5ab81 + request_id: 88865dea-88b9-48e0-9a08-662f0e7add4b errors: - code: api_plan_restricted message: Active subscription needed. @@ -4785,22 +4799,22 @@ paths: conversation found: value: type: conversation - id: '4508' - created_at: 1712222329 - updated_at: 1712222331 + id: '1131' + created_at: 1715076910 + updated_at: 1715076911 waiting_since: snoozed_until: source: type: conversation - id: '403920683' + id: '403918671' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991281498' - name: Ciaran163 Lee - email: admin163@email.com + id: '991270081' + name: Ciaran166 Lee + email: admin166@email.com attachments: [] url: redacted: false @@ -4808,7 +4822,7 @@ paths: type: contact.list contacts: - type: contact - id: 660e70796abd01b9d1904341 + id: 6639ff2ec2ba3caea1b5590a first_contact_reply: admin_assignee_id: team_assignee_id: @@ -4832,34 +4846,34 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '1051' + id: '252' part_type: conversation_attribute_updated_by_admin body: - created_at: 1712222330 - updated_at: 1712222330 - notified_at: 1712222330 + created_at: 1715076911 + updated_at: 1715076911 + notified_at: 1715076911 assigned_to: author: - id: '991281503' + id: '991270082' type: bot name: Operator - email: operator+this_is_an_id318_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id321_that_should_be_at_least_@intercom.io attachments: [] external_id: redacted: false - type: conversation_part - id: '1052' + id: '253' part_type: conversation_attribute_updated_by_admin body: - created_at: 1712222331 - updated_at: 1712222331 - notified_at: 1712222331 + created_at: 1715076911 + updated_at: 1715076911 + notified_at: 1715076911 assigned_to: author: - id: '991281503' + id: '991270082' type: bot name: Operator - email: operator+this_is_an_id318_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id321_that_should_be_at_least_@intercom.io attachments: [] external_id: redacted: false @@ -4874,7 +4888,7 @@ paths: Not found: value: type: error.list - request_id: ac76b019-8527-4347-bc82-efa342bdfe97 + request_id: 96c28dda-6339-4011-86bd-79a8367465f3 errors: - code: not_found message: Resource Not Found @@ -4888,7 +4902,7 @@ paths: Unauthorized: value: type: error.list - request_id: 32e1d8b8-3ed2-4467-bb85-6bda0d9bb372 + request_id: f92819c4-836b-49bf-a553-cd73bec3f5c4 errors: - code: unauthorized message: Access Token Invalid @@ -4902,7 +4916,7 @@ paths: API plan restricted: value: type: error.list - request_id: f737d77e-fc72-4136-94ce-b12a5a565c57 + request_id: aa09e4aa-4122-42d6-b8f5-16829e2b6a40 errors: - code: api_plan_restricted message: Active subscription needed. @@ -4945,6 +4959,12 @@ paths: To search for conversations, you need to send a `POST` request to `https://api.intercom.io/conversations/search`. This will accept a query object in the body which will define your filters in order to search for conversations. + {% admonition type="warning" name="Optimizing search queries" %} + Search queries can be complex, so optimizing them can help the performance of your search. + Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize + pagination to limit the number of results returned. The default is `20` results per page and maximum is `150`. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param. + {% /admonition %} ### Nesting & Limitations @@ -5008,6 +5028,13 @@ paths: | conversation_rating.remark | String | | conversation_rating.contact_id | String | | conversation_rating.admin_d | String | + | ai_agent_participated | Boolean | + | ai_agent.resolution_state | String | + | ai_agent.last_answer_type | String | + | ai_agent.rating | Integer | + | ai_agent.rating_remark | String | + | ai_agent.source_type | String | + | ai_agent.source_title | String | ### Accepted Operators @@ -5042,22 +5069,22 @@ paths: total_count: 1 conversations: - type: conversation - id: '4515' - created_at: 1712222339 - updated_at: 1712222339 + id: '1138' + created_at: 1715076919 + updated_at: 1715076919 waiting_since: snoozed_until: source: type: conversation - id: '403920690' + id: '403918678' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991281522' - name: Ciaran186 Lee - email: admin186@email.com + id: '991270111' + name: Ciaran189 Lee + email: admin189@email.com attachments: [] url: redacted: false @@ -5065,7 +5092,7 @@ paths: type: contact.list contacts: - type: contact - id: 660e70836abd01b9d1904348 + id: 6639ff36c2ba3caea1b55911 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5099,15 +5126,15 @@ paths: value: - field: id operator: "=" - value: '4515' + value: '1138' - operator: OR value: - field: id operator: "=" - value: '4515' + value: '1138' - field: id operator: "=" - value: '4515' + value: '1138' "/conversations/{id}/reply": post: summary: Reply to a conversation @@ -5138,22 +5165,22 @@ paths: User reply: value: type: conversation - id: '4523' - created_at: 1712222345 - updated_at: 1712222346 - waiting_since: 1712222346 + id: '1147' + created_at: 1715076925 + updated_at: 1715076926 + waiting_since: 1715076926 snoozed_until: source: type: conversation - id: '403920693' + id: '403918681' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991281524' - name: Ciaran187 Lee - email: admin187@email.com + id: '991270114' + name: Ciaran191 Lee + email: admin191@email.com attachments: [] url: redacted: false @@ -5161,9 +5188,9 @@ paths: type: contact.list contacts: - type: contact - id: 660e70896abd01b9d190434f + id: 6639ff3dc2ba3caea1b55919 first_contact_reply: - created_at: 1712222346 + created_at: 1715076926 type: conversation url: admin_assignee_id: @@ -5186,15 +5213,15 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '1054' + id: '255' part_type: open body: "

    Thanks again :)

    " - created_at: 1712222346 - updated_at: 1712222346 - notified_at: 1712222346 + created_at: 1715076926 + updated_at: 1715076926 + notified_at: 1715076926 assigned_to: author: - id: 660e70896abd01b9d190434f + id: 6639ff3dc2ba3caea1b55919 type: user name: Joe Bloggs email: joe@bloggs.com @@ -5205,22 +5232,22 @@ paths: Admin note reply: value: type: conversation - id: '4524' - created_at: 1712222347 - updated_at: 1712222348 + id: '1148' + created_at: 1715076927 + updated_at: 1715076927 waiting_since: snoozed_until: source: type: conversation - id: '403920694' + id: '403918682' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991281526' - name: Ciaran188 Lee - email: admin188@email.com + id: '991270116' + name: Ciaran192 Lee + email: admin192@email.com attachments: [] url: redacted: false @@ -5228,7 +5255,7 @@ paths: type: contact.list contacts: - type: contact - id: 660e708b6abd01b9d1904350 + id: 6639ff3fc2ba3caea1b5591a first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5250,7 +5277,7 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '1055' + id: '256' part_type: note body: |-

    An Unordered HTML List

    @@ -5265,15 +5292,15 @@ paths:
  • Tea
  • Milk
    • - created_at: 1712222348 - updated_at: 1712222348 - notified_at: 1712222348 + created_at: 1715076927 + updated_at: 1715076927 + notified_at: 1715076927 assigned_to: author: - id: '991281526' + id: '991270116' type: admin - name: Ciaran188 Lee - email: admin188@email.com + name: Ciaran192 Lee + email: admin192@email.com attachments: [] external_id: redacted: false @@ -5281,22 +5308,22 @@ paths: User last conversation reply: value: type: conversation - id: '4526' - created_at: 1712222349 - updated_at: 1712222350 - waiting_since: 1712222350 + id: '1150' + created_at: 1715076929 + updated_at: 1715076930 + waiting_since: 1715076930 snoozed_until: source: type: conversation - id: '403920696' + id: '403918684' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991281528' - name: Ciaran190 Lee - email: admin190@email.com + id: '991270120' + name: Ciaran194 Lee + email: admin194@email.com attachments: [] url: redacted: false @@ -5304,9 +5331,9 @@ paths: type: contact.list contacts: - type: contact - id: 660e708d6abd01b9d1904352 + id: 6639ff41c2ba3caea1b5591c first_contact_reply: - created_at: 1712222350 + created_at: 1715076930 type: conversation url: admin_assignee_id: @@ -5329,15 +5356,15 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '1056' + id: '257' part_type: open body: "

    Thanks again :)

    " - created_at: 1712222350 - updated_at: 1712222350 - notified_at: 1712222350 + created_at: 1715076930 + updated_at: 1715076930 + notified_at: 1715076930 assigned_to: author: - id: 660e708d6abd01b9d1904352 + id: 6639ff41c2ba3caea1b5591c type: user name: Joe Bloggs email: joe@bloggs.com @@ -5355,7 +5382,7 @@ paths: Not found: value: type: error.list - request_id: 5c54e252-13bc-41c6-9b0e-6c830429daff + request_id: 8e8f6828-80f3-496a-9323-98c3ce0a061a errors: - code: not_found message: Resource Not Found @@ -5369,7 +5396,7 @@ paths: Unauthorized: value: type: error.list - request_id: ee7c80e5-bf35-4168-96f9-d9c9f41e5e7c + request_id: 76c08045-d314-42ab-b5e1-0a3f26a91c99 errors: - code: unauthorized message: Access Token Invalid @@ -5383,7 +5410,7 @@ paths: API plan restricted: value: type: error.list - request_id: 157d01b4-bce1-4fa4-8182-daf9518dbc15 + request_id: 204bbaff-84ff-4b6c-bffe-64d4009e7e7e errors: - code: api_plan_restricted message: Active subscription needed. @@ -5400,14 +5427,14 @@ paths: value: message_type: comment type: user - intercom_user_id: 660e70896abd01b9d190434f + intercom_user_id: 6639ff3dc2ba3caea1b55919 body: Thanks again :) admin_note_reply: summary: Admin note reply value: message_type: note type: admin - admin_id: 991281526 + admin_id: 991270116 body: "

    An Unordered HTML List

    • Coffee
      • \
    • Tea
    • Milk

    An Ordered HTML List

    \
    1. Coffee
    2. Tea
    3. Milk
    @@ -5417,14 +5444,14 @@ paths: value: message_type: comment type: user - intercom_user_id: 660e708d6abd01b9d1904352 + intercom_user_id: 6639ff41c2ba3caea1b5591c body: Thanks again :) not_found: summary: Not found value: message_type: comment type: user - intercom_user_id: 660e708f6abd01b9d1904353 + intercom_user_id: 6639ff43c2ba3caea1b5591d body: Thanks again :) "/conversations/{id}/parts": post: @@ -5459,22 +5486,22 @@ paths: Close a conversation: value: type: conversation - id: '4530' - created_at: 1712222355 - updated_at: 1712222355 + id: '1154' + created_at: 1715076935 + updated_at: 1715076935 waiting_since: snoozed_until: source: type: conversation - id: '403920700' + id: '403918688' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991281533' - name: Ciaran194 Lee - email: admin194@email.com + id: '991270128' + name: Ciaran198 Lee + email: admin198@email.com attachments: [] url: redacted: false @@ -5482,7 +5509,7 @@ paths: type: contact.list contacts: - type: contact - id: 660e70936abd01b9d1904356 + id: 6639ff46c2ba3caea1b55920 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5504,18 +5531,18 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '1057' + id: '258' part_type: close body: "

    Goodbye :)

    " - created_at: 1712222355 - updated_at: 1712222355 - notified_at: 1712222355 + created_at: 1715076935 + updated_at: 1715076935 + notified_at: 1715076935 assigned_to: author: - id: '991281533' + id: '991270128' type: admin - name: Ciaran194 Lee - email: admin194@email.com + name: Ciaran198 Lee + email: admin198@email.com attachments: [] external_id: redacted: false @@ -5523,22 +5550,22 @@ paths: Snooze a conversation: value: type: conversation - id: '4531' - created_at: 1712222357 - updated_at: 1712222357 + id: '1155' + created_at: 1715076936 + updated_at: 1715076937 waiting_since: - snoozed_until: 1712225957 + snoozed_until: 1715080537 source: type: conversation - id: '403920701' + id: '403918689' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991281534' - name: Ciaran195 Lee - email: admin195@email.com + id: '991270130' + name: Ciaran199 Lee + email: admin199@email.com attachments: [] url: redacted: false @@ -5546,7 +5573,7 @@ paths: type: contact.list contacts: - type: contact - id: 660e70946abd01b9d1904357 + id: 6639ff48c2ba3caea1b55921 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5568,18 +5595,18 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '1058' + id: '259' part_type: snoozed body: - created_at: 1712222357 - updated_at: 1712222357 - notified_at: 1712222357 + created_at: 1715076937 + updated_at: 1715076937 + notified_at: 1715076937 assigned_to: author: - id: '991281534' + id: '991270130' type: admin - name: Ciaran195 Lee - email: admin195@email.com + name: Ciaran199 Lee + email: admin199@email.com attachments: [] external_id: redacted: false @@ -5587,22 +5614,22 @@ paths: Open a conversation: value: type: conversation - id: '4536' - created_at: 1712222356 - updated_at: 1712222364 + id: '1160' + created_at: 1715076935 + updated_at: 1715076944 waiting_since: snoozed_until: source: type: conversation - id: '403920702' + id: '403918690' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991281535' - name: Ciaran196 Lee - email: admin196@email.com + id: '991270132' + name: Ciaran200 Lee + email: admin200@email.com attachments: [] url: redacted: false @@ -5610,7 +5637,7 @@ paths: type: contact.list contacts: - type: contact - id: 660e70976abd01b9d190435c + id: 6639ff47c2ba3caea1b55926 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5632,18 +5659,18 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '1060' + id: '261' part_type: open body: - created_at: 1712222364 - updated_at: 1712222364 - notified_at: 1712222364 + created_at: 1715076944 + updated_at: 1715076944 + notified_at: 1715076944 assigned_to: author: - id: '991281535' + id: '991270132' type: admin - name: Ciaran196 Lee - email: admin196@email.com + name: Ciaran200 Lee + email: admin200@email.com attachments: [] external_id: redacted: false @@ -5651,22 +5678,22 @@ paths: Assign a conversation: value: type: conversation - id: '4540' - created_at: 1712222365 - updated_at: 1712222366 + id: '1165' + created_at: 1715076945 + updated_at: 1715076946 waiting_since: snoozed_until: source: type: conversation - id: '403920705' + id: '403918693' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991281537' - name: Ciaran197 Lee - email: admin197@email.com + id: '991270135' + name: Ciaran202 Lee + email: admin202@email.com attachments: [] url: redacted: false @@ -5674,9 +5701,9 @@ paths: type: contact.list contacts: - type: contact - id: 660e709d6abd01b9d190435f + id: 6639ff51c2ba3caea1b5592a first_contact_reply: - admin_assignee_id: 991281537 + admin_assignee_id: 991270135 team_assignee_id: open: true state: open @@ -5696,20 +5723,20 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '1061' + id: '262' part_type: assign_and_reopen body: - created_at: 1712222366 - updated_at: 1712222366 - notified_at: 1712222366 + created_at: 1715076946 + updated_at: 1715076946 + notified_at: 1715076946 assigned_to: type: admin - id: '991281537' + id: '991270135' author: - id: '991281537' + id: '991270135' type: admin - name: Ciaran197 Lee - email: admin197@email.com + name: Ciaran202 Lee + email: admin202@email.com attachments: [] external_id: redacted: false @@ -5724,7 +5751,7 @@ paths: Not found: value: type: error.list - request_id: f63fbea4-8cd2-46e3-827c-d0c94838872d + request_id: 8e60704d-240c-40b5-8776-02634a28ac5b errors: - code: not_found message: Resource Not Found @@ -5738,7 +5765,7 @@ paths: Unauthorized: value: type: error.list - request_id: 6f750190-3bbb-446b-b73e-06d5642aa8f9 + request_id: cb68ab5f-e3ed-439a-8c0e-1a936e003de3 errors: - code: unauthorized message: Access Token Invalid @@ -5752,7 +5779,7 @@ paths: API plan restricted: value: type: error.list - request_id: 20067280-1622-45ea-b59f-b1f1534382be + request_id: d043f638-a700-4b68-92be-ed9a39c8b589 errors: - code: api_plan_restricted message: Active subscription needed. @@ -5773,32 +5800,32 @@ paths: value: message_type: close type: admin - admin_id: 991281533 + admin_id: 991270128 body: Goodbye :) snooze_a_conversation: summary: Snooze a conversation value: message_type: snoozed - admin_id: 991281534 - snoozed_until: 1712225957 + admin_id: 991270130 + snoozed_until: 1715080537 open_a_conversation: summary: Open a conversation value: message_type: open - admin_id: 991281535 + admin_id: 991270132 assign_a_conversation: summary: Assign a conversation value: message_type: assignment type: admin - admin_id: 991281537 - assignee_id: 991281537 + admin_id: 991270135 + assignee_id: 991270135 not_found: summary: Not found value: message_type: close type: admin - admin_id: 991281539 + admin_id: 991270137 body: Goodbye :) "/conversations/{id}/run_assignment_rules": post: @@ -5832,22 +5859,22 @@ paths: Assign a conversation using assignment rules: value: type: conversation - id: '4544' - created_at: 1712222370 - updated_at: 1712222371 + id: '1169' + created_at: 1715076950 + updated_at: 1715076950 waiting_since: snoozed_until: source: type: conversation - id: '403920709' + id: '403918697' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991281542' - name: Ciaran201 Lee - email: admin201@email.com + id: '991270143' + name: Ciaran206 Lee + email: admin206@email.com attachments: [] url: redacted: false @@ -5855,7 +5882,7 @@ paths: type: contact.list contacts: - type: contact - id: 660e70a26abd01b9d1904363 + id: 6639ff56c2ba3caea1b5592e first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5877,20 +5904,20 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '1062' + id: '263' part_type: default_assignment body: - created_at: 1712222371 - updated_at: 1712222371 - notified_at: 1712222371 + created_at: 1715076950 + updated_at: 1715076950 + notified_at: 1715076950 assigned_to: type: nobody_admin id: author: - id: '991281543' + id: '991270144' type: bot name: Operator - email: operator+this_is_an_id359_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id364_that_should_be_at_least_@intercom.io attachments: [] external_id: redacted: false @@ -5905,7 +5932,7 @@ paths: Not found: value: type: error.list - request_id: 3a997fb9-7413-4916-aadf-05d39250b822 + request_id: c1e10854-ed23-4d8f-aaa7-f5f9506cff2c errors: - code: not_found message: Resource Not Found @@ -5919,7 +5946,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2a2b4477-6e9b-474e-86ce-011aa39e9add + request_id: 43f660b2-9aef-4a98-b289-f57cc28c665a errors: - code: unauthorized message: Access Token Invalid @@ -5933,7 +5960,7 @@ paths: API plan restricted: value: type: error.list - request_id: 20188c3c-577f-40bb-b7fd-55a989c25667 + request_id: 6ba01870-54d5-4cac-8f03-35c043a8c9e2 errors: - code: api_plan_restricted message: Active subscription needed. @@ -5974,7 +6001,7 @@ paths: value: customers: - type: user - id: 660e70a76abd01b9d1904367 + id: 6639ff5bc2ba3caea1b55932 schema: "$ref": "#/components/schemas/conversation" '404': @@ -5985,7 +6012,7 @@ paths: Not found: value: type: error.list - request_id: 80f69016-d9a0-4578-a54c-3b60883a1ea6 + request_id: fb68742a-5fdf-47d9-be7c-c1ac058cb7d6 errors: - code: not_found message: Resource Not Found @@ -5999,7 +6026,7 @@ paths: Unauthorized: value: type: error.list - request_id: 57f166f2-2c76-4b65-a615-0f5e42be24a4 + request_id: 3669ba0e-7d84-4a63-abaf-878c8fbf1787 errors: - code: unauthorized message: Access Token Invalid @@ -6013,7 +6040,7 @@ paths: API plan restricted: value: type: error.list - request_id: 66dc913a-6fab-4e99-be41-7c0e30164303 + request_id: 3b0b3e29-6411-4f87-ad69-dc0745d57d06 errors: - code: api_plan_restricted message: Active subscription needed. @@ -6028,15 +6055,15 @@ paths: attach_a_contact_to_a_conversation: summary: Attach a contact to a conversation value: - admin_id: 991281547 + admin_id: 991270151 customer: - intercom_user_id: 660e70a76abd01b9d1904367 + intercom_user_id: 6639ff5bc2ba3caea1b55932 not_found: summary: Not found value: - admin_id: 991281548 + admin_id: 991270153 customer: - intercom_user_id: 660e70a96abd01b9d1904368 + intercom_user_id: 6639ff5cc2ba3caea1b55933 "/conversations/{conversation_id}/customers/{contact_id}": delete: summary: Detach a contact from a group conversation @@ -6079,7 +6106,7 @@ paths: value: customers: - type: user - id: 660e70b26abd01b9d1904372 + id: 6639ff66c2ba3caea1b5593e schema: "$ref": "#/components/schemas/conversation" '404': @@ -6090,14 +6117,14 @@ paths: Conversation not found: value: type: error.list - request_id: ac355ab7-7451-4721-9529-081bfd99db12 + request_id: c74803d1-f815-4fe0-b18d-addaae82921a errors: - code: not_found message: Resource Not Found Contact not found: value: type: error.list - request_id: 69836b07-a76b-499a-a679-2029a852e3d9 + request_id: 21ed0e08-3f3b-4c80-b477-15017e9e21b4 errors: - code: not_found message: User Not Found @@ -6111,7 +6138,7 @@ paths: Last customer: value: type: error.list - request_id: dd571eb9-2eb2-458a-beef-fedbb3a5a96a + request_id: 8c90f735-2bbd-4bde-ad12-cb3fcd740e44 errors: - code: parameter_invalid message: Removing the last customer is not allowed @@ -6125,7 +6152,7 @@ paths: Unauthorized: value: type: error.list - request_id: c221c591-b4a3-4a20-b9cc-9a2d3caff395 + request_id: 0bc940fc-d08f-4dac-8a0a-37f0644a8001 errors: - code: unauthorized message: Access Token Invalid @@ -6139,7 +6166,7 @@ paths: API plan restricted: value: type: error.list - request_id: 1be0a2c7-efd4-402e-9bb3-e3251ec8c7ac + request_id: ab335845-9415-498f-a90d-21ee357eb61f errors: - code: api_plan_restricted message: Active subscription needed. @@ -6154,27 +6181,27 @@ paths: detach_a_contact_from_a_group_conversation: summary: Detach a contact from a group conversation value: - admin_id: 991281551 + admin_id: 991270159 customer: - intercom_user_id: 660e70ac6abd01b9d190436b + intercom_user_id: 6639ff60c2ba3caea1b55936 conversation_not_found: summary: Conversation not found value: - admin_id: 991281553 + admin_id: 991270162 customer: - intercom_user_id: 660e70b36abd01b9d1904373 + intercom_user_id: 6639ff67c2ba3caea1b5593f contact_not_found: summary: Contact not found value: - admin_id: 991281555 + admin_id: 991270165 customer: - intercom_user_id: 660e70b86abd01b9d190437a + intercom_user_id: 6639ff6dc2ba3caea1b55947 last_customer: summary: Last customer value: - admin_id: 991281557 + admin_id: 991270168 customer: - intercom_user_id: 660e70be6abd01b9d1904381 + intercom_user_id: 6639ff74c2ba3caea1b5594f "/conversations/redact": post: summary: Redact a conversation part @@ -6202,22 +6229,22 @@ paths: Redact a conversation part: value: type: conversation - id: '4600' - created_at: 1712222415 - updated_at: 1712222417 - waiting_since: 1712222416 + id: '1231' + created_at: 1715076998 + updated_at: 1715076999 + waiting_since: 1715076998 snoozed_until: source: type: conversation - id: '403920735' + id: '403918723' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991281563' - name: Ciaran215 Lee - email: admin215@email.com + id: '991270177' + name: Ciaran226 Lee + email: admin226@email.com attachments: [] url: redacted: false @@ -6225,9 +6252,9 @@ paths: type: contact.list contacts: - type: contact - id: 660e70cf6abd01b9d1904396 + id: 6639ff86c2ba3caea1b55967 first_contact_reply: - created_at: 1712222416 + created_at: 1715076998 type: conversation url: admin_assignee_id: @@ -6250,15 +6277,15 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '1070' + id: '271' part_type: open body: "

    This message was deleted

    " - created_at: 1712222416 - updated_at: 1712222417 - notified_at: 1712222416 + created_at: 1715076998 + updated_at: 1715076999 + notified_at: 1715076998 assigned_to: author: - id: 660e70cf6abd01b9d1904396 + id: 6639ff86c2ba3caea1b55967 type: user name: Joe Bloggs email: joe@bloggs.com @@ -6276,7 +6303,7 @@ paths: Not found: value: type: error.list - request_id: e6093446-5e19-4cd0-b3e0-e221453de823 + request_id: c1a3944c-ff4f-46b0-ad26-33b2da2b2577 errors: - code: conversation_part_or_message_not_found message: Conversation part or message not found @@ -6290,7 +6317,7 @@ paths: Unauthorized: value: type: error.list - request_id: 5f7b7f92-8501-4fb3-a7be-5111d4d42f19 + request_id: b4d2af7c-f494-4d09-86c4-f4d6a5b13105 errors: - code: unauthorized message: Access Token Invalid @@ -6306,8 +6333,8 @@ paths: summary: Redact a conversation part value: type: conversation_part - conversation_id: 4600 - conversation_part_id: 1070 + conversation_id: 1231 + conversation_part_id: 271 not_found: summary: Not found value: @@ -6494,7 +6521,7 @@ paths: custom: false archived: false model: company - - id: 485 + - id: 114 type: data_attribute name: The One Ring full_name: custom_attributes.The One Ring @@ -6507,9 +6534,9 @@ paths: messenger_writable: true custom: true archived: false - admin_id: '991281587' - created_at: 1712222429 - updated_at: 1712222429 + admin_id: '991270202' + created_at: 1715077010 + updated_at: 1715077010 model: company - type: data_attribute name: id @@ -6581,7 +6608,7 @@ paths: Unauthorized: value: type: error.list - request_id: fed82ddc-feff-48ed-92a5-a1fbfc622775 + request_id: 11d554ff-2aa2-4894-a251-4668309c339a errors: - code: unauthorized message: Access Token Invalid @@ -6606,7 +6633,7 @@ paths: examples: Successful: value: - id: 488 + id: 117 type: data_attribute name: Mithril Shirt full_name: custom_attributes.Mithril Shirt @@ -6617,9 +6644,9 @@ paths: messenger_writable: true custom: true archived: false - admin_id: '991281589' - created_at: 1712222430 - updated_at: 1712222430 + admin_id: '991270204' + created_at: 1715077011 + updated_at: 1715077011 model: company schema: "$ref": "#/components/schemas/data_attribute" @@ -6631,7 +6658,7 @@ paths: Same name already exists: value: type: error.list - request_id: 1519b515-4499-46d3-828d-f8143514170a + request_id: ba14e1a2-949b-43fa-9a88-555a8b648b63 errors: - code: parameter_invalid message: You already have 'The One Ring' in your company data. @@ -6639,7 +6666,7 @@ paths: Invalid name: value: type: error.list - request_id: 3e7e0f82-08dd-444d-bbe7-23ae8005181e + request_id: a5e57d87-2b2b-422b-989e-5159405b7eaa errors: - code: parameter_invalid message: Your name for this attribute must only contain alphanumeric @@ -6647,7 +6674,7 @@ paths: Attribute already exists: value: type: error.list - request_id: 699d3723-4f1a-4ca7-a38e-a88f0609b194 + request_id: 3e58a14f-c638-4843-907a-572f30e5b821 errors: - code: parameter_invalid message: You already have 'The One Ring' in your company data. @@ -6655,14 +6682,14 @@ paths: Invalid Data Type: value: type: error.list - request_id: 6777f6d3-f3b4-4044-87f0-32a901ce77a5 + request_id: 6a108b24-a8fa-498c-bd55-be26c40fa119 errors: - code: parameter_invalid message: Data Type isn't an option Too few options for list: value: type: error.list - request_id: 40e0c1db-092d-441f-8741-b27dae580a4b + request_id: c64c3972-b15c-4cf9-ae0a-6080c1bfa07a errors: - code: parameter_invalid message: The Data Attribute model field must be either contact @@ -6677,7 +6704,7 @@ paths: Unauthorized: value: type: error.list - request_id: 553340ce-dc68-4c91-a7f1-7c5e761b53e0 + request_id: 84eda796-9bfb-40e1-82a0-7859405e079f errors: - code: unauthorized message: Access Token Invalid @@ -6756,7 +6783,7 @@ paths: examples: Successful: value: - id: 495 + id: 124 type: data_attribute name: The One Ring full_name: custom_attributes.The One Ring @@ -6771,9 +6798,9 @@ paths: messenger_writable: true custom: true archived: false - admin_id: '991281596' - created_at: 1712222433 - updated_at: 1712222434 + admin_id: '991270211' + created_at: 1715077014 + updated_at: 1715077014 model: company schema: "$ref": "#/components/schemas/data_attribute" @@ -6785,7 +6812,7 @@ paths: Too few options in list: value: type: error.list - request_id: 95133d56-234d-41b2-b05a-3b5fa1f0aaa3 + request_id: c74405ef-df93-4b4f-8056-164ce51c0769 errors: - code: parameter_invalid message: Options isn't an array @@ -6799,7 +6826,7 @@ paths: Attribute Not Found: value: type: error.list - request_id: 491cc4d0-e8be-49a9-aa95-8791db6b6f47 + request_id: ea547599-2369-4240-b9b9-d2e685fc2246 errors: - code: field_not_found message: We couldn't find that data attribute to update @@ -6813,7 +6840,7 @@ paths: Has Dependant Object: value: type: error.list - request_id: 00306ada-7289-4d6f-a5d2-0be6c9fd3af1 + request_id: 2b3bcc55-eb56-49ec-8e99-338a95f52bc8 errors: - code: data_invalid message: The Data Attribute you are trying to archive has a @@ -6828,7 +6855,7 @@ paths: Unauthorized: value: type: error.list - request_id: e6878c4b-8709-4552-b888-3e85969dd09b + request_id: 4cca4b7f-2251-465e-ba8a-b766acb5bcb8 errors: - code: unauthorized message: Access Token Invalid @@ -6933,7 +6960,7 @@ paths: Unauthorized: value: type: error.list - request_id: a9017097-c21a-46ec-a84f-6576d8bf6ed5 + request_id: e4fe820b-b347-40ef-a4fd-72e9593ce766 errors: - code: unauthorized message: Access Token Invalid @@ -7020,7 +7047,7 @@ paths: pages: next: http://api.intercom.test/events?next page email: user26@email.com - intercom_user_id: 660e70e66abd01b9d190439f + intercom_user_id: 6639ff9ac2ba3caea1b55970 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 schema: "$ref": "#/components/schemas/data_event_summary" @@ -7032,7 +7059,7 @@ paths: Unauthorized: value: type: error.list - request_id: 829923f2-edb3-4231-b3d4-428bb0c16ab7 + request_id: d22a9eb0-a61a-463d-8416-2c9e144ecaca errors: - code: unauthorized message: Access Token Invalid @@ -7063,7 +7090,7 @@ paths: Unauthorized: value: type: error.list - request_id: e09337bd-1891-40b2-b208-d24897d009aa + request_id: c4aa407c-88c9-4c1b-a048-6217afe0db99 errors: - code: unauthorized message: Access Token Invalid @@ -7107,7 +7134,7 @@ paths: examples: successful: value: - job_identifier: gcwhklmoqhj3cb9f + job_identifier: avnjlkht90m5a3np status: pending download_url: '' download_expires_at: '' @@ -7122,8 +7149,8 @@ paths: successful: summary: successful value: - created_at_after: 1712204440 - created_at_before: 1712222440 + created_at_after: 1715059020 + created_at_before: 1715077020 "/export/content/data/{job_identifier}": get: summary: Show content data export @@ -7157,7 +7184,7 @@ paths: examples: successful: value: - job_identifier: 5mtuk5dah079hs94 + job_identifier: uw4ddsz5fq1ad2yb status: pending download_url: '' download_expires_at: '' @@ -7189,7 +7216,7 @@ paths: examples: successful: value: - job_identifier: q8iynd54l2j1xln7 + job_identifier: voy98uyzu30ompde status: canceled download_url: '' download_expires_at: '' @@ -7250,32 +7277,32 @@ paths: user message created: value: type: user_message - id: '403920740' - created_at: 1712222443 + id: '403918728' + created_at: 1715077022 body: heyy message_type: inapp - conversation_id: '4605' + conversation_id: '1236' lead message created: value: type: user_message - id: '403920741' - created_at: 1712222444 + id: '403918729' + created_at: 1715077023 body: heyy message_type: inapp - conversation_id: '4606' + conversation_id: '1237' admin message created: value: type: admin_message - id: '155' - created_at: 1712222445 + id: '40' + created_at: 1715077025 subject: heyy body: heyy message_type: inapp owner: type: admin - id: '991281619' - name: Ciaran265 Lee - email: admin265@email.com + id: '991270234' + name: Ciaran276 Lee + email: admin276@email.com away_mode_enabled: false away_mode_reassign: false schema: @@ -7288,14 +7315,14 @@ paths: No body supplied for message: value: type: error.list - request_id: d9a19087-0e5d-416f-bf64-2561bf983692 + request_id: 2a2507ce-aedf-4e8c-9d10-0826714147ad errors: - code: parameter_invalid message: Body is required No body supplied for email message: value: type: error.list - request_id: d347c7a4-3eb9-409e-9349-31a8ea4c36b9 + request_id: e4145c3e-58ac-4cd4-9ab3-dfc7dc412421 errors: - code: parameter_invalid message: Body is required @@ -7309,7 +7336,7 @@ paths: No subject supplied for email message: value: type: error.list - request_id: 350ae999-7b24-4dd8-8c5a-3aca98d2e086 + request_id: d768a104-2875-43b6-854d-4bc8ccaba650 errors: - code: parameter_not_found message: No subject supplied for email message @@ -7323,7 +7350,7 @@ paths: Unauthorized: value: type: error.list - request_id: 5fe21ec4-ec1c-4867-bc70-846cb94e043b + request_id: 471a4fc8-a6e6-48dc-971b-19eb90f1b66c errors: - code: unauthorized message: Access Token Invalid @@ -7337,7 +7364,7 @@ paths: API plan restricted: value: type: error.list - request_id: f9185688-5aba-450c-b932-f81e96b686b3 + request_id: ec725ab7-cf64-4fe4-8148-bd508da4b5c7 errors: - code: api_plan_restricted message: Active subscription needed. @@ -7354,7 +7381,7 @@ paths: value: from: type: user - id: 660e70eb6abd01b9d19043a4 + id: 6639ff9ec2ba3caea1b55975 body: heyy referer: https://twitter.com/bob lead_message_created: @@ -7362,7 +7389,7 @@ paths: value: from: type: lead - id: 660e70ec6abd01b9d19043a5 + id: 6639ff9fc2ba3caea1b55976 body: heyy referer: https://twitter.com/bob admin_message_created: @@ -7370,10 +7397,10 @@ paths: value: from: type: admin - id: '991281619' + id: '991270234' to: type: user - id: 660e70ed6abd01b9d19043a6 + id: 6639ffa0c2ba3caea1b55977 message_type: conversation body: heyy no_body_supplied_for_message: @@ -7381,10 +7408,10 @@ paths: value: from: type: admin - id: '991281621' + id: '991270236' to: type: user - id: 660e70ee6abd01b9d19043a7 + id: 6639ffa1c2ba3caea1b55978 message_type: inapp body: subject: heyy @@ -7393,7 +7420,7 @@ paths: value: from: type: admin - id: '991281622' + id: '991270237' to: type: user user_id: '70' @@ -7404,10 +7431,10 @@ paths: value: from: type: admin - id: '991281623' + id: '991270238' to: type: user - id: 660e70ef6abd01b9d19043a9 + id: 6639ffa2c2ba3caea1b5597a message_type: email body: subject: heyy @@ -7438,12 +7465,12 @@ paths: total_pages: 1 type: pages data: - - id: '421' + - id: '99' type: news-item - workspace_id: this_is_an_id481_that_should_be_at_least_ + workspace_id: this_is_an_id492_that_should_be_at_least_ title: We have news body: "

    Hello there,

    " - sender_id: 991281628 + sender_id: 991270243 state: draft labels: [] cover_image_url: @@ -7453,15 +7480,15 @@ paths: - - deliver_silently: false - created_at: 1712222449 - updated_at: 1712222449 + created_at: 1715077028 + updated_at: 1715077028 newsfeed_assignments: [] - - id: '422' + - id: '100' type: news-item - workspace_id: this_is_an_id481_that_should_be_at_least_ + workspace_id: this_is_an_id492_that_should_be_at_least_ title: We have news body: "

    Hello there,

    " - sender_id: 991281630 + sender_id: 991270245 state: draft labels: [] cover_image_url: @@ -7471,8 +7498,8 @@ paths: - - deliver_silently: false - created_at: 1712222449 - updated_at: 1712222449 + created_at: 1715077028 + updated_at: 1715077028 newsfeed_assignments: [] total_count: 2 schema: @@ -7485,7 +7512,7 @@ paths: Unauthorized: value: type: error.list - request_id: d7c9ad0d-9d99-4d08-81a1-93503c51af36 + request_id: 034c4d72-dd7d-484f-a903-658b076a62dd errors: - code: unauthorized message: Access Token Invalid @@ -7510,12 +7537,12 @@ paths: examples: successful: value: - id: '425' + id: '103' type: news-item - workspace_id: this_is_an_id485_that_should_be_at_least_ + workspace_id: this_is_an_id496_that_should_be_at_least_ title: Halloween is here! body: "

    New costumes in store for this spooky season

    " - sender_id: 991281637 + sender_id: 991270252 state: live labels: - New @@ -7526,10 +7553,10 @@ paths: - "\U0001F606" - "\U0001F605" deliver_silently: true - created_at: 1712222451 - updated_at: 1712222451 + created_at: 1715077030 + updated_at: 1715077030 newsfeed_assignments: - - newsfeed_id: 753 + - newsfeed_id: 178 published_at: 1664638214 schema: "$ref": "#/components/schemas/news_item" @@ -7541,7 +7568,7 @@ paths: Unauthorized: value: type: error.list - request_id: 3eee6295-8a37-4cad-a62b-a9bac86d4d0b + request_id: 12276e04-cc1f-4fb1-a147-7836585b53de errors: - code: unauthorized message: Access Token Invalid @@ -7562,14 +7589,14 @@ paths: - Product - Update - New - sender_id: 991281637 + sender_id: 991270252 deliver_silently: true reactions: - "\U0001F606" - "\U0001F605" state: live newsfeed_assignments: - - newsfeed_id: 753 + - newsfeed_id: 178 published_at: 1664638214 "/news/news_items/{id}": get: @@ -7598,12 +7625,12 @@ paths: examples: successful: value: - id: '426' + id: '104' type: news-item - workspace_id: this_is_an_id489_that_should_be_at_least_ + workspace_id: this_is_an_id500_that_should_be_at_least_ title: We have news body: "

    Hello there,

    " - sender_id: 991281640 + sender_id: 991270255 state: live labels: [] cover_image_url: @@ -7613,11 +7640,11 @@ paths: - - deliver_silently: false - created_at: 1712222452 - updated_at: 1712222452 + created_at: 1715077031 + updated_at: 1715077031 newsfeed_assignments: - - newsfeed_id: 755 - published_at: 1712222452 + - newsfeed_id: 180 + published_at: 1715077031 schema: "$ref": "#/components/schemas/news_item" '404': @@ -7628,7 +7655,7 @@ paths: News Item Not Found: value: type: error.list - request_id: 8742c698-75f0-4589-bf31-62d5c272b2d8 + request_id: f1979819-109f-4bfd-b419-34ec974efb71 errors: - code: not_found message: Resource Not Found @@ -7642,7 +7669,7 @@ paths: Unauthorized: value: type: error.list - request_id: 956c27d1-3ba0-4e2f-bf5a-8c0417f3e9fd + request_id: 140a1897-77ef-40c6-8f27-b5abdb076f59 errors: - code: unauthorized message: Access Token Invalid @@ -7673,12 +7700,12 @@ paths: examples: successful: value: - id: '429' + id: '107' type: news-item - workspace_id: this_is_an_id495_that_should_be_at_least_ + workspace_id: this_is_an_id506_that_should_be_at_least_ title: Christmas is here! body: "

    New gifts in store for the jolly season

    " - sender_id: 991281648 + sender_id: 991270263 state: live labels: [] cover_image_url: @@ -7686,8 +7713,8 @@ paths: - "\U0001F61D" - "\U0001F602" deliver_silently: false - created_at: 1712222454 - updated_at: 1712222455 + created_at: 1715077032 + updated_at: 1715077033 newsfeed_assignments: [] schema: "$ref": "#/components/schemas/news_item" @@ -7699,7 +7726,7 @@ paths: News Item Not Found: value: type: error.list - request_id: 17383b62-5b18-4af6-a221-e374fdb87466 + request_id: bae89ef2-40d2-4698-8aee-93b3f29f2473 errors: - code: not_found message: Resource Not Found @@ -7713,7 +7740,7 @@ paths: Unauthorized: value: type: error.list - request_id: c35a3c52-be69-4ac4-8c9f-f55b79e0a28e + request_id: 0cc0ae40-77c0-4b60-b162-46f44fef267b errors: - code: unauthorized message: Access Token Invalid @@ -7730,7 +7757,7 @@ paths: value: title: Christmas is here! body: "

    New gifts in store for the jolly season

    " - sender_id: 991281648 + sender_id: 991270263 reactions: - "\U0001F61D" - "\U0001F602" @@ -7739,7 +7766,7 @@ paths: value: title: Christmas is here! body: "

    New gifts in store for the jolly season

    " - sender_id: 991281651 + sender_id: 991270266 reactions: - "\U0001F61D" - "\U0001F602" @@ -7769,7 +7796,7 @@ paths: examples: successful: value: - id: '432' + id: '110' object: news-item deleted: true schema: @@ -7782,7 +7809,7 @@ paths: News Item Not Found: value: type: error.list - request_id: d4ca58fd-f0d7-4a69-87e1-2b4de5d81a42 + request_id: 9b2e2f12-eaa5-4ce2-a607-bcd193f11e93 errors: - code: not_found message: Resource Not Found @@ -7796,7 +7823,7 @@ paths: Unauthorized: value: type: error.list - request_id: a8ee9e41-32cd-43a6-9bc6-819fdc1ab30f + request_id: 1c644c20-1a2f-46c2-aabd-eeafce79ea18 errors: - code: unauthorized message: Access Token Invalid @@ -7849,7 +7876,7 @@ paths: Unauthorized: value: type: error.list - request_id: 041e3ea1-e840-407c-a96c-f7eaf062beff + request_id: 5a5c3f68-bd2c-4026-8f45-ef172ab53136 errors: - code: unauthorized message: Access Token Invalid @@ -7882,16 +7909,16 @@ paths: total_pages: 1 type: pages data: - - id: '768' + - id: '193' type: newsfeed name: Visitor Feed - created_at: 1712222459 - updated_at: 1712222459 - - id: '769' + created_at: 1715077037 + updated_at: 1715077037 + - id: '194' type: newsfeed name: Visitor Feed - created_at: 1712222459 - updated_at: 1712222459 + created_at: 1715077037 + updated_at: 1715077037 total_count: 2 schema: "$ref": "#/components/schemas/paginated_response" @@ -7903,7 +7930,7 @@ paths: Unauthorized: value: type: error.list - request_id: 45da78aa-ac1f-4224-a85e-037eccf2d811 + request_id: fd2212ca-1c8d-4677-b57e-e162833d74be errors: - code: unauthorized message: Access Token Invalid @@ -7937,11 +7964,11 @@ paths: examples: successful: value: - id: '772' + id: '197' type: newsfeed name: Visitor Feed - created_at: 1712222460 - updated_at: 1712222460 + created_at: 1715077038 + updated_at: 1715077038 schema: "$ref": "#/components/schemas/newsfeed" '401': @@ -7952,7 +7979,7 @@ paths: Unauthorized: value: type: error.list - request_id: 536d1c3e-9f2d-42a2-b2bf-8bc19ac54482 + request_id: 3b538847-10c0-4020-8a7c-4994204aae75 errors: - code: unauthorized message: Access Token Invalid @@ -7986,16 +8013,16 @@ paths: Note found: value: type: note - id: '421' - created_at: 1711531261 + id: '102' + created_at: 1714385839 contact: type: contact - id: 660e70fd6abd01b9d19043ac + id: 6639ffafc2ba3caea1b5597d author: type: admin - id: '991281667' - name: Ciaran312 Lee - email: admin312@email.com + id: '991270282' + name: Ciaran323 Lee + email: admin323@email.com away_mode_enabled: false away_mode_reassign: false body: "

    This is a note.

    " @@ -8009,7 +8036,7 @@ paths: Note not found: value: type: error.list - request_id: 6b623d66-e7c9-4209-80a1-164064adc722 + request_id: d7914c4c-263a-47a5-844e-636f4510c74c errors: - code: not_found message: Resource Not Found @@ -8023,7 +8050,7 @@ paths: Unauthorized: value: type: error.list - request_id: d67411fa-5f7e-4d99-81ee-75c2de756438 + request_id: 8e535091-60ce-4de9-9809-d49545ea3f6d errors: - code: unauthorized message: Access Token Invalid @@ -8059,16 +8086,16 @@ paths: type: segment.list segments: - type: segment - id: 660e70ff6abd01b9d19043af + id: 6639ffb0c2ba3caea1b55980 name: John segment - created_at: 1712222463 - updated_at: 1712222463 + created_at: 1715077040 + updated_at: 1715077040 person_type: user - type: segment - id: 660e70ff6abd01b9d19043b0 + id: 6639ffb0c2ba3caea1b55981 name: Jane segment - created_at: 1712222463 - updated_at: 1712222463 + created_at: 1715077040 + updated_at: 1715077040 person_type: user schema: "$ref": "#/components/schemas/segment_list" @@ -8080,7 +8107,7 @@ paths: Unauthorized: value: type: error.list - request_id: 46a7a758-bf10-402d-bb69-55f1d868311a + request_id: 22ff8b0f-07f6-4332-ad2b-dad0292ae4f6 errors: - code: unauthorized message: Access Token Invalid @@ -8114,10 +8141,10 @@ paths: Successful response: value: type: segment - id: 660e71006abd01b9d19043b3 + id: 6639ffb1c2ba3caea1b55984 name: John segment - created_at: 1712222464 - updated_at: 1712222464 + created_at: 1715077041 + updated_at: 1715077041 person_type: user schema: "$ref": "#/components/schemas/segment" @@ -8129,7 +8156,7 @@ paths: Segment not found: value: type: error.list - request_id: de937942-5245-470e-be5a-91e39d8c8ab6 + request_id: 46b74c38-217b-45f3-87dd-c349950c381b errors: - code: not_found message: Resource Not Found @@ -8143,7 +8170,7 @@ paths: Unauthorized: value: type: error.list - request_id: 7faac641-d1f5-4272-91b5-415a91aecdb5 + request_id: da2bfa99-bce3-4025-a3bf-48136fff7ec0 errors: - code: unauthorized message: Access Token Invalid @@ -8173,7 +8200,7 @@ paths: type: list data: - type: subscription - id: '1513' + id: '367' state: live consent_type: opt_out default_translation: @@ -8196,7 +8223,7 @@ paths: Unauthorized: value: type: error.list - request_id: e0ba699e-845f-4833-a93a-cbff470ed032 + request_id: 3b6a126b-2160-4fc7-a90a-f2c3fcbe2b6b errors: - code: unauthorized message: Access Token Invalid @@ -8226,7 +8253,7 @@ paths: examples: successful: value: - url: http://via.intercom.io/msgr/6f80c9f2-a85a-45c2-afdf-f041c3202972 + url: http://via.intercom.io/msgr/3d90e7e7-421c-4e13-8a53-1ee03602bcfc type: phone_call_redirect schema: "$ref": "#/components/schemas/phone_switch" @@ -8259,7 +8286,7 @@ paths: Unauthorized: value: type: error.list - request_id: 573a76cf-ee52-4ac4-bdf7-37b7e898ee11 + request_id: d3d5b41b-122d-4840-9ed4-e5a8fea391a7 errors: - code: unauthorized message: Access Token Invalid @@ -8322,7 +8349,7 @@ paths: type: list data: - type: tag - id: '1339' + id: '325' name: Manual tag 1 schema: "$ref": "#/components/schemas/tag_list" @@ -8334,7 +8361,7 @@ paths: Unauthorized: value: type: error.list - request_id: 7fda19cf-a0b3-44ba-8d55-335e2325a311 + request_id: fa06d3f2-0531-45b7-bd9e-391c979e3462 errors: - code: unauthorized message: Access Token Invalid @@ -8373,7 +8400,7 @@ paths: Action successful: value: type: tag - id: '1342' + id: '328' name: test schema: "$ref": "#/components/schemas/tag" @@ -8385,7 +8412,7 @@ paths: Invalid parameters: value: type: error.list - request_id: 548289dc-e642-430e-9c01-4a5320f6a35f + request_id: 84c51035-a73c-40e8-a60f-700b753bc864 errors: - code: parameter_invalid message: invalid tag parameters @@ -8399,14 +8426,14 @@ paths: Company not found: value: type: error.list - request_id: e1ab371e-8f0d-4ced-a8bd-e36d32dfe70c + request_id: eb81ca6c-3c9e-4fd5-b544-40f9ce6ed3c8 errors: - code: company_not_found message: Company Not Found User not found: value: type: error.list - request_id: b360c476-c787-4851-af8a-b4ba42170894 + request_id: b3a5466e-cce0-4bbc-8e8e-0c83a760786b errors: - code: not_found message: User Not Found @@ -8420,7 +8447,7 @@ paths: Unauthorized: value: type: error.list - request_id: c93558ac-b4c3-4e50-a170-81a3c7600fda + request_id: b1f21209-95bc-4132-90ec-edd1ba0c46d6 errors: - code: unauthorized message: Access Token Invalid @@ -8486,7 +8513,7 @@ paths: Tag found: value: type: tag - id: '1350' + id: '336' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -8498,7 +8525,7 @@ paths: Tag not found: value: type: error.list - request_id: 9022b0b8-8023-4dc3-836d-82ea23671b40 + request_id: 91189ead-98f4-4845-88d4-aada93f29573 errors: - code: not_found message: Resource Not Found @@ -8512,7 +8539,7 @@ paths: Unauthorized: value: type: error.list - request_id: a05c5761-67e2-4216-865a-3d9f045f3750 + request_id: 1072f721-a20c-401e-9428-c607ce4e715b errors: - code: unauthorized message: Access Token Invalid @@ -8548,7 +8575,7 @@ paths: Resource not found: value: type: error.list - request_id: c32964a1-27a2-446d-8701-437cbe67b32a + request_id: 77583d7e-4788-451f-8a2d-43bc6824b223 errors: - code: not_found message: Resource Not Found @@ -8562,7 +8589,7 @@ paths: Tag has dependent objects: value: type: error.list - request_id: 2b40287b-88c5-418b-84b4-53a810b76187 + request_id: 29b3dfa2-4f5d-4e0d-9e38-e1176011108d errors: - code: tag_has_dependent_objects message: 'Unable to delete Tag with dependent objects. Segments: @@ -8577,7 +8604,7 @@ paths: Unauthorized: value: type: error.list - request_id: 7d392ae9-423f-4f6b-a400-ff54d7cc9a0a + request_id: 3ca14c4e-91c5-4a19-96d7-e3797a944fca errors: - code: unauthorized message: Access Token Invalid @@ -8615,7 +8642,7 @@ paths: Unauthorized: value: type: error.list - request_id: 40615fb0-b680-4a9b-aeb0-750a33ad90b9 + request_id: 68d1e8dc-515b-4e20-8412-fd0f14ed2e04 errors: - code: unauthorized message: Access Token Invalid @@ -8650,7 +8677,7 @@ paths: successful: value: type: team - id: '991281705' + id: '991270320' name: team 1 admin_ids: [] schema: @@ -8663,7 +8690,7 @@ paths: Team not found: value: type: error.list - request_id: ef73a509-4b85-4fdf-ae06-0d11a5d07571 + request_id: 5e87886a-6fea-484f-8843-e815d0049eff errors: - code: team_not_found message: Team not found @@ -8677,7 +8704,7 @@ paths: Unauthorized: value: type: error.list - request_id: e03cd85f-2af6-4314-9014-a3d15b231e0f + request_id: dfc586dc-ea96-4b3f-bb8b-39a76e94d36e errors: - code: unauthorized message: Access Token Invalid @@ -8709,26 +8736,26 @@ paths: successful: value: type: visitor - id: 660e711f6abd01b9d19043d7 + id: 6639ffcbc2ba3caea1b559a8 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' phone: name: Gareth Bale - pseudonym: Charcoal Knight + pseudonym: Violet Bus avatar: type: avatar - image_url: https://static.intercomassets.com/app/pseudonym_avatars_2019/charcoal-knight.png - app_id: this_is_an_id611_that_should_be_at_least_ + image_url: https://static.intercomassets.com/app/pseudonym_avatars_2019/violet-bus.png + app_id: this_is_an_id622_that_should_be_at_least_ companies: type: company.list companies: [] location_data: {} last_request_at: - created_at: 1712222495 - remote_created_at: 1712222495 - signed_up_at: 1712222495 - updated_at: 1712222495 + created_at: 1715077067 + remote_created_at: 1715077067 + signed_up_at: 1715077067 + updated_at: 1715077068 session_count: 0 social_profiles: type: social_profile.list @@ -8761,7 +8788,7 @@ paths: visitor Not Found: value: type: error.list - request_id: 49fe698e-466f-440b-a616-6455c14e2de7 + request_id: 131e0e14-bf5f-4904-a84d-a915e2962fe9 errors: - code: not_found message: Visitor Not Found @@ -8775,7 +8802,7 @@ paths: Unauthorized: value: type: error.list - request_id: bbe7204f-5e2b-4bc9-8e4e-5de5e5ab3583 + request_id: e7af7e48-d2b2-46a7-8616-18ba97a34202 errors: - code: unauthorized message: Access Token Invalid @@ -8790,7 +8817,7 @@ paths: successful: summary: successful value: - id: 660e711f6abd01b9d19043d7 + id: 6639ffcbc2ba3caea1b559a8 name: Gareth Bale visitor_not_found: summary: visitor Not Found @@ -8823,7 +8850,7 @@ paths: successful: value: type: visitor - id: 660e71216abd01b9d19043dd + id: 6639ffcdc2ba3caea1b559ae user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' @@ -8833,16 +8860,16 @@ paths: avatar: type: avatar image_url: - app_id: this_is_an_id617_that_should_be_at_least_ + app_id: this_is_an_id628_that_should_be_at_least_ companies: type: company.list companies: [] location_data: {} last_request_at: - created_at: 1712222497 - remote_created_at: 1712222497 - signed_up_at: 1712222497 - updated_at: 1712222497 + created_at: 1715077069 + remote_created_at: 1715077069 + signed_up_at: 1715077069 + updated_at: 1715077069 session_count: 0 social_profiles: type: social_profile.list @@ -8875,7 +8902,7 @@ paths: Visitor not found: value: type: error.list - request_id: 89472d56-c695-4a0e-9716-ba329acede46 + request_id: bd5e14c4-e2f7-48ac-9cd2-9a29e792c3b2 errors: - code: not_found message: Visitor Not Found @@ -8889,206 +8916,7 @@ paths: Unauthorized: value: type: error.list - request_id: c167e427-c89a-42e2-b762-cc911f8d3d3a - errors: - - code: unauthorized - message: Access Token Invalid - schema: - "$ref": "#/components/schemas/error" - "/visitors/{id}": - get: - summary: Retrieve a visitor with ID - parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - - name: id - in: path - required: true - description: Id provided by Intercom. - example: 5e1c4c1c-7b1e-4b5d-8c1c-5e1c4c1c7b1e - schema: - type: string - tags: - - Visitors - operationId: retrieveVisitor - description: You can fetch the details of a single visitor. - responses: - '200': - description: successful - content: - application/json: - examples: - successful: - value: - type: visitor - id: 660e71236abd01b9d19043e3 - user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 - anonymous: true - email: '' - phone: - name: - pseudonym: - avatar: - type: avatar - image_url: - app_id: this_is_an_id623_that_should_be_at_least_ - companies: - type: company.list - companies: [] - location_data: {} - last_request_at: - created_at: 1712222499 - remote_created_at: 1712222499 - signed_up_at: 1712222499 - updated_at: 1712222499 - session_count: 0 - social_profiles: - type: social_profile.list - social_profiles: [] - owner_id: - unsubscribed_from_emails: false - marked_email_as_spam: false - has_hard_bounced: false - tags: - type: tag.list - tags: [] - segments: - type: segment.list - segments: [] - custom_attributes: {} - referrer: - utm_campaign: - utm_content: - utm_medium: - utm_source: - utm_term: - do_not_track: - schema: - "$ref": "#/components/schemas/visitor" - '404': - description: Visitor not found - content: - application/json: - examples: - Visitor not found: - value: - type: error.list - request_id: 1eae1999-15fc-4549-80b8-f038892bd3f6 - errors: - - code: not_found - message: Visitor Not Found - schema: - "$ref": "#/components/schemas/error" - '401': - description: Unauthorized - content: - application/json: - examples: - Unauthorized: - value: - type: error.list - request_id: 143e9493-d2d9-40cd-9a14-3c9d5d518a3b - errors: - - code: unauthorized - message: Access Token Invalid - schema: - "$ref": "#/components/schemas/error" - delete: - summary: Delete a visitor - parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - - name: id - in: path - required: true - description: Id provided by Intercom. - example: 5e1c4c1c-7b1e-4b5d-8c1c-5e1c4c1c7b1e - schema: - type: string - tags: - - Visitors - operationId: deleteVisitor - description: You can delete a single visitor. - responses: - '200': - description: successful - content: - application/json: - examples: - successful: - value: - type: visitor - id: 660e71256abd01b9d19043e9 - user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 - anonymous: true - email: '' - phone: - name: - pseudonym: - avatar: - type: avatar - image_url: - app_id: this_is_an_id629_that_should_be_at_least_ - companies: - type: company.list - companies: [] - location_data: {} - last_request_at: - created_at: 1712222501 - remote_created_at: 1712222501 - signed_up_at: 1712222501 - updated_at: 1712222501 - session_count: 0 - social_profiles: - type: social_profile.list - social_profiles: [] - owner_id: - unsubscribed_from_emails: false - marked_email_as_spam: false - has_hard_bounced: false - tags: - type: tag.list - tags: [] - segments: - type: segment.list - segments: [] - custom_attributes: {} - referrer: - utm_campaign: - utm_content: - utm_medium: - utm_source: - utm_term: - do_not_track: - schema: - "$ref": "#/components/schemas/visitor_deleted_object" - '404': - description: Visitor Not Found - content: - application/json: - examples: - Visitor Not Found: - value: - type: error.list - request_id: d1e0c2d5-c639-4882-9a76-e656e9d19029 - errors: - - code: not_found - message: User Not Found - schema: - "$ref": "#/components/schemas/error" - '401': - description: Unauthorized - content: - application/json: - examples: - Unauthorized: - value: - type: error.list - request_id: 7af7bdac-1a61-4b4e-a91f-bd73013a2559 + request_id: 4ca61a98-97f4-44a4-808c-8ac5bde4e409 errors: - code: unauthorized message: Access Token Invalid @@ -9119,8 +8947,8 @@ paths: successful: value: type: contact - id: 660e71276abd01b9d19043f0 - workspace_id: this_is_an_id635_that_should_be_at_least_ + id: 6639ffcfc2ba3caea1b559b5 + workspace_id: this_is_an_id634_that_should_be_at_least_ external_id: role: user email: foo@bar.com @@ -9134,9 +8962,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1712222503 - updated_at: 1712222503 - signed_up_at: 1712222503 + created_at: 1715077071 + updated_at: 1715077071 + signed_up_at: 1715077070 last_seen_at: last_replied_at: last_contacted_at: @@ -9170,31 +8998,31 @@ paths: tags: type: list data: [] - url: "/contacts/660e71276abd01b9d19043f0/tags" + url: "/contacts/6639ffcfc2ba3caea1b559b5/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/660e71276abd01b9d19043f0/notes" + url: "/contacts/6639ffcfc2ba3caea1b559b5/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/660e71276abd01b9d19043f0/companies" + url: "/contacts/6639ffcfc2ba3caea1b559b5/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/660e71276abd01b9d19043f0/subscriptions" + url: "/contacts/6639ffcfc2ba3caea1b559b5/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/660e71276abd01b9d19043f0/subscriptions" + url: "/contacts/6639ffcfc2ba3caea1b559b5/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -9213,7 +9041,7 @@ paths: Unauthorized: value: type: error.list - request_id: 7aa11d0f-8929-4927-b526-e28438bc07b0 + request_id: a4d32b12-4b18-4fc2-9be4-cced0c88b59d errors: - code: unauthorized message: Access Token Invalid @@ -13035,6 +12863,7 @@ components: - '2.8' - '2.9' - '2.10' + - '2.11' - Unstable merge_contacts_request: description: Merge contact data. @@ -13102,6 +12931,8 @@ components: - body - message_type multiple_filter_search_request: + title: Multiple Filter Search Request + description: Search using Intercoms Search APIs with more than one filter. type: object properties: operator: @@ -13749,12 +13580,14 @@ components: description: A pagination object, which may be empty, indicating no further pages to fetch. single_filter_search_request: + title: Single Filter Search Request + description: Search using Intercoms Search APIs with a single filter. type: object properties: field: type: string - description: The Intercom defined id representing the company. - example: custom_attributes.social_network + description: The accepted field that you want to search on. + example: created_at operator: type: string enum: @@ -13768,12 +13601,13 @@ components: - "!~" - "^" - "$" - description: The Intercom defined id representing the company. - example: "=" + description: The accepted operators you can use to define how you want to + search for the value. + example: ">" value: type: string - description: The Intercom defined id representing the company. - example: facebook + description: The value that you want to search on. + example: '73732934' sla_applied: title: Applied SLA type: object @@ -13846,16 +13680,20 @@ components: description: The name of the Social media profile example: http://twitter.com/th1sland starting_after_paging: - title: StartingAfterPaging + title: 'Pagination: Starting After' type: object nullable: true properties: - page: + per_page: type: integer + description: The number of results to fetch per page. example: 2 starting_after: type: string - example: 1HaSB+xrOyyMXAkS/c1RteCL7BzOzTvYjmjakgTergIH31eoe2v4/sbLsJWP\nIncfQLD3ouPkZlCwJ86F\n + description: The cursor to use in the next request to get the next page + of results. + nullable: true + example: your-cursor-from-response subscription_type: title: Subscription Types type: object diff --git a/descriptions/2.9/api.intercom.io.yaml b/descriptions/2.9/api.intercom.io.yaml index ca5b019..3ae41e6 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: '991281791' + id: '991270400' 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: 1712222515 + created_at: 1715077081 secure: false identity_verification: false timezone: America/Los_Angeles @@ -83,7 +83,7 @@ paths: Successful response: value: type: admin - id: '991281792' + id: '991270401' 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: 43ee316e-d98c-44fc-94e6-b1e1a55b5228 + request_id: f4f1ac07-17e5-4763-8cef-71b196170bac errors: - code: admin_not_found message: Admin for admin_id not found @@ -114,7 +114,7 @@ paths: Unauthorized: value: type: error.list - request_id: 145898f9-a6d4-4f3b-8a39-df28d984cb53 + request_id: 5a3cf748-b3a0-40e1-b72e-4527ba1f8f6e errors: - code: unauthorized message: Access Token Invalid @@ -201,10 +201,10 @@ paths: per_page: 20 total_pages: 1 activity_logs: - - id: 7bf4bd87-47a8-4dcf-aff0-eef4b10a9229 + - id: 5b550ba7-a955-48d8-b284-9b65d27cf35b performed_by: type: admin - id: '991281795' + id: '991270405' email: admin5@email.com ip: 127.0.0.1 metadata: @@ -213,21 +213,21 @@ paths: title: Initial message title before: Initial message title after: Eventual message title - created_at: 1712222521 + created_at: 1715077086 activity_type: message_state_change activity_description: Ciaran5 Lee changed your Initial message title message from Initial message title to Eventual message title. - - id: 598f95a0-6969-4ada-9de2-3be877cf3f11 + - id: 9754568b-99ce-491c-afe3-e5995924049d performed_by: type: admin - id: '991281795' + id: '991270405' email: admin5@email.com ip: 127.0.0.1 metadata: before: before after: after - created_at: 1712222521 + created_at: 1715077086 activity_type: app_name_change activity_description: Ciaran5 Lee changed your app name from before to after. @@ -241,7 +241,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0f3aa466-8936-4ab6-a492-19ab1a1087c4 + request_id: 9f84e800-881e-4e4d-87ad-f893205ed79e errors: - code: unauthorized message: Access Token Invalid @@ -271,7 +271,7 @@ paths: admins: - type: admin email: admin7@email.com - id: '991281797' + id: '991270407' name: Ciaran7 Lee away_mode_enabled: false away_mode_reassign: false @@ -287,7 +287,7 @@ paths: Unauthorized: value: type: error.list - request_id: '00922901-b69e-47a1-8f7d-4179fea8d8dc' + request_id: b572c847-d174-44b1-9018-0d9f91ec67f4 errors: - code: unauthorized message: Access Token Invalid @@ -321,7 +321,7 @@ paths: Admin found: value: type: admin - id: '991281799' + id: '991270409' 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: 28143bd2-8d6b-4555-8b80-bd8ee3e85f6c + request_id: cdf62500-d117-4a43-ae17-a8ac914c41ab errors: - code: admin_not_found message: Admin not found @@ -352,7 +352,7 @@ paths: Unauthorized: value: type: error.list - request_id: a446b7f5-8ed0-4db1-8959-42d772ecea4c + request_id: 65e0bfbf-19ef-43e1-9d71-a95b7c77df92 errors: - code: unauthorized message: Access Token Invalid @@ -390,20 +390,20 @@ paths: total_pages: 1 total_count: 1 data: - - id: '603' + - id: '143' type: article workspace_id: this_is_an_id22_that_should_be_at_least_4 - parent_id: 2442 + parent_id: 574 parent_type: collection parent_ids: [] title: This is the article title description: '' body: '' - author_id: 991281802 + author_id: 991270412 state: published - created_at: 1712222526 - updated_at: 1712222526 - url: http://help-center.test/myapp-22/en/articles/603-this-is-the-article-title + created_at: 1715077091 + updated_at: 1715077091 + 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: 46b18aa9-baac-42dd-8e0e-6f2db47052f9 + request_id: 8de6d7ab-c26c-4a42-aa3d-fca2273f1719 errors: - code: unauthorized message: Access Token Invalid @@ -439,10 +439,10 @@ paths: examples: article created: value: - id: '606' + id: '146' type: article workspace_id: this_is_an_id26_that_should_be_at_least_4 - parent_id: 2444 + 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: 991281807 + author_id: 991270417 state: published - created_at: 1712222528 - updated_at: 1712222528 - url: http://help-center.test/myapp-26/en/articles/606-thanks-for-everything + created_at: 1715077093 + updated_at: 1715077093 + 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: cca83e76-d644-4039-bdee-9818c21dd589 + request_id: 5adc9fb6-928b-4449-a8e0-9306c9358b3f 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: 1d93e5d6-2594-4d8d-bc0d-330b975b1449 + request_id: 0d19e38f-24cc-481b-aa3b-1aea1ffdbf48 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: 991281807 + author_id: 991270417 state: published - parent_id: 2444 + 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: 991281807 + author_id: 991270417 state: published bad_request: summary: Bad Request @@ -550,10 +550,10 @@ paths: examples: Article found: value: - id: '609' + id: '149' type: article workspace_id: this_is_an_id32_that_should_be_at_least_4 - parent_id: 2447 + parent_id: 579 parent_type: collection parent_ids: [] statistics: @@ -567,11 +567,11 @@ paths: title: This is the article title description: '' body: '' - author_id: 991281812 + author_id: 991270422 state: published - created_at: 1712222530 - updated_at: 1712222530 - url: http://help-center.test/myapp-32/en/articles/609-this-is-the-article-title + created_at: 1715077095 + updated_at: 1715077095 + 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: 6a489d6d-2183-4262-a0d0-4781eb6edda5 + request_id: 4c27f446-f8ac-463d-a182-7a63207c4f75 errors: - code: not_found message: Resource Not Found @@ -596,7 +596,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9d702eab-7fed-4f20-97ef-a62c76ecb00b + request_id: bf29c39a-a3a4-4be0-8e0a-88aec9233e09 errors: - code: unauthorized message: Access Token Invalid @@ -629,10 +629,10 @@ paths: examples: successful: value: - id: '612' + id: '152' type: article workspace_id: this_is_an_id38_that_should_be_at_least_4 - parent_id: 2450 + 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: 991281818 + author_id: 991270428 state: published - created_at: 1712222532 - updated_at: 1712222533 - url: http://help-center.test/myapp-38/en/articles/612-christmas-is-here + created_at: 1715077097 + updated_at: 1715077098 + 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: c0483279-1892-457c-8562-727df89d17aa + request_id: 55fcdd02-4a8a-450d-87f0-56af996eac8d errors: - code: not_found message: Resource Not Found @@ -675,7 +675,7 @@ paths: Unauthorized: value: type: error.list - request_id: e26ad315-de0f-441e-9dbb-8bb316386e65 + request_id: bbfb36a8-8892-438b-aa07-9eeb10d471fb errors: - code: unauthorized message: Access Token Invalid @@ -723,7 +723,7 @@ paths: examples: successful: value: - id: '615' + id: '155' object: article deleted: true schema: @@ -736,7 +736,7 @@ paths: Article Not Found: value: type: error.list - request_id: a61a8c1b-949d-436e-916d-c9f10d02b31f + request_id: 63f2e867-1c2b-4a18-9f1e-0ed1dbf9e449 errors: - code: not_found message: Resource Not Found @@ -750,7 +750,7 @@ paths: Unauthorized: value: type: error.list - request_id: c6494240-ac17-42c6-a7f9-996952500182 + request_id: a080f668-51b0-4fc2-af31-c1b2501ff787 errors: - code: unauthorized message: Access Token Invalid @@ -781,16 +781,16 @@ paths: value: type: list data: - - id: '2458' + - 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: 1712222538 - updated_at: 1712222538 + created_at: 1715077102 + updated_at: 1715077102 description: english collection description icon: bookmark - help_center_id: 1194 + help_center_id: 290 type: collection total_count: 1 pages: @@ -808,7 +808,7 @@ paths: Unauthorized: value: type: error.list - request_id: 21bf7182-6b07-420c-ae27-222f893df4ff + request_id: aebb566c-1bdb-4c26-b26f-3dcb49fbe7de errors: - code: unauthorized message: Access Token Invalid @@ -833,16 +833,16 @@ paths: examples: collection created: value: - id: '2464' + 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: 1712222539 - updated_at: 1712222539 + created_at: 1715077103 + updated_at: 1715077103 description: '' icon: book-bookmark - help_center_id: 1196 + help_center_id: 292 type: collection schema: "$ref": "#/components/schemas/collection" @@ -854,7 +854,7 @@ paths: Bad Request: value: type: error.list - request_id: e488bb81-b94e-445d-9013-f07ded85697a + request_id: 41379322-7221-4b96-bcd4-3a5b10d83452 errors: - code: parameter_not_found message: Name is a required parameter. @@ -868,7 +868,7 @@ paths: Unauthorized: value: type: error.list - request_id: 17a02d20-f0bb-4db5-931f-234a942f564c + request_id: 3d896271-cda1-4610-9ad9-5f187f9d3cd5 errors: - code: unauthorized message: Access Token Invalid @@ -916,16 +916,16 @@ paths: examples: Collection found: value: - id: '2469' + 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: 1712222541 - updated_at: 1712222541 + created_at: 1715077105 + updated_at: 1715077105 description: english collection description icon: bookmark - help_center_id: 1199 + help_center_id: 295 type: collection schema: "$ref": "#/components/schemas/collection" @@ -937,7 +937,7 @@ paths: Collection not found: value: type: error.list - request_id: 94dc5eca-0d4c-4633-bb78-61603ed827db + request_id: 0b992410-4bb4-4746-80dd-ee44486f76a3 errors: - code: not_found message: Resource Not Found @@ -951,7 +951,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0f655eea-6d5c-4d4b-9f38-8087fde70f98 + request_id: 735e9bc1-4d5b-424c-abe7-356a50b1c878 errors: - code: unauthorized message: Access Token Invalid @@ -984,16 +984,16 @@ paths: examples: successful: value: - id: '2475' + 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: 1712222542 - updated_at: 1712222543 + created_at: 1715077106 + updated_at: 1715077106 description: english collection description icon: folder - help_center_id: 1202 + help_center_id: 298 type: collection schema: "$ref": "#/components/schemas/collection" @@ -1005,7 +1005,7 @@ paths: Collection Not Found: value: type: error.list - request_id: f78b47cf-03ce-413d-b837-cf5f3660bdf4 + request_id: d8482579-109e-4315-9f85-a33c9136f311 errors: - code: not_found message: Resource Not Found @@ -1019,7 +1019,7 @@ paths: Unauthorized: value: type: error.list - request_id: 637b06b4-f414-4b46-bf49-55615276753b + request_id: 00753570-bd48-4e70-895e-bc9b5af1b8dc errors: - code: unauthorized message: Access Token Invalid @@ -1066,7 +1066,7 @@ paths: examples: successful: value: - id: '2481' + id: '613' object: collection deleted: true schema: @@ -1079,7 +1079,7 @@ paths: collection Not Found: value: type: error.list - request_id: 52d72e8b-e231-428d-97b7-34c9472b3a83 + request_id: b710f300-46b2-47c4-b084-dfc1e2a2e0ba errors: - code: not_found message: Resource Not Found @@ -1093,7 +1093,7 @@ paths: Unauthorized: value: type: error.list - request_id: 5e685910-bf31-47f8-afc2-0773088116ee + request_id: 51d50942-3c08-450f-aebb-2a6996c9b5c1 errors: - code: unauthorized message: Access Token Invalid @@ -1127,10 +1127,10 @@ paths: examples: Collection found: value: - id: '1208' + id: '304' workspace_id: this_is_an_id80_that_should_be_at_least_4 - created_at: 1712222546 - updated_at: 1712222546 + created_at: 1715077109 + updated_at: 1715077109 identifier: help-center-1 website_turned_on: false display_name: Intercom Help Center @@ -1144,7 +1144,7 @@ paths: Collection not found: value: type: error.list - request_id: 2d24ba07-070f-4e48-b94a-0ed61d31296a + request_id: 708ab705-f854-4d36-a73a-ce8f7608cb5c errors: - code: not_found message: Resource Not Found @@ -1158,7 +1158,7 @@ paths: Unauthorized: value: type: error.list - request_id: b91e0978-cc56-43f3-a30c-1e6c2d947453 + request_id: cf39e84a-093c-48a2-9562-243ff7f6767e errors: - code: unauthorized message: Access Token Invalid @@ -1196,7 +1196,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2a4eed35-42c6-4921-beb5-d9bae9ab4525 + request_id: a209164a-91da-458b-a9c9-c18d83fe28e0 errors: - code: unauthorized message: Access Token Invalid @@ -1228,15 +1228,15 @@ paths: value: type: list data: - - id: '2488' + - 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: 1712222549 - updated_at: 1712222549 + created_at: 1715077111 + updated_at: 1715077111 type: section - parent_id: 2487 + parent_id: 619 total_count: 1 pages: type: pages @@ -1253,7 +1253,7 @@ paths: Unauthorized: value: type: error.list - request_id: ad5efa21-51ef-475e-8519-7303aa9abfbd + request_id: 2d1483c6-8ece-40e6-95f6-da91c37b229d errors: - code: unauthorized message: Access Token Invalid @@ -1278,15 +1278,15 @@ paths: examples: section created: value: - id: '2493' + 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: 1712222550 - updated_at: 1712222550 + created_at: 1715077112 + updated_at: 1715077112 type: section - parent_id: '2491' + parent_id: '623' schema: "$ref": "#/components/schemas/section" '401': @@ -1297,7 +1297,7 @@ paths: Unauthorized: value: type: error.list - request_id: 21f8b084-b13f-45cf-8eee-f6c17f3577d5 + request_id: 1b4beddd-cbd7-4458-b920-55d249defbc5 errors: - code: unauthorized message: Access Token Invalid @@ -1313,7 +1313,7 @@ paths: summary: section created value: name: Thanks for everything - parent_id: 2491 + parent_id: 623 "/help_center/sections/{id}": get: summary: Retrieve a section @@ -1342,15 +1342,15 @@ paths: examples: Section found: value: - id: '2497' + 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: 1712222551 - updated_at: 1712222551 + created_at: 1715077113 + updated_at: 1715077113 type: section - parent_id: 2496 + parent_id: 628 schema: "$ref": "#/components/schemas/section" '404': @@ -1361,7 +1361,7 @@ paths: Section not found: value: type: error.list - request_id: '03822d88-6e54-4ab1-9074-1befaebdee29' + request_id: 66193450-a655-4fe2-bc87-e8230a8f36e2 errors: - code: not_found message: Resource Not Found @@ -1375,7 +1375,7 @@ paths: Unauthorized: value: type: error.list - request_id: 4371ace2-f7c2-453c-bb1f-019a3bfcfb1e + request_id: bcc599aa-3d30-4950-be71-11f25d9b9440 errors: - code: unauthorized message: Access Token Invalid @@ -1408,15 +1408,15 @@ paths: examples: successful: value: - id: '2503' + 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: 1712222553 - updated_at: 1712222553 + created_at: 1715077114 + updated_at: 1715077114 type: section - parent_id: '2502' + parent_id: '634' schema: "$ref": "#/components/schemas/section" '404': @@ -1427,7 +1427,7 @@ paths: Section Not Found: value: type: error.list - request_id: caa4dc4a-c501-4e2b-9117-58861a62b5d4 + request_id: 31ddd3da-8a89-4250-a61e-3a81c28c401e errors: - code: not_found message: Resource Not Found @@ -1441,7 +1441,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2093a533-d755-4f30-90ef-de20ac1d5794 + request_id: 15846ee7-5cbf-4402-8a63-4a4961196f81 errors: - code: unauthorized message: Access Token Invalid @@ -1457,12 +1457,12 @@ paths: summary: successful value: name: Update section name - parent_id: 2502 + parent_id: 634 section_not_found: summary: Section Not Found value: name: Update section name - parent_id: 2504 + parent_id: 636 delete: summary: Delete a section parameters: @@ -1489,7 +1489,7 @@ paths: examples: successful: value: - id: '2509' + id: '641' object: section deleted: true schema: @@ -1502,7 +1502,7 @@ paths: section Not Found: value: type: error.list - request_id: 3076071b-9711-49ac-b37d-652e795c6da7 + request_id: 658ba973-78b9-4eaf-85d4-64a5240a0788 errors: - code: not_found message: Resource Not Found @@ -1516,7 +1516,7 @@ paths: Unauthorized: value: type: error.list - request_id: d50cacd9-d2a3-4bfc-947f-12cff0ee1fa9 + request_id: 6f33b4a2-8ac6-4247-8feb-f5bb787cd86b errors: - code: unauthorized message: Access Token Invalid @@ -1553,12 +1553,12 @@ paths: value: type: company company_id: company_remote_id - id: 660e715d6abd01bb40bdc3dd + id: 6639fffdf7676c5662aebaaf app_id: this_is_an_id116_that_should_be_at_least_ name: my company remote_created_at: 1374138000 - created_at: 1712222557 - updated_at: 1712222557 + created_at: 1715077118 + updated_at: 1715077118 monthly_spend: 0 session_count: 0 user_count: 0 @@ -1595,7 +1595,7 @@ paths: Unauthorized: value: type: error.list - request_id: 20ee03bd-53d8-4b61-a4bb-66c41d8e9827 + request_id: e92b5576-a5b0-422e-8162-01fac4c42c94 errors: - code: unauthorized message: Access Token Invalid @@ -1693,12 +1693,12 @@ paths: data: - type: company company_id: remote_companies_scroll_2 - id: 660e715e6abd01bb40bdc3e5 + id: 6639fffff7676c5662aebab7 app_id: this_is_an_id122_that_should_be_at_least_ name: IntercomQATest1 - remote_created_at: 1712222558 - created_at: 1712222558 - updated_at: 1712222558 + remote_created_at: 1715077119 + created_at: 1715077119 + updated_at: 1715077119 monthly_spend: 0 session_count: 0 user_count: 4 @@ -1727,7 +1727,7 @@ paths: Company Not Found: value: type: error.list - request_id: 26a0da65-d990-4d97-a09b-fbd881c8685d + request_id: bd540cb3-5c54-4bb8-975e-4a2ff488f41b errors: - code: company_not_found message: Company Not Found @@ -1741,7 +1741,7 @@ paths: Unauthorized: value: type: error.list - request_id: 97a4b88f-ea2c-4e5f-b43d-b6258c1a0799 + request_id: f090330f-1070-480f-8758-5dcfc6fb6464 errors: - code: unauthorized message: Access Token Invalid @@ -1776,12 +1776,12 @@ paths: value: type: company company_id: '1' - id: 660e71616abd01bb40bdc3f0 + id: 663a0002f7676c5662aebac2 app_id: this_is_an_id128_that_should_be_at_least_ name: company1 - remote_created_at: 1712222561 - created_at: 1712222561 - updated_at: 1712222561 + remote_created_at: 1715077122 + created_at: 1715077122 + updated_at: 1715077122 monthly_spend: 0 session_count: 0 user_count: 1 @@ -1803,7 +1803,7 @@ paths: Company Not Found: value: type: error.list - request_id: 29190e80-1cac-4e21-b144-8aa0cbae0674 + request_id: effcaf9c-d525-4cc1-a772-3b90ee5287d4 errors: - code: company_not_found message: Company Not Found @@ -1817,7 +1817,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8d56cbe1-4d46-458c-9ce8-6946e4ef4c6d + request_id: 830f56ac-15e4-4858-a9ac-121fdad63d9f errors: - code: unauthorized message: Access Token Invalid @@ -1856,12 +1856,12 @@ paths: value: type: company company_id: '1' - id: 660e71636abd01bb40bdc3fa + id: 663a0004f7676c5662aebacc app_id: this_is_an_id134_that_should_be_at_least_ name: company2 - remote_created_at: 1712222563 - created_at: 1712222563 - updated_at: 1712222563 + remote_created_at: 1715077124 + created_at: 1715077124 + updated_at: 1715077124 monthly_spend: 0 session_count: 0 user_count: 1 @@ -1883,7 +1883,7 @@ paths: Company Not Found: value: type: error.list - request_id: 6c5ea588-2179-408c-882c-b1d0c4e032ba + request_id: 5eb2aa8d-f697-4960-b669-a25aa228e142 errors: - code: company_not_found message: Company Not Found @@ -1897,7 +1897,7 @@ paths: Unauthorized: value: type: error.list - request_id: 40166fe2-b53d-4615-931d-57d035a387b3 + request_id: 810ea0ac-478e-4c29-ae30-a4086eb2e0d5 errors: - code: unauthorized message: Access Token Invalid @@ -1929,7 +1929,7 @@ paths: examples: Successful: value: - id: 660e71656abd01bb40bdc404 + id: 663a0006f7676c5662aebad6 object: company deleted: true schema: @@ -1942,7 +1942,7 @@ paths: Company Not Found: value: type: error.list - request_id: f0c05b72-3ff1-4719-b894-ad567569b7de + request_id: ebb7e988-035f-4eb8-a4be-9e77bd52a2be errors: - code: company_not_found message: Company Not Found @@ -1956,7 +1956,7 @@ paths: Unauthorized: value: type: error.list - request_id: eef8513a-6de2-40d2-8876-977aa62e86a2 + request_id: 8b5bac17-e08c-4cfc-8a03-b95bde2c7dff errors: - code: unauthorized message: Access Token Invalid @@ -2008,7 +2008,7 @@ paths: Company Not Found: value: type: error.list - request_id: 46bd2cfa-9abe-489f-85b3-3feb90281893 + request_id: 2e38b0f8-b573-43f7-bf27-1568696607f6 errors: - code: company_not_found message: Company Not Found @@ -2022,7 +2022,7 @@ paths: Unauthorized: value: type: error.list - request_id: c02930e0-2f9e-4fd2-a0ff-fdad8e467af6 + request_id: '09995fbd-1426-4b72-b7de-7cb415660dbb' errors: - code: unauthorized message: Access Token Invalid @@ -2067,7 +2067,7 @@ paths: Company Not Found: value: type: error.list - request_id: 61cf32f3-e098-4b91-b0a7-c625796e11f4 + request_id: 00b3db3e-256a-4a0c-8569-48db1df52eff errors: - code: company_not_found message: Company Not Found @@ -2081,7 +2081,7 @@ paths: Unauthorized: value: type: error.list - request_id: f6e9b634-f7cd-4af3-b425-238c5e77d8ad + request_id: 38b3b713-40e4-4f1a-8a7d-d97a925c45ac errors: - code: unauthorized message: Access Token Invalid @@ -2098,14 +2098,14 @@ paths: - name: page in: query required: false - description: what page of results to fetch. Defaults to first page + description: The page of results to fetch. Defaults to first page example: 1 schema: type: integer - name: per_page in: query required: false - description: how many results per page. Defaults to 15 + description: How many results to return per page. Defaults to 15 example: 15 schema: type: integer @@ -2126,6 +2126,10 @@ paths: Note that the API does not include companies who have no associated users in list responses. When using the Companies endpoint and the pages object to iterate through the returned companies, there is a limit of 10,000 Companies that can be returned. If you need to list or iterate on more than 10,000 Companies, please use the [Scroll API](https://developers.intercom.com/reference#iterating-over-all-companies). + {% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `20` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. + {% /admonition %} responses: '200': description: Successful @@ -2138,12 +2142,12 @@ paths: data: - type: company company_id: remote_companies_scroll_2 - id: 660e716b6abd01bb40bdc420 + id: 663a000df7676c5662aebaf2 app_id: this_is_an_id158_that_should_be_at_least_ name: IntercomQATest1 - remote_created_at: 1712222571 - created_at: 1712222571 - updated_at: 1712222571 + remote_created_at: 1715077133 + created_at: 1715077133 + updated_at: 1715077133 monthly_spend: 0 session_count: 0 user_count: 4 @@ -2172,7 +2176,7 @@ paths: Unauthorized: value: type: error.list - request_id: fc30d013-a82c-479f-8b0a-8fa0ee26cf17 + request_id: 7d1cd6bd-a958-4154-8dab-b9bd3efd74aa errors: - code: unauthorized message: Access Token Invalid @@ -2195,23 +2199,22 @@ paths: tags: - Companies operationId: scrollOverAllCompanies - description: " The `list all companies` functionality does not work well - for huge datasets, and can result in errors and performance problems when - paging deeply. The Scroll API provides an efficient mechanism for iterating - over all companies in a dataset.\n\n- Each app can only have 1 scroll open - at a time. You'll get an error message if you try to have more than one open - per app.\n- If the scroll isn't used for 1 minute, it expires and calls with - that scroll param will fail\n- If the end of the scroll is reached, \"companies\" - will be empty and the scroll parameter will expire\n\n> \U0001F4D8 Scroll - Parameter\n>\n> You can get the first page of companies by simply sending - a GET request to the scroll endpoint. For subsequent requests you will need - to use the scroll parameter from the response.\n\n> ❗️ Scroll network timeouts\n>\n> - Since scroll is often used on large datasets network errors such as timeouts - can be encountered. When this occurs you will need to restart your scroll - query as it is not possible to continue from a specific point when using scroll.\n>\n> - When this occurs you will see a HTTP 500 error with the following message:\n> - \"Request failed due to an internal network error. Please restart the scroll - operation.\"\n" + description: |2 + The `list all companies` functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. The Scroll API provides an efficient mechanism for iterating over all companies in a dataset. + + - Each app can only have 1 scroll open at a time. You'll get an error message if you try to have more than one open per app. + - If the scroll isn't used for 1 minute, it expires and calls with that scroll param will fail + - If the end of the scroll is reached, "companies" will be empty and the scroll parameter will expire + + {% admonition type="info" name="Scroll Parameter" %} + You can get the first page of companies by simply sending a GET request to the scroll endpoint. + For subsequent requests you will need to use the scroll parameter from the response. + {% /admonition %} + {% admonition type="danger" name="Scroll network timeouts" %} + Since scroll is often used on large datasets network errors such as timeouts can be encountered. When this occurs you will see a HTTP 500 error with the following message: + "Request failed due to an internal network error. Please restart the scroll operation." + If this happens, you will need to restart your scroll query: It is not possible to continue from a specific point when using scroll. + {% /admonition %} responses: '200': description: Successful @@ -2224,12 +2227,12 @@ paths: data: - type: company company_id: remote_companies_scroll_2 - id: 660e716d6abd01bb40bdc426 + id: 663a000ef7676c5662aebaf8 app_id: this_is_an_id162_that_should_be_at_least_ name: IntercomQATest1 - remote_created_at: 1712222573 - created_at: 1712222573 - updated_at: 1712222573 + remote_created_at: 1715077134 + created_at: 1715077134 + updated_at: 1715077134 monthly_spend: 0 session_count: 0 user_count: 4 @@ -2243,7 +2246,7 @@ paths: custom_attributes: {} pages: total_count: - scroll_param: fe8397d1-1e4c-498f-a86e-712ad19f6c3c + scroll_param: 9f2e9ec3-8e79-4f30-bbd4-22d14072894d schema: "$ref": "#/components/schemas/company_scroll" '401': @@ -2254,7 +2257,7 @@ paths: Unauthorized: value: type: error.list - request_id: b7e4e7a7-f697-49fe-afad-d49e1cdedc67 + request_id: 642d8d2e-d7fc-444d-9785-38d30f01060f errors: - code: unauthorized message: Access Token Invalid @@ -2289,12 +2292,12 @@ paths: value: type: company company_id: '1' - id: 660e716f6abd01bb40bdc42f + id: 663a0010f7676c5662aebb01 app_id: this_is_an_id166_that_should_be_at_least_ name: company6 - remote_created_at: 1712222575 - created_at: 1712222575 - updated_at: 1712222575 + remote_created_at: 1715077136 + created_at: 1715077136 + updated_at: 1715077136 monthly_spend: 0 session_count: 0 user_count: 1 @@ -2316,7 +2319,7 @@ paths: Bad Request: value: type: error.list - request_id: cde9d7b0-b402-4d8c-b099-fbe437f71476 + request_id: 11a19b0c-0e52-4a18-ac8d-cd8fb07bf882 errors: - code: parameter_not_found message: company not specified @@ -2330,7 +2333,7 @@ paths: Company Not Found: value: type: error.list - request_id: a91cf9a9-ad1f-4a69-abad-0b2359543399 + request_id: 4744ede1-3b05-407e-ac0e-c832fba29d33 errors: - code: company_not_found message: Company Not Found @@ -2344,7 +2347,7 @@ paths: Unauthorized: value: type: error.list - request_id: 29fd1694-8406-448b-bc07-6109619f65af + request_id: 021d8f07-f1b3-4757-aeba-4b3df4c3309e errors: - code: unauthorized message: Access Token Invalid @@ -2367,7 +2370,7 @@ paths: successful: summary: Successful value: - id: 660e716f6abd01bb40bdc42f + id: 663a0010f7676c5662aebb01 bad_request: summary: Bad Request value: @@ -2406,13 +2409,13 @@ paths: data: - type: company company_id: '1' - id: 660e71756abd01bb40bdc450 + id: 663a0016f7676c5662aebb22 app_id: this_is_an_id182_that_should_be_at_least_ name: company12 - remote_created_at: 1712222581 - created_at: 1712222581 - updated_at: 1712222581 - last_request_at: 1712049781 + remote_created_at: 1715077142 + created_at: 1715077142 + updated_at: 1715077142 + last_request_at: 1714904342 monthly_spend: 0 session_count: 0 user_count: 1 @@ -2441,7 +2444,7 @@ paths: Contact not found: value: type: error.list - request_id: 77afe14f-f9b2-4e5a-8e01-8a7878a8be0f + request_id: bd074d66-adb8-4e82-b309-ef848f9216d5 errors: - code: not_found message: User Not Found @@ -2455,7 +2458,7 @@ paths: Unauthorized: value: type: error.list - request_id: 25988cb0-db2f-42a3-9582-cc07b230db13 + request_id: 3b97fb7f-8b83-4b9d-b018-6eef771aefb6 errors: - code: unauthorized message: Access Token Invalid @@ -2498,12 +2501,12 @@ paths: value: type: company company_id: '1' - id: 660e71726abd01bb40bdc43f + id: 663a0013f7676c5662aebb11 app_id: this_is_an_id174_that_should_be_at_least_ name: company8 - remote_created_at: 1712222578 - created_at: 1712222578 - updated_at: 1712222579 + remote_created_at: 1715077139 + created_at: 1715077139 + updated_at: 1715077140 monthly_spend: 0 session_count: 0 user_count: 0 @@ -2525,14 +2528,14 @@ paths: Company Not Found: value: type: error.list - request_id: e8cf3a7e-34e8-4f29-bfd4-f279e62dbae8 + request_id: 3407cabe-b670-44e8-b478-52044a2fea9a errors: - code: company_not_found message: Company Not Found Contact Not Found: value: type: error.list - request_id: 88aac085-d44d-4411-bcca-13cd523789f9 + request_id: 9e405193-c372-4c42-af96-2cca7a7f405e errors: - code: not_found message: User Not Found @@ -2546,7 +2549,7 @@ paths: Unauthorized: value: type: error.list - request_id: d6feb002-33d6-4a19-9859-3e13da7ef397 + request_id: 30eec6ba-993a-4c16-9040-02a830107eff errors: - code: unauthorized message: Access Token Invalid @@ -2582,42 +2585,42 @@ paths: type: list data: - type: note - id: '426' - created_at: 1711617784 + id: '107' + created_at: 1714472345 contact: type: contact - id: 660e71786abd01bb40bdc45b + id: 663a0019f7676c5662aebb2d author: type: admin - id: '991281900' + id: '991270510' name: Ciaran110 Lee email: admin110@email.com away_mode_enabled: false away_mode_reassign: false body: "

    This is a note.

    " - type: note - id: '425' - created_at: 1711531384 + id: '106' + created_at: 1714385945 contact: type: contact - id: 660e71786abd01bb40bdc45b + id: 663a0019f7676c5662aebb2d author: type: admin - id: '991281900' + id: '991270510' name: Ciaran110 Lee email: admin110@email.com away_mode_enabled: false away_mode_reassign: false body: "

    This is a note.

    " - type: note - id: '424' - created_at: 1711531384 + id: '105' + created_at: 1714385945 contact: type: contact - id: 660e71786abd01bb40bdc45b + id: 663a0019f7676c5662aebb2d author: type: admin - id: '991281900' + id: '991270510' name: Ciaran110 Lee email: admin110@email.com away_mode_enabled: false @@ -2640,7 +2643,7 @@ paths: Contact not found: value: type: error.list - request_id: 4545c8b9-c2a3-44c2-ab02-feaf40daf4a3 + request_id: 6aef0154-53ac-423c-bc3a-9a812adad0ed errors: - code: not_found message: User Not Found @@ -2674,14 +2677,14 @@ paths: Successful response: value: type: note - id: '431' - created_at: 1712222585 + id: '112' + created_at: 1715077146 contact: type: contact - id: 660e71796abd01bb40bdc45d + id: 663a001af7676c5662aebb2f author: type: admin - id: '991281902' + id: '991270512' name: Ciaran112 Lee email: admin112@email.com away_mode_enabled: false @@ -2697,14 +2700,14 @@ paths: Admin not found: value: type: error.list - request_id: 48b2a076-e101-496c-9fb8-0e34bf3419c8 + request_id: 3560a1c3-276b-4621-b85d-73df1861294b errors: - code: not_found message: Resource Not Found Contact not found: value: type: error.list - request_id: fadbd633-4d6b-4adb-a10c-872627a8bc22 + request_id: c8ad3077-b995-449c-bae8-fbb9dfe7e609 errors: - code: not_found message: User Not Found @@ -2734,20 +2737,20 @@ paths: successful_response: summary: Successful response value: - contact_id: 660e71796abd01bb40bdc45d - admin_id: 991281902 + contact_id: 663a001af7676c5662aebb2f + admin_id: 991270512 body: Hello admin_not_found: summary: Admin not found value: - contact_id: 660e717a6abd01bb40bdc45e + contact_id: 663a001af7676c5662aebb30 admin_id: 123 body: Hello contact_not_found: summary: Contact not found value: contact_id: 123 - admin_id: 991281904 + admin_id: 991270514 body: Hello "/contacts/{contact_id}/segments": get: @@ -2780,10 +2783,10 @@ paths: type: list data: - type: segment - id: 660e717b6abd01bb40bdc460 + id: 663a001bf7676c5662aebb32 name: segment - created_at: 1712222587 - updated_at: 1712222587 + created_at: 1715077147 + updated_at: 1715077147 person_type: user schema: "$ref": "#/components/schemas/contact_segments" @@ -2795,7 +2798,7 @@ paths: Contact not found: value: type: error.list - request_id: 8c8d5386-3111-481b-960a-f2efb6cadc83 + request_id: 9c6c6ec3-b000-465b-9209-52b20b42713e errors: - code: not_found message: User Not Found @@ -2809,7 +2812,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2b992ac4-90a5-4c56-9fd2-e9c9a1391575 + request_id: 80fedd40-c293-4d1d-b7f9-d3093f74ce9e errors: - code: unauthorized message: Access Token Invalid @@ -2853,7 +2856,7 @@ paths: type: list data: - type: subscription - id: '1515' + id: '369' state: live consent_type: opt_out default_translation: @@ -2867,7 +2870,7 @@ paths: content_types: - email - type: subscription - id: '1517' + id: '371' state: live consent_type: opt_in default_translation: @@ -2890,7 +2893,7 @@ paths: Contact not found: value: type: error.list - request_id: ce3025b9-d5bd-4bb9-a869-f6d3100b973f + request_id: 1c5778e4-5221-40fc-acad-6531ded15164 errors: - code: not_found message: User Not Found @@ -2904,7 +2907,7 @@ paths: Unauthorized: value: type: error.list - request_id: b5cd2435-2fa8-4e20-b8f8-1da7625bd3fd + request_id: a081e059-9e45-46a1-9579-cc82b104d24e errors: - code: unauthorized message: Access Token Invalid @@ -2945,7 +2948,7 @@ paths: Successful: value: type: subscription - id: '1530' + id: '384' state: live consent_type: opt_in default_translation: @@ -2968,14 +2971,14 @@ paths: Contact not found: value: type: error.list - request_id: 96992642-c2c0-42fa-9003-5470af378148 + request_id: eae72186-107f-4d6e-9a08-c3dfc797d82c errors: - code: not_found message: User Not Found Resource not found: value: type: error.list - request_id: 28601b6d-3cb5-438b-8778-29ec7053eb62 + request_id: dc5c6cdb-4679-4928-b670-1e74a22b5dd2 errors: - code: not_found message: Resource Not Found @@ -2989,7 +2992,7 @@ paths: Unauthorized: value: type: error.list - request_id: cae90b95-aff0-483a-b31b-e139b4287245 + request_id: 9dfa5df2-9c6e-470a-9c79-07e65a14605e errors: - code: unauthorized message: Access Token Invalid @@ -3017,12 +3020,12 @@ paths: successful: summary: Successful value: - id: 1530 + id: 384 consent_type: opt_in contact_not_found: summary: Contact not found value: - id: 1534 + id: 388 consent_type: opt_in resource_not_found: summary: Resource not found @@ -3068,7 +3071,7 @@ paths: Successful: value: type: subscription - id: '1546' + id: '400' state: live consent_type: opt_in default_translation: @@ -3091,14 +3094,14 @@ paths: Contact not found: value: type: error.list - request_id: 61fe5114-fc3c-449d-b2a6-e5b5221859bf + request_id: a0ab7732-9825-4917-b7ff-ab5e7d003e37 errors: - code: not_found message: User Not Found Resource not found: value: type: error.list - request_id: 92f79a3c-831f-42bd-b8ea-5ceeef6328a4 + request_id: a6df1d1c-7fe3-46b1-83a9-221883e1b217 errors: - code: not_found message: Resource Not Found @@ -3112,7 +3115,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2998ff7b-3f45-49b4-8051-a0bdccb99fef + request_id: 84955f95-4b54-480a-8c82-961a494d5232 errors: - code: unauthorized message: Access Token Invalid @@ -3150,7 +3153,7 @@ paths: type: list data: - type: tag - id: '1358' + id: '344' name: Manual tag schema: "$ref": "#/components/schemas/tag_list" @@ -3162,7 +3165,7 @@ paths: Contact not found: value: type: error.list - request_id: 80f29491-cd52-4ddb-b168-59fc4d555176 + request_id: d6f23095-c576-4df5-bf1a-f8b61179a267 errors: - code: not_found message: User Not Found @@ -3176,7 +3179,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9b62edc9-c256-40c8-a9c6-9c47d5345e24 + request_id: 8e028518-153b-4f39-ab0d-0918fee7d471 errors: - code: unauthorized message: Access Token Invalid @@ -3211,7 +3214,7 @@ paths: successful: value: type: tag - id: '1359' + id: '345' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -3223,14 +3226,14 @@ paths: Contact not found: value: type: error.list - request_id: 3fbdbed7-85f9-4ba2-9e7d-b0b2baf4e0b6 + request_id: 35162004-08f1-4fc5-b0b8-ef9ed7370665 errors: - code: not_found message: User Not Found Tag not found: value: type: error.list - request_id: 47c3071a-2ac0-4d7a-9da0-3dd97aebc71b + request_id: 36a01db6-aea1-4001-bf7e-17fca950f930 errors: - code: not_found message: Resource Not Found @@ -3244,7 +3247,7 @@ paths: Unauthorized: value: type: error.list - request_id: 243b1e03-9559-4334-b253-2ebcc00f96bf + request_id: d1e96344-2c70-4a01-a1f3-aeda6d804865 errors: - code: unauthorized message: Access Token Invalid @@ -3267,11 +3270,11 @@ paths: successful: summary: successful value: - id: 1359 + id: 345 contact_not_found: summary: Contact not found value: - id: 1360 + id: 346 tag_not_found: summary: Tag not found value: @@ -3313,7 +3316,7 @@ paths: successful: value: type: tag - id: '1362' + id: '348' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -3325,14 +3328,14 @@ paths: Contact not found: value: type: error.list - request_id: 9ba4f556-9b89-4a75-90d7-13a18b8c3e87 + request_id: eecb774c-2738-4f74-a39e-d0533bf3bf20 errors: - code: not_found message: User Not Found Tag not found: value: type: error.list - request_id: 5d6ed431-ad47-4945-a6af-c9972ed2dc5a + request_id: 0b1c8dda-e6f5-42f5-96c0-efac8da3ec83 errors: - code: not_found message: Resource Not Found @@ -3346,7 +3349,7 @@ paths: Unauthorized: value: type: error.list - request_id: 5e9d8fa7-817f-46d7-94fb-47d66c3b6ff7 + request_id: 6487b911-2dfa-4821-ab9e-54037364be64 errors: - code: unauthorized message: Access Token Invalid @@ -3380,7 +3383,7 @@ paths: successful: value: type: contact - id: 660e718b6abd01bb40bdc477 + id: 663a0029f7676c5662aebb49 workspace_id: this_is_an_id248_that_should_be_at_least_ external_id: '70' role: user @@ -3395,9 +3398,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1712222603 - updated_at: 1712222604 - signed_up_at: 1712222603 + created_at: 1715077161 + updated_at: 1715077161 + signed_up_at: 1715077161 last_seen_at: last_replied_at: last_contacted_at: @@ -3431,31 +3434,31 @@ paths: tags: type: list data: [] - url: "/contacts/660e718b6abd01bb40bdc477/tags" + url: "/contacts/663a0029f7676c5662aebb49/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/660e718b6abd01bb40bdc477/notes" + url: "/contacts/663a0029f7676c5662aebb49/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/660e718b6abd01bb40bdc477/companies" + url: "/contacts/663a0029f7676c5662aebb49/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/660e718b6abd01bb40bdc477/subscriptions" + url: "/contacts/663a0029f7676c5662aebb49/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/660e718b6abd01bb40bdc477/subscriptions" + url: "/contacts/663a0029f7676c5662aebb49/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3474,7 +3477,7 @@ paths: Unauthorized: value: type: error.list - request_id: 6b70564c-3cfd-41af-9242-79b9516f2f9c + request_id: 8c20a5bb-b587-463e-80a6-3870ac4954aa errors: - code: unauthorized message: Access Token Invalid @@ -3519,7 +3522,7 @@ paths: successful: value: type: contact - id: 660e718d6abd01bb40bdc478 + id: 663a002af7676c5662aebb4a workspace_id: this_is_an_id252_that_should_be_at_least_ external_id: '70' role: user @@ -3534,9 +3537,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1712222605 - updated_at: 1712222605 - signed_up_at: 1712222605 + created_at: 1715077162 + updated_at: 1715077162 + signed_up_at: 1715077162 last_seen_at: last_replied_at: last_contacted_at: @@ -3570,31 +3573,31 @@ paths: tags: type: list data: [] - url: "/contacts/660e718d6abd01bb40bdc478/tags" + url: "/contacts/663a002af7676c5662aebb4a/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/660e718d6abd01bb40bdc478/notes" + url: "/contacts/663a002af7676c5662aebb4a/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/660e718d6abd01bb40bdc478/companies" + url: "/contacts/663a002af7676c5662aebb4a/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/660e718d6abd01bb40bdc478/subscriptions" + url: "/contacts/663a002af7676c5662aebb4a/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/660e718d6abd01bb40bdc478/subscriptions" + url: "/contacts/663a002af7676c5662aebb4a/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3613,7 +3616,7 @@ paths: Unauthorized: value: type: error.list - request_id: 12bad5b4-caa9-4a9d-b114-08a924168b44 + request_id: 0a9aebb1-0542-4e3c-8477-2d58ad2601a5 errors: - code: unauthorized message: Access Token Invalid @@ -3644,7 +3647,7 @@ paths: examples: successful: value: - id: 660e718e6abd01bb40bdc479 + id: 663a002bf7676c5662aebb4b object: contact deleted: true schema: @@ -3657,7 +3660,7 @@ paths: Unauthorized: value: type: error.list - request_id: d4dd2433-946c-4d43-adf5-0b34a6e71f22 + request_id: 9da08ba3-9245-4e1a-bc34-05286fa7496c errors: - code: unauthorized message: Access Token Invalid @@ -3685,7 +3688,7 @@ paths: successful: value: type: contact - id: 660e718f6abd01bb40bdc47b + id: 663a002df7676c5662aebb4d workspace_id: this_is_an_id260_that_should_be_at_least_ external_id: '70' role: user @@ -3700,9 +3703,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1712222607 - updated_at: 1712222608 - signed_up_at: 1712222607 + created_at: 1715077165 + updated_at: 1715077165 + signed_up_at: 1715077165 last_seen_at: last_replied_at: last_contacted_at: @@ -3736,31 +3739,31 @@ paths: tags: type: list data: [] - url: "/contacts/660e718f6abd01bb40bdc47b/tags" + url: "/contacts/663a002df7676c5662aebb4d/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/660e718f6abd01bb40bdc47b/notes" + url: "/contacts/663a002df7676c5662aebb4d/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/660e718f6abd01bb40bdc47b/companies" + url: "/contacts/663a002df7676c5662aebb4d/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/660e718f6abd01bb40bdc47b/subscriptions" + url: "/contacts/663a002df7676c5662aebb4d/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/660e718f6abd01bb40bdc47b/subscriptions" + url: "/contacts/663a002df7676c5662aebb4d/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3779,7 +3782,7 @@ paths: Unauthorized: value: type: error.list - request_id: 453df255-8e1c-4b42-b64b-4bd1bcc02a7d + request_id: 91568c66-ecf7-4224-93cf-1a6d6022c236 errors: - code: unauthorized message: Access Token Invalid @@ -3794,8 +3797,8 @@ paths: successful: summary: successful value: - from: 660e718f6abd01bb40bdc47a - into: 660e718f6abd01bb40bdc47b + from: 663a002df7676c5662aebb4c + into: 663a002df7676c5662aebb4d "/contacts/search": post: summary: Search contacts @@ -3814,6 +3817,12 @@ paths: This will accept a query object in the body which will define your filters in order to search for contacts. + {% admonition type="warning" name="Optimizing search queries" %} + Search queries can be complex, so optimizing them can help the performance of your search. + Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize + pagination to limit the number of results returned. The default is `50` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param. + {% /admonition %} ### Contact Creation Delay If a contact has recently been created, there is a possibility that it will not yet be available when searching. This means that it may not appear in the response. This delay can take a few minutes. If you need to be instantly notified it is recommended to use webhooks and iterate to see if they match your search filters. @@ -3928,7 +3937,7 @@ paths: Unauthorized: value: type: error.list - request_id: 918d27e7-fd3c-48a3-8d1c-70adb6957f71 + request_id: 8d416561-2f45-4a8f-9ae4-c989b6a97023 errors: - code: unauthorized message: Access Token Invalid @@ -3948,15 +3957,15 @@ paths: value: - field: id operator: "=" - value: 660e71916abd01bb40bdc47e + value: 663a002ff7676c5662aebb50 - operator: OR value: - field: id operator: "=" - value: 660e71916abd01bb40bdc47e + value: 663a002ff7676c5662aebb50 - field: id operator: "=" - value: 660e71916abd01bb40bdc47e + value: 663a002ff7676c5662aebb50 "/contacts": get: summary: List all contacts @@ -3968,7 +3977,12 @@ paths: tags: - Contacts operationId: ListContacts - description: You can fetch a list of all contacts. + description: | + You can fetch a list of all contacts (ie. users or leads) in your workspace. + {% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `50` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. + {% /admonition %} responses: '200': description: successful @@ -3995,7 +4009,7 @@ paths: Unauthorized: value: type: error.list - request_id: 7c745346-e97d-4ab1-a34c-e88fab54c6ff + request_id: e04237a0-64e9-4a0b-821f-9f025ad757f2 errors: - code: unauthorized message: Access Token Invalid @@ -4021,7 +4035,7 @@ paths: successful: value: type: contact - id: 660e71946abd01bb40bdc480 + id: 663a0031f7676c5662aebb52 workspace_id: this_is_an_id272_that_should_be_at_least_ external_id: role: user @@ -4036,8 +4050,8 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1712222612 - updated_at: 1712222612 + created_at: 1715077169 + updated_at: 1715077169 signed_up_at: last_seen_at: last_replied_at: @@ -4072,31 +4086,31 @@ paths: tags: type: list data: [] - url: "/contacts/660e71946abd01bb40bdc480/tags" + url: "/contacts/663a0031f7676c5662aebb52/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/660e71946abd01bb40bdc480/notes" + url: "/contacts/663a0031f7676c5662aebb52/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/660e71946abd01bb40bdc480/companies" + url: "/contacts/663a0031f7676c5662aebb52/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/660e71946abd01bb40bdc480/subscriptions" + url: "/contacts/663a0031f7676c5662aebb52/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/660e71946abd01bb40bdc480/subscriptions" + url: "/contacts/663a0031f7676c5662aebb52/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -4115,7 +4129,7 @@ paths: Unauthorized: value: type: error.list - request_id: 704ec961-81e0-4e52-bff4-e070c4b1bba2 + request_id: de5f80c5-db18-4556-a8e1-790b925436f0 errors: - code: unauthorized message: Access Token Invalid @@ -4159,7 +4173,7 @@ paths: examples: successful: value: - id: 660e71956abd01bb40bdc481 + id: 663a0033f7676c5662aebb53 object: contact archived: true schema: @@ -4191,7 +4205,7 @@ paths: examples: successful: value: - id: 660e71966abd01bb40bdc482 + id: 663a0034f7676c5662aebb54 object: contact archived: false schema: @@ -4226,7 +4240,7 @@ paths: successful: value: type: tag - id: '1364' + id: '350' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -4238,7 +4252,7 @@ paths: Conversation not found: value: type: error.list - request_id: f31df173-7a24-4c28-ab8c-abe9a9c7d639 + request_id: ab651d37-af35-4ecb-8366-eb4d47529b93 errors: - code: not_found message: Conversation not found @@ -4252,7 +4266,7 @@ paths: Unauthorized: value: type: error.list - request_id: ff07bd89-55c0-4844-b6a6-2cdfbba80b9e + request_id: b28f2ef6-fc2b-4afc-8d89-a8bb79f23f30 errors: - code: unauthorized message: Access Token Invalid @@ -4281,13 +4295,13 @@ paths: successful: summary: successful value: - id: 1364 - admin_id: 991281935 + id: 350 + admin_id: 991270545 conversation_not_found: summary: Conversation not found value: - id: 1365 - admin_id: 991281937 + id: 351 + admin_id: 991270547 "/conversations/{conversation_id}/tags/{id}": delete: summary: Remove tag from a conversation @@ -4325,7 +4339,7 @@ paths: successful: value: type: tag - id: '1367' + id: '353' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -4337,14 +4351,14 @@ paths: Conversation not found: value: type: error.list - request_id: 45fd79dc-afe0-43e9-8d17-0b3e3b8d9299 + request_id: aefa237b-13b4-4386-b196-1ecb054c684e errors: - code: not_found message: Conversation not found Tag not found: value: type: error.list - request_id: 343755f7-bc06-4546-9c3c-64405b83879f + request_id: 4d5e51eb-9eb2-4601-80a0-1091dfa7f880 errors: - code: tag_not_found message: Tag not found @@ -4358,7 +4372,7 @@ paths: Unauthorized: value: type: error.list - request_id: 6b12ec6f-e6f3-4e91-af37-371c2c9a29a1 + request_id: b548b907-aa86-4603-b1a1-8cd5cb6aa27e errors: - code: unauthorized message: Access Token Invalid @@ -4381,15 +4395,15 @@ paths: successful: summary: successful value: - admin_id: 991281939 + admin_id: 991270549 conversation_not_found: summary: Conversation not found value: - admin_id: 991281941 + admin_id: 991270551 tag_not_found: summary: Tag not found value: - admin_id: 991281942 + admin_id: 991270552 "/conversations": get: summary: List all conversations @@ -4418,7 +4432,11 @@ paths: description: | You can fetch a list of all conversations. - You can optionally request the result page size and the cursor to start after to fetch the result + You can optionally request the result page size and the cursor to start after to fetch the result. + {% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `20` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. + {% /admonition %} responses: '200': description: successful @@ -4436,20 +4454,20 @@ paths: total_count: 1 conversations: - type: conversation - id: '4612' - created_at: 1712222624 - updated_at: 1712222624 + id: '1243' + created_at: 1715077180 + updated_at: 1715077180 waiting_since: snoozed_until: source: type: conversation - id: '403920746' + id: '403918734' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991281945' + id: '991270555' name: Ciaran152 Lee email: admin152@email.com attachments: [] @@ -4459,7 +4477,7 @@ paths: type: contact.list contacts: - type: contact - id: 660e71a06abd01bb40bdc486 + id: 663a003cf7676c5662aebb58 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -4488,7 +4506,7 @@ paths: Unauthorized: value: type: error.list - request_id: 93e44cbc-7a93-4205-a131-ca927ee3200c + request_id: 18f5b4ce-b4c2-439b-a748-36e98152aaa3 errors: - code: unauthorized message: Access Token Invalid @@ -4502,7 +4520,7 @@ paths: API plan restricted: value: type: error.list - request_id: c0c43415-2f53-4581-ba8c-ddcf59750833 + request_id: c8e1abbe-bbdb-4d5c-87b8-cb69290bceeb errors: - code: api_plan_restricted message: Active subscription needed. @@ -4538,11 +4556,11 @@ paths: conversation created: value: type: user_message - id: '403920756' - created_at: 1712222644 + id: '403918744' + created_at: 1715077199 body: Hello there message_type: inapp - conversation_id: '4637' + conversation_id: '1271' schema: "$ref": "#/components/schemas/message" '404': @@ -4553,7 +4571,7 @@ paths: Contact Not Found: value: type: error.list - request_id: 4adfaa47-7d65-485c-a459-cd6ac6ad8ced + request_id: 4b568b47-d637-4df9-8c70-fd04a8a67e7f errors: - code: not_found message: User Not Found @@ -4567,7 +4585,7 @@ paths: Unauthorized: value: type: error.list - request_id: 776be9b1-b32a-456b-8e19-b789870c17b3 + request_id: b3adaf4c-8b61-4eec-8662-9461ecd6bcc8 errors: - code: unauthorized message: Access Token Invalid @@ -4581,7 +4599,7 @@ paths: API plan restricted: value: type: error.list - request_id: b5425509-f8f3-48c0-b04c-52adac691963 + request_id: 8be720a8-367c-4e12-8635-ef9b0c0297cb errors: - code: api_plan_restricted message: Active subscription needed. @@ -4598,7 +4616,7 @@ paths: value: from: type: user - id: 660e71b46abd01bb40bdc49b + id: 663a004ff7676c5662aebb70 body: Hello there contact_not_found: summary: Contact Not Found @@ -4642,11 +4660,7 @@ paths: The maximum number of conversation parts that can be returned via the API is 500. If you have more than that we will return the 500 most recent conversation parts. {% /admonition %} - ### Bot Name in Conversation Parts - - For conversation parts generated by a bot, bot name will depend on the following: - - Customers that never turned on AI answers will have `operator` as the bot name - - Customers that have turned on AI answers at some point will have `fin` as the bot name + For AI agent conversation metadata, please note that you need to have the agent enabled in your workspace, which is a [paid feature](https://www.intercom.com/help/en/articles/8205718-fin-resolutions#h_97f8c2e671). responses: '200': description: conversation found @@ -4656,22 +4670,22 @@ paths: conversation found: value: type: conversation - id: '4641' - created_at: 1712222649 - updated_at: 1712222649 + id: '1275' + created_at: 1715077204 + updated_at: 1715077204 waiting_since: snoozed_until: source: type: conversation - id: '403920760' + id: '403918748' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991281956' - name: Ciaran159 Lee - email: admin159@email.com + id: '991270572' + name: Ciaran162 Lee + email: admin162@email.com attachments: [] url: redacted: false @@ -4679,7 +4693,7 @@ paths: type: contact.list contacts: - type: contact - id: 660e71b96abd01bb40bdc49f + id: 663a0054f7676c5662aebb74 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -4712,7 +4726,7 @@ paths: Not found: value: type: error.list - request_id: 8045b6e2-1d00-416c-b7e1-b2e2e737a349 + request_id: a4e3a46c-983e-4ee1-82db-b457710bcb50 errors: - code: not_found message: Resource Not Found @@ -4726,7 +4740,7 @@ paths: Unauthorized: value: type: error.list - request_id: 4a5c52ed-8614-4fa8-9e87-4605954aaf56 + request_id: 8668f74e-9975-4fa6-9b48-6e93ef0a36de errors: - code: unauthorized message: Access Token Invalid @@ -4740,7 +4754,7 @@ paths: API plan restricted: value: type: error.list - request_id: 8b133b35-43cc-4ffc-92b4-252ef26f1bb2 + request_id: 315eea18-ebcb-4dd1-beec-0cbff9a9fbf7 errors: - code: api_plan_restricted message: Active subscription needed. @@ -4787,22 +4801,22 @@ paths: conversation found: value: type: conversation - id: '4645' - created_at: 1712222654 - updated_at: 1712222655 + id: '1279' + created_at: 1715077210 + updated_at: 1715077211 waiting_since: snoozed_until: source: type: conversation - id: '403920764' + id: '403918752' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991281960' - name: Ciaran163 Lee - email: admin163@email.com + id: '991270580' + name: Ciaran166 Lee + email: admin166@email.com attachments: [] url: redacted: false @@ -4810,7 +4824,7 @@ paths: type: contact.list contacts: - type: contact - id: 660e71be6abd01bb40bdc4a3 + id: 663a0059f7676c5662aebb78 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -4835,34 +4849,34 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '1077' + id: '278' part_type: conversation_attribute_updated_by_admin body: - created_at: 1712222655 - updated_at: 1712222655 - notified_at: 1712222655 + created_at: 1715077211 + updated_at: 1715077211 + notified_at: 1715077211 assigned_to: author: - id: '991281965' + id: '991270581' type: bot name: Operator - email: operator+this_is_an_id318_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id321_that_should_be_at_least_@intercom.io attachments: [] external_id: redacted: false - type: conversation_part - id: '1078' + id: '279' part_type: conversation_attribute_updated_by_admin body: - created_at: 1712222655 - updated_at: 1712222655 - notified_at: 1712222655 + created_at: 1715077211 + updated_at: 1715077211 + notified_at: 1715077211 assigned_to: author: - id: '991281965' + id: '991270581' type: bot name: Operator - email: operator+this_is_an_id318_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id321_that_should_be_at_least_@intercom.io attachments: [] external_id: redacted: false @@ -4877,7 +4891,7 @@ paths: Not found: value: type: error.list - request_id: 58773009-2f66-487d-a77a-01e79964507d + request_id: 188a3623-a7f0-4261-be74-916771748814 errors: - code: not_found message: Resource Not Found @@ -4891,7 +4905,7 @@ paths: Unauthorized: value: type: error.list - request_id: 56daf104-b15d-4b10-b1a0-6731ef0f12dd + request_id: ed723370-51c9-4516-a76c-3879b66c5257 errors: - code: unauthorized message: Access Token Invalid @@ -4905,7 +4919,7 @@ paths: API plan restricted: value: type: error.list - request_id: 8da3156b-c4d8-4151-8c98-89b249fbd6e8 + request_id: 758f4e9a-830d-43f7-b25f-500c0f2baa2a errors: - code: api_plan_restricted message: Active subscription needed. @@ -4948,6 +4962,12 @@ paths: To search for conversations, you need to send a `POST` request to `https://api.intercom.io/conversations/search`. This will accept a query object in the body which will define your filters in order to search for conversations. + {% admonition type="warning" name="Optimizing search queries" %} + Search queries can be complex, so optimizing them can help the performance of your search. + Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize + pagination to limit the number of results returned. The default is `20` results per page and maximum is `150`. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param. + {% /admonition %} ### Nesting & Limitations @@ -5011,6 +5031,13 @@ paths: | conversation_rating.remark | String | | conversation_rating.contact_id | String | | conversation_rating.admin_d | String | + | ai_agent_participated | Boolean | + | ai_agent.resolution_state | String | + | ai_agent.last_answer_type | String | + | ai_agent.rating | Integer | + | ai_agent.rating_remark | String | + | ai_agent.source_type | String | + | ai_agent.source_title | String | ### Accepted Operators @@ -5045,22 +5072,22 @@ paths: total_count: 1 conversations: - type: conversation - id: '4652' - created_at: 1712222664 - updated_at: 1712222664 + id: '1286' + created_at: 1715077220 + updated_at: 1715077220 waiting_since: snoozed_until: source: type: conversation - id: '403920771' + id: '403918759' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991281984' - name: Ciaran186 Lee - email: admin186@email.com + id: '991270610' + name: Ciaran189 Lee + email: admin189@email.com attachments: [] url: redacted: false @@ -5068,7 +5095,7 @@ paths: type: contact.list contacts: - type: contact - id: 660e71c86abd01bb40bdc4aa + id: 663a0064f7676c5662aebb7f first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5103,15 +5130,15 @@ paths: value: - field: id operator: "=" - value: '4652' + value: '1286' - operator: OR value: - field: id operator: "=" - value: '4652' + value: '1286' - field: id operator: "=" - value: '4652' + value: '1286' "/conversations/{id}/reply": post: summary: Reply to a conversation @@ -5142,22 +5169,22 @@ paths: User reply: value: type: conversation - id: '4660' - created_at: 1712222670 - updated_at: 1712222671 - waiting_since: 1712222671 + id: '1295' + created_at: 1715077227 + updated_at: 1715077227 + waiting_since: 1715077227 snoozed_until: source: type: conversation - id: '403920774' + id: '403918762' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991281986' - name: Ciaran187 Lee - email: admin187@email.com + id: '991270613' + name: Ciaran191 Lee + email: admin191@email.com attachments: [] url: redacted: false @@ -5165,9 +5192,9 @@ paths: type: contact.list contacts: - type: contact - id: 660e71ce6abd01bb40bdc4b1 + id: 663a006bf7676c5662aebb87 first_contact_reply: - created_at: 1712222671 + created_at: 1715077227 type: conversation url: admin_assignee_id: @@ -5191,15 +5218,15 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '1080' + id: '281' part_type: open body: "

    Thanks again :)

    " - created_at: 1712222671 - updated_at: 1712222671 - notified_at: 1712222671 + created_at: 1715077227 + updated_at: 1715077227 + notified_at: 1715077227 assigned_to: author: - id: 660e71ce6abd01bb40bdc4b1 + id: 663a006bf7676c5662aebb87 type: user name: Joe Bloggs email: joe@bloggs.com @@ -5210,22 +5237,22 @@ paths: Admin note reply: value: type: conversation - id: '4661' - created_at: 1712222672 - updated_at: 1712222673 + id: '1296' + created_at: 1715077229 + updated_at: 1715077230 waiting_since: snoozed_until: source: type: conversation - id: '403920775' + id: '403918763' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991281988' - name: Ciaran188 Lee - email: admin188@email.com + id: '991270615' + name: Ciaran192 Lee + email: admin192@email.com attachments: [] url: redacted: false @@ -5233,7 +5260,7 @@ paths: type: contact.list contacts: - type: contact - id: 660e71d06abd01bb40bdc4b2 + id: 663a006df7676c5662aebb88 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5256,7 +5283,7 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '1081' + id: '282' part_type: note body: |-

    An Unordered HTML List

    @@ -5271,15 +5298,15 @@ paths:
  • Tea
  • Milk
    • - created_at: 1712222673 - updated_at: 1712222673 - notified_at: 1712222673 + created_at: 1715077230 + updated_at: 1715077230 + notified_at: 1715077230 assigned_to: author: - id: '991281988' + id: '991270615' type: admin - name: Ciaran188 Lee - email: admin188@email.com + name: Ciaran192 Lee + email: admin192@email.com attachments: [] external_id: redacted: false @@ -5287,22 +5314,22 @@ paths: User last conversation reply: value: type: conversation - id: '4663' - created_at: 1712222675 - updated_at: 1712222675 - waiting_since: 1712222675 + id: '1298' + created_at: 1715077232 + updated_at: 1715077233 + waiting_since: 1715077233 snoozed_until: source: type: conversation - id: '403920777' + id: '403918765' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991281990' - name: Ciaran190 Lee - email: admin190@email.com + id: '991270619' + name: Ciaran194 Lee + email: admin194@email.com attachments: [] url: redacted: false @@ -5310,9 +5337,9 @@ paths: type: contact.list contacts: - type: contact - id: 660e71d36abd01bb40bdc4b4 + id: 663a0070f7676c5662aebb8a first_contact_reply: - created_at: 1712222675 + created_at: 1715077233 type: conversation url: admin_assignee_id: @@ -5336,15 +5363,15 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '1082' + id: '283' part_type: open body: "

    Thanks again :)

    " - created_at: 1712222675 - updated_at: 1712222675 - notified_at: 1712222675 + created_at: 1715077233 + updated_at: 1715077233 + notified_at: 1715077233 assigned_to: author: - id: 660e71d36abd01bb40bdc4b4 + id: 663a0070f7676c5662aebb8a type: user name: Joe Bloggs email: joe@bloggs.com @@ -5362,7 +5389,7 @@ paths: Not found: value: type: error.list - request_id: e89ad4f2-78a3-435e-84e9-e1c090eb8247 + request_id: 9f9c4410-13a6-446b-8cd2-74e1f3588dcd errors: - code: not_found message: Resource Not Found @@ -5376,7 +5403,7 @@ paths: Unauthorized: value: type: error.list - request_id: 60bef61d-de56-41e2-8ea9-ffd04225ec63 + request_id: f020f7a7-40d1-485e-9d7c-a4118d643c30 errors: - code: unauthorized message: Access Token Invalid @@ -5390,7 +5417,7 @@ paths: API plan restricted: value: type: error.list - request_id: 13ba89e9-9bca-49b4-9171-275c4550494d + request_id: 2407b0a8-d231-4b63-b221-43cc78cf2dfb errors: - code: api_plan_restricted message: Active subscription needed. @@ -5407,14 +5434,14 @@ paths: value: message_type: comment type: user - intercom_user_id: 660e71ce6abd01bb40bdc4b1 + intercom_user_id: 663a006bf7676c5662aebb87 body: Thanks again :) admin_note_reply: summary: Admin note reply value: message_type: note type: admin - admin_id: 991281988 + admin_id: 991270615 body: "

    An Unordered HTML List

    • Coffee
      • \
    • Tea
    • Milk

    An Ordered HTML List

    \
    1. Coffee
    2. Tea
    3. Milk
    @@ -5424,14 +5451,14 @@ paths: value: message_type: comment type: user - intercom_user_id: 660e71d36abd01bb40bdc4b4 + intercom_user_id: 663a0070f7676c5662aebb8a body: Thanks again :) not_found: summary: Not found value: message_type: comment type: user - intercom_user_id: 660e71d46abd01bb40bdc4b5 + intercom_user_id: 663a0072f7676c5662aebb8b body: Thanks again :) "/conversations/{id}/parts": post: @@ -5466,22 +5493,22 @@ paths: Close a conversation: value: type: conversation - id: '4667' - created_at: 1712222681 - updated_at: 1712222681 + id: '1302' + created_at: 1715077238 + updated_at: 1715077239 waiting_since: snoozed_until: source: type: conversation - id: '403920781' + id: '403918769' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991281995' - name: Ciaran194 Lee - email: admin194@email.com + id: '991270627' + name: Ciaran198 Lee + email: admin198@email.com attachments: [] url: redacted: false @@ -5489,7 +5516,7 @@ paths: type: contact.list contacts: - type: contact - id: 660e71d96abd01bb40bdc4b8 + id: 663a0075f7676c5662aebb8e first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5512,18 +5539,18 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '1083' + id: '284' part_type: close body: "

    Goodbye :)

    " - created_at: 1712222681 - updated_at: 1712222681 - notified_at: 1712222681 + created_at: 1715077239 + updated_at: 1715077239 + notified_at: 1715077239 assigned_to: author: - id: '991281995' + id: '991270627' type: admin - name: Ciaran194 Lee - email: admin194@email.com + name: Ciaran198 Lee + email: admin198@email.com attachments: [] external_id: redacted: false @@ -5531,22 +5558,22 @@ paths: Snooze a conversation: value: type: conversation - id: '4668' - created_at: 1712222683 - updated_at: 1712222683 + id: '1303' + created_at: 1715077240 + updated_at: 1715077240 waiting_since: - snoozed_until: 1712226283 + snoozed_until: 1715080840 source: type: conversation - id: '403920782' + id: '403918770' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991281996' - name: Ciaran195 Lee - email: admin195@email.com + id: '991270629' + name: Ciaran199 Lee + email: admin199@email.com attachments: [] url: redacted: false @@ -5554,7 +5581,7 @@ paths: type: contact.list contacts: - type: contact - id: 660e71da6abd01bb40bdc4b9 + id: 663a0078f7676c5662aebb8f first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5577,18 +5604,18 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '1084' + id: '285' part_type: snoozed body: - created_at: 1712222683 - updated_at: 1712222683 - notified_at: 1712222683 + created_at: 1715077240 + updated_at: 1715077240 + notified_at: 1715077240 assigned_to: author: - id: '991281996' + id: '991270629' type: admin - name: Ciaran195 Lee - email: admin195@email.com + name: Ciaran199 Lee + email: admin199@email.com attachments: [] external_id: redacted: false @@ -5596,22 +5623,22 @@ paths: Open a conversation: value: type: conversation - id: '4673' - created_at: 1712222682 - updated_at: 1712222689 + id: '1308' + created_at: 1715077239 + updated_at: 1715077247 waiting_since: snoozed_until: source: type: conversation - id: '403920783' + id: '403918771' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991281997' - name: Ciaran196 Lee - email: admin196@email.com + id: '991270631' + name: Ciaran200 Lee + email: admin200@email.com attachments: [] url: redacted: false @@ -5619,7 +5646,7 @@ paths: type: contact.list contacts: - type: contact - id: 660e71dd6abd01bb40bdc4be + id: 663a0077f7676c5662aebb94 first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5642,18 +5669,18 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '1086' + id: '287' part_type: open body: - created_at: 1712222689 - updated_at: 1712222689 - notified_at: 1712222689 + created_at: 1715077247 + updated_at: 1715077247 + notified_at: 1715077247 assigned_to: author: - id: '991281997' + id: '991270631' type: admin - name: Ciaran196 Lee - email: admin196@email.com + name: Ciaran200 Lee + email: admin200@email.com attachments: [] external_id: redacted: false @@ -5661,22 +5688,22 @@ paths: Assign a conversation: value: type: conversation - id: '4677' - created_at: 1712222691 - updated_at: 1712222691 + id: '1313' + created_at: 1715077248 + updated_at: 1715077249 waiting_since: snoozed_until: source: type: conversation - id: '403920786' + id: '403918774' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991281999' - name: Ciaran197 Lee - email: admin197@email.com + id: '991270634' + name: Ciaran202 Lee + email: admin202@email.com attachments: [] url: redacted: false @@ -5684,9 +5711,9 @@ paths: type: contact.list contacts: - type: contact - id: 660e71e26abd01bb40bdc4c1 + id: 663a0080f7676c5662aebb98 first_contact_reply: - admin_assignee_id: 991281999 + admin_assignee_id: 991270634 team_assignee_id: open: true state: open @@ -5707,20 +5734,20 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '1087' + id: '288' part_type: assign_and_reopen body: - created_at: 1712222691 - updated_at: 1712222691 - notified_at: 1712222691 + created_at: 1715077249 + updated_at: 1715077249 + notified_at: 1715077249 assigned_to: type: admin - id: '991281999' + id: '991270634' author: - id: '991281999' + id: '991270634' type: admin - name: Ciaran197 Lee - email: admin197@email.com + name: Ciaran202 Lee + email: admin202@email.com attachments: [] external_id: redacted: false @@ -5735,7 +5762,7 @@ paths: Not found: value: type: error.list - request_id: 9b0edc27-a851-4664-bde9-10fdd433cb5f + request_id: c199ed11-9cc0-42ff-b00b-667f1fe67fbd errors: - code: not_found message: Resource Not Found @@ -5749,7 +5776,7 @@ paths: Unauthorized: value: type: error.list - request_id: 4b06be72-9a1f-4cb9-93e5-6b83ee4a1915 + request_id: '068c5fa9-ac0d-4220-aa93-dcb617259a6d' errors: - code: unauthorized message: Access Token Invalid @@ -5763,7 +5790,7 @@ paths: API plan restricted: value: type: error.list - request_id: e529e09a-514a-48ef-a61b-40c05d8b63ba + request_id: 8697377c-7a50-4fe3-8a49-d231a36df3b3 errors: - code: api_plan_restricted message: Active subscription needed. @@ -5784,32 +5811,32 @@ paths: value: message_type: close type: admin - admin_id: 991281995 + admin_id: 991270627 body: Goodbye :) snooze_a_conversation: summary: Snooze a conversation value: message_type: snoozed - admin_id: 991281996 - snoozed_until: 1712226283 + admin_id: 991270629 + snoozed_until: 1715080840 open_a_conversation: summary: Open a conversation value: message_type: open - admin_id: 991281997 + admin_id: 991270631 assign_a_conversation: summary: Assign a conversation value: message_type: assignment type: admin - admin_id: 991281999 - assignee_id: 991281999 + admin_id: 991270634 + assignee_id: 991270634 not_found: summary: Not found value: message_type: close type: admin - admin_id: 991282001 + admin_id: 991270636 body: Goodbye :) "/conversations/{id}/run_assignment_rules": post: @@ -5843,22 +5870,22 @@ paths: Assign a conversation using assignment rules: value: type: conversation - id: '4681' - created_at: 1712222696 - updated_at: 1712222696 + id: '1317' + created_at: 1715077254 + updated_at: 1715077255 waiting_since: snoozed_until: source: type: conversation - id: '403920790' + id: '403918778' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991282004' - name: Ciaran201 Lee - email: admin201@email.com + id: '991270642' + name: Ciaran206 Lee + email: admin206@email.com attachments: [] url: redacted: false @@ -5866,7 +5893,7 @@ paths: type: contact.list contacts: - type: contact - id: 660e71e86abd01bb40bdc4c5 + id: 663a0086f7676c5662aebb9c first_contact_reply: admin_assignee_id: team_assignee_id: @@ -5889,20 +5916,20 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '1088' + id: '289' part_type: default_assignment body: - created_at: 1712222696 - updated_at: 1712222696 - notified_at: 1712222696 + created_at: 1715077255 + updated_at: 1715077255 + notified_at: 1715077255 assigned_to: type: nobody_admin id: author: - id: '991282005' + id: '991270643' type: bot name: Operator - email: operator+this_is_an_id359_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id364_that_should_be_at_least_@intercom.io attachments: [] external_id: redacted: false @@ -5917,7 +5944,7 @@ paths: Not found: value: type: error.list - request_id: a76be700-2f74-41c6-b8ef-9989afdaf1f8 + request_id: 2e99b23c-24e7-4e67-92aa-4a681a829001 errors: - code: not_found message: Resource Not Found @@ -5931,7 +5958,7 @@ paths: Unauthorized: value: type: error.list - request_id: 47f31007-0209-4659-a3bf-cc5043b45577 + request_id: 96f44f9b-5008-4284-b1b1-2393bcd1aaa0 errors: - code: unauthorized message: Access Token Invalid @@ -5945,7 +5972,7 @@ paths: API plan restricted: value: type: error.list - request_id: 7cbb363c-3a58-4755-b601-f6bcbf32ba86 + request_id: 9dd9cf4a-0b98-42f9-bfd5-0aff42cb0ed0 errors: - code: api_plan_restricted message: Active subscription needed. @@ -5986,7 +6013,7 @@ paths: value: customers: - type: user - id: 660e71ed6abd01bb40bdc4c9 + id: 663a008bf7676c5662aebba0 schema: "$ref": "#/components/schemas/conversation" '404': @@ -5997,7 +6024,7 @@ paths: Not found: value: type: error.list - request_id: ee480c51-d08a-4602-b4ba-fb63c0a30d12 + request_id: b1231066-a5e7-485f-9184-f7ba596095c9 errors: - code: not_found message: Resource Not Found @@ -6011,7 +6038,7 @@ paths: Unauthorized: value: type: error.list - request_id: de3c8ecc-39a4-4867-95e6-15f06f0dd1ce + request_id: cd09a948-65f7-475e-8854-080d6e8d118a errors: - code: unauthorized message: Access Token Invalid @@ -6025,7 +6052,7 @@ paths: API plan restricted: value: type: error.list - request_id: 46051847-7384-4c97-be75-562e017c0537 + request_id: 6980373d-f353-4ca3-aaa1-444a2a142898 errors: - code: api_plan_restricted message: Active subscription needed. @@ -6040,15 +6067,15 @@ paths: attach_a_contact_to_a_conversation: summary: Attach a contact to a conversation value: - admin_id: 991282009 + admin_id: 991270650 customer: - intercom_user_id: 660e71ed6abd01bb40bdc4c9 + intercom_user_id: 663a008bf7676c5662aebba0 not_found: summary: Not found value: - admin_id: 991282010 + admin_id: 991270652 customer: - intercom_user_id: 660e71ef6abd01bb40bdc4ca + intercom_user_id: 663a008df7676c5662aebba1 "/conversations/{conversation_id}/customers/{contact_id}": delete: summary: Detach a contact from a group conversation @@ -6091,7 +6118,7 @@ paths: value: customers: - type: user - id: 660e71f76abd01bb40bdc4d4 + id: 663a0096f7676c5662aebbac schema: "$ref": "#/components/schemas/conversation" '404': @@ -6102,14 +6129,14 @@ paths: Conversation not found: value: type: error.list - request_id: 385709a1-1ad0-493a-8365-bb0460078da0 + request_id: d975d17d-5407-4d23-9fde-0e573b4b1ae6 errors: - code: not_found message: Resource Not Found Contact not found: value: type: error.list - request_id: f2ff9914-c8a9-42b2-9293-fe72da0c6c73 + request_id: 9226cf98-5fba-4619-93af-c033d25a711d errors: - code: not_found message: User Not Found @@ -6123,7 +6150,7 @@ paths: Last customer: value: type: error.list - request_id: 38eaed72-35c5-451b-aa27-e5abe3bb271f + request_id: 6507e994-aba4-4c00-a88a-e35c29f5b7be errors: - code: parameter_invalid message: Removing the last customer is not allowed @@ -6137,7 +6164,7 @@ paths: Unauthorized: value: type: error.list - request_id: 5c189ea8-9edc-434a-970a-6bd5bd9746d4 + request_id: dc333e4b-33f6-41a0-a048-ba28ba2cbdf6 errors: - code: unauthorized message: Access Token Invalid @@ -6151,7 +6178,7 @@ paths: API plan restricted: value: type: error.list - request_id: 88211ebb-3ec2-447a-bdaf-7649f7479259 + request_id: 43498bf9-c575-4c38-b1ca-52aa1d737d9b errors: - code: api_plan_restricted message: Active subscription needed. @@ -6166,27 +6193,27 @@ paths: detach_a_contact_from_a_group_conversation: summary: Detach a contact from a group conversation value: - admin_id: 991282013 + admin_id: 991270658 customer: - intercom_user_id: 660e71f26abd01bb40bdc4cd + intercom_user_id: 663a0091f7676c5662aebba4 conversation_not_found: summary: Conversation not found value: - admin_id: 991282015 + admin_id: 991270661 customer: - intercom_user_id: 660e71f86abd01bb40bdc4d5 + intercom_user_id: 663a0097f7676c5662aebbad contact_not_found: summary: Contact not found value: - admin_id: 991282017 + admin_id: 991270664 customer: - intercom_user_id: 660e71fe6abd01bb40bdc4dc + intercom_user_id: 663a009df7676c5662aebbb5 last_customer: summary: Last customer value: - admin_id: 991282019 + admin_id: 991270667 customer: - intercom_user_id: 660e72046abd01bb40bdc4e3 + intercom_user_id: 663a00a4f7676c5662aebbbd "/conversations/redact": post: summary: Redact a conversation part @@ -6214,22 +6241,22 @@ paths: Redact a conversation part: value: type: conversation - id: '4737' - created_at: 1712222741 - updated_at: 1712222742 - waiting_since: 1712222741 + id: '1379' + created_at: 1715077303 + updated_at: 1715077304 + waiting_since: 1715077303 snoozed_until: source: type: conversation - id: '403920816' + id: '403918804' delivered_as: admin_initiated subject: '' body: "

    this is the message body

    " author: type: admin - id: '991282025' - name: Ciaran215 Lee - email: admin215@email.com + id: '991270676' + name: Ciaran226 Lee + email: admin226@email.com attachments: [] url: redacted: false @@ -6237,9 +6264,9 @@ paths: type: contact.list contacts: - type: contact - id: 660e72146abd01bb40bdc4f8 + id: 663a00b7f7676c5662aebbd5 first_contact_reply: - created_at: 1712222741 + created_at: 1715077303 type: conversation url: admin_assignee_id: @@ -6263,15 +6290,15 @@ paths: type: conversation_part.list conversation_parts: - type: conversation_part - id: '1096' + id: '297' part_type: open body: "

    This message was deleted

    " - created_at: 1712222741 - updated_at: 1712222742 - notified_at: 1712222741 + created_at: 1715077303 + updated_at: 1715077304 + notified_at: 1715077303 assigned_to: author: - id: 660e72146abd01bb40bdc4f8 + id: 663a00b7f7676c5662aebbd5 type: user name: Joe Bloggs email: joe@bloggs.com @@ -6289,7 +6316,7 @@ paths: Not found: value: type: error.list - request_id: 73050477-0b2a-4259-805a-41c15721bb13 + request_id: be2d78e4-d193-4535-b0f9-7bdf4eeb5a49 errors: - code: conversation_part_or_message_not_found message: Conversation part or message not found @@ -6303,7 +6330,7 @@ paths: Unauthorized: value: type: error.list - request_id: e7d18e3f-d466-4912-99bf-8cbe882f6cca + request_id: 3c4fb9db-6874-4f88-bc8b-d725ba1dc1a0 errors: - code: unauthorized message: Access Token Invalid @@ -6319,8 +6346,8 @@ paths: summary: Redact a conversation part value: type: conversation_part - conversation_id: 4737 - conversation_part_id: 1096 + conversation_id: 1379 + conversation_part_id: 297 not_found: summary: Not found value: @@ -6507,7 +6534,7 @@ paths: custom: false archived: false model: company - - id: 501 + - id: 130 type: data_attribute name: The One Ring full_name: custom_attributes.The One Ring @@ -6520,9 +6547,9 @@ paths: messenger_writable: true custom: true archived: false - admin_id: '991282049' - created_at: 1712222754 - updated_at: 1712222754 + admin_id: '991270701' + created_at: 1715077316 + updated_at: 1715077316 model: company - type: data_attribute name: id @@ -6594,7 +6621,7 @@ paths: Unauthorized: value: type: error.list - request_id: a6925c93-9ae5-4c6c-b56e-04f5631864ac + request_id: ebd9cbde-7381-43ee-9113-733b024aa305 errors: - code: unauthorized message: Access Token Invalid @@ -6619,7 +6646,7 @@ paths: examples: Successful: value: - id: 504 + id: 133 type: data_attribute name: Mithril Shirt full_name: custom_attributes.Mithril Shirt @@ -6630,9 +6657,9 @@ paths: messenger_writable: true custom: true archived: false - admin_id: '991282051' - created_at: 1712222755 - updated_at: 1712222755 + admin_id: '991270703' + created_at: 1715077317 + updated_at: 1715077317 model: company schema: "$ref": "#/components/schemas/data_attribute" @@ -6644,7 +6671,7 @@ paths: Same name already exists: value: type: error.list - request_id: f6c3aad7-7e3e-45d3-b32c-3cd0fc9b234f + request_id: af1c5575-7c27-4ae3-8d66-f0c7bd0a50fc errors: - code: parameter_invalid message: You already have 'The One Ring' in your company data. @@ -6652,7 +6679,7 @@ paths: Invalid name: value: type: error.list - request_id: 3f2bee02-77ab-4a65-965c-2b0105d14360 + request_id: '088a9af5-c6d0-4f0e-8bdd-8f2b6e1ee3ab' errors: - code: parameter_invalid message: Your name for this attribute must only contain alphanumeric @@ -6660,7 +6687,7 @@ paths: Attribute already exists: value: type: error.list - request_id: a778a9f7-1d5e-42d6-beb5-3ec0a40e6aeb + request_id: 68c2363b-99fb-4abf-ab94-52ec8f610875 errors: - code: parameter_invalid message: You already have 'The One Ring' in your company data. @@ -6668,14 +6695,14 @@ paths: Invalid Data Type: value: type: error.list - request_id: 241f99d0-4cbe-4fd9-8ad6-5d82a4baeb84 + request_id: 116df0fe-f898-4a4d-a835-2b749e0e1055 errors: - code: parameter_invalid message: Data Type isn't an option Too few options for list: value: type: error.list - request_id: 4d50bfac-62e8-4962-a069-ee79d2a4daee + request_id: eb8fc39e-c6cf-4af5-8305-9926577be842 errors: - code: parameter_invalid message: The Data Attribute model field must be either contact @@ -6690,7 +6717,7 @@ paths: Unauthorized: value: type: error.list - request_id: 1a8b762d-b183-479a-bb44-4e3d4c348eba + request_id: ad9eb614-8ba1-4920-b28b-47a6132ccee6 errors: - code: unauthorized message: Access Token Invalid @@ -6769,7 +6796,7 @@ paths: examples: Successful: value: - id: 511 + id: 140 type: data_attribute name: The One Ring full_name: custom_attributes.The One Ring @@ -6784,9 +6811,9 @@ paths: messenger_writable: true custom: true archived: false - admin_id: '991282058' - created_at: 1712222758 - updated_at: 1712222759 + admin_id: '991270710' + created_at: 1715077320 + updated_at: 1715077320 model: company schema: "$ref": "#/components/schemas/data_attribute" @@ -6798,7 +6825,7 @@ paths: Too few options in list: value: type: error.list - request_id: 303a18e2-96ba-4910-b6d8-036d7f346519 + request_id: 3c1c6cad-ff58-4d41-a161-97cef40e53cf errors: - code: parameter_invalid message: Options isn't an array @@ -6812,7 +6839,7 @@ paths: Attribute Not Found: value: type: error.list - request_id: 8764deb6-447d-4a37-aeeb-9a6dccc2cda7 + request_id: 338559c8-41d0-4ee5-befc-562f24b0e42f errors: - code: field_not_found message: We couldn't find that data attribute to update @@ -6826,7 +6853,7 @@ paths: Has Dependant Object: value: type: error.list - request_id: bc8cf353-9fbb-499d-b74f-99c0eddf404f + request_id: f753e0a2-308c-409d-b28f-6cfcb362ccb9 errors: - code: data_invalid message: The Data Attribute you are trying to archive has a @@ -6841,7 +6868,7 @@ paths: Unauthorized: value: type: error.list - request_id: b3a35115-6362-45db-a4ba-ebc55296fe44 + request_id: 0160d8e0-ff04-44cb-b779-941e43923a94 errors: - code: unauthorized message: Access Token Invalid @@ -6946,7 +6973,7 @@ paths: Unauthorized: value: type: error.list - request_id: 7e44ba75-b3f4-484c-9a7e-12d3c3e717b5 + request_id: 2a3ffc97-61f0-4e1e-aa0e-80337cbf13d4 errors: - code: unauthorized message: Access Token Invalid @@ -7033,7 +7060,7 @@ paths: pages: next: http://api.intercom.test/events?next page email: user26@email.com - intercom_user_id: 660e722b6abd01bb40bdc501 + intercom_user_id: 663a00cdf7676c5662aebbde user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 schema: "$ref": "#/components/schemas/data_event_summary" @@ -7045,7 +7072,7 @@ paths: Unauthorized: value: type: error.list - request_id: 11b40f66-c30a-489a-80d0-fe644db01a25 + request_id: 11392e12-9d3c-48cf-aa61-80d55657c853 errors: - code: unauthorized message: Access Token Invalid @@ -7076,7 +7103,7 @@ paths: Unauthorized: value: type: error.list - request_id: acf2416b-3458-44ea-83b9-ff1c37284df8 + request_id: cb105bee-215c-493f-9626-d6933d561e00 errors: - code: unauthorized message: Access Token Invalid @@ -7120,7 +7147,7 @@ paths: examples: successful: value: - job_identifier: iorz4ldualozv1pw + job_identifier: ofg8prqfoddw2p00 status: pending download_url: '' download_expires_at: '' @@ -7135,8 +7162,8 @@ paths: successful: summary: successful value: - created_at_after: 1712204765 - created_at_before: 1712222765 + created_at_after: 1715059327 + created_at_before: 1715077327 "/export/content/data/{job_identifier}": get: summary: Show content data export @@ -7170,7 +7197,7 @@ paths: examples: successful: value: - job_identifier: qzfurn6ajnhwrlmw + job_identifier: l3wn98jcjyt4zyvc status: pending download_url: '' download_expires_at: '' @@ -7202,7 +7229,7 @@ paths: examples: successful: value: - job_identifier: 3manl979nqyiwoxq + job_identifier: a2zjehjyrgj2c0w3 status: canceled download_url: '' download_expires_at: '' @@ -7263,32 +7290,32 @@ paths: user message created: value: type: user_message - id: '403920821' - created_at: 1712222768 + id: '403918809' + created_at: 1715077329 body: heyy message_type: inapp - conversation_id: '4742' + conversation_id: '1384' lead message created: value: type: user_message - id: '403920822' - created_at: 1712222769 + id: '403918810' + created_at: 1715077330 body: heyy message_type: inapp - conversation_id: '4743' + conversation_id: '1385' admin message created: value: type: admin_message - id: '160' - created_at: 1712222770 + id: '45' + created_at: 1715077331 subject: heyy body: heyy message_type: inapp owner: type: admin - id: '991282081' - name: Ciaran265 Lee - email: admin265@email.com + id: '991270733' + name: Ciaran276 Lee + email: admin276@email.com away_mode_enabled: false away_mode_reassign: false schema: @@ -7301,14 +7328,14 @@ paths: No body supplied for message: value: type: error.list - request_id: 1aa94bb1-ca4a-4070-8989-5f7f877ba97a + request_id: 73ecb53c-d0c8-498e-9121-88df1b02b0c5 errors: - code: parameter_invalid message: Body is required No body supplied for email message: value: type: error.list - request_id: 79f133e4-5df4-4691-b998-934065a7ed26 + request_id: 6239dd2b-1312-4793-ba43-cdf56f63f391 errors: - code: parameter_invalid message: Body is required @@ -7322,7 +7349,7 @@ paths: No subject supplied for email message: value: type: error.list - request_id: c50c104a-a579-4447-b538-a0b6238f3b1f + request_id: f14ec73c-f73a-47b1-bd8a-b1f9cd36642b errors: - code: parameter_not_found message: No subject supplied for email message @@ -7336,7 +7363,7 @@ paths: Unauthorized: value: type: error.list - request_id: 3c2db2aa-959f-42ef-b5c7-9be34f563a0f + request_id: 9b679ea6-96e7-4c97-892a-e3b2b0dd4bd9 errors: - code: unauthorized message: Access Token Invalid @@ -7350,7 +7377,7 @@ paths: API plan restricted: value: type: error.list - request_id: 729921ca-bd95-46c5-9f4c-15429ed6c295 + request_id: 6220db0a-0bed-4354-bded-efe9ec7086c6 errors: - code: api_plan_restricted message: Active subscription needed. @@ -7367,7 +7394,7 @@ paths: value: from: type: user - id: 660e722f6abd01bb40bdc506 + id: 663a00d1f7676c5662aebbe3 body: heyy referer: https://twitter.com/bob lead_message_created: @@ -7375,7 +7402,7 @@ paths: value: from: type: lead - id: 660e72306abd01bb40bdc507 + id: 663a00d2f7676c5662aebbe4 body: heyy referer: https://twitter.com/bob admin_message_created: @@ -7383,10 +7410,10 @@ paths: value: from: type: admin - id: '991282081' + id: '991270733' to: type: user - id: 660e72316abd01bb40bdc508 + id: 663a00d3f7676c5662aebbe5 message_type: conversation body: heyy no_body_supplied_for_message: @@ -7394,10 +7421,10 @@ paths: value: from: type: admin - id: '991282083' + id: '991270735' to: type: user - id: 660e72336abd01bb40bdc509 + id: 663a00d4f7676c5662aebbe6 message_type: inapp body: subject: heyy @@ -7406,7 +7433,7 @@ paths: value: from: type: admin - id: '991282084' + id: '991270736' to: type: user user_id: '70' @@ -7417,10 +7444,10 @@ paths: value: from: type: admin - id: '991282085' + id: '991270737' to: type: user - id: 660e72346abd01bb40bdc50b + id: 663a00d5f7676c5662aebbe8 message_type: email body: subject: heyy @@ -7451,12 +7478,12 @@ paths: total_pages: 1 type: pages data: - - id: '435' + - id: '114' type: news-item - workspace_id: this_is_an_id481_that_should_be_at_least_ + workspace_id: this_is_an_id492_that_should_be_at_least_ title: We have news body: "

    Hello there,

    " - sender_id: 991282090 + sender_id: 991270744 state: draft labels: [] cover_image_url: @@ -7466,15 +7493,15 @@ paths: - - deliver_silently: false - created_at: 1712222774 - updated_at: 1712222774 + created_at: 1715077335 + updated_at: 1715077335 newsfeed_assignments: [] - - id: '436' + - id: '113' type: news-item - workspace_id: this_is_an_id481_that_should_be_at_least_ + workspace_id: this_is_an_id492_that_should_be_at_least_ title: We have news body: "

    Hello there,

    " - sender_id: 991282092 + sender_id: 991270742 state: draft labels: [] cover_image_url: @@ -7484,8 +7511,8 @@ paths: - - deliver_silently: false - created_at: 1712222774 - updated_at: 1712222774 + created_at: 1715077334 + updated_at: 1715077334 newsfeed_assignments: [] total_count: 2 schema: @@ -7498,7 +7525,7 @@ paths: Unauthorized: value: type: error.list - request_id: 5eaada61-57cd-4c90-b195-56752076d426 + request_id: b1aef759-3c78-436d-97d7-1ed8c43b167e errors: - code: unauthorized message: Access Token Invalid @@ -7523,12 +7550,12 @@ paths: examples: successful: value: - id: '439' + id: '117' type: news-item - workspace_id: this_is_an_id485_that_should_be_at_least_ + workspace_id: this_is_an_id496_that_should_be_at_least_ title: Halloween is here! body: "

    New costumes in store for this spooky season

    " - sender_id: 991282099 + sender_id: 991270751 state: live labels: - New @@ -7539,10 +7566,10 @@ paths: - "\U0001F606" - "\U0001F605" deliver_silently: true - created_at: 1712222777 - updated_at: 1712222777 + created_at: 1715077336 + updated_at: 1715077336 newsfeed_assignments: - - newsfeed_id: 778 + - newsfeed_id: 203 published_at: 1664638214 schema: "$ref": "#/components/schemas/news_item" @@ -7554,7 +7581,7 @@ paths: Unauthorized: value: type: error.list - request_id: 179f4dc2-87bd-458e-9102-574432610cf8 + request_id: 072b1442-7c52-4b4f-8f81-4dee5fc0ad1b errors: - code: unauthorized message: Access Token Invalid @@ -7575,14 +7602,14 @@ paths: - Product - Update - New - sender_id: 991282099 + sender_id: 991270751 deliver_silently: true reactions: - "\U0001F606" - "\U0001F605" state: live newsfeed_assignments: - - newsfeed_id: 778 + - newsfeed_id: 203 published_at: 1664638214 "/news/news_items/{id}": get: @@ -7611,12 +7638,12 @@ paths: examples: successful: value: - id: '440' + id: '118' type: news-item - workspace_id: this_is_an_id489_that_should_be_at_least_ + workspace_id: this_is_an_id500_that_should_be_at_least_ title: We have news body: "

    Hello there,

    " - sender_id: 991282102 + sender_id: 991270754 state: live labels: [] cover_image_url: @@ -7626,11 +7653,11 @@ paths: - - deliver_silently: false - created_at: 1712222778 - updated_at: 1712222778 + created_at: 1715077338 + updated_at: 1715077338 newsfeed_assignments: - - newsfeed_id: 780 - published_at: 1712222778 + - newsfeed_id: 205 + published_at: 1715077338 schema: "$ref": "#/components/schemas/news_item" '404': @@ -7641,7 +7668,7 @@ paths: News Item Not Found: value: type: error.list - request_id: b191a001-e043-4920-9a17-5eed2fc3d746 + request_id: 75f1d65c-ced5-431e-96c2-77ff7e06af74 errors: - code: not_found message: Resource Not Found @@ -7655,7 +7682,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2e71d756-891d-40ef-b24f-2b7a7f5de783 + request_id: e66d79cb-87af-4aed-8aec-7536c6a0d04b errors: - code: unauthorized message: Access Token Invalid @@ -7686,12 +7713,12 @@ paths: examples: successful: value: - id: '443' + id: '121' type: news-item - workspace_id: this_is_an_id495_that_should_be_at_least_ + workspace_id: this_is_an_id506_that_should_be_at_least_ title: Christmas is here! body: "

    New gifts in store for the jolly season

    " - sender_id: 991282110 + sender_id: 991270762 state: live labels: [] cover_image_url: @@ -7699,8 +7726,8 @@ paths: - "\U0001F61D" - "\U0001F602" deliver_silently: false - created_at: 1712222780 - updated_at: 1712222781 + created_at: 1715077339 + updated_at: 1715077340 newsfeed_assignments: [] schema: "$ref": "#/components/schemas/news_item" @@ -7712,7 +7739,7 @@ paths: News Item Not Found: value: type: error.list - request_id: 3ddccb7c-95fb-476b-a3ed-4d3c4e354ec6 + request_id: ee9f829f-8b4f-4724-8c49-8ec066761090 errors: - code: not_found message: Resource Not Found @@ -7726,7 +7753,7 @@ paths: Unauthorized: value: type: error.list - request_id: e9e6b04e-fc93-4de4-92e7-ae51d4eb47f4 + request_id: c5aef59d-49e4-44d8-b961-952c5e127e01 errors: - code: unauthorized message: Access Token Invalid @@ -7743,7 +7770,7 @@ paths: value: title: Christmas is here! body: "

    New gifts in store for the jolly season

    " - sender_id: 991282110 + sender_id: 991270762 reactions: - "\U0001F61D" - "\U0001F602" @@ -7752,7 +7779,7 @@ paths: value: title: Christmas is here! body: "

    New gifts in store for the jolly season

    " - sender_id: 991282113 + sender_id: 991270765 reactions: - "\U0001F61D" - "\U0001F602" @@ -7782,7 +7809,7 @@ paths: examples: successful: value: - id: '446' + id: '124' object: news-item deleted: true schema: @@ -7795,7 +7822,7 @@ paths: News Item Not Found: value: type: error.list - request_id: 8eb32604-d17f-468e-835d-58d28083892d + request_id: fe357c70-3286-447b-8414-604be5f2d6ee errors: - code: not_found message: Resource Not Found @@ -7809,7 +7836,7 @@ paths: Unauthorized: value: type: error.list - request_id: a8ede400-b6b1-4b1d-859e-2b98a6f919f8 + request_id: d4ef81b3-1693-48b2-aeab-44a7db242ea1 errors: - code: unauthorized message: Access Token Invalid @@ -7862,7 +7889,7 @@ paths: Unauthorized: value: type: error.list - request_id: baeca96f-48d7-4650-87b0-9c5655c5a4ec + request_id: 9d00c6b8-fcfc-4bdf-8701-8b293b69ccc9 errors: - code: unauthorized message: Access Token Invalid @@ -7895,16 +7922,16 @@ paths: total_pages: 1 type: pages data: - - id: '793' + - id: '218' type: newsfeed name: Visitor Feed - created_at: 1712222785 - updated_at: 1712222785 - - id: '794' + created_at: 1715077344 + updated_at: 1715077344 + - id: '219' type: newsfeed name: Visitor Feed - created_at: 1712222785 - updated_at: 1712222785 + created_at: 1715077344 + updated_at: 1715077344 total_count: 2 schema: "$ref": "#/components/schemas/paginated_response" @@ -7916,7 +7943,7 @@ paths: Unauthorized: value: type: error.list - request_id: 11cecb94-0ceb-4806-afc2-2b40cc2ceef3 + request_id: a43b5eb4-1153-4450-821e-b088770520eb errors: - code: unauthorized message: Access Token Invalid @@ -7950,11 +7977,11 @@ paths: examples: successful: value: - id: '797' + id: '222' type: newsfeed name: Visitor Feed - created_at: 1712222786 - updated_at: 1712222786 + created_at: 1715077345 + updated_at: 1715077345 schema: "$ref": "#/components/schemas/newsfeed" '401': @@ -7965,7 +7992,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9878bcbc-794f-4b7f-bd4e-affd270e988b + request_id: eedb9268-981c-4178-91e3-7ed07e4a6a14 errors: - code: unauthorized message: Access Token Invalid @@ -7999,16 +8026,16 @@ paths: Note found: value: type: note - id: '434' - created_at: 1711531587 + id: '115' + created_at: 1714386146 contact: type: contact - id: 660e72436abd01bb40bdc50e + id: 663a00e2f7676c5662aebbeb author: type: admin - id: '991282129' - name: Ciaran312 Lee - email: admin312@email.com + id: '991270781' + name: Ciaran323 Lee + email: admin323@email.com away_mode_enabled: false away_mode_reassign: false body: "

    This is a note.

    " @@ -8022,7 +8049,7 @@ paths: Note not found: value: type: error.list - request_id: 9c0addda-ed80-4887-8db4-17fb71baeff3 + request_id: 31268c18-5241-4bb3-87b7-e946afb9437b errors: - code: not_found message: Resource Not Found @@ -8036,7 +8063,7 @@ paths: Unauthorized: value: type: error.list - request_id: e8129946-362c-4cb5-8bc3-86d835caa31d + request_id: 896483de-6227-4566-925e-57e340a4ebdf errors: - code: unauthorized message: Access Token Invalid @@ -8072,16 +8099,16 @@ paths: type: segment.list segments: - type: segment - id: 660e72456abd01bb40bdc511 + id: 663a00e3f7676c5662aebbee name: John segment - created_at: 1712222789 - updated_at: 1712222789 + created_at: 1715077347 + updated_at: 1715077347 person_type: user - type: segment - id: 660e72456abd01bb40bdc512 + id: 663a00e3f7676c5662aebbef name: Jane segment - created_at: 1712222789 - updated_at: 1712222789 + created_at: 1715077347 + updated_at: 1715077347 person_type: user schema: "$ref": "#/components/schemas/segment_list" @@ -8093,7 +8120,7 @@ paths: Unauthorized: value: type: error.list - request_id: dac96276-9f91-423e-8e34-795ab7af0ca5 + request_id: b6db13cb-69ac-416a-8a37-2f810409bf0b errors: - code: unauthorized message: Access Token Invalid @@ -8127,10 +8154,10 @@ paths: Successful response: value: type: segment - id: 660e72466abd01bb40bdc515 + id: 663a00e4f7676c5662aebbf2 name: John segment - created_at: 1712222790 - updated_at: 1712222790 + created_at: 1715077348 + updated_at: 1715077348 person_type: user schema: "$ref": "#/components/schemas/segment" @@ -8142,7 +8169,7 @@ paths: Segment not found: value: type: error.list - request_id: a4173cf9-b4f6-4fd2-b635-8bb910317a47 + request_id: 9c9d95de-dc26-408a-b7ef-e12d6856a050 errors: - code: not_found message: Resource Not Found @@ -8156,7 +8183,7 @@ paths: Unauthorized: value: type: error.list - request_id: fbe87691-57db-4443-8e81-9f907c41f322 + request_id: 5673c948-1237-4869-b940-d8f786e2ad10 errors: - code: unauthorized message: Access Token Invalid @@ -8186,7 +8213,7 @@ paths: type: list data: - type: subscription - id: '1559' + id: '413' state: live consent_type: opt_out default_translation: @@ -8209,7 +8236,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9425795e-de3a-4118-a746-47783d302856 + request_id: 5f630b1f-e786-4ae5-965c-293fa0349e6c errors: - code: unauthorized message: Access Token Invalid @@ -8239,7 +8266,7 @@ paths: examples: successful: value: - url: http://via.intercom.io/msgr/e6a6bfb4-574c-4ea5-94d9-695259de491b + url: http://via.intercom.io/msgr/95d46a28-ce1d-4ace-b9fc-93d02f3c9d50 type: phone_call_redirect schema: "$ref": "#/components/schemas/phone_switch" @@ -8272,7 +8299,7 @@ paths: Unauthorized: value: type: error.list - request_id: 7dc05420-042f-4d61-aaac-c97ace13b7d0 + request_id: 7b3f8014-6d2e-48a2-92d2-9ec6ade0eef6 errors: - code: unauthorized message: Access Token Invalid @@ -8335,7 +8362,7 @@ paths: type: list data: - type: tag - id: '1380' + id: '366' name: Manual tag 1 schema: "$ref": "#/components/schemas/tag_list" @@ -8347,7 +8374,7 @@ paths: Unauthorized: value: type: error.list - request_id: 1974babf-7454-4491-adc6-53af6c7a8a67 + request_id: d25d9749-5209-465d-85b9-ce8040228afb errors: - code: unauthorized message: Access Token Invalid @@ -8386,7 +8413,7 @@ paths: Action successful: value: type: tag - id: '1383' + id: '369' name: test schema: "$ref": "#/components/schemas/tag" @@ -8398,7 +8425,7 @@ paths: Invalid parameters: value: type: error.list - request_id: bb051b77-bd1a-44a1-a74f-daba710abe0b + request_id: 3afeb629-a7d2-46c9-ae6b-59d56b5b948a errors: - code: parameter_invalid message: invalid tag parameters @@ -8412,14 +8439,14 @@ paths: Company not found: value: type: error.list - request_id: 52377454-2cbd-45cd-978d-074ce5fe1339 + request_id: 1fae9f92-0d7c-42f4-8f75-022ee55ed05e errors: - code: company_not_found message: Company Not Found User not found: value: type: error.list - request_id: e753d321-85e8-4050-9507-93e449615f45 + request_id: e50bfb27-8419-414a-b975-cbfbf0d68f3a errors: - code: not_found message: User Not Found @@ -8433,7 +8460,7 @@ paths: Unauthorized: value: type: error.list - request_id: a15ad52b-6dc9-4347-938c-3c038b0f425d + request_id: 91538db8-9a92-4028-8aba-7be8b1a3af32 errors: - code: unauthorized message: Access Token Invalid @@ -8499,7 +8526,7 @@ paths: Tag found: value: type: tag - id: '1391' + id: '377' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -8511,7 +8538,7 @@ paths: Tag not found: value: type: error.list - request_id: '0786ba7c-0e2e-44d9-a65e-0603e5a1fbb3' + request_id: 0f8a69e6-2fd0-40c2-b52c-c71203220894 errors: - code: not_found message: Resource Not Found @@ -8525,7 +8552,7 @@ paths: Unauthorized: value: type: error.list - request_id: d6fb41a4-c62b-49bc-a33f-0c02a0e6e870 + request_id: 6316e32c-da5e-405e-bc09-948ee08b4b9c errors: - code: unauthorized message: Access Token Invalid @@ -8561,7 +8588,7 @@ paths: Resource not found: value: type: error.list - request_id: e7040821-251a-49ee-ac46-9185d86eca86 + request_id: 52845df8-e05a-4383-b70f-f2fca3ab8ffa errors: - code: not_found message: Resource Not Found @@ -8575,7 +8602,7 @@ paths: Tag has dependent objects: value: type: error.list - request_id: c6cf4ce2-a6fd-4c43-9453-c535f6d51f58 + request_id: cdfbb7e0-a02a-4c42-a5bd-84ca2044b084 errors: - code: tag_has_dependent_objects message: 'Unable to delete Tag with dependent objects. Segments: @@ -8590,7 +8617,7 @@ paths: Unauthorized: value: type: error.list - request_id: 47e95eab-db61-429e-aa7d-4fb9672032e0 + request_id: e8fdef89-af00-434a-abff-521cb722f3ea errors: - code: unauthorized message: Access Token Invalid @@ -8628,7 +8655,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9ad9f707-3d3e-4fd7-908f-6564deff618e + request_id: 66be1b7b-b4bc-453c-bbf1-d1b16e634e40 errors: - code: unauthorized message: Access Token Invalid @@ -8663,7 +8690,7 @@ paths: successful: value: type: team - id: '991282167' + id: '991270819' name: team 1 admin_ids: [] schema: @@ -8676,7 +8703,7 @@ paths: Team not found: value: type: error.list - request_id: e4d61db2-b620-48bd-a590-214756387b69 + request_id: 4868214a-4741-43ca-84c8-5a685adae454 errors: - code: team_not_found message: Team not found @@ -8690,7 +8717,7 @@ paths: Unauthorized: value: type: error.list - request_id: 5561a4c5-4a2f-4f1c-bd6a-65da19d5264c + request_id: 26164a43-61ec-4a49-b2ec-4b9d5448268d errors: - code: unauthorized message: Access Token Invalid @@ -8723,8 +8750,8 @@ paths: Ticket Type Attribute created: value: type: ticket_type_attribute - id: '2356' - workspace_id: this_is_an_id587_that_should_be_at_least_ + id: '625' + workspace_id: this_is_an_id598_that_should_be_at_least_ name: Attribute Title description: Attribute Description data_type: string @@ -8736,10 +8763,10 @@ paths: visible_on_create: true visible_to_contacts: true default: false - ticket_type_id: 848 + ticket_type_id: 224 archived: false - created_at: 1712222808 - updated_at: 1712222808 + created_at: 1715077366 + updated_at: 1715077366 schema: "$ref": "#/components/schemas/ticket_type_attribute" '401': @@ -8750,7 +8777,7 @@ paths: Unauthorized: value: type: error.list - request_id: 5ef49531-45bf-4bec-8067-eb4c710134ca + request_id: 3f6fc5dc-dedd-486b-8072-3e56dbd1764a errors: - code: unauthorized message: Access Token Invalid @@ -8803,8 +8830,8 @@ paths: Ticket Type Attribute updated: value: type: ticket_type_attribute - id: '2361' - workspace_id: this_is_an_id591_that_should_be_at_least_ + id: '630' + workspace_id: this_is_an_id602_that_should_be_at_least_ name: name description: New Attribute Description data_type: string @@ -8814,10 +8841,10 @@ paths: visible_on_create: false visible_to_contacts: false default: false - ticket_type_id: 850 + ticket_type_id: 226 archived: false - created_at: 1712222809 - updated_at: 1712222809 + created_at: 1715077367 + updated_at: 1715077367 schema: "$ref": "#/components/schemas/ticket_type_attribute" '401': @@ -8828,7 +8855,7 @@ paths: Unauthorized: value: type: error.list - request_id: 892278bc-d7e9-4731-8315-9cc25fd41434 + request_id: 90cf6cef-e049-4024-961d-d5c414701c36 errors: - code: unauthorized message: Access Token Invalid @@ -8867,21 +8894,21 @@ paths: type: list data: - type: ticket_type - id: '852' + id: '228' name: Bug Report description: Bug Report Template icon: "\U0001F39F️" - workspace_id: this_is_an_id595_that_should_be_at_least_ + workspace_id: this_is_an_id606_that_should_be_at_least_ archived: false - created_at: 1712222810 - updated_at: 1712222810 + created_at: 1715077368 + updated_at: 1715077368 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '2364' - workspace_id: this_is_an_id595_that_should_be_at_least_ + id: '633' + workspace_id: this_is_an_id606_that_should_be_at_least_ name: _default_title_ description: '' data_type: string @@ -8893,13 +8920,13 @@ paths: visible_on_create: true visible_to_contacts: true default: true - ticket_type_id: 852 + ticket_type_id: 228 archived: false - created_at: 1712222810 - updated_at: 1712222810 + created_at: 1715077368 + updated_at: 1715077368 - type: ticket_type_attribute - id: '2366' - workspace_id: this_is_an_id595_that_should_be_at_least_ + id: '635' + workspace_id: this_is_an_id606_that_should_be_at_least_ name: name description: description data_type: string @@ -8910,13 +8937,13 @@ paths: visible_on_create: false visible_to_contacts: false default: false - ticket_type_id: 852 + ticket_type_id: 228 archived: false - created_at: 1712222810 - updated_at: 1712222810 + created_at: 1715077368 + updated_at: 1715077368 - type: ticket_type_attribute - id: '2365' - workspace_id: this_is_an_id595_that_should_be_at_least_ + id: '634' + workspace_id: this_is_an_id606_that_should_be_at_least_ name: _default_description_ description: '' data_type: string @@ -8928,10 +8955,10 @@ paths: visible_on_create: true visible_to_contacts: true default: true - ticket_type_id: 852 + ticket_type_id: 228 archived: false - created_at: 1712222810 - updated_at: 1712222810 + created_at: 1715077368 + updated_at: 1715077368 schema: "$ref": "#/components/schemas/ticket_type_list" '401': @@ -8942,7 +8969,7 @@ paths: Unauthorized: value: type: error.list - request_id: af47f487-2ce8-4a83-b85b-ed8ffb1aa826 + request_id: 5d7fea33-d07e-4b50-af2f-068e9d315bb8 errors: - code: unauthorized message: Access Token Invalid @@ -8971,21 +8998,21 @@ paths: Ticket type created: value: type: ticket_type - id: '855' + id: '231' name: Customer Issue description: Customer Report Template icon: "\U0001F39F️" - workspace_id: this_is_an_id599_that_should_be_at_least_ + workspace_id: this_is_an_id610_that_should_be_at_least_ archived: false - created_at: 1712222812 - updated_at: 1712222812 + created_at: 1715077369 + updated_at: 1715077369 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '2373' - workspace_id: this_is_an_id599_that_should_be_at_least_ + id: '642' + workspace_id: this_is_an_id610_that_should_be_at_least_ name: _default_title_ description: '' data_type: string @@ -8997,13 +9024,13 @@ paths: visible_on_create: true visible_to_contacts: true default: true - ticket_type_id: 855 + ticket_type_id: 231 archived: false - created_at: 1712222812 - updated_at: 1712222812 + created_at: 1715077369 + updated_at: 1715077369 - type: ticket_type_attribute - id: '2374' - workspace_id: this_is_an_id599_that_should_be_at_least_ + id: '643' + workspace_id: this_is_an_id610_that_should_be_at_least_ name: _default_description_ description: '' data_type: string @@ -9015,10 +9042,10 @@ paths: visible_on_create: true visible_to_contacts: true default: true - ticket_type_id: 855 + ticket_type_id: 231 archived: false - created_at: 1712222812 - updated_at: 1712222812 + created_at: 1715077369 + updated_at: 1715077369 schema: "$ref": "#/components/schemas/ticket_type" '401': @@ -9029,7 +9056,7 @@ paths: Unauthorized: value: type: error.list - request_id: 007415e7-f7e7-4f02-8af1-a8a9bebdbf66 + request_id: 41b14237-1c30-4978-ae2f-e091f98617c8 errors: - code: unauthorized message: Access Token Invalid @@ -9074,21 +9101,21 @@ paths: Ticket type found: value: type: ticket_type - id: '857' + id: '233' name: Bug Report description: Bug Report Template icon: "\U0001F39F️" - workspace_id: this_is_an_id603_that_should_be_at_least_ + workspace_id: this_is_an_id614_that_should_be_at_least_ archived: false - created_at: 1712222813 - updated_at: 1712222813 + created_at: 1715077370 + updated_at: 1715077370 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '2378' - workspace_id: this_is_an_id603_that_should_be_at_least_ + id: '647' + workspace_id: this_is_an_id614_that_should_be_at_least_ name: _default_title_ description: '' data_type: string @@ -9100,13 +9127,13 @@ paths: visible_on_create: true visible_to_contacts: true default: true - ticket_type_id: 857 + ticket_type_id: 233 archived: false - created_at: 1712222813 - updated_at: 1712222813 + created_at: 1715077370 + updated_at: 1715077370 - type: ticket_type_attribute - id: '2380' - workspace_id: this_is_an_id603_that_should_be_at_least_ + id: '649' + workspace_id: this_is_an_id614_that_should_be_at_least_ name: name description: description data_type: string @@ -9117,13 +9144,13 @@ paths: visible_on_create: false visible_to_contacts: false default: false - ticket_type_id: 857 + ticket_type_id: 233 archived: false - created_at: 1712222813 - updated_at: 1712222813 + created_at: 1715077370 + updated_at: 1715077370 - type: ticket_type_attribute - id: '2379' - workspace_id: this_is_an_id603_that_should_be_at_least_ + id: '648' + workspace_id: this_is_an_id614_that_should_be_at_least_ name: _default_description_ description: '' data_type: string @@ -9135,10 +9162,10 @@ paths: visible_on_create: true visible_to_contacts: true default: true - ticket_type_id: 857 + ticket_type_id: 233 archived: false - created_at: 1712222813 - updated_at: 1712222813 + created_at: 1715077370 + updated_at: 1715077370 schema: "$ref": "#/components/schemas/ticket_type" '401': @@ -9149,7 +9176,7 @@ paths: Unauthorized: value: type: error.list - request_id: d42d4c3d-6b43-4ade-9ee3-5a4b4051f343 + request_id: b49b4aec-3125-4d91-bcc8-178848cae296 errors: - code: unauthorized message: Access Token Invalid @@ -9182,21 +9209,21 @@ paths: Ticket type updated: value: type: ticket_type - id: '859' + id: '235' name: Bug Report 2 description: Bug Report Template icon: "\U0001F39F️" - workspace_id: this_is_an_id607_that_should_be_at_least_ + workspace_id: this_is_an_id618_that_should_be_at_least_ archived: false - created_at: 1712222814 - updated_at: 1712222814 + created_at: 1715077371 + updated_at: 1715077371 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '2384' - workspace_id: this_is_an_id607_that_should_be_at_least_ + id: '653' + workspace_id: this_is_an_id618_that_should_be_at_least_ name: _default_title_ description: '' data_type: string @@ -9208,13 +9235,13 @@ paths: visible_on_create: true visible_to_contacts: true default: true - ticket_type_id: 859 + ticket_type_id: 235 archived: false - created_at: 1712222814 - updated_at: 1712222814 + created_at: 1715077371 + updated_at: 1715077371 - type: ticket_type_attribute - id: '2386' - workspace_id: this_is_an_id607_that_should_be_at_least_ + id: '655' + workspace_id: this_is_an_id618_that_should_be_at_least_ name: name description: description data_type: string @@ -9225,13 +9252,13 @@ paths: visible_on_create: false visible_to_contacts: false default: false - ticket_type_id: 859 + ticket_type_id: 235 archived: false - created_at: 1712222814 - updated_at: 1712222814 + created_at: 1715077371 + updated_at: 1715077371 - type: ticket_type_attribute - id: '2385' - workspace_id: this_is_an_id607_that_should_be_at_least_ + id: '654' + workspace_id: this_is_an_id618_that_should_be_at_least_ name: _default_description_ description: '' data_type: string @@ -9243,10 +9270,10 @@ paths: visible_on_create: true visible_to_contacts: true default: true - ticket_type_id: 859 + ticket_type_id: 235 archived: false - created_at: 1712222814 - updated_at: 1712222814 + created_at: 1715077371 + updated_at: 1715077371 schema: "$ref": "#/components/schemas/ticket_type" '401': @@ -9257,7 +9284,7 @@ paths: Unauthorized: value: type: error.list - request_id: 41946719-44ab-45fa-8fbc-fd6b5ed7b871 + request_id: c0a87943-a1d7-4623-8363-c067687fc6de errors: - code: unauthorized message: Access Token Invalid @@ -9302,7 +9329,7 @@ paths: Admin note reply: value: type: ticket_part - id: '1101' + id: '302' part_type: note body: |-

    An Unordered HTML List

    @@ -9317,13 +9344,13 @@ paths:
  • Tea
  • Milk
    • - created_at: 1712222818 - updated_at: 1712222818 + created_at: 1715077374 + updated_at: 1715077374 author: - id: '991282193' + id: '991270845' type: admin - name: Ciaran371 Lee - email: admin371@email.com + name: Ciaran382 Lee + email: admin382@email.com attachments: [] redacted: false schema: @@ -9336,7 +9363,7 @@ paths: Unauthorized: value: type: error.list - request_id: 71ff1a74-97b5-4021-aebb-91caaad31a11 + request_id: 5c59e307-4df7-4680-8834-fcec5d59e1cb errors: - code: unauthorized message: Access Token Invalid @@ -9353,7 +9380,7 @@ paths: value: message_type: note type: admin - admin_id: 991282193 + admin_id: 991270845 body: "

    An Unordered HTML List

    • Coffee
      • \
    • Tea
    • Milk

    An Ordered HTML List

    \
    1. Coffee
    2. Tea
    3. Milk
    @@ -9379,7 +9406,7 @@ paths: Successful response: value: type: ticket - id: '4746' + id: '1388' ticket_attributes: title: example description: there is a problem @@ -9388,21 +9415,21 @@ paths: ticket_state_external_label: Submitted ticket_type: type: ticket_type - id: '866' + id: '242' name: my-ticket-type-6 description: my ticket type description is awesome. icon: "\U0001F981" - workspace_id: this_is_an_id621_that_should_be_at_least_ + workspace_id: this_is_an_id632_that_should_be_at_least_ archived: false - created_at: 1712222821 - updated_at: 1712222821 + created_at: 1715077377 + updated_at: 1715077377 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '2396' - workspace_id: this_is_an_id621_that_should_be_at_least_ + id: '665' + workspace_id: this_is_an_id632_that_should_be_at_least_ name: title description: ola data_type: string @@ -9413,13 +9440,13 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 866 + ticket_type_id: 242 archived: false - created_at: 1712222821 - updated_at: 1712222821 + created_at: 1715077377 + updated_at: 1715077377 - type: ticket_type_attribute - id: '2397' - workspace_id: this_is_an_id621_that_should_be_at_least_ + id: '666' + workspace_id: this_is_an_id632_that_should_be_at_least_ name: description description: ola data_type: string @@ -9430,34 +9457,34 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 866 + ticket_type_id: 242 archived: false - created_at: 1712222821 - updated_at: 1712222821 + created_at: 1715077377 + updated_at: 1715077377 contacts: type: contact.list contacts: - - id: 660e72666abd01bb40bdc538 + - id: 663a0101f7676c5662aebc15 role: user admin_assignee_id: '0' team_assignee_id: '0' - created_at: 1712222822 - updated_at: 1712222822 + created_at: 1715077378 + updated_at: 1715077378 ticket_parts: type: ticket_part.list ticket_parts: - type: ticket_part - id: '1102' + id: '303' part_type: ticket_state_updated_by_admin ticket_state: submitted previous_ticket_state: submitted - created_at: 1712222822 - updated_at: 1712222822 + created_at: 1715077378 + updated_at: 1715077378 author: - id: '991282213' + id: '991270865' type: bot name: Operator - email: operator+this_is_an_id621_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id632_that_should_be_at_least_@intercom.io attachments: [] redacted: false total_count: 1 @@ -9471,7 +9498,7 @@ paths: Unauthorized: value: type: error.list - request_id: 1e5eb029-95a4-4003-9598-09f20cd48c89 + request_id: aa5127f2-a2cd-4426-86ca-398f71a77cb8 errors: - code: unauthorized message: Access Token Invalid @@ -9486,9 +9513,9 @@ paths: successful_response: summary: Successful response value: - ticket_type_id: 866 + ticket_type_id: 242 contacts: - - id: 660e72666abd01bb40bdc538 + - id: 663a0101f7676c5662aebc15 ticket_attributes: title: example description: there is a problem @@ -9519,7 +9546,7 @@ paths: Successful response: value: type: ticket - id: '4747' + id: '1389' ticket_attributes: title: example description: there is a problem @@ -9528,21 +9555,21 @@ paths: ticket_state_external_label: In progress ticket_type: type: ticket_type - id: '868' + id: '244' name: my-ticket-type-8 description: my ticket type description is awesome. icon: "\U0001F981" - workspace_id: this_is_an_id625_that_should_be_at_least_ + workspace_id: this_is_an_id636_that_should_be_at_least_ archived: false - created_at: 1712222824 - updated_at: 1712222824 + created_at: 1715077379 + updated_at: 1715077379 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '2401' - workspace_id: this_is_an_id625_that_should_be_at_least_ + id: '670' + workspace_id: this_is_an_id636_that_should_be_at_least_ name: title description: ola data_type: string @@ -9553,13 +9580,13 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 868 + ticket_type_id: 244 archived: false - created_at: 1712222824 - updated_at: 1712222824 + created_at: 1715077379 + updated_at: 1715077379 - type: ticket_type_attribute - id: '2402' - workspace_id: this_is_an_id625_that_should_be_at_least_ + id: '671' + workspace_id: this_is_an_id636_that_should_be_at_least_ name: description description: ola data_type: string @@ -9570,87 +9597,87 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 868 + ticket_type_id: 244 archived: false - created_at: 1712222824 - updated_at: 1712222824 + created_at: 1715077380 + updated_at: 1715077380 contacts: type: contact.list contacts: - - id: 660e72686abd01bb40bdc539 + - id: 663a0104f7676c5662aebc16 role: lead - admin_assignee_id: '991282227' + admin_assignee_id: '991270879' team_assignee_id: '0' - created_at: 1712222824 - updated_at: 1712222826 + created_at: 1715077380 + updated_at: 1715077382 ticket_parts: type: ticket_part.list ticket_parts: - type: ticket_part - id: '1103' + id: '304' part_type: ticket_state_updated_by_admin ticket_state: submitted previous_ticket_state: submitted - created_at: 1712222825 - updated_at: 1712222825 + created_at: 1715077380 + updated_at: 1715077380 author: - id: '991282225' + id: '991270877' type: admin - name: Ciaran401 Lee - email: admin401@email.com + name: Ciaran412 Lee + email: admin412@email.com attachments: [] redacted: false - type: ticket_part - id: '1104' + id: '305' part_type: ticket_attribute_updated_by_admin - created_at: 1712222826 - updated_at: 1712222826 + created_at: 1715077381 + updated_at: 1715077381 author: - id: '991282226' + id: '991270878' type: bot name: Operator - email: operator+this_is_an_id625_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id636_that_should_be_at_least_@intercom.io attachments: [] redacted: false - type: ticket_part - id: '1105' + id: '306' part_type: ticket_attribute_updated_by_admin - created_at: 1712222826 - updated_at: 1712222826 + created_at: 1715077381 + updated_at: 1715077381 author: - id: '991282226' + id: '991270878' type: bot name: Operator - email: operator+this_is_an_id625_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id636_that_should_be_at_least_@intercom.io attachments: [] redacted: false - type: ticket_part - id: '1106' + id: '307' part_type: ticket_state_updated_by_admin ticket_state: in_progress previous_ticket_state: submitted - created_at: 1712222826 - updated_at: 1712222826 + created_at: 1715077382 + updated_at: 1715077382 author: - id: '991282226' + id: '991270878' type: bot name: Operator - email: operator+this_is_an_id625_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id636_that_should_be_at_least_@intercom.io attachments: [] redacted: false - type: ticket_part - id: '1107' + id: '308' part_type: assignment - created_at: 1712222826 - updated_at: 1712222826 + created_at: 1715077382 + updated_at: 1715077382 assigned_to: type: admin - id: '991282227' + id: '991270879' author: - id: '991282225' + id: '991270877' type: admin - name: Ciaran401 Lee - email: admin401@email.com + name: Ciaran412 Lee + email: admin412@email.com attachments: [] redacted: false total_count: 5 @@ -9664,14 +9691,14 @@ paths: Admin not found: value: type: error.list - request_id: 752fe552-f009-4e9e-b08a-0cbf6ff78c9b + request_id: eb56031e-7756-4510-aa52-44a51b4e4ed2 errors: - code: assignee_not_found message: Assignee not found Assignee not found: value: type: error.list - request_id: 939b9ffa-83dd-408f-ad52-409429b964ba + request_id: 78bd0342-5de0-43fe-adab-55d1a402a788 errors: - code: assignee_not_found message: Assignee not found @@ -9683,7 +9710,7 @@ paths: Unauthorized: value: type: error.list - request_id: '08101b0c-8964-4e53-93d5-fb15ff5cf916' + request_id: 47825dc7-c551-48c3-8a70-f3802c3394ab errors: - code: unauthorized message: Access Token Invalid @@ -9703,8 +9730,8 @@ paths: description: there is a problem state: in_progress assignment: - admin_id: '991282225' - assignee_id: '991282227' + admin_id: '991270877' + assignee_id: '991270879' open: true snoozed_until: 1673609604 admin_not_found: @@ -9716,7 +9743,7 @@ paths: state: in_progress assignment: admin_id: '123' - assignee_id: '991282235' + assignee_id: '991270887' assignee_not_found: summary: Assignee not found value: @@ -9725,7 +9752,7 @@ paths: description: there is a problem state: in_progress assignment: - admin_id: '991282241' + admin_id: '991270893' assignee_id: '456' get: summary: Retrieve a ticket @@ -9753,7 +9780,7 @@ paths: Ticket found: value: type: ticket - id: '4750' + id: '1392' ticket_attributes: title: attribute_value description: @@ -9762,21 +9789,21 @@ paths: ticket_state_external_label: Submitted ticket_type: type: ticket_type - id: '872' + id: '248' name: my-ticket-type-12 description: my ticket type description is awesome. icon: "\U0001F981" - workspace_id: this_is_an_id633_that_should_be_at_least_ + workspace_id: this_is_an_id644_that_should_be_at_least_ archived: false - created_at: 1712222832 - updated_at: 1712222832 + created_at: 1715077388 + updated_at: 1715077388 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '2412' - workspace_id: this_is_an_id633_that_should_be_at_least_ + id: '681' + workspace_id: this_is_an_id644_that_should_be_at_least_ name: title description: ola data_type: string @@ -9787,13 +9814,13 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 872 + ticket_type_id: 248 archived: false - created_at: 1712222832 - updated_at: 1712222832 + created_at: 1715077388 + updated_at: 1715077388 - type: ticket_type_attribute - id: '2413' - workspace_id: this_is_an_id633_that_should_be_at_least_ + id: '682' + workspace_id: this_is_an_id644_that_should_be_at_least_ name: description description: ola data_type: string @@ -9804,34 +9831,34 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 872 + ticket_type_id: 248 archived: false - created_at: 1712222832 - updated_at: 1712222832 + created_at: 1715077388 + updated_at: 1715077388 contacts: type: contact.list contacts: - - id: 660e72706abd01bb40bdc53c + - id: 663a010cf7676c5662aebc19 role: lead admin_assignee_id: '0' team_assignee_id: '0' - created_at: 1712222832 - updated_at: 1712222833 + created_at: 1715077388 + updated_at: 1715077389 ticket_parts: type: ticket_part.list ticket_parts: - type: ticket_part - id: '1110' + id: '311' part_type: ticket_state_updated_by_admin ticket_state: submitted previous_ticket_state: submitted - created_at: 1712222833 - updated_at: 1712222833 + created_at: 1715077389 + updated_at: 1715077389 author: - id: '991282254' + id: '991270906' type: admin - name: Ciaran427 Lee - email: admin427@email.com + name: Ciaran438 Lee + email: admin438@email.com attachments: [] redacted: false total_count: 1 @@ -9845,7 +9872,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9edd1e77-2b74-49b6-986d-3693a8cb3719 + request_id: 937b4a88-7dbd-4cfd-ac01-5ae55b10b3a4 errors: - code: unauthorized message: Access Token Invalid @@ -9877,26 +9904,26 @@ paths: successful: value: type: visitor - id: 660e72746abd01bb40bdc53f + id: 663a0110f7676c5662aebc1c user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' phone: name: Gareth Bale - pseudonym: Pink Butterfly + pseudonym: Mint Bear avatar: type: avatar - image_url: https://static.intercomassets.com/app/pseudonym_avatars_2019/pink-butterfly.png - app_id: this_is_an_id640_that_should_be_at_least_ + image_url: https://static.intercomassets.com/app/pseudonym_avatars_2019/mint-bear.png + app_id: this_is_an_id651_that_should_be_at_least_ companies: type: company.list companies: [] location_data: {} last_request_at: - created_at: 1712222836 - remote_created_at: 1712222836 - signed_up_at: 1712222836 - updated_at: 1712222837 + created_at: 1715077392 + remote_created_at: 1715077392 + signed_up_at: 1715077392 + updated_at: 1715077392 session_count: 0 social_profiles: type: social_profile.list @@ -9929,7 +9956,7 @@ paths: visitor Not Found: value: type: error.list - request_id: 63e86e26-d99c-4db3-82e1-26488ffce694 + request_id: 4143c45d-fdc6-43ba-bbf3-340b00fed180 errors: - code: not_found message: Visitor Not Found @@ -9943,7 +9970,7 @@ paths: Unauthorized: value: type: error.list - request_id: '0773399d-30f9-42e5-9788-b741c785241c' + request_id: b50967d4-1019-413c-a218-df032159ab99 errors: - code: unauthorized message: Access Token Invalid @@ -9958,7 +9985,7 @@ paths: successful: summary: successful value: - id: 660e72746abd01bb40bdc53f + id: 663a0110f7676c5662aebc1c name: Gareth Bale visitor_not_found: summary: visitor Not Found @@ -9991,107 +10018,7 @@ paths: successful: value: type: visitor - id: 660e72766abd01bb40bdc545 - user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 - anonymous: true - email: '' - phone: - name: - pseudonym: - avatar: - type: avatar - image_url: - app_id: this_is_an_id646_that_should_be_at_least_ - companies: - type: company.list - companies: [] - location_data: {} - last_request_at: - created_at: 1712222838 - remote_created_at: 1712222838 - signed_up_at: 1712222838 - updated_at: 1712222838 - session_count: 0 - social_profiles: - type: social_profile.list - social_profiles: [] - owner_id: - unsubscribed_from_emails: false - marked_email_as_spam: false - has_hard_bounced: false - tags: - type: tag.list - tags: [] - segments: - type: segment.list - segments: [] - custom_attributes: {} - referrer: - utm_campaign: - utm_content: - utm_medium: - utm_source: - utm_term: - do_not_track: - schema: - "$ref": "#/components/schemas/visitor" - '404': - description: Visitor not found - content: - application/json: - examples: - Visitor not found: - value: - type: error.list - request_id: 3628833a-3f4c-4b1c-84ae-07a029d68981 - errors: - - code: not_found - message: Visitor Not Found - schema: - "$ref": "#/components/schemas/error" - '401': - description: Unauthorized - content: - application/json: - examples: - Unauthorized: - value: - type: error.list - request_id: 92905691-0088-410d-95ea-1d8acfe2418c - errors: - - code: unauthorized - message: Access Token Invalid - schema: - "$ref": "#/components/schemas/error" - "/visitors/{id}": - get: - summary: Retrieve a visitor with ID - parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - - name: id - in: path - required: true - description: Id provided by Intercom. - example: 5e1c4c1c-7b1e-4b5d-8c1c-5e1c4c1c7b1e - schema: - type: string - tags: - - Visitors - operationId: retrieveVisitor - description: You can fetch the details of a single visitor. - responses: - '200': - description: successful - content: - application/json: - examples: - successful: - value: - type: visitor - id: 660e72786abd01bb40bdc54b + id: 663a0111f7676c5662aebc22 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' @@ -10101,16 +10028,16 @@ paths: avatar: type: avatar image_url: - app_id: this_is_an_id652_that_should_be_at_least_ + app_id: this_is_an_id657_that_should_be_at_least_ companies: type: company.list companies: [] location_data: {} last_request_at: - created_at: 1712222840 - remote_created_at: 1712222840 - signed_up_at: 1712222840 - updated_at: 1712222840 + created_at: 1715077393 + remote_created_at: 1715077393 + signed_up_at: 1715077393 + updated_at: 1715077393 session_count: 0 social_profiles: type: social_profile.list @@ -10143,7 +10070,7 @@ paths: Visitor not found: value: type: error.list - request_id: 7bed5f39-edc1-4596-8872-01e594777af8 + request_id: b1aa15c8-ee1e-4782-aa5a-430cb0641cb9 errors: - code: not_found message: Visitor Not Found @@ -10157,106 +10084,7 @@ paths: Unauthorized: value: type: error.list - request_id: 6d954527-238c-4a20-b477-1ed2de48f9cb - errors: - - code: unauthorized - message: Access Token Invalid - schema: - "$ref": "#/components/schemas/error" - delete: - summary: Delete a visitor - parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - - name: id - in: path - required: true - description: Id provided by Intercom. - example: 5e1c4c1c-7b1e-4b5d-8c1c-5e1c4c1c7b1e - schema: - type: string - tags: - - Visitors - operationId: deleteVisitor - description: You can delete a single visitor. - responses: - '200': - description: successful - content: - application/json: - examples: - successful: - value: - type: visitor - id: 660e727a6abd01bb40bdc551 - user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 - anonymous: true - email: '' - phone: - name: - pseudonym: - avatar: - type: avatar - image_url: - app_id: this_is_an_id658_that_should_be_at_least_ - companies: - type: company.list - companies: [] - location_data: {} - last_request_at: - created_at: 1712222842 - remote_created_at: 1712222842 - signed_up_at: 1712222842 - updated_at: 1712222842 - session_count: 0 - social_profiles: - type: social_profile.list - social_profiles: [] - owner_id: - unsubscribed_from_emails: false - marked_email_as_spam: false - has_hard_bounced: false - tags: - type: tag.list - tags: [] - segments: - type: segment.list - segments: [] - custom_attributes: {} - referrer: - utm_campaign: - utm_content: - utm_medium: - utm_source: - utm_term: - do_not_track: - schema: - "$ref": "#/components/schemas/visitor_deleted_object" - '404': - description: Visitor Not Found - content: - application/json: - examples: - Visitor Not Found: - value: - type: error.list - request_id: cb8e48da-f086-48f8-a868-dab875c8e7dd - errors: - - code: not_found - message: User Not Found - schema: - "$ref": "#/components/schemas/error" - '401': - description: Unauthorized - content: - application/json: - examples: - Unauthorized: - value: - type: error.list - request_id: 42b8d092-fa21-46cb-a874-b23a24a4f906 + request_id: 128f5dca-0a47-4ea9-9e64-91a0de433dee errors: - code: unauthorized message: Access Token Invalid @@ -10287,8 +10115,8 @@ paths: successful: value: type: contact - id: 660e727c6abd01bb40bdc558 - workspace_id: this_is_an_id664_that_should_be_at_least_ + id: 663a0113f7676c5662aebc29 + workspace_id: this_is_an_id663_that_should_be_at_least_ external_id: role: user email: foo@bar.com @@ -10302,9 +10130,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1712222844 - updated_at: 1712222844 - signed_up_at: 1712222844 + created_at: 1715077395 + updated_at: 1715077395 + signed_up_at: 1715077395 last_seen_at: last_replied_at: last_contacted_at: @@ -10338,31 +10166,31 @@ paths: tags: type: list data: [] - url: "/contacts/660e727c6abd01bb40bdc558/tags" + url: "/contacts/663a0113f7676c5662aebc29/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/660e727c6abd01bb40bdc558/notes" + url: "/contacts/663a0113f7676c5662aebc29/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/660e727c6abd01bb40bdc558/companies" + url: "/contacts/663a0113f7676c5662aebc29/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/660e727c6abd01bb40bdc558/subscriptions" + url: "/contacts/663a0113f7676c5662aebc29/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/660e727c6abd01bb40bdc558/subscriptions" + url: "/contacts/663a0113f7676c5662aebc29/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -10381,7 +10209,7 @@ paths: Unauthorized: value: type: error.list - request_id: 99a5543a-768f-4121-9fc0-7ebacdfdf4b3 + request_id: 5a208417-bb77-4d24-b06a-023f450ad770 errors: - code: unauthorized message: Access Token Invalid @@ -13382,6 +13210,11 @@ components: - email example: - id: '1234' + company_id: + type: string + description: The ID of the company that the ticket is associated with. The + ID that you set upon company creation. + example: '1234' ticket_attributes: "$ref": "#/components/schemas/ticket_request_custom_attributes" required: @@ -14369,6 +14202,7 @@ components: - '2.8' - '2.9' - '2.10' + - '2.11' - Unstable merge_contacts_request: description: Merge contact data. @@ -14436,6 +14270,8 @@ components: - body - message_type multiple_filter_search_request: + title: Multiple Filter Search Request + description: Search using Intercoms Search APIs with more than one filter. type: object properties: operator: @@ -15083,12 +14919,14 @@ components: description: A pagination object, which may be empty, indicating no further pages to fetch. single_filter_search_request: + title: Single Filter Search Request + description: Search using Intercoms Search APIs with a single filter. type: object properties: field: type: string - description: The Intercom defined id representing the company. - example: custom_attributes.social_network + description: The accepted field that you want to search on. + example: created_at operator: type: string enum: @@ -15102,12 +14940,13 @@ components: - "!~" - "^" - "$" - description: The Intercom defined id representing the company. - example: "=" + description: The accepted operators you can use to define how you want to + search for the value. + example: ">" value: type: string - description: The Intercom defined id representing the company. - example: facebook + description: The value that you want to search on. + example: '73732934' sla_applied: title: Applied SLA type: object @@ -15180,16 +15019,20 @@ components: description: The name of the Social media profile example: http://twitter.com/th1sland starting_after_paging: - title: StartingAfterPaging + title: 'Pagination: Starting After' type: object nullable: true properties: - page: + per_page: type: integer + description: The number of results to fetch per page. example: 2 starting_after: type: string - example: 1HaSB+xrOyyMXAkS/c1RteCL7BzOzTvYjmjakgTergIH31eoe2v4/sbLsJWP\nIncfQLD3ouPkZlCwJ86F\n + description: The cursor to use in the next request to get the next page + of results. + nullable: true + example: your-cursor-from-response subscription_type: title: Subscription Types type: object