diff --git a/descriptions/0/api.intercom.io.yaml b/descriptions/0/api.intercom.io.yaml index 1dbb460..6327338 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: '991267459' + id: '991266214' 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: 1734537243 + created_at: 1744295175 secure: false identity_verification: false timezone: America/Los_Angeles @@ -83,11 +83,12 @@ paths: Successful response: value: type: admin - id: '991267460' + id: '991266215' name: Ciaran2 Lee email: admin2@email.com away_mode_enabled: true away_mode_reassign: true + away_status_reason_id: has_inbox_seat: true team_ids: [] schema: @@ -100,7 +101,7 @@ paths: Admin not found: value: type: error.list - request_id: efcd0531-798b-4c22-bccd-68877ed7faa4 + request_id: bf4dea34-dd0c-47a6-857d-c6320ec6a818 errors: - code: admin_not_found message: Admin for admin_id not found @@ -114,7 +115,7 @@ paths: Unauthorized: value: type: error.list - request_id: e76b2df0-2413-4215-8a5a-b5f6ebd4e642 + request_id: dde542a6-de28-423d-b94a-f138921b19df errors: - code: unauthorized message: Access Token Invalid @@ -201,23 +202,23 @@ paths: per_page: 20 total_pages: 1 activity_logs: - - id: fca05814-4b72-4dce-ad4f-77a786a2c136 + - id: df018e53-066b-454e-8fa3-26805fbc91b6 performed_by: type: admin - id: '991267464' + id: '991266219' email: admin5@email.com ip: 127.0.0.1 metadata: before: before after: after - created_at: 1734537253 + created_at: 1744295182 activity_type: app_name_change activity_description: Ciaran5 Lee changed your app name from before to after. - - id: f48c653b-0185-48ac-a276-23d11006bafb + - id: 95359045-c37a-4697-aac5-34feb1114f6f performed_by: type: admin - id: '991267464' + id: '991266219' email: admin5@email.com ip: 127.0.0.1 metadata: @@ -226,7 +227,7 @@ paths: title: Initial message title before: Initial message title after: Eventual message title - created_at: 1734537253 + created_at: 1744295182 activity_type: message_state_change activity_description: Ciaran5 Lee changed your Initial message title message from Initial message title to Eventual message @@ -241,7 +242,7 @@ paths: Unauthorized: value: type: error.list - request_id: 57cc6148-2c0a-471b-bd9e-859538110958 + request_id: b971ddfc-4ec0-4414-aa26-25f709fe80ba errors: - code: unauthorized message: Access Token Invalid @@ -271,7 +272,7 @@ paths: admins: - type: admin email: admin7@email.com - id: '991267466' + id: '991266221' name: Ciaran7 Lee away_mode_enabled: false away_mode_reassign: false @@ -287,7 +288,7 @@ paths: Unauthorized: value: type: error.list - request_id: 5ef5682e-f66e-40a4-b828-8592175f83b8 + request_id: 5c00c287-a827-4c7d-9543-d323817fc8e5 errors: - code: unauthorized message: Access Token Invalid @@ -321,11 +322,12 @@ paths: Admin found: value: type: admin - id: '991267468' + id: '991266223' name: Ciaran9 Lee email: admin9@email.com away_mode_enabled: false away_mode_reassign: false + away_status_reason_id: has_inbox_seat: true team_ids: [] schema: @@ -338,7 +340,7 @@ paths: Admin not found: value: type: error.list - request_id: c59f7ca5-1639-4284-a66d-50e34ed98ab3 + request_id: 23477dc9-e6ae-423c-9148-c54963baa331 errors: - code: admin_not_found message: Admin not found @@ -352,7 +354,7 @@ paths: Unauthorized: value: type: error.list - request_id: ff783bc1-754f-4a9f-887b-22f94fec18f0 + request_id: 6843e92d-df46-4155-8d13-4f5ebd6ce886 errors: - code: unauthorized message: Access Token Invalid @@ -379,30 +381,30 @@ paths: successful: value: data: - - id: 33 + - id: 1 type: content_import_source - last_synced_at: 1734537259 + last_synced_at: 1744295186 status: active url: https://support.example.com/us/1 sync_behavior: automatic - created_at: 1734537259 - updated_at: 1734537259 - - id: 34 + created_at: 1744295186 + updated_at: 1744295186 + - id: 2 type: content_import_source - last_synced_at: 1734537259 + last_synced_at: 1744295186 status: active url: https://support.example.com/us/2 sync_behavior: automatic - created_at: 1734537259 - updated_at: 1734537259 - - id: 35 + created_at: 1744295186 + updated_at: 1744295186 + - id: 3 type: content_import_source - last_synced_at: 1734537259 + last_synced_at: 1744295186 status: active url: https://support.example.com/us/3 sync_behavior: automatic - created_at: 1734537259 - updated_at: 1734537259 + created_at: 1744295186 + updated_at: 1744295186 pages: type: pages page: 1 @@ -420,7 +422,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9e554e0f-ed0a-4fc6-b141-105d70c9d485 + request_id: 7d2e28c7-1d6c-4fc7-ba1a-877bd96500cc errors: - code: unauthorized message: Access Token Invalid @@ -446,14 +448,14 @@ paths: examples: successful: value: - id: 36 + id: 4 type: content_import_source - last_synced_at: 1734537261 + last_synced_at: 1744295187 status: active url: https://www.example.com sync_behavior: api - created_at: 1734537261 - updated_at: 1734537261 + created_at: 1744295187 + updated_at: 1744295187 schema: "$ref": "#/components/schemas/content_import_source" '401': @@ -464,7 +466,7 @@ paths: Unauthorized: value: type: error.list - request_id: 31262ee6-aa3b-4748-a260-a1084754ebae + request_id: 33625097-df53-4f14-877f-22a0283ad13a errors: - code: unauthorized message: Access Token Invalid @@ -514,7 +516,7 @@ paths: Unauthorized: value: type: error.list - request_id: '093e1dd9-996a-4154-a64c-80803a5c2084' + request_id: d9de5025-356d-4500-9577-9eaabc73780c errors: - code: unauthorized message: Access Token Invalid @@ -538,14 +540,14 @@ paths: examples: successful: value: - id: 38 + id: 6 type: content_import_source - last_synced_at: 1734537265 + last_synced_at: 1744295190 status: active url: https://support.example.com/us/5 sync_behavior: api - created_at: 1734537265 - updated_at: 1734537265 + created_at: 1744295190 + updated_at: 1744295190 schema: "$ref": "#/components/schemas/content_import_source" '401': @@ -556,7 +558,7 @@ paths: Unauthorized: value: type: error.list - request_id: 5556d3dd-d4e2-4424-9757-2ad0accb52e5 + request_id: 3594f8cd-c7d6-4c99-a11e-3988214b3cf4 errors: - code: unauthorized message: Access Token Invalid @@ -581,14 +583,14 @@ paths: examples: successful: value: - id: 39 + id: 7 type: content_import_source - last_synced_at: 1734537267 + last_synced_at: 1744295191 status: active url: https://www.example.com sync_behavior: api - created_at: 1734537267 - updated_at: 1734537267 + created_at: 1744295191 + updated_at: 1744295191 schema: "$ref": "#/components/schemas/content_import_source" '401': @@ -599,7 +601,7 @@ paths: Unauthorized: value: type: error.list - request_id: cb4a6795-2cdb-44f9-adb7-0624702f7e8a + request_id: 235bc351-ca58-46bd-8156-67ab1bb08e36 errors: - code: unauthorized message: Access Token Invalid @@ -637,7 +639,7 @@ paths: successful: value: data: - - id: '19' + - id: '3' type: external_page title: My External Content html: "

Hello world

This is external content

" @@ -646,12 +648,12 @@ paths: ai_copilot_availability: true fin_availability: true locale: en - source_id: 42 + source_id: 10 external_id: '3' - created_at: 1734537269 - updated_at: 1734537269 - last_ingested_at: 1734537269 - - id: '18' + created_at: 1744295192 + updated_at: 1744295192 + last_ingested_at: 1744295192 + - id: '2' type: external_page title: My External Content html: "

Hello world

This is external content

" @@ -660,12 +662,12 @@ paths: ai_copilot_availability: true fin_availability: true locale: en - source_id: 41 + source_id: 9 external_id: '2' - created_at: 1734537269 - updated_at: 1734537269 - last_ingested_at: 1734537269 - - id: '17' + created_at: 1744295192 + updated_at: 1744295192 + last_ingested_at: 1744295192 + - id: '1' type: external_page title: My External Content html: "

Hello world

This is external content

" @@ -674,11 +676,11 @@ paths: ai_copilot_availability: true fin_availability: true locale: en - source_id: 40 + source_id: 8 external_id: '1' - created_at: 1734537269 - updated_at: 1734537269 - last_ingested_at: 1734537269 + created_at: 1744295192 + updated_at: 1744295192 + last_ingested_at: 1744295192 pages: type: pages page: 1 @@ -696,7 +698,7 @@ paths: Unauthorized: value: type: error.list - request_id: bd0c53dd-d3fd-4095-be25-94537a8ba364 + request_id: 2a3de71c-b706-4163-bb7c-347c64177ea1 errors: - code: unauthorized message: Access Token Invalid @@ -723,7 +725,7 @@ paths: examples: successful: value: - id: '21' + id: '5' type: external_page title: Test html: "

Test

" @@ -732,11 +734,11 @@ paths: ai_copilot_availability: true fin_availability: true locale: en - source_id: 44 + source_id: 12 external_id: abc1234 - created_at: 1734537273 - updated_at: 1734537274 - last_ingested_at: 1734537274 + created_at: 1744295194 + updated_at: 1744295194 + last_ingested_at: 1744295194 schema: "$ref": "#/components/schemas/external_page" '401': @@ -747,7 +749,7 @@ paths: Unauthorized: value: type: error.list - request_id: 205ffc13-1b25-43b2-a176-cb817af5f899 + request_id: 3f0ecdd2-758c-413a-a1c4-d19d27e6e978 errors: - code: unauthorized message: Access Token Invalid @@ -765,7 +767,7 @@ paths: external_id: abc1234 html: "

Test

" locale: en - source_id: 44 + source_id: 12 title: Test url: https://www.example.com "/ai/external_pages/{id}": @@ -796,7 +798,7 @@ paths: examples: successful: value: - id: '22' + id: '6' type: external_page title: My External Content html: '' @@ -805,11 +807,11 @@ paths: ai_copilot_availability: true fin_availability: true locale: en - source_id: 45 + source_id: 13 external_id: '4' - created_at: 1734537276 - updated_at: 1734537276 - last_ingested_at: 1734537276 + created_at: 1744295195 + updated_at: 1744295195 + last_ingested_at: 1744295195 schema: "$ref": "#/components/schemas/external_page" '401': @@ -820,7 +822,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2380cdd5-c4a0-451a-b07d-a6f4b720add3 + request_id: 7709f26f-0c22-4aa4-aaff-6de6e72e6cf3 errors: - code: unauthorized message: Access Token Invalid @@ -845,7 +847,7 @@ paths: examples: successful: value: - id: '23' + id: '7' type: external_page title: My External Content html: "

Hello world

This is external content

" @@ -854,11 +856,11 @@ paths: ai_copilot_availability: true fin_availability: true locale: en - source_id: 46 + source_id: 14 external_id: '5' - created_at: 1734537278 - updated_at: 1734537278 - last_ingested_at: 1734537278 + created_at: 1744295197 + updated_at: 1744295197 + last_ingested_at: 1744295197 schema: "$ref": "#/components/schemas/external_page" '401': @@ -869,7 +871,7 @@ paths: Unauthorized: value: type: error.list - request_id: 504cde98-f786-4f64-b373-e26a6a41fd11 + request_id: 76e1ad70-2041-468d-95dd-3f11a857362a errors: - code: unauthorized message: Access Token Invalid @@ -895,7 +897,7 @@ paths: examples: successful: value: - id: '24' + id: '8' type: external_page title: Test html: "

Test

" @@ -904,11 +906,11 @@ paths: ai_copilot_availability: true fin_availability: true locale: en - source_id: 47 + source_id: 15 external_id: '5678' - created_at: 1734537280 - updated_at: 1734537281 - last_ingested_at: 1734537281 + created_at: 1744295198 + updated_at: 1744295198 + last_ingested_at: 1744295198 schema: "$ref": "#/components/schemas/external_page" '401': @@ -919,7 +921,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8217b189-b908-4562-962d-2a19a7b77f25 + request_id: 8e82bfb9-0d37-4cbe-baff-d6c3638deb0c errors: - code: unauthorized message: Access Token Invalid @@ -937,7 +939,7 @@ paths: external_id: '5678' html: "

Test

" locale: en - source_id: 47 + source_id: 15 title: Test url: https://www.example.com "/articles": @@ -972,10 +974,10 @@ paths: total_pages: 1 total_count: 1 data: - - id: '39' + - id: '1' type: article workspace_id: this_is_an_id64_that_should_be_at_least_4 - parent_id: 143 + parent_id: 1 parent_type: collection parent_ids: [] tags: @@ -984,11 +986,11 @@ paths: title: This is the article title description: '' body: '' - author_id: 991267492 + author_id: 991266247 state: published - created_at: 1734537283 - updated_at: 1734537283 - url: http://help-center.test/myapp-64/en/articles/39-this-is-the-article-title + created_at: 1744295199 + updated_at: 1744295199 + url: http://help-center.test/myapp-64/en/articles/1-this-is-the-article-title schema: "$ref": "#/components/schemas/article_list" '401': @@ -999,7 +1001,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2e760b85-9020-471b-89dc-f579ec8a0104 + request_id: 6d97fef9-7a07-4051-9d3d-57cf765ef87e errors: - code: unauthorized message: Access Token Invalid @@ -1024,10 +1026,10 @@ paths: examples: article created: value: - id: '42' + id: '4' type: article workspace_id: this_is_an_id68_that_should_be_at_least_4 - parent_id: 145 + parent_id: 3 parent_type: collection parent_ids: [] statistics: @@ -1044,11 +1046,11 @@ paths: title: Thanks for everything description: Description of the Article body:

Body of the Article

- author_id: 991267497 + author_id: 991266252 state: published - created_at: 1734537288 - updated_at: 1734537288 - url: http://help-center.test/myapp-68/en/articles/42-thanks-for-everything + created_at: 1744295201 + updated_at: 1744295201 + url: http://help-center.test/myapp-68/en/articles/4-thanks-for-everything schema: "$ref": "#/components/schemas/article" '400': @@ -1059,7 +1061,7 @@ paths: Bad Request: value: type: error.list - request_id: e522ca8a-cd15-404e-84b3-7f7536003d4a + request_id: 9b270237-bfca-4c9e-b5d4-3b2f0194c4dc errors: - code: parameter_not_found message: author_id must be in the main body or default locale @@ -1074,7 +1076,7 @@ paths: Unauthorized: value: type: error.list - request_id: 85e91429-72df-4e69-8a12-b55793dff59f + request_id: aa663a0d-3abf-4e6a-89d0-dad8d692343c errors: - code: unauthorized message: Access Token Invalid @@ -1092,16 +1094,16 @@ paths: title: Thanks for everything description: Description of the Article body: Body of the Article - author_id: 991267497 + author_id: 991266252 state: published - parent_id: 145 + parent_id: 3 parent_type: collection translated_content: fr: title: Merci pour tout description: Description de l'article body: Corps de l'article - author_id: 991267497 + author_id: 991266252 state: published bad_request: summary: Bad Request @@ -1138,10 +1140,10 @@ paths: examples: Article found: value: - id: '45' + id: '7' type: article workspace_id: this_is_an_id74_that_should_be_at_least_4 - parent_id: 148 + parent_id: 6 parent_type: collection parent_ids: [] statistics: @@ -1158,11 +1160,11 @@ paths: title: This is the article title description: '' body: '' - author_id: 991267502 + author_id: 991266257 state: published - created_at: 1734537292 - updated_at: 1734537292 - url: http://help-center.test/myapp-74/en/articles/45-this-is-the-article-title + created_at: 1744295203 + updated_at: 1744295203 + url: http://help-center.test/myapp-74/en/articles/7-this-is-the-article-title schema: "$ref": "#/components/schemas/article" '404': @@ -1173,7 +1175,7 @@ paths: Article not found: value: type: error.list - request_id: 79abd27a-1bfb-42ec-a404-5728c76ba773 + request_id: a67b8929-6b42-4858-8ecc-74e960d63a64 errors: - code: not_found message: Resource Not Found @@ -1187,7 +1189,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2eab07fb-5092-49a4-ba74-44094f31f264 + request_id: a595b425-4468-4a46-a247-7b0ec4113eb0 errors: - code: unauthorized message: Access Token Invalid @@ -1220,10 +1222,10 @@ paths: examples: successful: value: - id: '48' + id: '10' type: article workspace_id: this_is_an_id80_that_should_be_at_least_4 - parent_id: 151 + parent_id: 9 parent_type: collection parent_ids: [] statistics: @@ -1240,11 +1242,11 @@ paths: title: Christmas is here! description: '' body:

New gifts in store for the jolly season

- author_id: 991267508 + author_id: 991266263 state: published - created_at: 1734537297 - updated_at: 1734537298 - url: http://help-center.test/myapp-80/en/articles/48-christmas-is-here + created_at: 1744295206 + updated_at: 1744295207 + url: http://help-center.test/myapp-80/en/articles/10-christmas-is-here schema: "$ref": "#/components/schemas/article" '404': @@ -1255,7 +1257,7 @@ paths: Article Not Found: value: type: error.list - request_id: f9adccb2-9fca-4b87-bbb7-65f2af5e1d78 + request_id: 371bd9ca-fa0d-4409-b43e-cbe3e58b4215 errors: - code: not_found message: Resource Not Found @@ -1269,7 +1271,7 @@ paths: Unauthorized: value: type: error.list - request_id: d1ea223d-bb62-42e3-8bcf-30fdcf7dbd99 + request_id: 95775333-1583-4c67-b612-331a670c69ca errors: - code: unauthorized message: Access Token Invalid @@ -1317,7 +1319,7 @@ paths: examples: successful: value: - id: '51' + id: '13' object: article deleted: true schema: @@ -1330,7 +1332,7 @@ paths: Article Not Found: value: type: error.list - request_id: afe37506-cc48-4727-8068-ae7ff0e7b0e3 + request_id: 60b8b4a7-ecd6-4fa5-8fe5-df7bf20f7085 errors: - code: not_found message: Resource Not Found @@ -1344,7 +1346,7 @@ paths: Unauthorized: value: type: error.list - request_id: c6e86ce8-9402-4196-89c5-f1b2912b4bac + request_id: f34df361-80ed-45c5-b005-1393b00babac errors: - code: unauthorized message: Access Token Invalid @@ -1404,7 +1406,7 @@ paths: total_count: 1 data: articles: - - id: '55' + - id: '17' type: article workspace_id: this_is_an_id92_that_should_be_at_least_4 parent_id: @@ -1416,10 +1418,10 @@ paths: title: Title 1 description: '' body: '' - author_id: 991267521 + author_id: 991266276 state: draft - created_at: 1734537306 - updated_at: 1734537306 + created_at: 1744295211 + updated_at: 1744295211 url: highlights: [] pages: @@ -1437,7 +1439,7 @@ paths: Unauthorized: value: type: error.list - request_id: c70746a8-a5b2-4772-afba-1a4b487ea75d + request_id: 35f8668d-0376-476c-80ac-acfa44e9c182 errors: - code: unauthorized message: Access Token Invalid @@ -1468,27 +1470,27 @@ paths: value: type: list data: - - id: '159' + - id: '17' 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: 1734537309 - updated_at: 1734537309 + created_at: 1744295213 + updated_at: 1744295213 description: english collection description icon: bookmark parent_id: - help_center_id: 79 - - id: '160' + help_center_id: 17 + - id: '18' 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: 1734537309 - updated_at: 1734537309 + created_at: 1744295213 + updated_at: 1744295213 description: icon: bookmark - parent_id: '159' + parent_id: '17' help_center_id: total_count: 2 pages: @@ -1506,7 +1508,7 @@ paths: Unauthorized: value: type: error.list - request_id: 12c2d3a0-77ef-462e-a5ed-e67ddff50b6e + request_id: b5acd3db-ec81-4ce9-bcd1-17b21ae34254 errors: - code: unauthorized message: Access Token Invalid @@ -1531,17 +1533,17 @@ paths: examples: collection created: value: - id: '165' + id: '23' 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: 1734537312 - updated_at: 1734537312 + created_at: 1744295214 + updated_at: 1744295214 description: '' icon: book-bookmark parent_id: - help_center_id: 81 + help_center_id: 19 schema: "$ref": "#/components/schemas/collection" '400': @@ -1552,7 +1554,7 @@ paths: Bad Request: value: type: error.list - request_id: 816186b3-3187-4b47-adf8-e201bea32208 + request_id: 9245cb0b-6c14-412a-81ad-e3aee8e0126d errors: - code: parameter_not_found message: Name is a required parameter. @@ -1566,7 +1568,7 @@ paths: Unauthorized: value: type: error.list - request_id: 25d96ec2-641f-4354-b24e-83a85d33bd30 + request_id: 7914ed0d-3704-46b4-b701-ff7a42dfa508 errors: - code: unauthorized message: Access Token Invalid @@ -1614,17 +1616,17 @@ paths: examples: Collection found: value: - id: '170' + id: '28' 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: 1734537315 - updated_at: 1734537315 + created_at: 1744295216 + updated_at: 1744295216 description: english collection description icon: bookmark parent_id: - help_center_id: 84 + help_center_id: 22 schema: "$ref": "#/components/schemas/collection" '404': @@ -1635,7 +1637,7 @@ paths: Collection not found: value: type: error.list - request_id: a074a09e-97d1-44e2-b164-b703559c9f23 + request_id: '05985e61-e558-496b-a716-deaca4c98813' errors: - code: not_found message: Resource Not Found @@ -1649,7 +1651,7 @@ paths: Unauthorized: value: type: error.list - request_id: a29395a5-181c-4f3b-b069-5b2f32604c58 + request_id: 2d4f62f0-f0ef-48e3-a703-6dcc364420dc errors: - code: unauthorized message: Access Token Invalid @@ -1682,17 +1684,17 @@ paths: examples: successful: value: - id: '176' + id: '34' 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: 1734537318 - updated_at: 1734537319 + created_at: 1744295218 + updated_at: 1744295218 description: english collection description icon: folder parent_id: - help_center_id: 87 + help_center_id: 25 schema: "$ref": "#/components/schemas/collection" '404': @@ -1703,7 +1705,7 @@ paths: Collection Not Found: value: type: error.list - request_id: 198e3add-d017-4e18-b478-fbe2cb8c538b + request_id: 8cfdbcec-49f6-4116-bd64-83e8cb2414bd errors: - code: not_found message: Resource Not Found @@ -1717,7 +1719,7 @@ paths: Unauthorized: value: type: error.list - request_id: b286edcc-453d-43af-bf2f-40f303708c61 + request_id: dfd04f44-5018-42b9-ab21-b6d8198c80a9 errors: - code: unauthorized message: Access Token Invalid @@ -1764,7 +1766,7 @@ paths: examples: successful: value: - id: '182' + id: '40' object: collection deleted: true schema: @@ -1777,7 +1779,7 @@ paths: collection Not Found: value: type: error.list - request_id: f0d0ea9b-ffaf-48f5-95d0-e99531c379e2 + request_id: 6b83058a-7915-440e-8a1a-ec61a11866ea errors: - code: not_found message: Resource Not Found @@ -1791,7 +1793,7 @@ paths: Unauthorized: value: type: error.list - request_id: d0d16fb5-93e6-45ca-b07d-f98fb92fd733 + request_id: 325ce4d9-ba87-4ff1-b1f2-11c962055ba4 errors: - code: unauthorized message: Access Token Invalid @@ -1825,10 +1827,10 @@ paths: examples: Collection found: value: - id: '93' + id: '31' workspace_id: this_is_an_id124_that_should_be_at_least_ - created_at: 1734537325 - updated_at: 1734537325 + created_at: 1744295221 + updated_at: 1744295221 identifier: help-center-1 website_turned_on: false display_name: Intercom Help Center @@ -1842,7 +1844,7 @@ paths: Collection not found: value: type: error.list - request_id: bbd5de60-49c4-4850-afff-1226cdaa0beb + request_id: 44be5bbb-509c-4573-b289-1e66e7870e03 errors: - code: not_found message: Resource Not Found @@ -1856,7 +1858,7 @@ paths: Unauthorized: value: type: error.list - request_id: c7c301f6-9206-418b-9792-98821970e48b + request_id: 303d8621-cb8d-4ea2-b800-7d23fb087e62 errors: - code: unauthorized message: Access Token Invalid @@ -1894,7 +1896,7 @@ paths: Unauthorized: value: type: error.list - request_id: 76edbbb7-e463-4f6a-817a-b7905d467535 + request_id: e255810a-d9bc-41b4-b642-10617675c70b errors: - code: unauthorized message: Access Token Invalid @@ -1931,12 +1933,12 @@ paths: value: type: company company_id: company_remote_id - id: 6762f0761bb69f9f2193bae2 + id: 67f7d53ccc99153fd67530e3 app_id: this_is_an_id147_that_should_be_at_least_ name: my company remote_created_at: 1374138000 - created_at: 1734537334 - updated_at: 1734537334 + created_at: 1744295228 + updated_at: 1744295228 monthly_spend: 0 session_count: 0 user_count: 0 @@ -1973,7 +1975,7 @@ paths: Unauthorized: value: type: error.list - request_id: 8a9f415f-e9df-41e9-ba1f-739914f66551 + request_id: d1185a1c-8c79-49e1-b883-65d82cab2364 errors: - code: unauthorized message: Access Token Invalid @@ -2071,12 +2073,12 @@ paths: data: - type: company company_id: remote_companies_scroll_2 - id: 6762f07a1bb69f9f2193baea + id: 67f7d53ecc99153fd67530eb app_id: this_is_an_id153_that_should_be_at_least_ name: IntercomQATest1 - remote_created_at: 1734537338 - created_at: 1734537338 - updated_at: 1734537338 + remote_created_at: 1744295230 + created_at: 1744295230 + updated_at: 1744295230 monthly_spend: 0 session_count: 0 user_count: 4 @@ -2105,7 +2107,7 @@ paths: Company Not Found: value: type: error.list - request_id: 9bc4fc62-7cdf-4f72-a56e-02af4836d499 + request_id: b3305c8d-d583-42eb-8ff1-a27ba5282e2d errors: - code: company_not_found message: Company Not Found @@ -2119,7 +2121,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2fa563ba-f9c9-4281-a76b-10bfd777dfd7 + request_id: 7923937e-f840-4b3d-83cd-93f5dcbff778 errors: - code: unauthorized message: Access Token Invalid @@ -2154,12 +2156,12 @@ paths: value: type: company company_id: '1' - id: 6762f07f1bb69f9f2193baf5 + id: 67f7d541cc99153fd67530f6 app_id: this_is_an_id159_that_should_be_at_least_ name: company1 - remote_created_at: 1734537343 - created_at: 1734537343 - updated_at: 1734537343 + remote_created_at: 1744295233 + created_at: 1744295233 + updated_at: 1744295233 monthly_spend: 0 session_count: 0 user_count: 1 @@ -2181,7 +2183,7 @@ paths: Company Not Found: value: type: error.list - request_id: 57d57564-b5e2-4064-abfe-4653e5ac24c0 + request_id: 2d0b8aec-8b5b-40de-9441-a92f932e89e7 errors: - code: company_not_found message: Company Not Found @@ -2195,7 +2197,7 @@ paths: Unauthorized: value: type: error.list - request_id: caf73ce4-bda6-4f2b-bbfb-0d984d430335 + request_id: ad36f8ab-85f9-485f-82ee-4fa05d1d8c5a errors: - code: unauthorized message: Access Token Invalid @@ -2234,12 +2236,12 @@ paths: value: type: company company_id: '1' - id: 6762f0841bb69f9f2193baff + id: 67f7d543cc99153fd6753100 app_id: this_is_an_id165_that_should_be_at_least_ name: company2 - remote_created_at: 1734537348 - created_at: 1734537348 - updated_at: 1734537348 + remote_created_at: 1744295235 + created_at: 1744295235 + updated_at: 1744295235 monthly_spend: 0 session_count: 0 user_count: 1 @@ -2261,7 +2263,7 @@ paths: Company Not Found: value: type: error.list - request_id: daa64b43-3e3c-4fc4-aef9-91eb40c7885c + request_id: 2210a338-848f-4427-86aa-8690d6f84f19 errors: - code: company_not_found message: Company Not Found @@ -2275,7 +2277,7 @@ paths: Unauthorized: value: type: error.list - request_id: 4748eb32-3261-4798-ace0-a5825edf4eb5 + request_id: 9f4a8ff1-8cc8-4dfc-b203-285ae5a4213a errors: - code: unauthorized message: Access Token Invalid @@ -2307,7 +2309,7 @@ paths: examples: Successful: value: - id: 6762f0881bb69f9f2193bb09 + id: 67f7d546cc99153fd675310a object: company deleted: true schema: @@ -2320,7 +2322,7 @@ paths: Company Not Found: value: type: error.list - request_id: 4f41d1d6-7a42-45e3-a24e-544deb62da47 + request_id: f0b6c733-62c7-428c-9ca8-d706fcdfcad2 errors: - code: company_not_found message: Company Not Found @@ -2334,7 +2336,7 @@ paths: Unauthorized: value: type: error.list - request_id: 7b13fd9c-31be-40de-94e1-d71f260a3458 + request_id: 5f1485e8-e80f-4d59-85c4-696d5986d26c errors: - code: unauthorized message: Access Token Invalid @@ -2386,7 +2388,7 @@ paths: Company Not Found: value: type: error.list - request_id: 5dde0b79-8c81-4d9e-a4d4-736a44cf2f00 + request_id: b2f70560-bcc3-48c8-9809-89e42ec6fda9 errors: - code: company_not_found message: Company Not Found @@ -2400,7 +2402,7 @@ paths: Unauthorized: value: type: error.list - request_id: f7586690-c217-47db-9042-cb9550b81260 + request_id: 26720d43-5ba9-4bb5-b604-dda9244b8a4d errors: - code: unauthorized message: Access Token Invalid @@ -2445,7 +2447,7 @@ paths: Company Not Found: value: type: error.list - request_id: de5d939e-77fb-46d7-a3b9-f34199d9f25a + request_id: 2fd339e1-0ff1-483c-ac92-4597e5ff6210 errors: - code: company_not_found message: Company Not Found @@ -2459,7 +2461,7 @@ paths: Unauthorized: value: type: error.list - request_id: 91f04dce-5759-4d80-981e-f598ec989d1a + request_id: 63caeb73-cb2f-4ce5-8509-dd2562681867 errors: - code: unauthorized message: Access Token Invalid @@ -2520,12 +2522,12 @@ paths: data: - type: company company_id: remote_companies_scroll_2 - id: 6762f0941bb69f9f2193bb25 + id: 67f7d54ecc99153fd6753126 app_id: this_is_an_id189_that_should_be_at_least_ name: IntercomQATest1 - remote_created_at: 1734537364 - created_at: 1734537364 - updated_at: 1734537364 + remote_created_at: 1744295246 + created_at: 1744295246 + updated_at: 1744295246 monthly_spend: 0 session_count: 0 user_count: 4 @@ -2554,7 +2556,7 @@ paths: Unauthorized: value: type: error.list - request_id: 537ccc45-2cae-4e72-ac2f-849f1422a771 + request_id: d166ca36-d088-403d-9448-e3de98e5c0bb errors: - code: unauthorized message: Access Token Invalid @@ -2605,12 +2607,12 @@ paths: data: - type: company company_id: remote_companies_scroll_2 - id: 6762f0971bb69f9f2193bb2b + id: 67f7d550cc99153fd675312c app_id: this_is_an_id193_that_should_be_at_least_ name: IntercomQATest1 - remote_created_at: 1734537367 - created_at: 1734537367 - updated_at: 1734537367 + remote_created_at: 1744295248 + created_at: 1744295248 + updated_at: 1744295248 monthly_spend: 0 session_count: 0 user_count: 4 @@ -2624,7 +2626,7 @@ paths: custom_attributes: {} pages: total_count: - scroll_param: 69352cd2-ab5b-42ac-b004-a13d4e55e9b0 + scroll_param: 72d07e49-5ee7-4807-a68d-a142d2af4b59 schema: "$ref": "#/components/schemas/company_scroll" '401': @@ -2635,7 +2637,7 @@ paths: Unauthorized: value: type: error.list - request_id: ca269b05-8c42-4615-a28d-7df0eb1687c5 + request_id: 794bed6e-cf8e-4658-a73b-6298f541f3e0 errors: - code: unauthorized message: Access Token Invalid @@ -2670,12 +2672,12 @@ paths: value: type: company company_id: '1' - id: 6762f09a1bb69f9f2193bb34 + id: 67f7d552cc99153fd6753135 app_id: this_is_an_id197_that_should_be_at_least_ name: company6 - remote_created_at: 1734537370 - created_at: 1734537370 - updated_at: 1734537370 + remote_created_at: 1744295250 + created_at: 1744295250 + updated_at: 1744295250 monthly_spend: 0 session_count: 0 user_count: 1 @@ -2697,7 +2699,7 @@ paths: Bad Request: value: type: error.list - request_id: 8879ee29-ade4-4b5a-a275-ab1ac531b82a + request_id: a260a3e0-66d5-4087-ac43-f6f781129585 errors: - code: parameter_not_found message: company not specified @@ -2711,7 +2713,7 @@ paths: Company Not Found: value: type: error.list - request_id: 981799ea-f19b-432d-828c-491a3b29ad29 + request_id: 3270c6a9-7514-435e-864c-e3e57748a29f errors: - code: company_not_found message: Company Not Found @@ -2725,7 +2727,7 @@ paths: Unauthorized: value: type: error.list - request_id: 1f187e85-cd9a-4be4-964e-cdbb8c66334a + request_id: 1184e58e-030d-4018-896e-b87b065bb284 errors: - code: unauthorized message: Access Token Invalid @@ -2748,7 +2750,7 @@ paths: successful: summary: Successful value: - id: 6762f09a1bb69f9f2193bb34 + id: 67f7d552cc99153fd6753135 bad_request: summary: Bad Request value: @@ -2787,13 +2789,13 @@ paths: data: - type: company company_id: '1' - id: 6762f0a61bb69f9f2193bb55 + id: 67f7d55acc99153fd6753156 app_id: this_is_an_id213_that_should_be_at_least_ name: company12 - remote_created_at: 1734537382 - created_at: 1734537382 - updated_at: 1734537382 - last_request_at: 1734364582 + remote_created_at: 1744295258 + created_at: 1744295258 + updated_at: 1744295258 + last_request_at: 1744122458 monthly_spend: 0 session_count: 0 user_count: 1 @@ -2822,7 +2824,7 @@ paths: Contact not found: value: type: error.list - request_id: 32c856ba-901b-49c4-8e8d-d43fc3ee6ea5 + request_id: c440f233-bffc-42ff-9254-2e3b580f6001 errors: - code: not_found message: User Not Found @@ -2836,7 +2838,7 @@ paths: Unauthorized: value: type: error.list - request_id: 565a4f38-5fa9-451d-bcf0-32076f79517f + request_id: 9f94c101-2535-4bdb-a57b-0599042d3465 errors: - code: unauthorized message: Access Token Invalid @@ -2879,12 +2881,12 @@ paths: value: type: company company_id: '1' - id: 6762f0a01bb69f9f2193bb44 + id: 67f7d556cc99153fd6753145 app_id: this_is_an_id205_that_should_be_at_least_ name: company8 - remote_created_at: 1734537376 - created_at: 1734537376 - updated_at: 1734537377 + remote_created_at: 1744295254 + created_at: 1744295254 + updated_at: 1744295254 monthly_spend: 0 session_count: 0 user_count: 0 @@ -2906,14 +2908,14 @@ paths: Company Not Found: value: type: error.list - request_id: dcfc3465-8a51-4d78-b24c-2f215d48f339 + request_id: 1f518e94-d69b-449c-aa5a-7a3517d4a6db errors: - code: company_not_found message: Company Not Found Contact Not Found: value: type: error.list - request_id: b5a1f332-1bf1-44bd-a068-2634244b6051 + request_id: f207f4e6-8f42-44c2-b4cf-a10192b1310f errors: - code: not_found message: User Not Found @@ -2927,7 +2929,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9bc1e0cc-5cc4-412d-8037-57e073375ab0 + request_id: dda68adc-ab9e-459a-ba37-bb6268b9c586 errors: - code: unauthorized message: Access Token Invalid @@ -2963,46 +2965,55 @@ paths: type: list data: - type: note - id: '26' - created_at: 1733932587 + id: '3' + created_at: 1743690466 contact: type: contact - id: 6762f0ab1bb69f9f2193bb60 + id: 67f7d562cc99153fd6753161 author: type: admin - id: '991267581' + id: '991266336' name: Ciaran122 Lee email: admin122@email.com away_mode_enabled: false away_mode_reassign: false + away_status_reason_id: + has_inbox_seat: true + team_ids: [] body: "

This is a note.

" - type: note - id: '25' - created_at: 1733846187 + id: '2' + created_at: 1743604066 contact: type: contact - id: 6762f0ab1bb69f9f2193bb60 + id: 67f7d562cc99153fd6753161 author: type: admin - id: '991267581' + id: '991266336' name: Ciaran122 Lee email: admin122@email.com away_mode_enabled: false away_mode_reassign: false + away_status_reason_id: + has_inbox_seat: true + team_ids: [] body: "

This is a note.

" - type: note - id: '24' - created_at: 1733846187 + id: '1' + created_at: 1743604066 contact: type: contact - id: 6762f0ab1bb69f9f2193bb60 + id: 67f7d562cc99153fd6753161 author: type: admin - id: '991267581' + id: '991266336' name: Ciaran122 Lee email: admin122@email.com away_mode_enabled: false away_mode_reassign: false + away_status_reason_id: + has_inbox_seat: true + team_ids: [] body: "

This is a note.

" total_count: 3 pages: @@ -3021,7 +3032,7 @@ paths: Contact not found: value: type: error.list - request_id: 57055cde-3d0d-4c67-b5c9-b20b80340bf0 + request_id: 29e76959-123c-4df7-b475-80e5077273ef errors: - code: not_found message: User Not Found @@ -3055,18 +3066,21 @@ paths: Successful response: value: type: note - id: '31' - created_at: 1734537390 + id: '8' + created_at: 1744295268 contact: type: contact - id: 6762f0ad1bb69f9f2193bb62 + id: 67f7d564cc99153fd6753163 author: type: admin - id: '991267583' + id: '991266338' name: Ciaran124 Lee email: admin124@email.com away_mode_enabled: false away_mode_reassign: false + away_status_reason_id: + has_inbox_seat: true + team_ids: [] body: "

Hello

" schema: "$ref": "#/components/schemas/note" @@ -3078,14 +3092,14 @@ paths: Admin not found: value: type: error.list - request_id: 168f1bc3-d198-4797-8422-9f93fe8af5ad + request_id: 7b42057f-d814-4eb1-986d-3689e139de87 errors: - code: not_found message: Resource Not Found Contact not found: value: type: error.list - request_id: 6f372239-0259-428f-9943-91b8f7a92162 + request_id: 29bbf30a-932a-494f-ac01-ae4da816723a errors: - code: not_found message: User Not Found @@ -3115,20 +3129,20 @@ paths: successful_response: summary: Successful response value: - contact_id: 6762f0ad1bb69f9f2193bb62 - admin_id: 991267583 + contact_id: 67f7d564cc99153fd6753163 + admin_id: 991266338 body: Hello admin_not_found: summary: Admin not found value: - contact_id: 6762f0af1bb69f9f2193bb63 + contact_id: 67f7d564cc99153fd6753164 admin_id: 123 body: Hello contact_not_found: summary: Contact not found value: contact_id: 123 - admin_id: 991267585 + admin_id: 991266340 body: Hello "/contacts/{contact_id}/segments": get: @@ -3161,10 +3175,10 @@ paths: type: list data: - type: segment - id: 6762f0b21bb69f9f2193bb65 + id: 67f7d566cc99153fd6753166 name: segment - created_at: 1734537394 - updated_at: 1734537394 + created_at: 1744295270 + updated_at: 1744295270 person_type: user schema: "$ref": "#/components/schemas/contact_segments" @@ -3176,7 +3190,7 @@ paths: Contact not found: value: type: error.list - request_id: 61c119c7-b2f0-4158-8457-fd53e83f936a + request_id: 0401d97c-9c06-4a99-9f90-83ccd812139e errors: - code: not_found message: User Not Found @@ -3190,7 +3204,7 @@ paths: Unauthorized: value: type: error.list - request_id: 0273c219-51b7-4938-95d2-19996b2e2734 + request_id: 8d52bcfc-9370-447e-b342-1b165a5c1df8 errors: - code: unauthorized message: Access Token Invalid @@ -3234,7 +3248,7 @@ paths: type: list data: - type: subscription - id: '91' + id: '1' state: live consent_type: opt_out default_translation: @@ -3248,7 +3262,7 @@ paths: content_types: - email - type: subscription - id: '93' + id: '3' state: live consent_type: opt_in default_translation: @@ -3271,7 +3285,7 @@ paths: Contact not found: value: type: error.list - request_id: c9b793ad-ff39-436c-80c9-db6f24d0d444 + request_id: 9a01b0e7-f287-409f-9b43-cfc5d19d0f1a errors: - code: not_found message: User Not Found @@ -3285,7 +3299,7 @@ paths: Unauthorized: value: type: error.list - request_id: 7323b97b-9ba4-4c54-946c-38cecea65b3c + request_id: 9a0c47a6-a55b-449d-9b0e-aa91b46e0faa errors: - code: unauthorized message: Access Token Invalid @@ -3326,7 +3340,7 @@ paths: Successful: value: type: subscription - id: '106' + id: '16' state: live consent_type: opt_in default_translation: @@ -3349,14 +3363,14 @@ paths: Contact not found: value: type: error.list - request_id: 0c2871af-abed-4bce-a5c5-77efbe721711 + request_id: d5e0e281-c176-448e-8e5e-8ef7292223a5 errors: - code: not_found message: User Not Found Resource not found: value: type: error.list - request_id: 2774db46-34d9-4925-a24d-8203d4a39f65 + request_id: 6ec4665e-f30c-41ef-a45c-75284b240f09 errors: - code: not_found message: Resource Not Found @@ -3370,7 +3384,7 @@ paths: Unauthorized: value: type: error.list - request_id: f615465d-fd5f-4d68-8498-389130b897e4 + request_id: 6924f96a-73da-48a6-8bcc-e3c3ec82866f errors: - code: unauthorized message: Access Token Invalid @@ -3398,12 +3412,12 @@ paths: successful: summary: Successful value: - id: 106 + id: 16 consent_type: opt_in contact_not_found: summary: Contact not found value: - id: 110 + id: 20 consent_type: opt_in resource_not_found: summary: Resource not found @@ -3449,7 +3463,7 @@ paths: Successful: value: type: subscription - id: '122' + id: '32' state: live consent_type: opt_in default_translation: @@ -3472,14 +3486,14 @@ paths: Contact not found: value: type: error.list - request_id: 82b37940-b43f-46ee-a492-11543a317c97 + request_id: b0d7382e-d2a6-4a9b-a47e-90e93092dad4 errors: - code: not_found message: User Not Found Resource not found: value: type: error.list - request_id: c18422ca-5454-42af-9e1d-dd92066e6e9d + request_id: 0b5375df-8ab4-4363-b150-8486a6f88f7d errors: - code: not_found message: Resource Not Found @@ -3493,7 +3507,7 @@ paths: Unauthorized: value: type: error.list - request_id: c7de741d-dc8f-49b1-8cbe-791668ade76c + request_id: d0295478-724c-441d-b5f4-fd4eab6b515f errors: - code: unauthorized message: Access Token Invalid @@ -3531,7 +3545,7 @@ paths: type: list data: - type: tag - id: '80' + id: '1' name: Manual tag schema: "$ref": "#/components/schemas/tag_list" @@ -3543,7 +3557,7 @@ paths: Contact not found: value: type: error.list - request_id: 302049fb-b8c1-4dc8-a327-a8f6e1923484 + request_id: 452b4380-d06d-45a4-ae19-28722ce5768a errors: - code: not_found message: User Not Found @@ -3557,7 +3571,7 @@ paths: Unauthorized: value: type: error.list - request_id: ca3c5e6e-c743-428b-aa8a-ac371a50cc39 + request_id: a096f342-19a7-4985-8798-646cfe62abf2 errors: - code: unauthorized message: Access Token Invalid @@ -3592,7 +3606,7 @@ paths: successful: value: type: tag - id: '81' + id: '2' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -3604,14 +3618,14 @@ paths: Contact not found: value: type: error.list - request_id: f22a7847-ee33-449f-80c0-707efd295a53 + request_id: cf4e1967-1dc5-4b57-b751-0afdefb2e4fa errors: - code: not_found message: User Not Found Tag not found: value: type: error.list - request_id: 8a3e4f88-ae65-433a-b4eb-46780ffc5402 + request_id: f7ebe3d3-e96c-4a8d-a5d1-04b501e546c3 errors: - code: not_found message: Resource Not Found @@ -3625,7 +3639,7 @@ paths: Unauthorized: value: type: error.list - request_id: 9b1c9966-caeb-485a-8419-d707fd472c63 + request_id: 2482a9b3-e3aa-449e-8926-0c4b936dca80 errors: - code: unauthorized message: Access Token Invalid @@ -3648,11 +3662,11 @@ paths: successful: summary: successful value: - id: 81 + id: 2 contact_not_found: summary: Contact not found value: - id: 82 + id: 3 tag_not_found: summary: Tag not found value: @@ -3694,7 +3708,7 @@ paths: successful: value: type: tag - id: '84' + id: '5' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -3706,14 +3720,14 @@ paths: Contact not found: value: type: error.list - request_id: b3d41080-5b35-42b8-8584-31e4660d355f + request_id: 364ac6af-03b9-4f74-9983-7b0b43a6bdf5 errors: - code: not_found message: User Not Found Tag not found: value: type: error.list - request_id: '02871f7a-860e-433a-8545-6a73fbbe5e22' + request_id: 5871a450-652d-4f1e-8316-4ce61e5f7a03 errors: - code: not_found message: Resource Not Found @@ -3727,7 +3741,7 @@ paths: Unauthorized: value: type: error.list - request_id: 491beaa4-a452-4940-85e0-498c0ca5528d + request_id: 0a5736c6-e02f-420f-b4ae-30e322a22ad8 errors: - code: unauthorized message: Access Token Invalid @@ -3750,16 +3764,8 @@ paths: type: string tags: - Contacts - - Custom Object Instances operationId: UpdateContact - description: | - You can update an existing contact (ie. user or lead). - - {% admonition type="info" %} - This endpoint handles both **contact updates** and **custom object associations**. - - See _`update a contact with an association to a custom object instance`_ in the request/response examples to see the custom object association format. - {% /admonition %} + description: You can update an existing contact (ie. user or lead). responses: '200': description: successful @@ -3769,7 +3775,7 @@ paths: successful: value: type: contact - id: 6762f0cd1bb69f9f2193bb7c + id: 67f7d579cc99153fd675317d workspace_id: this_is_an_id279_that_should_be_at_least_ external_id: '70' role: user @@ -3785,9 +3791,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1734537421 - updated_at: 1734537422 - signed_up_at: 1734537421 + created_at: 1744295289 + updated_at: 1744295289 + signed_up_at: 1744295289 last_seen_at: last_replied_at: last_contacted_at: @@ -3821,131 +3827,31 @@ paths: tags: type: list data: [] - url: "/contacts/6762f0cd1bb69f9f2193bb7c/tags" - total_count: 0 - has_more: false - notes: - type: list - data: [] - url: "/contacts/6762f0cd1bb69f9f2193bb7c/notes" - total_count: 0 - has_more: false - companies: - type: list - data: [] - url: "/contacts/6762f0cd1bb69f9f2193bb7c/companies" - total_count: 0 - has_more: false - opted_out_subscription_types: - type: list - data: [] - url: "/contacts/6762f0cd1bb69f9f2193bb7c/subscriptions" - total_count: 0 - has_more: false - opted_in_subscription_types: - type: list - data: [] - url: "/contacts/6762f0cd1bb69f9f2193bb7c/subscriptions" - total_count: 0 - has_more: false - utm_campaign: - utm_content: - utm_medium: - utm_source: - utm_term: - referrer: - enabled_push_messaging: - update a contact with an association to a custom object instance: - value: - type: contact - id: 6762f0cd1bb69f9f2193bb7c - workspace_id: this_is_an_id279_that_should_be_at_least_ - external_id: '70' - role: user - email: joebloggs@intercom.io - phone: - formatted_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: 1734537421 - updated_at: 1734537422 - signed_up_at: 1734537421 - 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: - order: - type: Order.list - instances: - - id: '21' - external_id: '123' - external_created_at: 1392036272 - external_updated_at: 1392036272 - custom_attributes: - order_number: ORDER-12345 - total_amount: 99.99 - type: Order - tags: - type: list - data: [] - url: "/contacts/6762f0cd1bb69f9f2193bb7c/tags" + url: "/contacts/67f7d579cc99153fd675317d/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/6762f0cd1bb69f9f2193bb7c/notes" + url: "/contacts/67f7d579cc99153fd675317d/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/6762f0cd1bb69f9f2193bb7c/companies" + url: "/contacts/67f7d579cc99153fd675317d/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/6762f0cd1bb69f9f2193bb7c/subscriptions" + url: "/contacts/67f7d579cc99153fd675317d/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/6762f0cd1bb69f9f2193bb7c/subscriptions" + url: "/contacts/67f7d579cc99153fd675317d/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -3954,6 +3860,8 @@ paths: utm_source: utm_term: referrer: + sms_consent: false + unsubscribed_from_sms: false enabled_push_messaging: schema: allOf: @@ -3972,7 +3880,7 @@ paths: Unauthorized: value: type: error.list - request_id: 89ce96d9-aae9-4eec-ace2-d68cc4f74879 + request_id: 328e768f-9642-413c-86c7-9d23f212acb5 errors: - code: unauthorized message: Access Token Invalid @@ -3990,13 +3898,6 @@ paths: value: email: joebloggs@intercom.io name: joe bloggs - update_a_contact_with_an_association_to_a_custom_object_instance: - summary: update a contact with an association to a custom object - instance - value: - custom_attributes: - order: - - '21' get: summary: Get a contact parameters: @@ -4024,7 +3925,7 @@ paths: successful: value: type: contact - id: 6762f0d01bb69f9f2193bb7d + id: 67f7d57bcc99153fd675317e workspace_id: this_is_an_id283_that_should_be_at_least_ external_id: '70' role: user @@ -4040,9 +3941,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1734537424 - updated_at: 1734537424 - signed_up_at: 1734537424 + created_at: 1744295291 + updated_at: 1744295291 + signed_up_at: 1744295291 last_seen_at: last_replied_at: last_contacted_at: @@ -4076,31 +3977,31 @@ paths: tags: type: list data: [] - url: "/contacts/6762f0d01bb69f9f2193bb7d/tags" + url: "/contacts/67f7d57bcc99153fd675317e/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/6762f0d01bb69f9f2193bb7d/notes" + url: "/contacts/67f7d57bcc99153fd675317e/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/6762f0d01bb69f9f2193bb7d/companies" + url: "/contacts/67f7d57bcc99153fd675317e/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/6762f0d01bb69f9f2193bb7d/subscriptions" + url: "/contacts/67f7d57bcc99153fd675317e/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/6762f0d01bb69f9f2193bb7d/subscriptions" + url: "/contacts/67f7d57bcc99153fd675317e/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -4109,6 +4010,8 @@ paths: utm_source: utm_term: referrer: + sms_consent: false + unsubscribed_from_sms: false enabled_push_messaging: schema: allOf: @@ -4127,7 +4030,7 @@ paths: Unauthorized: value: type: error.list - request_id: 45b30bd1-75d2-40cc-bb39-74ac133a2836 + request_id: c6c8c05d-b70f-4745-819b-47c449b6140e errors: - code: unauthorized message: Access Token Invalid @@ -4155,6 +4058,13 @@ paths: description: successful content: application/json: + examples: + successful: + value: + id: 67f7d57dcc99153fd675317f + external_id: '70' + type: contact + deleted: true schema: "$ref": "#/components/schemas/contact_deleted" '401': @@ -4165,7 +4075,7 @@ paths: Unauthorized: value: type: error.list - request_id: a947b2f0-23d3-419d-9ec4-cdd191cea676 + request_id: 63511fbe-553c-40b3-b0c6-938c650b3da4 errors: - code: unauthorized message: Access Token Invalid @@ -4193,7 +4103,7 @@ paths: successful: value: type: contact - id: 6762f0d51bb69f9f2193bb80 + id: 67f7d580cc99153fd6753181 workspace_id: this_is_an_id291_that_should_be_at_least_ external_id: '70' role: user @@ -4209,9 +4119,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1734537429 - updated_at: 1734537430 - signed_up_at: 1734537429 + created_at: 1744295296 + updated_at: 1744295296 + signed_up_at: 1744295296 last_seen_at: last_replied_at: last_contacted_at: @@ -4245,31 +4155,31 @@ paths: tags: type: list data: [] - url: "/contacts/6762f0d51bb69f9f2193bb80/tags" + url: "/contacts/67f7d580cc99153fd6753181/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/6762f0d51bb69f9f2193bb80/notes" + url: "/contacts/67f7d580cc99153fd6753181/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/6762f0d51bb69f9f2193bb80/companies" + url: "/contacts/67f7d580cc99153fd6753181/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/6762f0d51bb69f9f2193bb80/subscriptions" + url: "/contacts/67f7d580cc99153fd6753181/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/6762f0d51bb69f9f2193bb80/subscriptions" + url: "/contacts/67f7d580cc99153fd6753181/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -4278,6 +4188,8 @@ paths: utm_source: utm_term: referrer: + sms_consent: false + unsubscribed_from_sms: false enabled_push_messaging: schema: allOf: @@ -4296,7 +4208,7 @@ paths: Unauthorized: value: type: error.list - request_id: ff328c7c-6140-48eb-84dd-bb8960b66cd0 + request_id: 51868d52-6304-446b-bd7f-d11a3dab496d errors: - code: unauthorized message: Access Token Invalid @@ -4311,8 +4223,8 @@ paths: successful: summary: successful value: - from: 6762f0d51bb69f9f2193bb7f - into: 6762f0d51bb69f9f2193bb80 + from: 67f7d580cc99153fd6753180 + into: 67f7d580cc99153fd6753181 "/contacts/search": post: summary: Search contacts @@ -4451,7 +4363,7 @@ paths: Unauthorized: value: type: error.list - request_id: f0dc95f1-9e46-4e8d-8150-89365c2c5195 + request_id: 2bcc8559-4f13-4f8f-a04a-0cfc8e343560 errors: - code: unauthorized message: Access Token Invalid @@ -4517,7 +4429,7 @@ paths: Unauthorized: value: type: error.list - request_id: e097e446-9ae6-44a8-8e13-2bf3008b87ef + request_id: 35ed1fd7-80c3-4d4a-a56f-e01d0399e30c errors: - code: unauthorized message: Access Token Invalid @@ -4543,7 +4455,7 @@ paths: successful: value: type: contact - id: 6762f0dd1bb69f9f2193bb83 + id: 67f7d586cc99153fd6753184 workspace_id: this_is_an_id303_that_should_be_at_least_ external_id: role: user @@ -4559,8 +4471,8 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1734537437 - updated_at: 1734537437 + created_at: 1744295302 + updated_at: 1744295302 signed_up_at: last_seen_at: last_replied_at: @@ -4595,31 +4507,31 @@ paths: tags: type: list data: [] - url: "/contacts/6762f0dd1bb69f9f2193bb83/tags" + url: "/contacts/67f7d586cc99153fd6753184/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/6762f0dd1bb69f9f2193bb83/notes" + url: "/contacts/67f7d586cc99153fd6753184/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/6762f0dd1bb69f9f2193bb83/companies" + url: "/contacts/67f7d586cc99153fd6753184/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/6762f0dd1bb69f9f2193bb83/subscriptions" + url: "/contacts/67f7d586cc99153fd6753184/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/6762f0dd1bb69f9f2193bb83/subscriptions" + url: "/contacts/67f7d586cc99153fd6753184/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -4628,6 +4540,8 @@ paths: utm_source: utm_term: referrer: + sms_consent: false + unsubscribed_from_sms: false enabled_push_messaging: schema: allOf: @@ -4646,7 +4560,7 @@ paths: Unauthorized: value: type: error.list - request_id: ff2353d3-d3d6-4f20-8268-847869d01e73 + request_id: dd7557db-097e-4f7f-83e0-3b99623db38f errors: - code: unauthorized message: Access Token Invalid @@ -4692,7 +4606,7 @@ paths: successful: value: type: contact - id: 6762f0df1bb69f9f2193bb84 + id: 67f7d587cc99153fd6753185 workspace_id: this_is_an_id307_that_should_be_at_least_ external_id: '70' role: user @@ -4708,9 +4622,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1734537439 - updated_at: 1734537439 - signed_up_at: 1734537439 + created_at: 1744295303 + updated_at: 1744295303 + signed_up_at: 1744295303 last_seen_at: last_replied_at: last_contacted_at: @@ -4744,31 +4658,31 @@ paths: tags: type: list data: [] - url: "/contacts/6762f0df1bb69f9f2193bb84/tags" + url: "/contacts/67f7d587cc99153fd6753185/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/6762f0df1bb69f9f2193bb84/notes" + url: "/contacts/67f7d587cc99153fd6753185/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/6762f0df1bb69f9f2193bb84/companies" + url: "/contacts/67f7d587cc99153fd6753185/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/6762f0df1bb69f9f2193bb84/subscriptions" + url: "/contacts/67f7d587cc99153fd6753185/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/6762f0df1bb69f9f2193bb84/subscriptions" + url: "/contacts/67f7d587cc99153fd6753185/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -4777,6 +4691,8 @@ paths: utm_source: utm_term: referrer: + sms_consent: false + unsubscribed_from_sms: false enabled_push_messaging: schema: allOf: @@ -4795,7 +4711,7 @@ paths: Unauthorized: value: type: error.list - request_id: 1fb28be7-cda6-4029-b4da-447ef61cb61a + request_id: e7ab28a0-6322-44e5-8be3-4a3518498e2c errors: - code: unauthorized message: Access Token Invalid @@ -4825,6 +4741,13 @@ paths: description: successful content: application/json: + examples: + successful: + value: + id: 67f7d589cc99153fd6753187 + external_id: '70' + type: contact + archived: true schema: "$ref": "#/components/schemas/contact_archived" "/contacts/{id}/unarchive": @@ -4851,34 +4774,15 @@ paths: description: successful content: application/json: + examples: + successful: + value: + id: 67f7d58acc99153fd6753188 + external_id: '70' + type: contact + archived: false schema: "$ref": "#/components/schemas/contact_unarchived" - "/contacts/{id}/block": - post: - summary: Block 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: BlockContact - description: Block a single contact.
**Note:** conversations of the contact will also be archived during the process.
More details in [FAQ How do I block Inbox spam?](https://www.intercom.com/help/en/articles/8838656-inbox-faqs) - responses: - '200': - description: successful - content: - application/json: - schema: - "$ref": "#/components/schemas/contact_blocked" "/conversations/{conversation_id}/tags": post: summary: Add tag to a conversation @@ -4909,7 +4813,7 @@ paths: successful: value: type: tag - id: '86' + id: '7' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -4921,7 +4825,7 @@ paths: Conversation not found: value: type: error.list - request_id: c6e8c74f-a354-4dfd-a5be-6061d2d26341 + request_id: 01d6e51f-3bc0-483f-9850-399076cfd717 errors: - code: not_found message: Conversation not found @@ -4935,7 +4839,7 @@ paths: Unauthorized: value: type: error.list - request_id: 617bb25d-4dea-4a68-ae74-2fb8f4e87b39 + request_id: 3bb87d65-5690-483a-bb4e-8a75f9b9322e errors: - code: unauthorized message: Access Token Invalid @@ -4964,13 +4868,13 @@ paths: successful: summary: successful value: - id: 86 - admin_id: 991267618 + id: 7 + admin_id: 991266373 conversation_not_found: summary: Conversation not found value: - id: 87 - admin_id: 991267620 + id: 8 + admin_id: 991266375 "/conversations/{conversation_id}/tags/{id}": delete: summary: Remove tag from a conversation @@ -5008,7 +4912,7 @@ paths: successful: value: type: tag - id: '89' + id: '10' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -5020,14 +4924,14 @@ paths: Conversation not found: value: type: error.list - request_id: 84db22c5-0fef-465a-a909-2643d8a22c69 + request_id: 21035b27-9cc4-453b-9ce1-db4adbd49f71 errors: - code: not_found message: Conversation not found Tag not found: value: type: error.list - request_id: 1fe3e9ec-6a5b-4abc-b51c-a515f77d9577 + request_id: 9f99a388-6acb-45c3-af81-56ca50853e4b errors: - code: tag_not_found message: Tag not found @@ -5041,7 +4945,7 @@ paths: Unauthorized: value: type: error.list - request_id: df73b7b4-2352-44fd-8d14-4ea8536ad138 + request_id: f53ce282-389c-4b9f-902e-0ced055b32a2 errors: - code: unauthorized message: Access Token Invalid @@ -5064,15 +4968,15 @@ paths: successful: summary: successful value: - admin_id: 991267622 + admin_id: 991266377 conversation_not_found: summary: Conversation not found value: - admin_id: 991267624 + admin_id: 991266379 tag_not_found: summary: Tag not found value: - admin_id: 991267625 + admin_id: 991266380 "/conversations": get: summary: List all conversations @@ -5111,96 +5015,18 @@ paths: 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: '471' - created_at: 1734537460 - updated_at: 1734537460 - waiting_since: - snoozed_until: - source: - type: conversation - id: '403918320' - delivered_as: admin_initiated - subject: '' - body: "

this is the message body

" - author: - type: admin - id: '991267628' - name: Ciaran166 Lee - email: admin166@email.com - attachments: [] - url: - redacted: false - contacts: - type: contact.list - contacts: - - type: contact - id: 6762f0f31bb69f9f2193bb8b - 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" + "$ref": "#/components/schemas/paginated_response" '401': description: Unauthorized content: application/json: - examples: - Unauthorized: - value: - type: error.list - request_id: b14d75ab-7d26-4191-b33f-77ca0a4d4ede - 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: 591a0c2f-78b3-41bb-bfa7-f1fae15107b9 - errors: - - code: api_plan_restricted - message: Active subscription needed. schema: "$ref": "#/components/schemas/error" post: @@ -5229,57 +5055,24 @@ paths: description: conversation created content: application/json: - examples: - conversation created: - value: - type: user_message - id: '403918330' - created_at: 1734537501 - body: Hello there - message_type: inapp - conversation_id: '499' schema: "$ref": "#/components/schemas/message" '404': description: Contact Not Found content: application/json: - examples: - Contact Not Found: - value: - type: error.list - request_id: d7eb553e-74ae-4341-820b-5d38a94d4a99 - 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: 68e42c33-8220-48ea-906f-75584c3ec440 - 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: dcf1b373-3e66-4026-a987-98c16f00a908 - errors: - - code: api_plan_restricted - message: Active subscription needed. schema: "$ref": "#/components/schemas/error" requestBody: @@ -5287,21 +5080,6 @@ paths: application/json: schema: "$ref": "#/components/schemas/create_conversation_request" - examples: - conversation_created: - summary: conversation created - value: - from: - type: user - id: 6762f11b1bb69f9f2193bba3 - 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 @@ -5343,211 +5121,24 @@ paths: description: conversation found content: application/json: - examples: - conversation found: - value: - type: conversation - id: '503' - created_at: 1734537511 - updated_at: 1734537511 - waiting_since: - snoozed_until: - source: - type: conversation - id: '403918334' - delivered_as: admin_initiated - subject: '' - body: "

this is the message body

" - author: - type: admin - id: '991267645' - name: Ciaran176 Lee - email: admin176@email.com - attachments: [] - url: - redacted: false - contacts: - type: contact.list - contacts: - - type: contact - id: 6762f1261bb69f9f2193bba7 - external_id: '70' - first_contact_reply: - admin_assignee_id: - team_assignee_id: - open: false - state: closed - read: false - tags: - type: tag.list - tags: - - type: tag - id: '123456' - name: Test tag - applied_at: 1663597223 - applied_by: - type: contact - id: '1a2b3c' - 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: 1 - part_type: comment - body:

Okay!

- created_at: 1663597223 - updated_at: 1663597260 - notified_at: 1663597260 - assigned_to: - type: contact - id: '1a2b3c' - author: - type: admin - id: '274' - name: Operator - email: operator+abcd1234@intercom.io - attachments: [] - external_id: 'abcd1234' - redacted: false - email_message_metadata: null - state: open - tags: - - type: tag - id: '123456' - name: Test tag - event_details: - app_package_code: null - - type: conversation_part - id: 2 - part_type: custom_action_started - body: - created_at: 1740141842 - updated_at: 1740141842 - notified_at: 1740141842 - assigned_to: - author: - type: admin - id: '274' - name: Jamie Oliver - email: jamie+abcd1234@intercom.io - attachments: [] - external_id: - redacted: false - email_message_metadata: null - state: open - tags: [] - event_details: - action: - name: Jira Create Issue - app_package_code: test-integration - - type: conversation_part - id: 3 - part_type: conversation_attribute_updated_by_admin - body: - created_at: 1740141851 - updated_at: 1740141851 - notified_at: 1740141851 - assigned_to: - author: - type: bot - id: '278' - name: Fin - email: operator+abcd1234@intercom.io - attachments: [] - external_id: - redacted: false - email_message_metadata: null - state: open - tags: [] - event_details: - attribute: - name: jira_issue_key - value: - name: PROJ-007 - app_package_code: null - - type: conversation_part - id: 4 - part_type: custom_action_finished - body: - created_at: 1740141857 - updated_at: 1740141857 - notified_at: 1740141857 - assigned_to: - author: - type: admin - id: '274' - name: Jamie Oliver - email: jamie+abcd1234@intercom.io - attachments: [] - external_id: - redacted: false - email_message_metadata: null - state: closed - tags: [] - event_details: - action: - name: Jira Create Issue - result: success - app_package_code: null - total_count: 4 schema: "$ref": "#/components/schemas/conversation" '404': description: Not found content: application/json: - examples: - Not found: - value: - type: error.list - request_id: 8c288c4f-b699-4209-9de4-064398f02785 - 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: 1350c241-0f22-48ca-bab9-169080340870 - 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: 8b3deed3-fd8b-43d6-b6a8-428c9e17aabb - errors: - - code: api_plan_restricted - message: Active subscription needed. schema: "$ref": "#/components/schemas/error" put: @@ -5573,7 +5164,6 @@ paths: type: string tags: - Conversations - - Custom Object Instances operationId: updateConversation description: |2+ @@ -5583,226 +5173,30 @@ paths: 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 %} - {% admonition type="info" %} - This endpoint handles both **conversation updates** and **custom object associations**. - - See _`update a conversation with an association to a custom object instance`_ in the request/response examples to see the custom object association format. - {% /admonition %} - responses: '200': description: update a conversation with an association to a custom object instance content: application/json: - examples: - conversation found: - value: - type: conversation - id: '507' - created_at: 1734537521 - updated_at: 1734537523 - waiting_since: - snoozed_until: - source: - type: conversation - id: '403918338' - delivered_as: admin_initiated - subject: '' - body: "

this is the message body

" - author: - type: admin - id: '991267653' - name: Ciaran180 Lee - email: admin180@email.com - attachments: [] - url: - redacted: false - contacts: - type: contact.list - contacts: - - type: contact - id: 6762f1301bb69f9f2193bbab - 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: '129' - part_type: conversation_attribute_updated_by_admin - body: - created_at: 1734537523 - updated_at: 1734537523 - notified_at: 1734537523 - assigned_to: - author: - id: '991267654' - type: bot - name: Fin - email: operator+this_is_an_id354_that_should_be_at_least_@intercom.io - attachments: [] - external_id: - redacted: false - metadata: {} - email_message_metadata: - app_package_code: null - - type: conversation_part - id: '130' - part_type: conversation_attribute_updated_by_admin - body: - created_at: 1734537523 - updated_at: 1734537523 - notified_at: 1734537523 - assigned_to: - author: - id: '991267654' - type: bot - name: Fin - email: operator+this_is_an_id354_that_should_be_at_least_@intercom.io - attachments: [] - external_id: - redacted: false - metadata: {} - email_message_metadata: - app_package_code: null - total_count: 2 - update a conversation with an association to a custom object instance: - value: - type: conversation - id: '508' - created_at: 1734537525 - updated_at: 1734537525 - waiting_since: - snoozed_until: - source: - type: conversation - id: '403918339' - delivered_as: admin_initiated - subject: '' - body: "

this is the message body

" - author: - type: admin - id: '991267659' - name: Ciaran185 Lee - email: admin185@email.com - attachments: [] - url: - redacted: false - contacts: - type: contact.list - contacts: - - type: contact - id: 6762f1341bb69f9f2193bbac - 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: - order: - type: Order.list - instances: - - id: '21' - external_id: '123' - external_created_at: 1392036272 - external_updated_at: 1392036272 - custom_attributes: - order_number: ORDER-12345 - total_amount: 99.99 - type: Order - 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: de1be01d-a0d3-48a6-9ea6-9789931a6887 - 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: de63ddb2-c525-4ebf-ad38-82ed8b44c896 - 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: 34072e07-6b70-4f59-96bf-3106a3563a24 - errors: - - code: api_plan_restricted - message: Active subscription needed. schema: "$ref": "#/components/schemas/error" requestBody: @@ -5810,30 +5204,6 @@ paths: application/json: schema: "$ref": "#/components/schemas/update_conversation_request" - examples: - conversation_found: - summary: conversation found - value: - read: true - title: new conversation title - custom_attributes: - issue_type: Billing - priority: High - update_a_conversation_with_an_association_to_a_custom_object_instance: - summary: update a conversation with an association to a custom object - instance - value: - custom_attributes: - order: - - '21' - not_found: - summary: Not found - value: - read: true - title: new conversation title - custom_attributes: - issue_type: Billing - priority: High delete: summary: Delete a conversation parameters: @@ -5856,40 +5226,18 @@ paths: description: successful content: application/json: - examples: - successful: - value: - id: '512' - object: conversation - deleted: true schema: "$ref": "#/components/schemas/conversation_deleted" '401': description: Unauthorized content: application/json: - examples: - Unauthorized: - value: - type: error.list - request_id: 310f55b0-2660-43e8-bed4-7e82b2f40920 - 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: 7a80b950-b392-499f-85db-ea7c6c424d37 - errors: - - code: api_plan_restricted - message: Active subscription needed. schema: "$ref": "#/components/schemas/error" "/conversations/search": @@ -5925,8 +5273,7 @@ paths: ### Accepted Fields - Most keys listed in the conversation 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"`). - The `source.body` field is unique as the search will not be performed against the entire value, but instead against every element of the value separately. For example, when searching for a conversation with a `"I need support"` body - the query should contain a `=` operator with the value `"support"` for such conversation to be returned. A query with a `=` operator and a `"need support"` value will not yield a result. + 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 | | :---------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -6008,68 +5355,6 @@ paths: description: successful content: application/json: - examples: - successful: - value: - type: conversation.list - pages: - type: pages - page: 1 - per_page: 5 - total_pages: 1 - total_count: 1 - conversations: - - type: conversation - id: '515' - created_at: 1734537546 - updated_at: 1734537546 - waiting_since: - snoozed_until: - source: - type: conversation - id: '403918346' - delivered_as: admin_initiated - subject: '' - body: "

this is the message body

" - author: - type: admin - id: '991267691' - name: Ciaran210 Lee - email: admin210@email.com - attachments: [] - url: - redacted: false - contacts: - type: contact.list - contacts: - - type: contact - id: 6762f14a1bb69f9f2193bbb3 - 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: @@ -6077,18 +5362,6 @@ paths: application/json: schema: "$ref": "#/components/schemas/search_request" - examples: - successful: - summary: successful - value: - query: - operator: AND - value: - - field: created_at - operator: ">" - value: '1306054154' - pagination: - per_page: 5 "/conversations/{id}/reply": post: summary: Reply to a conversation @@ -6115,371 +5388,24 @@ paths: description: User last conversation reply content: application/json: - examples: - User reply: - value: - type: conversation - id: '524' - created_at: 1734537559 - updated_at: 1734537561 - waiting_since: 1734537561 - snoozed_until: - source: - type: conversation - id: '403918349' - delivered_as: admin_initiated - subject: '' - body: "

this is the message body

" - author: - type: admin - id: '991267694' - name: Ciaran212 Lee - email: admin212@email.com - attachments: [] - url: - redacted: false - contacts: - type: contact.list - contacts: - - type: contact - id: 6762f1571bb69f9f2193bbbb - external_id: '70' - first_contact_reply: - created_at: 1734537561 - 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: '132' - part_type: open - body: "

Thanks again :)

" - created_at: 1734537561 - updated_at: 1734537561 - notified_at: 1734537561 - assigned_to: - author: - id: 6762f1571bb69f9f2193bbbb - type: user - name: Joe Bloggs - email: joe@bloggs.com - attachments: [] - external_id: - redacted: false - metadata: {} - email_message_metadata: - app_package_code: null - total_count: 1 - Admin note reply: - value: - type: conversation - id: '525' - created_at: 1734537563 - updated_at: 1734537565 - waiting_since: - snoozed_until: - source: - type: conversation - id: '403918350' - delivered_as: admin_initiated - subject: '' - body: "

this is the message body

" - author: - type: admin - id: '991267696' - name: Ciaran213 Lee - email: admin213@email.com - attachments: [] - url: - redacted: false - contacts: - type: contact.list - contacts: - - type: contact - id: 6762f15b1bb69f9f2193bbbc - 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: '133' - part_type: note - body: |- -

An Unordered HTML List

- -

An Ordered HTML List

-
    -
  1. Coffee
    2. -
  2. Tea
    3. -
  3. Milk
    4. -
- created_at: 1734537565 - updated_at: 1734537565 - notified_at: 1734537565 - assigned_to: - author: - id: '991267696' - type: admin - name: Ciaran213 Lee - email: admin213@email.com - attachments: [] - external_id: - redacted: false - metadata: {} - email_message_metadata: - app_package_code: null - total_count: 1 - Admin quick_reply reply: - value: - type: conversation - id: '526' - created_at: 1734537567 - updated_at: 1734537568 - waiting_since: - snoozed_until: - source: - type: conversation - id: '403918351' - delivered_as: admin_initiated - subject: '' - body: "

this is the message body

" - author: - type: admin - id: '991267698' - name: Ciaran214 Lee - email: admin214@email.com - attachments: [] - url: - redacted: false - contacts: - type: contact.list - contacts: - - type: contact - id: 6762f15e1bb69f9f2193bbbd - 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: '134' - part_type: quick_reply - body: - created_at: 1734537568 - updated_at: 1734537568 - notified_at: 1734537568 - assigned_to: - author: - id: '991267698' - type: admin - name: Ciaran214 Lee - email: admin214@email.com - attachments: [] - external_id: - redacted: false - metadata: {} - email_message_metadata: - app_package_code: null - total_count: 1 - User last conversation reply: - value: - type: conversation - id: '527' - created_at: 1734537571 - updated_at: 1734537572 - waiting_since: 1734537572 - snoozed_until: - source: - type: conversation - id: '403918352' - delivered_as: admin_initiated - subject: '' - body: "

this is the message body

" - author: - type: admin - id: '991267700' - name: Ciaran215 Lee - email: admin215@email.com - attachments: [] - url: - redacted: false - contacts: - type: contact.list - contacts: - - type: contact - id: 6762f1621bb69f9f2193bbbe - external_id: '70' - first_contact_reply: - created_at: 1734537572 - 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: '135' - part_type: open - body: "

Thanks again :)

" - created_at: 1734537572 - updated_at: 1734537572 - notified_at: 1734537572 - assigned_to: - author: - id: 6762f1621bb69f9f2193bbbe - type: user - name: Joe Bloggs - email: joe@bloggs.com - attachments: [] - external_id: - redacted: false - metadata: {} - email_message_metadata: - app_package_code: null - total_count: 1 schema: "$ref": "#/components/schemas/conversation" '404': description: Not found content: application/json: - examples: - Not found: - value: - type: error.list - request_id: '06234918-c245-4caa-a2cc-90247983c6ff' - 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: 50f1e8d1-cf1a-450c-a7b5-87a264076241 - 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: 48ad16d0-525c-40bf-b733-89239feb70e3 - errors: - - code: api_plan_restricted - message: Active subscription needed. schema: "$ref": "#/components/schemas/error" requestBody: @@ -6487,49 +5413,6 @@ paths: application/json: schema: "$ref": "#/components/schemas/reply_conversation_request" - examples: - user_reply: - summary: User reply - value: - message_type: comment - type: user - intercom_user_id: 6762f1571bb69f9f2193bbbb - body: Thanks again :) - admin_note_reply: - summary: Admin note reply - value: - message_type: note - type: admin - admin_id: 991267696 - body: "

An Unordered HTML List

An Ordered HTML List

- \
  1. Coffee
  2. Tea
  3. Milk
- \ " - admin_quick_reply_reply: - summary: Admin quick_reply reply - value: - message_type: quick_reply - type: admin - admin_id: 991267698 - reply_options: - - text: 'Yes' - uuid: a5e1c524-5ddd-4c3e-9328-6bca5d6e3edb - - text: 'No' - uuid: f4a98af1-be56-4948-a57e-e1a83f8484c6 - user_last_conversation_reply: - summary: User last conversation reply - value: - message_type: comment - type: user - intercom_user_id: 6762f1621bb69f9f2193bbbe - body: Thanks again :) - not_found: - summary: Not found - value: - message_type: comment - type: user - intercom_user_id: 6762f1661bb69f9f2193bbbf - body: Thanks again :) "/conversations/{id}/parts": post: summary: Manage a conversation @@ -6559,355 +5442,24 @@ paths: description: Assign a conversation content: application/json: - examples: - Close a conversation: - value: - type: conversation - id: '531' - created_at: 1734537582 - updated_at: 1734537584 - waiting_since: - snoozed_until: - source: - type: conversation - id: '403918356' - delivered_as: admin_initiated - subject: '' - body: "

this is the message body

" - author: - type: admin - id: '991267708' - name: Ciaran219 Lee - email: admin219@email.com - attachments: [] - url: - redacted: false - contacts: - type: contact.list - contacts: - - type: contact - id: 6762f16e1bb69f9f2193bbc2 - 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: '136' - part_type: close - body: "

Goodbye :)

" - created_at: 1734537584 - updated_at: 1734537584 - notified_at: 1734537584 - assigned_to: - author: - id: '991267708' - type: admin - name: Ciaran219 Lee - email: admin219@email.com - attachments: [] - external_id: - redacted: false - metadata: {} - email_message_metadata: - app_package_code: null - total_count: 1 - Snooze a conversation: - value: - type: conversation - id: '532' - created_at: 1734537586 - updated_at: 1734537587 - waiting_since: - snoozed_until: 1734541187 - source: - type: conversation - id: '403918357' - delivered_as: admin_initiated - subject: '' - body: "

this is the message body

" - author: - type: admin - id: '991267710' - name: Ciaran220 Lee - email: admin220@email.com - attachments: [] - url: - redacted: false - contacts: - type: contact.list - contacts: - - type: contact - id: 6762f1711bb69f9f2193bbc3 - 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: '137' - part_type: snoozed - body: - created_at: 1734537587 - updated_at: 1734537587 - notified_at: 1734537587 - assigned_to: - author: - id: '991267710' - type: admin - name: Ciaran220 Lee - email: admin220@email.com - attachments: [] - external_id: - redacted: false - metadata: {} - email_message_metadata: - app_package_code: null - total_count: 1 - Open a conversation: - value: - type: conversation - id: '537' - created_at: 1734537587 - updated_at: 1734537601 - waiting_since: - snoozed_until: - source: - type: conversation - id: '403918358' - delivered_as: admin_initiated - subject: '' - body: "

this is the message body

" - author: - type: admin - id: '991267712' - name: Ciaran221 Lee - email: admin221@email.com - attachments: [] - url: - redacted: false - contacts: - type: contact.list - contacts: - - type: contact - id: 6762f1781bb69f9f2193bbc8 - 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: '139' - part_type: open - body: - created_at: 1734537601 - updated_at: 1734537601 - notified_at: 1734537601 - assigned_to: - author: - id: '991267712' - type: admin - name: Ciaran221 Lee - email: admin221@email.com - attachments: [] - external_id: - redacted: false - metadata: {} - email_message_metadata: - app_package_code: null - total_count: 1 - Assign a conversation: - value: - type: conversation - id: '542' - created_at: 1734537603 - updated_at: 1734537605 - waiting_since: - snoozed_until: - source: - type: conversation - id: '403918361' - delivered_as: admin_initiated - subject: '' - body: "

this is the message body

" - author: - type: admin - id: '991267715' - name: Ciaran223 Lee - email: admin223@email.com - attachments: [] - url: - redacted: false - contacts: - type: contact.list - contacts: - - type: contact - id: 6762f1831bb69f9f2193bbcc - external_id: '70' - first_contact_reply: - admin_assignee_id: 991267715 - 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: '140' - part_type: assign_and_reopen - body: - created_at: 1734537605 - updated_at: 1734537605 - notified_at: 1734537605 - assigned_to: - type: admin - id: '991267715' - author: - id: '991267715' - type: admin - name: Ciaran223 Lee - email: admin223@email.com - attachments: [] - external_id: - redacted: false - metadata: {} - email_message_metadata: - app_package_code: null - total_count: 1 schema: "$ref": "#/components/schemas/conversation" '404': description: Not found content: application/json: - examples: - Not found: - value: - type: error.list - request_id: e056b3c3-fae3-4a3c-9bcf-836b84efa331 - 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: 623bbbb8-f6fb-45f3-a2e2-4106ff3a4349 - 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: a57737d0-63a7-42bd-aa65-8380ef828124 - errors: - - code: api_plan_restricted - message: Active subscription needed. schema: "$ref": "#/components/schemas/error" requestBody: @@ -6919,39 +5471,54 @@ paths: - "$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: 991267708 - body: Goodbye :) - snooze_a_conversation: - summary: Snooze a conversation - value: - message_type: snoozed - admin_id: 991267710 - snoozed_until: 1734541187 - open_a_conversation: - summary: Open a conversation - value: - message_type: open - admin_id: 991267712 - assign_a_conversation: - summary: Assign a conversation - value: - message_type: assignment - type: admin - admin_id: 991267715 - assignee_id: 991267715 - not_found: - summary: Not found - value: - message_type: close - type: admin - admin_id: 991267717 - 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="warning" 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: + schema: + "$ref": "#/components/schemas/conversation" + '404': + description: Not found + content: + application/json: + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + schema: + "$ref": "#/components/schemas/error" + '403': + description: API plan restricted + content: + application/json: + schema: + "$ref": "#/components/schemas/error" "/conversations/{id}/customers": post: summary: Attach a contact to a conversation @@ -6982,54 +5549,24 @@ paths: description: Attach a contact to a conversation content: application/json: - examples: - Attach a contact to a conversation: - value: - customers: - - type: user - id: 6762f19b1bb69f9f2193bbd4 schema: "$ref": "#/components/schemas/conversation" '404': description: Not found content: application/json: - examples: - Not found: - value: - type: error.list - request_id: 86fd8b2e-7048-4fbd-9fb0-d73085d7210b - 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: 9dc7c1a0-b818-472c-adf6-3e327f22f541 - 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: 99f72599-ac98-4b1e-af96-808654b6383e - errors: - - code: api_plan_restricted - message: Active subscription needed. schema: "$ref": "#/components/schemas/error" requestBody: @@ -7037,19 +5574,6 @@ paths: 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: 991267731 - customer: - intercom_user_id: 6762f19b1bb69f9f2193bbd4 - not_found: - summary: Not found - value: - admin_id: 991267733 - customer: - intercom_user_id: 6762f19e1bb69f9f2193bbd5 "/conversations/{conversation_id}/customers/{contact_id}": delete: summary: Detach a contact from a group conversation @@ -7087,75 +5611,30 @@ paths: description: Detach a contact from a group conversation content: application/json: - examples: - Detach a contact from a group conversation: - value: - customers: - - type: user - id: 6762f1b41bb69f9f2193bbe0 schema: "$ref": "#/components/schemas/conversation" '404': description: Contact not found content: application/json: - examples: - Conversation not found: - value: - type: error.list - request_id: 89835b60-6756-4d2a-b148-26ca0cb49f9f - errors: - - code: not_found - message: Resource Not Found - Contact not found: - value: - type: error.list - request_id: ab1b9371-3185-417f-a53a-dcae35892980 - 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: 8275e92f-66b7-40f9-82a8-9647ca8d7eb4 - 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: 89ef64b2-d1f9-40c3-89e9-d39175d3d647 - 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: 6fe4106b-967a-46ba-b1c9-9996aff6e8c3 - errors: - - code: api_plan_restricted - message: Active subscription needed. schema: "$ref": "#/components/schemas/error" requestBody: @@ -7163,31 +5642,6 @@ paths: 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: 991267739 - customer: - intercom_user_id: 6762f1a61bb69f9f2193bbd8 - conversation_not_found: - summary: Conversation not found - value: - admin_id: 991267742 - customer: - intercom_user_id: 6762f1b61bb69f9f2193bbe1 - contact_not_found: - summary: Contact not found - value: - admin_id: 991267745 - customer: - intercom_user_id: 6762f1c41bb69f9f2193bbe9 - last_customer: - summary: Last customer - value: - admin_id: 991267748 - customer: - intercom_user_id: 6762f1d11bb69f9f2193bbf1 "/conversations/redact": post: summary: Redact a conversation part @@ -7211,114 +5665,18 @@ paths: description: Redact a conversation part content: application/json: - examples: - Redact a conversation part: - value: - type: conversation - id: '608' - created_at: 1734537721 - updated_at: 1734537724 - waiting_since: 1734537722 - snoozed_until: - source: - type: conversation - id: '403918391' - delivered_as: admin_initiated - subject: '' - body: "

this is the message body

" - author: - type: admin - id: '991267757' - name: Ciaran247 Lee - email: admin247@email.com - attachments: [] - url: - redacted: false - contacts: - type: contact.list - contacts: - - type: contact - id: 6762f1f81bb69f9f2193bc09 - external_id: '70' - first_contact_reply: - created_at: 1734537722 - 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: '149' - part_type: open - body: "

This message was deleted

" - created_at: 1734537722 - updated_at: 1734537724 - notified_at: 1734537722 - assigned_to: - author: - id: 6762f1f81bb69f9f2193bc09 - type: user - name: Joe Bloggs - email: joe@bloggs.com - attachments: [] - external_id: - redacted: true - metadata: {} - email_message_metadata: - app_package_code: null - total_count: 1 schema: "$ref": "#/components/schemas/conversation" '404': description: Not found content: application/json: - examples: - Not found: - value: - type: error.list - request_id: 5b7bb755-4031-4bfe-8897-54d0f1872bbc - 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: 4814668f-5d31-4bf7-8f66-b426aac054db - errors: - - code: unauthorized - message: Access Token Invalid schema: "$ref": "#/components/schemas/error" requestBody: @@ -7326,19 +5684,6 @@ paths: 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: 608 - conversation_part_id: 149 - 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 @@ -7363,99 +5708,12 @@ paths: description: successful content: application/json: - examples: - successful: - value: - type: ticket - id: '611' - ticket_id: '22' - ticket_attributes: {} - ticket_state: - type: ticket_state - id: '7493' - category: submitted - internal_label: Submitted - external_label: Submitted - ticket_type: - type: ticket_type - id: '53' - name: my-ticket-type-1 - description: my ticket type description is awesome. - icon: "\U0001F981" - workspace_id: this_is_an_id442_that_should_be_at_least_ - archived: false - created_at: 1734537737 - updated_at: 1734537737 - is_internal: false - ticket_type_attributes: - type: list - data: [] - category: Customer - contacts: - type: contact.list - contacts: - - type: contact - id: 6762f2041bb69f9f2193bc0c - external_id: '70' - admin_assignee_id: '0' - team_assignee_id: '0' - created_at: 1734537732 - updated_at: 1734537737 - ticket_parts: - type: ticket_part.list - ticket_parts: - - type: ticket_part - id: '151' - part_type: comment - body: "

Comment for message

" - created_at: 1734537732 - updated_at: 1734537732 - author: - id: 6762f2041bb69f9f2193bc0c - type: user - name: Joe Bloggs - email: joe@bloggs.com - attachments: [] - redacted: false - app_package_code: test-integration - - type: ticket_part - id: '152' - part_type: ticket_state_updated_by_admin - ticket_state: submitted - previous_ticket_state: submitted - created_at: 1734537737 - updated_at: 1734537737 - author: - id: '991267767' - type: bot - name: Fin - email: operator+this_is_an_id442_that_should_be_at_least_@intercom.io - attachments: [] - redacted: false - app_package_code: test-integration - 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: 450e0b22-ccc2-40dd-bf54-bc0faaa28f57 - errors: - - code: parameter_invalid - message: Ticket type is not a customer ticket type schema: "$ref": "#/components/schemas/error" requestBody: @@ -7463,15 +5721,6 @@ paths: application/json: schema: "$ref": "#/components/schemas/convert_conversation_to_ticket_request" - examples: - successful: - summary: successful - value: - ticket_type_id: '53' - bad_request: - summary: Bad request - value: - ticket_type_id: '54' "/custom_object_instances/{custom_object_type_identifier}": parameters: - name: custom_object_type_identifier @@ -7483,146 +5732,80 @@ paths: schema: type: string post: - summary: Create or Update a Custom Object Instance - parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - tags: - - Custom Object Instances - operationId: createCustomObjectInstances - description: Create or update a custom object instance - responses: - '200': - description: successful - content: - application/json: - examples: - successful: - value: - id: '22' - type: Order - custom_attributes: - order_number: ORDER-12345 - total_amount: 99.99 - external_id: '123' - external_created_at: 1392036272 - external_updated_at: 1392036272 - created_at: 1734537745 - updated_at: 1734537745 - schema: - "$ref": "#/components/schemas/custom_object_instance" - '401': - $ref: "#/components/responses/Unauthorized" - '404': - $ref: "#/components/responses/TypeNotFound" - requestBody: - content: - application/json: - schema: - "$ref": "#/components/schemas/create_or_update_custom_object_instance_request" - examples: - successful: - summary: successful - value: - external_id: '123' - external_created_at: 1392036272 - external_updated_at: 1392036272 - custom_attributes: - order_number: ORDER-12345 - total_amount: 99.99 - get: - summary: Get Custom Object Instance by External ID - parameters: - - name: external_id - in: query - style: form - required: true - schema: - type: string - description: The unique identifier for the instance in the external system - it originated from. - title: Find by external_id - properties: - external_id: - type: string - required: - - external_id + summary: Create or Update a Custom Object Instance + parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" tags: - Custom Object Instances - operationId: getCustomObjectInstancesByExternalId - description: Fetch a Custom Object Instance by external_id. + description: Create or update a custom object instance responses: '200': description: successful content: application/json: - examples: - successful: - value: - id: '24' - type: Order - custom_attributes: - order_number: ORDER-12345 - total_amount: 99.99 - external_id: '123' - external_created_at: - external_updated_at: - created_at: 1734537748 - updated_at: 1734537748 schema: "$ref": "#/components/schemas/custom_object_instance" '401': - $ref: "#/components/responses/Unauthorized" - '404': - $ref: "#/components/responses/ObjectNotFound" - delete: - summary: Delete a Custom Object Instance by External ID + description: Unauthorized + content: + application/json: + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_or_update_custom_object_instance_request" + get: + summary: Get Custom Object Instance by External ID parameters: - name: external_id in: query style: form required: true schema: - type: string - description: The unique identifier for the instance in the external system - it originated from. - title: Find by external_id - properties: - external_id: - type: string - required: - - external_id + type: object + oneOf: + - description: The Intercom defined id representing the custom object instance. + title: Find by id + properties: + external_id: + type: string + required: + - external_id + additionalProperties: false + - description: The unique identifier for the instance in the external system + it originated from. + title: Find by external_id + properties: + external_id: + type: string + required: + - external_id + additionalProperties: false - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" tags: - Custom Object Instances - operationId: deleteCustomObjectInstancesById - description: Delete a single Custom Object instance by external_id. + description: Fetch a Custom Object Instance by external_id. responses: '200': description: successful content: application/json: - examples: - successful: - value: - id: '26' - object: Order - deleted: true schema: - "$ref": "#/components/schemas/custom_object_instance_deleted" + "$ref": "#/components/schemas/custom_object_instance" '401': - $ref: "#/components/responses/Unauthorized" - '404': - $ref: "#/components/responses/ObjectNotFound" + description: Unauthorized + content: + application/json: + schema: + "$ref": "#/components/schemas/error" "/custom_object_instances/{custom_object_type_identifier}/{id}": parameters: - name: custom_object_type_identifier @@ -7648,34 +5831,22 @@ paths: "$ref": "#/components/schemas/intercom_version" tags: - Custom Object Instances - operationId: getCustomObjectInstancesById description: Fetch a Custom Object Instance by id. responses: '200': description: successful content: application/json: - examples: - successful: - value: - id: '25' - type: Order - custom_attributes: - order_number: ORDER-12345 - total_amount: 99.99 - external_id: '123' - external_created_at: - external_updated_at: - created_at: 1734537750 - updated_at: 1734537750 schema: "$ref": "#/components/schemas/custom_object_instance" '401': - $ref: "#/components/responses/Unauthorized" - '404': - $ref: "#/components/responses/ObjectNotFound" + description: Unauthorized + content: + application/json: + schema: + "$ref": "#/components/schemas/error" delete: - summary: Delete a Custom Object Instance by ID + summary: Delete a Custom Object Instance parameters: - name: id in: path @@ -7689,7 +5860,6 @@ paths: "$ref": "#/components/schemas/intercom_version" tags: - Custom Object Instances - operationId: deleteCustomObjectInstancesByExternalId description: Delete a single Custom Object instance using the Intercom defined id. responses: @@ -7697,18 +5867,14 @@ paths: description: successful content: application/json: - examples: - successful: - value: - id: '26' - object: Order - deleted: true schema: "$ref": "#/components/schemas/custom_object_instance_deleted" '401': - $ref: "#/components/responses/Unauthorized" - '404': - $ref: "#/components/responses/ObjectNotFound" + description: Unauthorized + content: + application/json: + schema: + "$ref": "#/components/schemas/error" "/data_attributes": get: summary: List all data attributes @@ -7889,7 +6055,7 @@ paths: custom: false archived: false model: company - - id: 34 + - id: 2 type: data_attribute name: The One Ring full_name: custom_attributes.The One Ring @@ -7902,9 +6068,9 @@ paths: messenger_writable: true custom: true archived: false - admin_id: '991267784' - created_at: 1734537753 - updated_at: 1734537753 + admin_id: '991266487' + created_at: 1744295390 + updated_at: 1744295390 model: company - type: data_attribute name: id @@ -7976,7 +6142,7 @@ paths: Unauthorized: value: type: error.list - request_id: 6d231766-b44b-4e78-bc9e-9c268ff19671 + request_id: fc5787c4-e7c6-4e3f-893c-2c63965b00f9 errors: - code: unauthorized message: Access Token Invalid @@ -8001,7 +6167,7 @@ paths: examples: Successful: value: - id: 37 + id: 5 type: data_attribute name: Mithril Shirt full_name: custom_attributes.Mithril Shirt @@ -8012,9 +6178,9 @@ paths: messenger_writable: false custom: true archived: false - admin_id: '991267786' - created_at: 1734537756 - updated_at: 1734537756 + admin_id: '991266489' + created_at: 1744295392 + updated_at: 1744295392 model: company schema: "$ref": "#/components/schemas/data_attribute" @@ -8026,7 +6192,7 @@ paths: Same name already exists: value: type: error.list - request_id: da2a7037-11f4-4fcc-8d19-27da3b3a4336 + request_id: e4daa181-80e0-474f-bb79-d01efe61b0e0 errors: - code: parameter_invalid message: You already have 'The One Ring' in your company data. @@ -8034,7 +6200,7 @@ paths: Invalid name: value: type: error.list - request_id: 1c45cfd9-ffd1-4e3e-9f7a-2ac99abdf03d + request_id: bc5e9327-b9c4-4526-9f9e-68f286e28b7b errors: - code: parameter_invalid message: Your name for this attribute must only contain alphanumeric @@ -8042,7 +6208,7 @@ paths: Attribute already exists: value: type: error.list - request_id: 55999605-a170-4894-a3d0-090c4fee8d11 + request_id: 4731e698-e9b0-4b59-be8e-0ce0f943ce62 errors: - code: parameter_invalid message: You already have 'The One Ring' in your company data. @@ -8050,14 +6216,14 @@ paths: Invalid Data Type: value: type: error.list - request_id: e0a9ccc7-a540-4ef0-8ffc-28ab86658b04 + request_id: 47f9a788-a8bf-45c4-9639-12824f970ede errors: - code: parameter_invalid message: Data Type isn't an option Too few options for list: value: type: error.list - request_id: 6544ccf8-435d-49e1-91ed-e49356f14255 + request_id: 7dadb3da-41d1-4222-866b-04415fd80e5e errors: - code: parameter_invalid message: The Data Attribute model field must be either contact @@ -8072,7 +6238,7 @@ paths: Unauthorized: value: type: error.list - request_id: fa71b91c-4a25-4fe6-88a9-884f6950860e + request_id: 3ef56005-4ffb-4f73-81e8-e4ac272a6599 errors: - code: unauthorized message: Access Token Invalid @@ -8151,7 +6317,7 @@ paths: examples: Successful: value: - id: 44 + id: 12 type: data_attribute name: The One Ring full_name: custom_attributes.The One Ring @@ -8166,9 +6332,9 @@ paths: messenger_writable: true custom: true archived: false - admin_id: '991267793' - created_at: 1734537762 - updated_at: 1734537763 + admin_id: '991266496' + created_at: 1744295396 + updated_at: 1744295396 model: company schema: "$ref": "#/components/schemas/data_attribute" @@ -8180,7 +6346,7 @@ paths: Too few options in list: value: type: error.list - request_id: 37cff4c5-5e1a-4958-a2ba-149b09d1915c + request_id: 37dc1cba-7531-43f6-a388-f01e9c9a85bd errors: - code: parameter_invalid message: Options isn't an array @@ -8194,7 +6360,7 @@ paths: Attribute Not Found: value: type: error.list - request_id: eee16d31-0b0a-4b5f-b95a-25d37528c80f + request_id: 75318d50-6939-456a-a8c7-f54e57e9e90a errors: - code: field_not_found message: We couldn't find that data attribute to update @@ -8208,7 +6374,7 @@ paths: Has Dependant Object: value: type: error.list - request_id: f04b6b14-1c5b-46e1-9c95-4a914557062c + request_id: a2815925-eeb0-4923-ad5c-95d34fe4152a errors: - code: data_invalid message: The Data Attribute you are trying to archive has a @@ -8223,7 +6389,7 @@ paths: Unauthorized: value: type: error.list - request_id: c60ce63d-1c74-4fe2-8e21-31d1f817a0c2 + request_id: e585be35-8895-4b25-a24c-0e247c5c5e8a errors: - code: unauthorized message: Access Token Invalid @@ -8328,7 +6494,7 @@ paths: Unauthorized: value: type: error.list - request_id: 212c8206-e7a6-44c8-8f27-5f0ad7f1d243 + request_id: e4759118-fcd6-4d8a-8150-c2ae2ce940ad errors: - code: unauthorized message: Access Token Invalid @@ -8414,8 +6580,8 @@ paths: events: [] pages: next: http://api.intercom.test/events?next page - email: user26@email.com - intercom_user_id: 6762f22b1bb69f9f2193bc12 + email: user28@email.com + intercom_user_id: 67f7d5e9cc99153fd67531c5 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 schema: "$ref": "#/components/schemas/data_event_summary" @@ -8427,7 +6593,7 @@ paths: Unauthorized: value: type: error.list - request_id: e6f50446-be4a-40ac-8c8d-6fb91e1040fd + request_id: 833c7f67-e643-4c3c-962c-ab2c3aaa471c errors: - code: unauthorized message: Access Token Invalid @@ -8458,7 +6624,7 @@ paths: Unauthorized: value: type: error.list - request_id: 7a7d8425-2c1b-46ab-8133-c043fc1e5711 + request_id: 60113c9e-f576-4fa8-acb9-fc4bbb65e92a errors: - code: unauthorized message: Access Token Invalid @@ -8502,7 +6668,7 @@ paths: examples: successful: value: - job_identifier: al9w983lwu88w1fd + job_identifier: fvpr3m1jx9ahn33g status: pending download_url: '' download_expires_at: '' @@ -8517,8 +6683,8 @@ paths: successful: summary: successful value: - created_at_after: 1734519776 - created_at_before: 1734537776 + created_at_after: 1744277404 + created_at_before: 1744295404 "/export/content/data/{job_identifier}": get: summary: Show content data export @@ -8552,7 +6718,7 @@ paths: examples: successful: value: - job_identifier: braxwk3j039t6txy + job_identifier: 80rorjqluursine6 status: pending download_url: '' download_expires_at: '' @@ -8584,7 +6750,7 @@ paths: examples: successful: value: - job_identifier: v134nyc2bku9hj91 + job_identifier: d1tkk2lvwqcry5cp status: canceled download_url: '' download_expires_at: '' @@ -8616,68 +6782,6 @@ paths: responses: '200': description: successful - "/jobs/status/{id}": - get: - summary: Retrieve job status - parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - - name: id - in: path - required: true - description: The unique identifier for the job which is given by Intercom - schema: - type: string - tags: - - Jobs - operationId: jobsStatus - description: Retrieve the status of job execution. - responses: - '200': - description: Job execution status - content: - application/json: - examples: - job status retrieved: - value: - type: job - id: '2' - status: success - resource_type: ticket - resource_id: '20' - resource_url: 'https://api.intercom.io/tickets/20' - schema: - "$ref": "#/components/schemas/jobs" - '404': - description: Job not found - content: - application/json: - examples: - Job not found: - value: - type: error.list - request_id: 123e4567-e89b-12d3-a456-426614174000 - errors: - - code: job_not_found - message: Job Not Found - schema: - "$ref": "#/components/schemas/error" - '401': - description: Unauthorized - content: - application/json: - examples: - Unauthorized: - value: - type: error.list - request_id: 2c8a20ee-ed09-42c0-a31d-a1b4f5d2742d - errors: - - code: unauthorized - message: Access Token Invalid - schema: - "$ref": "#/components/schemas/error" "/messages": post: summary: Create a message @@ -8690,7 +6794,7 @@ paths: - 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, an email or sms.\n\n> \U0001F6A7 + 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 @@ -8707,34 +6811,32 @@ paths: user message created: value: type: user_message - id: '403918396' - created_at: 1734537780 + id: '403918118' + created_at: 1744295408 body: heyy message_type: inapp - conversation_id: '613' + conversation_id: '58' lead message created: value: type: user_message - id: '403918397' - created_at: 1734537783 + id: '403918119' + created_at: 1744295409 body: heyy message_type: inapp - conversation_id: '614' + conversation_id: '59' admin message created: value: type: admin_message - id: '19' - created_at: 1734537786 + id: '1' + created_at: 1744295411 subject: heyy body: heyy message_type: inapp owner: type: admin - id: '991267816' - name: Ciaran299 Lee - email: admin299@email.com - away_mode_enabled: false - away_mode_reassign: false + id: '991266519' + name: Ciaran247 Lee + email: admin247@email.com schema: "$ref": "#/components/schemas/message" '400': @@ -8745,24 +6847,17 @@ paths: No body supplied for message: value: type: error.list - request_id: 3f3e74cc-65af-4408-9bf5-9e71b55c8166 + request_id: 7c91f0d2-defa-43f9-abd1-7d28d9f50d4f errors: - code: parameter_invalid message: Body is required No body supplied for email message: value: type: error.list - request_id: 2d6abc61-1441-4860-9ef0-777852f8b24f + request_id: 6b6aa70d-252a-4874-8a13-8a1ef66b1cb4 errors: - code: parameter_invalid message: Body is required - Invalid body supplied for sms message: - value: - type: error.list - request_id: d7997515-65af-4860-9bf5-777852f8b24f - errors: - - code: parameter_invalid - message: Invalid SMS message body schema: "$ref": "#/components/schemas/error" '422': @@ -8773,7 +6868,7 @@ paths: No subject supplied for email message: value: type: error.list - request_id: 97db463e-7070-4ac9-9846-9a5d31933772 + request_id: 156e2d3d-c377-4a4a-8e15-95b1f5505fe1 errors: - code: parameter_not_found message: No subject supplied for email message @@ -8787,7 +6882,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2c8a20ee-ed09-42c0-a31d-a1b4f5d2742d + request_id: 05c5bbcc-e418-49d9-b9fc-3f0fadc1ac0b errors: - code: unauthorized message: Access Token Invalid @@ -8801,7 +6896,7 @@ paths: API plan restricted: value: type: error.list - request_id: 72b6821e-54ff-4a25-adf9-abdfef5fe72b + request_id: d45fbdab-c1d5-404d-ac8e-38f8796f33ba errors: - code: api_plan_restricted message: Active subscription needed. @@ -8818,7 +6913,7 @@ paths: value: from: type: user - id: 6762f2341bb69f9f2193bc17 + id: 67f7d5efcc99153fd67531ca body: heyy referer: https://twitter.com/bob lead_message_created: @@ -8826,7 +6921,7 @@ paths: value: from: type: lead - id: 6762f2371bb69f9f2193bc18 + id: 67f7d5f1cc99153fd67531cb body: heyy referer: https://twitter.com/bob admin_message_created: @@ -8834,32 +6929,21 @@ paths: value: from: type: admin - id: '991267816' + id: '991266519' to: type: user - id: 6762f2391bb69f9f2193bc19 + id: 67f7d5f3cc99153fd67531cc message_type: conversation body: heyy - admin_sms_message_created: - summary: admin sms message created - value: - from: - type: admin - id: '991267817' - to: - type: user - id: 6762f23a1bb69f9f2193bc1a - message_type: sms - body: heyy no_body_supplied_for_message: summary: No body supplied for message value: from: type: admin - id: '991267818' + id: '991266521' to: type: user - id: 6762f23b1bb69f9f2193bc1a + id: 67f7d5f4cc99153fd67531cd message_type: inapp body: subject: heyy @@ -8868,7 +6952,7 @@ paths: value: from: type: admin - id: '991267819' + id: '991266522' to: type: user user_id: '70' @@ -8879,24 +6963,13 @@ paths: value: from: type: admin - id: '991267820' + id: '991266523' to: type: user - id: 6762f23d1bb69f9f2193bc1c + id: 67f7d5f5cc99153fd67531cf message_type: email body: subject: heyy - invalid_body_supplied_for_sms_message: - summary: Invalid body supplied for sms message - value: - from: - type: admin - id: '991267821' - to: - type: user - id: 6762f23b1bb69f9f2193bc1d - message_type: sms - body: heyy https://picsum.photos/200/300 "/news/news_items": get: summary: List all news items @@ -8924,12 +6997,12 @@ paths: total_pages: 1 type: pages data: - - id: '29' + - id: '2' type: news-item - workspace_id: this_is_an_id530_that_should_be_at_least_ + workspace_id: this_is_an_id448_that_should_be_at_least_ title: We have news body: "

Hello there,

" - sender_id: 991267825 + sender_id: 991266530 state: draft labels: [] cover_image_url: @@ -8939,15 +7012,15 @@ paths: - - deliver_silently: false - created_at: 1734537793 - updated_at: 1734537793 + created_at: 1744295416 + updated_at: 1744295416 newsfeed_assignments: [] - - id: '30' + - id: '1' type: news-item - workspace_id: this_is_an_id530_that_should_be_at_least_ + workspace_id: this_is_an_id448_that_should_be_at_least_ title: We have news body: "

Hello there,

" - sender_id: 991267827 + sender_id: 991266528 state: draft labels: [] cover_image_url: @@ -8957,8 +7030,8 @@ paths: - - deliver_silently: false - created_at: 1734537793 - updated_at: 1734537793 + created_at: 1744295415 + updated_at: 1744295415 newsfeed_assignments: [] total_count: 2 schema: @@ -8971,7 +7044,7 @@ paths: Unauthorized: value: type: error.list - request_id: d7997515-cd92-4fe4-966c-cb1f4bdda1d4 + request_id: a8b5e55e-b09d-4d67-9508-f126a0f020f1 errors: - code: unauthorized message: Access Token Invalid @@ -8996,12 +7069,12 @@ paths: examples: successful: value: - id: '33' + id: '5' type: news-item - workspace_id: this_is_an_id534_that_should_be_at_least_ + workspace_id: this_is_an_id452_that_should_be_at_least_ title: Halloween is here! body: "

New costumes in store for this spooky season

" - sender_id: 991267834 + sender_id: 991266537 state: live labels: - New @@ -9012,10 +7085,10 @@ paths: - "\U0001F606" - "\U0001F605" deliver_silently: true - created_at: 1734537797 - updated_at: 1734537797 + created_at: 1744295417 + updated_at: 1744295417 newsfeed_assignments: - - newsfeed_id: 53 + - newsfeed_id: 3 published_at: 1664638214 schema: "$ref": "#/components/schemas/news_item" @@ -9027,7 +7100,7 @@ paths: Unauthorized: value: type: error.list - request_id: 5142ad8e-883e-4b71-9adb-6494851e9b77 + request_id: 24cf0adf-b582-4be9-9003-1ddcfc5f8dda errors: - code: unauthorized message: Access Token Invalid @@ -9048,14 +7121,14 @@ paths: - Product - Update - New - sender_id: 991267834 + sender_id: 991266537 deliver_silently: true reactions: - "\U0001F606" - "\U0001F605" state: live newsfeed_assignments: - - newsfeed_id: 53 + - newsfeed_id: 3 published_at: 1664638214 "/news/news_items/{id}": get: @@ -9084,12 +7157,12 @@ paths: examples: successful: value: - id: '34' + id: '6' type: news-item - workspace_id: this_is_an_id538_that_should_be_at_least_ + workspace_id: this_is_an_id456_that_should_be_at_least_ title: We have news body: "

Hello there,

" - sender_id: 991267837 + sender_id: 991266540 state: live labels: [] cover_image_url: @@ -9099,11 +7172,11 @@ paths: - - deliver_silently: false - created_at: 1734537800 - updated_at: 1734537800 + created_at: 1744295419 + updated_at: 1744295419 newsfeed_assignments: - - newsfeed_id: 55 - published_at: 1734537800 + - newsfeed_id: 5 + published_at: 1744295419 schema: "$ref": "#/components/schemas/news_item" '404': @@ -9114,7 +7187,7 @@ paths: News Item Not Found: value: type: error.list - request_id: da84e250-8626-47e8-815c-62b33f0f2c36 + request_id: 45e79bcb-69b4-4231-84ba-1981ae209bb9 errors: - code: not_found message: Resource Not Found @@ -9128,7 +7201,7 @@ paths: Unauthorized: value: type: error.list - request_id: 33ff62c6-ceb7-4bde-93d6-301bed6f24b2 + request_id: c83ce013-6d85-4606-b6fe-c6c7fe2884fb errors: - code: unauthorized message: Access Token Invalid @@ -9159,12 +7232,12 @@ paths: examples: successful: value: - id: '37' + id: '9' type: news-item - workspace_id: this_is_an_id544_that_should_be_at_least_ + workspace_id: this_is_an_id462_that_should_be_at_least_ title: Christmas is here! body: "

New gifts in store for the jolly season

" - sender_id: 991267845 + sender_id: 991266548 state: live labels: [] cover_image_url: @@ -9172,8 +7245,8 @@ paths: - "\U0001F61D" - "\U0001F602" deliver_silently: false - created_at: 1734537803 - updated_at: 1734537804 + created_at: 1744295421 + updated_at: 1744295422 newsfeed_assignments: [] schema: "$ref": "#/components/schemas/news_item" @@ -9185,7 +7258,7 @@ paths: News Item Not Found: value: type: error.list - request_id: 2014d867-b634-495a-9b4f-ce56c4d657a9 + request_id: ac8db914-2c93-4481-a715-4c5ec97fbb30 errors: - code: not_found message: Resource Not Found @@ -9199,7 +7272,7 @@ paths: Unauthorized: value: type: error.list - request_id: 5838c54e-dd15-460b-82dd-794c4d0e12c5 + request_id: 6ce10058-20b8-4b77-b13d-7d431f330f4b errors: - code: unauthorized message: Access Token Invalid @@ -9216,7 +7289,7 @@ paths: value: title: Christmas is here! body: "

New gifts in store for the jolly season

" - sender_id: 991267845 + sender_id: 991266548 reactions: - "\U0001F61D" - "\U0001F602" @@ -9225,7 +7298,7 @@ paths: value: title: Christmas is here! body: "

New gifts in store for the jolly season

" - sender_id: 991267848 + sender_id: 991266551 reactions: - "\U0001F61D" - "\U0001F602" @@ -9255,7 +7328,7 @@ paths: examples: successful: value: - id: '40' + id: '12' object: news-item deleted: true schema: @@ -9268,7 +7341,7 @@ paths: News Item Not Found: value: type: error.list - request_id: 23728e22-7b9f-44a9-9b8d-5028811b9cd0 + request_id: f8c09fb8-250c-469c-9ce3-798d1889ea56 errors: - code: not_found message: Resource Not Found @@ -9282,7 +7355,7 @@ paths: Unauthorized: value: type: error.list - request_id: e5357876-89be-4a04-80c3-16735b7f53ff + request_id: 8ae52140-15ff-40c8-9674-dffc4d9ce2fb errors: - code: unauthorized message: Access Token Invalid @@ -9335,7 +7408,7 @@ paths: Unauthorized: value: type: error.list - request_id: 022ff8b0-d16f-437c-8217-754c13e16dee + request_id: d9499d92-1daa-42ba-b7b8-d63aff40da1e errors: - code: unauthorized message: Access Token Invalid @@ -9368,16 +7441,16 @@ paths: total_pages: 1 type: pages data: - - id: '68' + - id: '18' type: newsfeed name: Visitor Feed - created_at: 1734537813 - updated_at: 1734537813 - - id: '69' + created_at: 1744295428 + updated_at: 1744295428 + - id: '19' type: newsfeed name: Visitor Feed - created_at: 1734537813 - updated_at: 1734537813 + created_at: 1744295428 + updated_at: 1744295428 total_count: 2 schema: "$ref": "#/components/schemas/paginated_response" @@ -9389,7 +7462,7 @@ paths: Unauthorized: value: type: error.list - request_id: caa26d8b-6512-445d-9418-9fc5849ca304 + request_id: c46555f7-b8be-4193-9330-72b80fbe96f6 errors: - code: unauthorized message: Access Token Invalid @@ -9423,11 +7496,11 @@ paths: examples: successful: value: - id: '72' + id: '22' type: newsfeed name: Visitor Feed - created_at: 1734537815 - updated_at: 1734537815 + created_at: 1744295429 + updated_at: 1744295429 schema: "$ref": "#/components/schemas/newsfeed" '401': @@ -9438,7 +7511,7 @@ paths: Unauthorized: value: type: error.list - request_id: 6d9a1bf5-aa08-4c93-a61a-5a21130b6553 + request_id: 9ddcd57a-5743-4371-927a-be79aed740f1 errors: - code: unauthorized message: Access Token Invalid @@ -9472,18 +7545,21 @@ paths: Note found: value: type: note - id: '34' - created_at: 1733846617 + id: '11' + created_at: 1743604230 contact: type: contact - id: 6762f2591bb69f9f2193bc1f + id: 67f7d606cc99153fd67531d2 author: type: admin - id: '991267864' - name: Ciaran346 Lee - email: admin346@email.com + id: '991266567' + name: Ciaran294 Lee + email: admin294@email.com away_mode_enabled: false away_mode_reassign: false + away_status_reason_id: + has_inbox_seat: true + team_ids: [] body: "

This is a note.

" schema: "$ref": "#/components/schemas/note" @@ -9495,7 +7571,7 @@ paths: Note not found: value: type: error.list - request_id: bc300b1a-492a-405f-924e-a5881cb72e3a + request_id: 368cc7e2-efbb-427c-a1df-eced675dc2da errors: - code: not_found message: Resource Not Found @@ -9509,7 +7585,7 @@ paths: Unauthorized: value: type: error.list - request_id: 81384687-5818-4df9-b421-fba77edd6c17 + request_id: 697384eb-e597-4db2-b19b-6a1e809d987b errors: - code: unauthorized message: Access Token Invalid @@ -9545,16 +7621,16 @@ paths: type: segment.list segments: - type: segment - id: 6762f25c1bb69f9f2193bc22 + id: 67f7d608cc99153fd67531d5 name: John segment - created_at: 1734537820 - updated_at: 1734537820 + created_at: 1744295432 + updated_at: 1744295432 person_type: user - type: segment - id: 6762f25c1bb69f9f2193bc23 + id: 67f7d608cc99153fd67531d6 name: Jane segment - created_at: 1734537820 - updated_at: 1734537820 + created_at: 1744295432 + updated_at: 1744295432 person_type: user schema: "$ref": "#/components/schemas/segment_list" @@ -9566,7 +7642,7 @@ paths: Unauthorized: value: type: error.list - request_id: b1939528-98f0-4a63-a442-2cc9203fc8c7 + request_id: d62979af-05d2-4426-905c-c76b70fd1963 errors: - code: unauthorized message: Access Token Invalid @@ -9600,10 +7676,10 @@ paths: Successful response: value: type: segment - id: 6762f25f1bb69f9f2193bc26 + id: 67f7d609cc99153fd67531d9 name: John segment - created_at: 1734537823 - updated_at: 1734537823 + created_at: 1744295433 + updated_at: 1744295433 person_type: user schema: "$ref": "#/components/schemas/segment" @@ -9615,7 +7691,7 @@ paths: Segment not found: value: type: error.list - request_id: bd697cc6-7757-488c-a89f-16e6feaf7585 + request_id: 5cb854d5-18f1-4599-aac1-fca1a70ecaa8 errors: - code: not_found message: Resource Not Found @@ -9629,7 +7705,7 @@ paths: Unauthorized: value: type: error.list - request_id: be0d5309-d722-4d2a-aae9-77f4bc0a2cd0 + request_id: 9314e4e8-7b87-4ec2-a23b-a525dd264b6b errors: - code: unauthorized message: Access Token Invalid @@ -9659,7 +7735,7 @@ paths: type: list data: - type: subscription - id: '135' + id: '45' state: live consent_type: opt_out default_translation: @@ -9682,7 +7758,7 @@ paths: Unauthorized: value: type: error.list - request_id: 06d15b1f-19b0-42cc-aff9-a9d9db39402b + request_id: 223a6eb9-a8e3-4d22-89d9-83f440f021ff errors: - code: unauthorized message: Access Token Invalid @@ -9712,7 +7788,7 @@ paths: examples: successful: value: - url: http://via.intercom.io/msgr/1add3dd1-a75e-4a96-96fd-984d16aba059 + url: http://via.intercom.io/msgr/68972eee-f569-4d02-b021-ca79ba0a0866 type: phone_call_redirect schema: "$ref": "#/components/schemas/phone_switch" @@ -9745,7 +7821,7 @@ paths: Unauthorized: value: type: error.list - request_id: e1ed4f34-9477-492a-8ddb-22f10af39734 + request_id: '09d1a806-ae89-4c11-a892-2101fb16aa55' errors: - code: unauthorized message: Access Token Invalid @@ -9808,7 +7884,7 @@ paths: type: list data: - type: tag - id: '102' + id: '12' name: Manual tag 1 schema: "$ref": "#/components/schemas/tag_list" @@ -9820,7 +7896,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2859da57-c83f-405c-8166-240a312442a3 + request_id: b1a0a721-d953-4d56-80f6-409bb763b91c errors: - code: unauthorized message: Access Token Invalid @@ -9859,7 +7935,7 @@ paths: Action successful: value: type: tag - id: '105' + id: '15' name: test schema: "$ref": "#/components/schemas/tag" @@ -9871,7 +7947,7 @@ paths: Invalid parameters: value: type: error.list - request_id: 33a05108-3bf7-411f-a270-72db40b5a31c + request_id: a7147ef5-2bd4-41e7-a2e4-57143a902ce7 errors: - code: parameter_invalid message: invalid tag parameters @@ -9885,14 +7961,14 @@ paths: Company not found: value: type: error.list - request_id: 23c998cc-32b8-435d-9653-932c15809460 + request_id: 711ae745-9786-4983-9e5e-6114590f0cb7 errors: - code: company_not_found message: Company Not Found User not found: value: type: error.list - request_id: 7358f78d-f122-45dd-a2e1-c2261300c38a + request_id: dcaa575e-81d0-4751-b194-98893b151336 errors: - code: not_found message: User Not Found @@ -9906,7 +7982,7 @@ paths: Unauthorized: value: type: error.list - request_id: f230e3a7-00a9-456b-bf1c-2ad4b7dc49f6 + request_id: 4219e55e-6c8f-4638-9f3d-4107ee80ae1d errors: - code: unauthorized message: Access Token Invalid @@ -9972,7 +8048,7 @@ paths: Tag found: value: type: tag - id: '113' + id: '23' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -9984,7 +8060,7 @@ paths: Tag not found: value: type: error.list - request_id: e20c89d2-29c6-4abb-aa3d-c860e1cec1ca + request_id: f207e21d-edd0-4bbb-be22-143d4500e119 errors: - code: not_found message: Resource Not Found @@ -9998,7 +8074,7 @@ paths: Unauthorized: value: type: error.list - request_id: c1c0477c-5b80-4874-be65-01ec8a9ffe14 + request_id: b563c9bc-c03f-45fb-8863-b1f03f252acc errors: - code: unauthorized message: Access Token Invalid @@ -10034,7 +8110,7 @@ paths: Resource not found: value: type: error.list - request_id: 49536975-bbc5-4a2f-ab8b-7928275cb4d3 + request_id: 0ebf4b13-b96e-4706-aa8c-702b8fd46531 errors: - code: not_found message: Resource Not Found @@ -10048,7 +8124,7 @@ paths: Tag has dependent objects: value: type: error.list - request_id: 28960d1e-a056-46c0-bf18-a0d798eb889f + request_id: 8e43ecc0-61ef-4a8e-99d7-76dd38d78784 errors: - code: tag_has_dependent_objects message: 'Unable to delete Tag with dependent objects. Segments: @@ -10063,7 +8139,7 @@ paths: Unauthorized: value: type: error.list - request_id: 90a369be-14bb-48d1-8ed6-6287976f6a64 + request_id: 7084c137-cf60-4051-8743-100b2566d69b errors: - code: unauthorized message: Access Token Invalid @@ -10101,7 +8177,7 @@ paths: Unauthorized: value: type: error.list - request_id: a77dadbc-1f1e-4875-bac3-f0d09bbc214a + request_id: 00a7ede3-01eb-4b2b-b359-91fd1946f887 errors: - code: unauthorized message: Access Token Invalid @@ -10136,7 +8212,7 @@ paths: successful: value: type: team - id: '991267902' + id: '991266605' name: team 1 admin_ids: [] schema: @@ -10149,7 +8225,7 @@ paths: Team not found: value: type: error.list - request_id: 3ff156ba-a66e-40d4-93ff-cb6e6afc3c9d + request_id: f71fa21a-2dc2-4554-8c72-c959bde72c55 errors: - code: team_not_found message: Team not found @@ -10163,7 +8239,7 @@ paths: Unauthorized: value: type: error.list - request_id: fc4b741b-b9f1-4ef9-92c7-eb71e9811df3 + request_id: 56987deb-2c3a-4921-9c63-1d94593e11ed errors: - code: unauthorized message: Access Token Invalid @@ -10192,7 +8268,7 @@ paths: type: list data: - type: ticket_state - id: '8269' + id: '2213' category: submitted internal_label: Submitted external_label: Submitted @@ -10200,24 +8276,24 @@ paths: type: list data: - type: ticket_type - id: '55' - name: my-ticket-type-3 + id: '1' + name: my-ticket-type-1 description: my ticket type description is awesome. icon: "\U0001F981" archived: false is_internal: false category: Back-office - type: ticket_type - id: '56' - name: my-ticket-type-4 + id: '2' + name: my-ticket-type-2 description: my ticket type description is awesome. icon: "\U0001F981" archived: false is_internal: false category: Back-office - type: ticket_type - id: '58' - name: my-ticket-type-6 + id: '4' + name: my-ticket-type-4 description: my ticket type description is awesome. icon: "\U0001F981" archived: false @@ -10225,7 +8301,7 @@ paths: category: Back-office archived: false - type: ticket_state - id: '8270' + id: '2214' category: in_progress internal_label: In progress external_label: In progress @@ -10233,24 +8309,24 @@ paths: type: list data: - type: ticket_type - id: '55' - name: my-ticket-type-3 + id: '1' + name: my-ticket-type-1 description: my ticket type description is awesome. icon: "\U0001F981" archived: false is_internal: false category: Back-office - type: ticket_type - id: '56' - name: my-ticket-type-4 + id: '2' + name: my-ticket-type-2 description: my ticket type description is awesome. icon: "\U0001F981" archived: false is_internal: false category: Back-office - type: ticket_type - id: '58' - name: my-ticket-type-6 + id: '4' + name: my-ticket-type-4 description: my ticket type description is awesome. icon: "\U0001F981" archived: false @@ -10258,7 +8334,7 @@ paths: category: Back-office archived: false - type: ticket_state - id: '8271' + id: '2215' category: waiting_on_customer internal_label: Waiting on customer external_label: Waiting on you @@ -10266,24 +8342,24 @@ paths: type: list data: - type: ticket_type - id: '55' - name: my-ticket-type-3 + id: '1' + name: my-ticket-type-1 description: my ticket type description is awesome. icon: "\U0001F981" archived: false is_internal: false category: Back-office - type: ticket_type - id: '56' - name: my-ticket-type-4 + id: '2' + name: my-ticket-type-2 description: my ticket type description is awesome. icon: "\U0001F981" archived: false is_internal: false category: Back-office - type: ticket_type - id: '58' - name: my-ticket-type-6 + id: '4' + name: my-ticket-type-4 description: my ticket type description is awesome. icon: "\U0001F981" archived: false @@ -10291,7 +8367,7 @@ paths: category: Back-office archived: false - type: ticket_state - id: '8272' + id: '2216' category: resolved internal_label: Resolved external_label: Resolved @@ -10299,24 +8375,24 @@ paths: type: list data: - type: ticket_type - id: '55' - name: my-ticket-type-3 + id: '1' + name: my-ticket-type-1 description: my ticket type description is awesome. icon: "\U0001F981" archived: false is_internal: false category: Back-office - type: ticket_type - id: '56' - name: my-ticket-type-4 + id: '2' + name: my-ticket-type-2 description: my ticket type description is awesome. icon: "\U0001F981" archived: false is_internal: false category: Back-office - type: ticket_type - id: '58' - name: my-ticket-type-6 + id: '4' + name: my-ticket-type-4 description: my ticket type description is awesome. icon: "\U0001F981" archived: false @@ -10324,7 +8400,7 @@ paths: category: Back-office archived: false - type: ticket_state - id: '8273' + id: '2217' category: submitted internal_label: Admin label 1 external_label: User label @@ -10332,16 +8408,16 @@ paths: type: list data: - type: ticket_type - id: '55' - name: my-ticket-type-3 + id: '1' + name: my-ticket-type-1 description: my ticket type description is awesome. icon: "\U0001F981" archived: false is_internal: false category: Back-office - type: ticket_type - id: '56' - name: my-ticket-type-4 + id: '2' + name: my-ticket-type-2 description: my ticket type description is awesome. icon: "\U0001F981" archived: false @@ -10349,7 +8425,7 @@ paths: category: Back-office archived: false - type: ticket_state - id: '8274' + id: '2218' category: submitted internal_label: Admin label 2 external_label: User label @@ -10357,8 +8433,8 @@ paths: type: list data: - type: ticket_type - id: '58' - name: my-ticket-type-6 + id: '4' + name: my-ticket-type-4 description: my ticket type description is awesome. icon: "\U0001F981" archived: false @@ -10375,7 +8451,7 @@ paths: Unauthorized: value: type: error.list - request_id: 5e0bd231-7307-42e6-a6ee-babf05bd163b + request_id: 5c6cf015-a51b-4baf-b3be-c62e197805dc errors: - code: unauthorized message: Access Token Invalid @@ -10408,8 +8484,8 @@ paths: Ticket Type Attribute created: value: type: ticket_type_attribute - id: '157' - workspace_id: this_is_an_id640_that_should_be_at_least_ + id: '13' + workspace_id: this_is_an_id558_that_should_be_at_least_ name: Attribute Title description: Attribute Description data_type: string @@ -10421,10 +8497,10 @@ paths: visible_on_create: true visible_to_contacts: true default: false - ticket_type_id: 63 + ticket_type_id: 9 archived: false - created_at: 1734537862 - updated_at: 1734537862 + created_at: 1744295459 + updated_at: 1744295459 schema: "$ref": "#/components/schemas/ticket_type_attribute" '401': @@ -10435,7 +8511,7 @@ paths: Unauthorized: value: type: error.list - request_id: 6c9836ed-8485-4f1d-929d-b9d7e153daed + request_id: 913d3cc6-f816-4d40-9db9-437daedd5be0 errors: - code: unauthorized message: Access Token Invalid @@ -10488,8 +8564,8 @@ paths: Ticket Type Attribute updated: value: type: ticket_type_attribute - id: '162' - workspace_id: this_is_an_id644_that_should_be_at_least_ + id: '18' + workspace_id: this_is_an_id562_that_should_be_at_least_ name: name description: New Attribute Description data_type: string @@ -10499,10 +8575,10 @@ paths: visible_on_create: false visible_to_contacts: false default: false - ticket_type_id: 65 + ticket_type_id: 11 archived: false - created_at: 1734537864 - updated_at: 1734537864 + created_at: 1744295460 + updated_at: 1744295461 schema: "$ref": "#/components/schemas/ticket_type_attribute" '401': @@ -10513,7 +8589,7 @@ paths: Unauthorized: value: type: error.list - request_id: cd303186-b33e-4409-8bfc-5814b176d6e1 + request_id: e62ca5a3-2769-41f2-98a8-3fd8b99dd91c errors: - code: unauthorized message: Access Token Invalid @@ -10552,21 +8628,21 @@ paths: type: list data: - type: ticket_type - id: '67' + id: '13' name: Bug Report description: Bug Report Template icon: "\U0001F39F️" - workspace_id: this_is_an_id648_that_should_be_at_least_ + workspace_id: this_is_an_id566_that_should_be_at_least_ archived: false - created_at: 1734537866 - updated_at: 1734537866 + created_at: 1744295461 + updated_at: 1744295461 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '165' - workspace_id: this_is_an_id648_that_should_be_at_least_ + id: '21' + workspace_id: this_is_an_id566_that_should_be_at_least_ name: _default_title_ description: '' data_type: string @@ -10578,13 +8654,13 @@ paths: visible_on_create: true visible_to_contacts: true default: true - ticket_type_id: 67 + ticket_type_id: 13 archived: false - created_at: 1734537866 - updated_at: 1734537866 + created_at: 1744295461 + updated_at: 1744295461 - type: ticket_type_attribute - id: '167' - workspace_id: this_is_an_id648_that_should_be_at_least_ + id: '23' + workspace_id: this_is_an_id566_that_should_be_at_least_ name: name description: description data_type: string @@ -10595,13 +8671,13 @@ paths: visible_on_create: false visible_to_contacts: false default: false - ticket_type_id: 67 + ticket_type_id: 13 archived: false - created_at: 1734537866 - updated_at: 1734537866 + created_at: 1744295462 + updated_at: 1744295462 - type: ticket_type_attribute - id: '166' - workspace_id: this_is_an_id648_that_should_be_at_least_ + id: '22' + workspace_id: this_is_an_id566_that_should_be_at_least_ name: _default_description_ description: '' data_type: string @@ -10613,31 +8689,31 @@ paths: visible_on_create: true visible_to_contacts: true default: true - ticket_type_id: 67 + ticket_type_id: 13 archived: false - created_at: 1734537866 - updated_at: 1734537866 + created_at: 1744295461 + updated_at: 1744295461 category: Customer ticket_states: type: list data: - type: ticket_state - id: '8321' + id: '2265' category: submitted internal_label: Submitted external_label: Submitted - type: ticket_state - id: '8322' + id: '2266' category: in_progress internal_label: In progress external_label: In progress - type: ticket_state - id: '8323' + id: '2267' category: waiting_on_customer internal_label: Waiting on customer external_label: Waiting on you - type: ticket_state - id: '8324' + id: '2268' category: resolved internal_label: Resolved external_label: Resolved @@ -10651,7 +8727,7 @@ paths: Unauthorized: value: type: error.list - request_id: a63507c2-3b3b-4a1a-aafa-f08b87eb2c12 + request_id: 57742c5c-5287-4a2b-a81e-f0f4dd911c3e errors: - code: unauthorized message: Access Token Invalid @@ -10680,21 +8756,21 @@ paths: Ticket type created: value: type: ticket_type - id: '70' + id: '16' name: Customer Issue description: Customer Report Template icon: "\U0001F39F️" - workspace_id: this_is_an_id652_that_should_be_at_least_ + workspace_id: this_is_an_id570_that_should_be_at_least_ archived: false - created_at: 1734537869 - updated_at: 1734537869 + created_at: 1744295463 + updated_at: 1744295463 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '174' - workspace_id: this_is_an_id652_that_should_be_at_least_ + id: '30' + workspace_id: this_is_an_id570_that_should_be_at_least_ name: _default_title_ description: '' data_type: string @@ -10706,13 +8782,13 @@ paths: visible_on_create: true visible_to_contacts: true default: true - ticket_type_id: 70 + ticket_type_id: 16 archived: false - created_at: 1734537869 - updated_at: 1734537869 + created_at: 1744295463 + updated_at: 1744295463 - type: ticket_type_attribute - id: '175' - workspace_id: this_is_an_id652_that_should_be_at_least_ + id: '31' + workspace_id: this_is_an_id570_that_should_be_at_least_ name: _default_description_ description: '' data_type: string @@ -10724,31 +8800,31 @@ paths: visible_on_create: true visible_to_contacts: true default: true - ticket_type_id: 70 + ticket_type_id: 16 archived: false - created_at: 1734537869 - updated_at: 1734537869 + created_at: 1744295463 + updated_at: 1744295463 category: Customer ticket_states: type: list data: - type: ticket_state - id: '8337' + id: '2281' category: submitted internal_label: Submitted external_label: Submitted - type: ticket_state - id: '8338' + id: '2282' category: in_progress internal_label: In progress external_label: In progress - type: ticket_state - id: '8339' + id: '2283' category: waiting_on_customer internal_label: Waiting on customer external_label: Waiting on you - type: ticket_state - id: '8340' + id: '2284' category: resolved internal_label: Resolved external_label: Resolved @@ -10762,7 +8838,7 @@ paths: Unauthorized: value: type: error.list - request_id: 36b79d0c-b78f-4e1d-bd6d-bfc3dcc71f53 + request_id: 34d6de81-0be9-4418-a648-a55bfad894e5 errors: - code: unauthorized message: Access Token Invalid @@ -10808,21 +8884,21 @@ paths: Ticket type found: value: type: ticket_type - id: '72' + id: '18' name: Bug Report description: Bug Report Template icon: "\U0001F39F️" - workspace_id: this_is_an_id656_that_should_be_at_least_ + workspace_id: this_is_an_id574_that_should_be_at_least_ archived: false - created_at: 1734537870 - updated_at: 1734537870 + created_at: 1744295464 + updated_at: 1744295464 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '179' - workspace_id: this_is_an_id656_that_should_be_at_least_ + id: '35' + workspace_id: this_is_an_id574_that_should_be_at_least_ name: _default_title_ description: '' data_type: string @@ -10834,13 +8910,13 @@ paths: visible_on_create: true visible_to_contacts: true default: true - ticket_type_id: 72 + ticket_type_id: 18 archived: false - created_at: 1734537871 - updated_at: 1734537871 + created_at: 1744295464 + updated_at: 1744295464 - type: ticket_type_attribute - id: '181' - workspace_id: this_is_an_id656_that_should_be_at_least_ + id: '37' + workspace_id: this_is_an_id574_that_should_be_at_least_ name: name description: description data_type: string @@ -10851,13 +8927,13 @@ paths: visible_on_create: false visible_to_contacts: false default: false - ticket_type_id: 72 + ticket_type_id: 18 archived: false - created_at: 1734537871 - updated_at: 1734537871 + created_at: 1744295464 + updated_at: 1744295464 - type: ticket_type_attribute - id: '180' - workspace_id: this_is_an_id656_that_should_be_at_least_ + id: '36' + workspace_id: this_is_an_id574_that_should_be_at_least_ name: _default_description_ description: '' data_type: string @@ -10869,31 +8945,31 @@ paths: visible_on_create: true visible_to_contacts: true default: true - ticket_type_id: 72 + ticket_type_id: 18 archived: false - created_at: 1734537871 - updated_at: 1734537871 + created_at: 1744295464 + updated_at: 1744295464 category: Customer ticket_states: type: list data: - type: ticket_state - id: '8353' + id: '2297' category: submitted internal_label: Submitted external_label: Submitted - type: ticket_state - id: '8354' + id: '2298' category: in_progress internal_label: In progress external_label: In progress - type: ticket_state - id: '8355' + id: '2299' category: waiting_on_customer internal_label: Waiting on customer external_label: Waiting on you - type: ticket_state - id: '8356' + id: '2300' category: resolved internal_label: Resolved external_label: Resolved @@ -10907,7 +8983,7 @@ paths: Unauthorized: value: type: error.list - request_id: c9a2c3da-7536-4eba-bde7-c38c2d9e2942 + request_id: 835a2ca1-fade-4961-80e2-3227bb7afe71 errors: - code: unauthorized message: Access Token Invalid @@ -10940,21 +9016,21 @@ paths: Ticket type updated: value: type: ticket_type - id: '74' + id: '20' name: Bug Report 2 description: Bug Report Template icon: "\U0001F39F️" - workspace_id: this_is_an_id660_that_should_be_at_least_ + workspace_id: this_is_an_id578_that_should_be_at_least_ archived: false - created_at: 1734537873 - updated_at: 1734537874 + created_at: 1744295466 + updated_at: 1744295466 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '185' - workspace_id: this_is_an_id660_that_should_be_at_least_ + id: '41' + workspace_id: this_is_an_id578_that_should_be_at_least_ name: _default_title_ description: '' data_type: string @@ -10966,13 +9042,13 @@ paths: visible_on_create: true visible_to_contacts: true default: true - ticket_type_id: 74 + ticket_type_id: 20 archived: false - created_at: 1734537873 - updated_at: 1734537873 + created_at: 1744295466 + updated_at: 1744295466 - type: ticket_type_attribute - id: '187' - workspace_id: this_is_an_id660_that_should_be_at_least_ + id: '43' + workspace_id: this_is_an_id578_that_should_be_at_least_ name: name description: description data_type: string @@ -10983,13 +9059,13 @@ paths: visible_on_create: false visible_to_contacts: false default: false - ticket_type_id: 74 + ticket_type_id: 20 archived: false - created_at: 1734537873 - updated_at: 1734537873 + created_at: 1744295466 + updated_at: 1744295466 - type: ticket_type_attribute - id: '186' - workspace_id: this_is_an_id660_that_should_be_at_least_ + id: '42' + workspace_id: this_is_an_id578_that_should_be_at_least_ name: _default_description_ description: '' data_type: string @@ -11001,31 +9077,31 @@ paths: visible_on_create: true visible_to_contacts: true default: true - ticket_type_id: 74 + ticket_type_id: 20 archived: false - created_at: 1734537873 - updated_at: 1734537873 + created_at: 1744295466 + updated_at: 1744295466 category: Customer ticket_states: type: list data: - type: ticket_state - id: '8369' + id: '2313' category: submitted internal_label: Submitted external_label: Submitted - type: ticket_state - id: '8370' + id: '2314' category: in_progress internal_label: In progress external_label: In progress - type: ticket_state - id: '8371' + id: '2315' category: waiting_on_customer internal_label: Waiting on customer external_label: Waiting on you - type: ticket_state - id: '8372' + id: '2316' category: resolved internal_label: Resolved external_label: Resolved @@ -11039,7 +9115,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2fc2ae95-64ec-4581-80f0-79ecfdc2e759 + request_id: 94c0d097-90b4-46d2-9b38-99305b5c73dd errors: - code: unauthorized message: Access Token Invalid @@ -11085,7 +9161,7 @@ paths: User reply: value: type: error.list - request_id: 603ce1da-f2bf-4641-a1ee-d1f13ebf9172 + request_id: a9174d89-529a-4389-ba07-c91477d11ee4 errors: - code: parameter_mismatch message: User replies are not allowed on Backoffice tickets @@ -11099,7 +9175,7 @@ paths: Admin note reply: value: type: ticket_part - id: '156' + id: '5' part_type: note body: |-

An Unordered HTML List

@@ -11114,30 +9190,31 @@ paths:
  • Tea
  • Milk
    • - created_at: 1734537884 - updated_at: 1734537884 + created_at: 1744295473 + updated_at: 1744295473 author: - id: '991267943' + id: '991266646' type: admin - name: Ciaran419 Lee - email: admin419@email.com + name: Ciaran367 Lee + email: admin367@email.com attachments: [] redacted: false - app_package_code: test-integration + app_package_code: test-app-package-259 Admin quick_reply reply: value: type: ticket_part - id: '158' + id: '7' part_type: quick_reply - created_at: 1734537890 - updated_at: 1734537890 + created_at: 1744295477 + updated_at: 1744295477 author: - id: '991267948' + id: '991266651' type: admin - name: Ciaran423 Lee - email: admin423@email.com + name: Ciaran371 Lee + email: admin371@email.com attachments: [] redacted: false + app_package_code: test-app-package-260 schema: "$ref": "#/components/schemas/ticket_reply" '404': @@ -11148,7 +9225,7 @@ paths: Not found: value: type: error.list - request_id: 24561472-06a4-41b2-aca2-97b3ccd9ca19 + request_id: be07ac19-ef13-4d51-8fc5-e55d12760190 errors: - code: not_found message: Resource Not Found @@ -11162,7 +9239,7 @@ paths: Unauthorized: value: type: error.list - request_id: ed4305b3-4364-4fab-9f8d-e07e9a8190ab + request_id: 7fc96685-0c6e-4039-ac9d-1a558ee20048 errors: - code: unauthorized message: Access Token Invalid @@ -11187,14 +9264,14 @@ paths: value: message_type: comment type: user - intercom_user_id: 6762f2971bb69f9f2193bc49 + intercom_user_id: 67f7d62ecc99153fd67531fc body: Thanks again :) admin_note_reply: summary: Admin note reply value: message_type: note type: admin - admin_id: 991267943 + admin_id: 991266646 body: "

    An Unordered HTML List

    An Ordered HTML List

    \
    1. Coffee
    2. Tea
    3. Milk
    @@ -11204,18 +9281,18 @@ paths: value: message_type: quick_reply type: admin - admin_id: 991267948 + admin_id: 991266651 reply_options: - text: 'Yes' - uuid: 0df48b85-9a93-4c66-a167-753eff0baaec + uuid: acce66d3-a608-476d-bf70-a67895df27c7 - text: 'No' - uuid: 4f0b5145-4193-4b4f-8cad-ce19478a3938 + uuid: 2740b48d-1675-477b-abe2-2ffd4c0c8551 not_found: summary: Not found value: message_type: comment type: user - intercom_user_id: 6762f2a41bb69f9f2193bc4c + intercom_user_id: 67f7d637cc99153fd67531ff body: Thanks again :) "/tickets/{ticket_id}/tags": post: @@ -11247,7 +9324,7 @@ paths: successful: value: type: tag - id: '121' + id: '31' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -11259,7 +9336,7 @@ paths: Ticket not found: value: type: error.list - request_id: b44cff1d-c6f8-4d60-ab6f-33522cd739d8 + request_id: e8437b8f-3d26-4bf0-b4ed-c491fdb0e1b8 errors: - code: ticket_not_found message: Ticket not found @@ -11273,7 +9350,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2bed74fe-1b04-4c07-8813-02c700e8dcad + request_id: 8f1db9fb-9f66-4593-9626-c61a048fc3be errors: - code: unauthorized message: Access Token Invalid @@ -11302,13 +9379,13 @@ paths: successful: summary: successful value: - id: 121 - admin_id: 991267958 + id: 31 + admin_id: 991266661 ticket_not_found: summary: Ticket not found value: - id: 122 - admin_id: 991267963 + id: 32 + admin_id: 991266666 "/tickets/{ticket_id}/tags/{id}": delete: summary: Remove tag from a ticket @@ -11346,7 +9423,7 @@ paths: successful: value: type: tag - id: '124' + id: '34' name: Manual tag schema: "$ref": "#/components/schemas/tag" @@ -11358,14 +9435,14 @@ paths: Ticket not found: value: type: error.list - request_id: 734019dc-1d61-4fad-a86e-e3fb06244c4d + request_id: 718affc9-aa8e-42d5-8606-b4a60859c511 errors: - code: ticket_not_found message: Ticket not found Tag not found: value: type: error.list - request_id: a3658b9a-3562-48a7-8afe-362284632d67 + request_id: 2c25242b-546a-4fb3-940f-72144aa6c829 errors: - code: tag_not_found message: Tag not found @@ -11379,7 +9456,7 @@ paths: Unauthorized: value: type: error.list - request_id: 2e87c98e-4ffc-407e-b7bc-065d4d456ea7 + request_id: 57bb67b6-3e4c-4d74-bfbb-030958c52bdf errors: - code: unauthorized message: Access Token Invalid @@ -11402,15 +9479,15 @@ paths: successful: summary: successful value: - admin_id: 991267973 + admin_id: 991266676 ticket_not_found: summary: Ticket not found value: - admin_id: 991267978 + admin_id: 991266681 tag_not_found: summary: Tag not found value: - admin_id: 991267983 + admin_id: 991266686 "/tickets": post: summary: Create a ticket @@ -11432,34 +9509,34 @@ paths: Successful response: value: type: ticket - id: '626' - ticket_id: '33' + id: '71' + ticket_id: '11' ticket_attributes: _default_title_: example _default_description_: there is a problem ticket_state: type: ticket_state - id: '8481' + id: '2425' category: submitted internal_label: Submitted external_label: Submitted ticket_type: type: ticket_type - id: '88' - name: my-ticket-type-23 + id: '34' + name: my-ticket-type-21 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_id606_that_should_be_at_least_ archived: false - created_at: 1734537943 - updated_at: 1734537943 + created_at: 1744295508 + updated_at: 1744295508 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '196' - workspace_id: this_is_an_id688_that_should_be_at_least_ + id: '52' + workspace_id: this_is_an_id606_that_should_be_at_least_ name: _default_title_ description: ola data_type: string @@ -11470,13 +9547,13 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 88 + ticket_type_id: 34 archived: false - created_at: 1734537943 - updated_at: 1734537943 + created_at: 1744295508 + updated_at: 1744295508 - type: ticket_type_attribute - id: '197' - workspace_id: this_is_an_id688_that_should_be_at_least_ + id: '53' + workspace_id: this_is_an_id606_that_should_be_at_least_ name: _default_description_ description: ola data_type: string @@ -11487,36 +9564,36 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 88 + ticket_type_id: 34 archived: false - created_at: 1734537943 - updated_at: 1734537943 + created_at: 1744295508 + updated_at: 1744295508 category: Back-office contacts: type: contact.list contacts: - type: contact - id: 6762f2d81bb69f9f2193bc54 + id: 67f7d655cc99153fd6753207 external_id: '70' admin_assignee_id: '0' team_assignee_id: '0' - created_at: 1734537944 - updated_at: 1734537946 + created_at: 1744295509 + updated_at: 1744295510 ticket_parts: type: ticket_part.list ticket_parts: - type: ticket_part - id: '175' + id: '24' part_type: ticket_state_updated_by_admin ticket_state: submitted previous_ticket_state: submitted - created_at: 1734537945 - updated_at: 1734537945 + created_at: 1744295510 + updated_at: 1744295510 author: - id: '991267999' + id: '991266702' type: bot name: Fin - email: operator+this_is_an_id688_that_should_be_at_least_@intercom.io + email: operator+this_is_an_id606_that_should_be_at_least_@intercom.io attachments: [] redacted: false total_count: 1 @@ -11538,7 +9615,7 @@ paths: Unauthorized: value: type: error.list - request_id: c7bf358f-135e-48d7-8286-a4988a8a1d9b + request_id: 15cb8827-1215-4c77-8a55-1351d0bf3f64 errors: - code: unauthorized message: Access Token Invalid @@ -11559,90 +9636,12 @@ paths: successful_response: summary: Successful response value: - ticket_type_id: 88 - contacts: - - id: 6762f2d81bb69f9f2193bc54 - ticket_attributes: - _default_title_: example - _default_description_: there is a problem - "/tickets/enqueue": - post: - summary: Enqueue create ticket - description: Enqueues ticket creation for asynchronous processing, returning if the job was enqueued successfully to be processed. We attempt to perform a best-effort validation on inputs before tasks are enqueued. If the given parameters are incorrect, we won't enqueue the job. - operationId: enqueueCreateTicket - tags: - - Tickets - parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - requestBody: - content: - application/json: - schema: - allOf: - - "$ref": "#/components/schemas/create_ticket_request" - properties: - skip_notifications: - type: boolean - description: Option to disable notifications when a Ticket is created. - example: true - examples: - successful_response: - summary: Successful response - value: - ticket_type_id: 88 + ticket_type_id: 34 contacts: - - id: 6762f2d81bb69f9f2193bc54 + - id: 67f7d655cc99153fd6753207 ticket_attributes: _default_title_: example _default_description_: there is a problem - responses: - '200': - description: Successful response - content: - application/json: - examples: - Successful response: - value: - type: job - id: "20" - status: pending - url: https://api.intercom.io/jobs/status/20 - resource_type: ticket - resource_id: null - resource_url: null - schema: - "$ref": "#/components/schemas/jobs" - '401': - description: Unauthorized - content: - application/json: - examples: - Unauthorized: - value: - type: error.list - request_id: c7bf358f-135e-48d7-8286-a4988a8a1d9b - errors: - - code: unauthorized - message: Access Token Invalid - schema: - "$ref": "#/components/schemas/error" - '400': - description: Bad Request - content: - application/json: - examples: - Bad Request: - value: - type: error.list - request_id: c7bf358f-135e-48d7-8286-a4988a8a1456 - errors: - - code: parameter_invalid - message: "Missing required ticket attributes" - schema: - "$ref": "#/components/schemas/error" "/tickets/{id}": put: summary: Update a ticket @@ -11670,34 +9669,34 @@ paths: Successful response: value: type: ticket - id: '627' - ticket_id: '34' + id: '72' + ticket_id: '12' ticket_attributes: _default_title_: example _default_description_: there is a problem ticket_state: type: ticket_state - id: '8498' + id: '2442' category: in_progress internal_label: In progress external_label: In progress ticket_type: type: ticket_type - id: '90' - name: my-ticket-type-25 + id: '36' + name: my-ticket-type-23 description: my ticket type description is awesome. icon: "\U0001F981" - workspace_id: this_is_an_id692_that_should_be_at_least_ + workspace_id: this_is_an_id610_that_should_be_at_least_ archived: false - created_at: 1734537948 - updated_at: 1734537948 + created_at: 1744295512 + updated_at: 1744295512 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '200' - workspace_id: this_is_an_id692_that_should_be_at_least_ + id: '56' + workspace_id: this_is_an_id610_that_should_be_at_least_ name: _default_title_ description: ola data_type: string @@ -11708,13 +9707,13 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 90 + ticket_type_id: 36 archived: false - created_at: 1734537949 - updated_at: 1734537949 + created_at: 1744295512 + updated_at: 1744295512 - type: ticket_type_attribute - id: '201' - workspace_id: this_is_an_id692_that_should_be_at_least_ + id: '57' + workspace_id: this_is_an_id610_that_should_be_at_least_ name: _default_description_ description: ola data_type: string @@ -11725,107 +9724,106 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 90 + ticket_type_id: 36 archived: false - created_at: 1734537949 - updated_at: 1734537949 + created_at: 1744295512 + updated_at: 1744295512 category: Back-office contacts: type: contact.list contacts: - type: contact - id: 6762f2dd1bb69f9f2193bc55 - external_id: 8df1fa21-b41d-4621-9229-d6f7a3a590ce - admin_assignee_id: '991268013' + id: 67f7d658cc99153fd6753208 + external_id: f1f85c8c-fc48-4a15-aa9a-d6a9757d93da + admin_assignee_id: '991266716' team_assignee_id: '0' - created_at: 1734537950 - updated_at: 1734537955 + created_at: 1744295512 + updated_at: 1744295516 ticket_parts: type: ticket_part.list ticket_parts: - type: ticket_part - id: '176' + id: '25' part_type: ticket_state_updated_by_admin ticket_state: submitted previous_ticket_state: submitted - created_at: 1734537951 - updated_at: 1734537951 + created_at: 1744295513 + updated_at: 1744295513 author: - id: '991268011' + id: '991266714' type: admin - name: Ciaran477 Lee - email: admin477@email.com + name: Ciaran425 Lee + email: admin425@email.com attachments: [] redacted: false - type: ticket_part - id: '177' + id: '26' part_type: ticket_attribute_updated_by_admin - created_at: 1734537953 - updated_at: 1734537953 + created_at: 1744295514 + updated_at: 1744295514 author: - id: '991268012' - type: bot - name: Fin - email: operator+this_is_an_id692_that_should_be_at_least_@intercom.io + id: '991266714' + type: admin + name: Ciaran425 Lee + email: admin425@email.com attachments: [] redacted: false - type: ticket_part - id: '178' + id: '27' part_type: ticket_attribute_updated_by_admin - created_at: 1734537953 - updated_at: 1734537953 + created_at: 1744295515 + updated_at: 1744295515 author: - id: '991268012' - type: bot - name: Fin - email: operator+this_is_an_id692_that_should_be_at_least_@intercom.io + id: '991266714' + type: admin + name: Ciaran425 Lee + email: admin425@email.com attachments: [] redacted: false - type: ticket_part - id: '179' + id: '28' part_type: ticket_state_updated_by_admin ticket_state: in_progress previous_ticket_state: submitted - created_at: 1734537954 - updated_at: 1734537954 + created_at: 1744295515 + updated_at: 1744295515 author: - id: '991268012' - type: bot - name: Fin - email: operator+this_is_an_id692_that_should_be_at_least_@intercom.io + id: '991266714' + type: admin + name: Ciaran425 Lee + email: admin425@email.com attachments: [] redacted: false - app_package_code: test-integration - type: ticket_part - id: '180' + id: '29' part_type: assignment - created_at: 1734537954 - updated_at: 1734537954 + created_at: 1744295516 + updated_at: 1744295516 assigned_to: type: admin - id: '991268013' + id: '991266716' author: - id: '991268011' + id: '991266714' type: admin - name: Ciaran477 Lee - email: admin477@email.com + name: Ciaran425 Lee + email: admin425@email.com attachments: [] redacted: false - type: ticket_part - id: '181' + id: '30' part_type: snoozed - created_at: 1734537955 - updated_at: 1734537955 + created_at: 1744295516 + updated_at: 1744295516 author: - id: '991268012' - type: bot - name: Fin - email: operator+this_is_an_id692_that_should_be_at_least_@intercom.io + id: '991266714' + type: admin + name: Ciaran425 Lee + email: admin425@email.com attachments: [] redacted: false total_count: 6 open: true - snoozed_until: 1734627600 + snoozed_until: 1744381914 linked_objects: type: list data: [] @@ -11843,14 +9841,14 @@ paths: Admin not found: value: type: error.list - request_id: f9757add-b48a-4519-a6e0-04b2ef9c8c6c + request_id: f6a34658-1aba-44af-87b0-46ae1030dfc2 errors: - - code: assignee_not_found - message: Assignee not found + - code: admin_not_found + message: Admin not found Assignee not found: value: type: error.list - request_id: 39cf6495-768c-450c-a2c4-c9c3c4ea2e01 + request_id: 8ebb053b-5372-4818-9d45-5b5dcc907b37 errors: - code: assignee_not_found message: Assignee not found @@ -11863,7 +9861,7 @@ paths: Ticket state id is not valid or is not associated with the ticket type.: value: type: error.list - request_id: 28b71de1-b451-433a-a08c-845f2b1736b6 + request_id: 96db70a4-a6bb-4b15-ad19-4369a16d5d0e errors: - code: ticket_state_id_invalid message: Ticket state id is not valid or is not associated with @@ -11876,7 +9874,7 @@ paths: Unauthorized: value: type: error.list - request_id: 17db783e-1e43-41c9-b4db-0c05da78a909 + request_id: 1eed2ecd-5674-4965-a704-08084ba5a138 errors: - code: unauthorized message: Access Token Invalid @@ -11894,32 +9892,28 @@ paths: ticket_attributes: _default_title_: example _default_description_: there is a problem - assignment: - admin_id: '991268011' - assignee_id: '991268013' - open: true - snoozed_until: 1673609604 - ticket_state_id: 8498 + snoozed_until: 1744381914 + admin_id: 991266714 + assignee_id: '991266716' + ticket_state_id: 2442 admin_not_found: summary: Admin not found value: ticket_attributes: _default_title_: example _default_description_: there is a problem - assignment: - admin_id: '123' - assignee_id: '991268021' - ticket_state_id: 8506 + admin_id: 123 + assignee_id: '991266724' + ticket_state_id: 2450 assignee_not_found: summary: Assignee not found value: ticket_attributes: _default_title_: example _default_description_: there is a problem - assignment: - admin_id: '991268027' - assignee_id: '456' - ticket_state_id: 8514 + admin_id: 991266730 + assignee_id: '456' + ticket_state_id: 2458 ticket_state_id_is_not_valid_or_is_not_associated_with_the_ticket_type: summary: Ticket state id is not valid or is not associated with the ticket type. @@ -11951,34 +9945,34 @@ paths: Ticket found: value: type: ticket - id: '631' - ticket_id: '38' + id: '76' + ticket_id: '16' ticket_attributes: _default_title_: attribute_value _default_description_: ticket_state: type: ticket_state - id: '8537' + id: '2481' category: submitted internal_label: Submitted external_label: Submitted ticket_type: type: ticket_type - id: '95' - name: my-ticket-type-30 + id: '41' + name: my-ticket-type-28 description: my ticket type description is awesome. icon: "\U0001F981" - workspace_id: this_is_an_id702_that_should_be_at_least_ + workspace_id: this_is_an_id620_that_should_be_at_least_ archived: false - created_at: 1734537973 - updated_at: 1734537973 + created_at: 1744295525 + updated_at: 1744295525 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '210' - workspace_id: this_is_an_id702_that_should_be_at_least_ + id: '66' + workspace_id: this_is_an_id620_that_should_be_at_least_ name: _default_title_ description: ola data_type: string @@ -11989,13 +9983,13 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 95 + ticket_type_id: 41 archived: false - created_at: 1734537973 - updated_at: 1734537973 + created_at: 1744295525 + updated_at: 1744295525 - type: ticket_type_attribute - id: '211' - workspace_id: this_is_an_id702_that_should_be_at_least_ + id: '67' + workspace_id: this_is_an_id620_that_should_be_at_least_ name: _default_description_ description: ola data_type: string @@ -12006,39 +10000,38 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 95 + ticket_type_id: 41 archived: false - created_at: 1734537973 - updated_at: 1734537973 + created_at: 1744295526 + updated_at: 1744295526 category: Back-office contacts: type: contact.list contacts: - type: contact - id: 6762f2f61bb69f9f2193bc59 - external_id: b16afa36-2637-4880-adee-a46d145bc27f + id: 67f7d666cc99153fd675320c + external_id: 28013569-3ced-4d87-85ba-7ed8c0a21fa1 admin_assignee_id: '0' team_assignee_id: '0' - created_at: 1734537974 - updated_at: 1734537976 + created_at: 1744295526 + updated_at: 1744295527 ticket_parts: type: ticket_part.list ticket_parts: - type: ticket_part - id: '185' + id: '34' part_type: ticket_state_updated_by_admin ticket_state: submitted previous_ticket_state: submitted - created_at: 1734537975 - updated_at: 1734537975 + created_at: 1744295526 + updated_at: 1744295526 author: - id: '991268047' + id: '991266750' type: admin - name: Ciaran509 Lee - email: admin509@email.com + name: Ciaran457 Lee + email: admin457@email.com attachments: [] redacted: false - app_package_code: test-integration total_count: 1 open: true linked_objects: @@ -12058,7 +10051,7 @@ paths: Unauthorized: value: type: error.list - request_id: d719ad4f-5ae2-492f-88d6-98ba0a9ab6cc + request_id: abaca57d-fbd1-4f86-b741-3c71b063b2ff errors: - code: unauthorized message: Access Token Invalid @@ -12089,7 +10082,7 @@ paths: examples: successful: value: - id: '632' + id: '77' object: ticket deleted: true schema: @@ -12119,7 +10112,7 @@ paths: Ticket not found: value: type: error.list - request_id: 34a070f1-122e-42dc-a94e-9b86768df26c + request_id: db8ebfe1-e73b-43ab-9afe-cf71fdf6efbb errors: - code: ticket_not_found message: Ticket not found @@ -12164,7 +10157,7 @@ paths: Unauthorized: value: type: error.list - request_id: 50348131-55cd-4ca1-a65f-de093b232adb + request_id: d0f24298-12b8-4075-970b-3d1632e0f2d8 errors: - code: unauthorized message: Access Token Invalid @@ -12204,7 +10197,6 @@ paths: ### 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"`). - The `source.body` field is unique as the search will not be performed against the entire value, but instead against every element of the value separately. For example, when searching for a conversation with a `"I need support"` body - the query should contain a `=` operator with the value `"support"` for such conversation to be returned. A query with a `=` operator and a `"need support"` value will not yield a result. | Field | Type | | :---------------------------------------- | :--------------------------------------------------------------------------------------- | @@ -12261,34 +10253,34 @@ paths: total_count: 1 tickets: - type: ticket - id: '633' - ticket_id: '40' + id: '78' + ticket_id: '18' ticket_attributes: _default_title_: attribute_value _default_description_: ticket_state: type: ticket_state - id: '8577' + id: '2521' category: submitted internal_label: Submitted external_label: Submitted ticket_type: type: ticket_type - id: '100' - name: my-ticket-type-35 + id: '46' + name: my-ticket-type-33 description: my ticket type description is awesome. icon: "\U0001F981" - workspace_id: this_is_an_id712_that_should_be_at_least_ + workspace_id: this_is_an_id630_that_should_be_at_least_ archived: false - created_at: 1734537989 - updated_at: 1734537989 + created_at: 1744295534 + updated_at: 1744295534 is_internal: false ticket_type_attributes: type: list data: - type: ticket_type_attribute - id: '220' - workspace_id: this_is_an_id712_that_should_be_at_least_ + id: '76' + workspace_id: this_is_an_id630_that_should_be_at_least_ name: _default_title_ description: ola data_type: string @@ -12299,13 +10291,13 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 100 + ticket_type_id: 46 archived: false - created_at: 1734537989 - updated_at: 1734537989 + created_at: 1744295534 + updated_at: 1744295534 - type: ticket_type_attribute - id: '221' - workspace_id: this_is_an_id712_that_should_be_at_least_ + id: '77' + workspace_id: this_is_an_id630_that_should_be_at_least_ name: _default_description_ description: ola data_type: string @@ -12316,36 +10308,36 @@ paths: visible_on_create: true visible_to_contacts: false default: false - ticket_type_id: 100 + ticket_type_id: 46 archived: false - created_at: 1734537989 - updated_at: 1734537989 + created_at: 1744295535 + updated_at: 1744295535 category: Back-office contacts: type: contact.list contacts: - type: contact - id: 6762f3061bb69f9f2193bc5b - external_id: 9b913927-c084-4391-b1db-098341b5ffe3 + id: 67f7d66fcc99153fd675320e + external_id: f2de07d5-4e5e-4b71-8cd2-0b270b88b8d3 admin_assignee_id: '0' team_assignee_id: '0' - created_at: 1734537990 - updated_at: 1734537992 + created_at: 1744295535 + updated_at: 1744295536 ticket_parts: type: ticket_part.list ticket_parts: - type: ticket_part - id: '188' + id: '37' part_type: ticket_state_updated_by_admin ticket_state: submitted previous_ticket_state: submitted - created_at: 1734537991 - updated_at: 1734537991 + created_at: 1744295536 + updated_at: 1744295536 author: - id: '991268079' + id: '991266782' type: admin - name: Ciaran539 Lee - email: admin539@email.com + name: Ciaran487 Lee + email: admin487@email.com attachments: [] redacted: false total_count: 1 @@ -12402,26 +10394,26 @@ paths: successful: value: type: visitor - id: 6762f30c1bb69f9f2193bc5e + id: 67f7d673cc99153fd6753211 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' phone: name: Gareth Bale - pseudonym: Violet Suitcase + pseudonym: Blue Kangaroo avatar: type: avatar - image_url: https://static.intercomassets.com/app/pseudonym_avatars_2019/violet-suitcase.png - app_id: this_is_an_id716_that_should_be_at_least_ + image_url: https://static.intercomassets.com/app/pseudonym_avatars_2019/blue-kangaroo.png + app_id: this_is_an_id634_that_should_be_at_least_ companies: type: company.list companies: [] location_data: {} last_request_at: - created_at: 1734537996 - remote_created_at: 1734537996 - signed_up_at: 1734537996 - updated_at: 1734537997 + created_at: 1744295539 + remote_created_at: 1744295539 + signed_up_at: 1744295539 + updated_at: 1744295539 session_count: 0 social_profiles: type: social_profile.list @@ -12454,7 +10446,7 @@ paths: visitor Not Found: value: type: error.list - request_id: 6a6d5522-54e2-437d-8fd0-1109686af965 + request_id: f5f1dc6a-f688-4481-a9ab-ba23e1ba87e7 errors: - code: not_found message: Visitor Not Found @@ -12468,7 +10460,7 @@ paths: Unauthorized: value: type: error.list - request_id: 3f474ec4-4e61-42ee-9acc-eac64982e393 + request_id: 2ec479b8-d906-46c7-a990-c918e92f80ba errors: - code: unauthorized message: Access Token Invalid @@ -12483,7 +10475,7 @@ paths: successful: summary: successful value: - id: 6762f30c1bb69f9f2193bc5e + id: 67f7d673cc99153fd6753211 name: Gareth Bale visitor_not_found: summary: visitor Not Found @@ -12516,7 +10508,7 @@ paths: successful: value: type: visitor - id: 6762f3101bb69f9f2193bc64 + id: 67f7d675cc99153fd6753217 user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 anonymous: true email: '' @@ -12526,16 +10518,16 @@ paths: avatar: type: avatar image_url: - app_id: this_is_an_id722_that_should_be_at_least_ + app_id: this_is_an_id640_that_should_be_at_least_ companies: type: company.list companies: [] location_data: {} last_request_at: - created_at: 1734538000 - remote_created_at: 1734538000 - signed_up_at: 1734538000 - updated_at: 1734538000 + created_at: 1744295541 + remote_created_at: 1744295541 + signed_up_at: 1744295541 + updated_at: 1744295541 session_count: 0 social_profiles: type: social_profile.list @@ -12568,7 +10560,7 @@ paths: Visitor not found: value: type: error.list - request_id: 3c1b017d-39fb-4d13-8cc9-540ad0d37106 + request_id: fdbea5ea-ea3c-4b23-bfc1-bb9371d035f6 errors: - code: not_found message: Visitor Not Found @@ -12582,7 +10574,7 @@ paths: Unauthorized: value: type: error.list - request_id: 1d7f49b3-10bc-4bf8-a28a-1ac95de3a6ff + request_id: c98706a7-34f2-428b-b876-928798664a14 errors: - code: unauthorized message: Access Token Invalid @@ -12613,8 +10605,8 @@ paths: successful: value: type: contact - id: 6762f3141bb69f9f2193bc6b - workspace_id: this_is_an_id728_that_should_be_at_least_ + id: 67f7d677cc99153fd675321e + workspace_id: this_is_an_id646_that_should_be_at_least_ external_id: role: user email: foo@bar.com @@ -12629,9 +10621,9 @@ paths: has_hard_bounced: false marked_email_as_spam: false unsubscribed_from_emails: false - created_at: 1734538004 - updated_at: 1734538005 - signed_up_at: 1734538004 + created_at: 1744295543 + updated_at: 1744295543 + signed_up_at: 1744295543 last_seen_at: last_replied_at: last_contacted_at: @@ -12665,31 +10657,31 @@ paths: tags: type: list data: [] - url: "/contacts/6762f3141bb69f9f2193bc6b/tags" + url: "/contacts/67f7d677cc99153fd675321e/tags" total_count: 0 has_more: false notes: type: list data: [] - url: "/contacts/6762f3141bb69f9f2193bc6b/notes" + url: "/contacts/67f7d677cc99153fd675321e/notes" total_count: 0 has_more: false companies: type: list data: [] - url: "/contacts/6762f3141bb69f9f2193bc6b/companies" + url: "/contacts/67f7d677cc99153fd675321e/companies" total_count: 0 has_more: false opted_out_subscription_types: type: list data: [] - url: "/contacts/6762f3141bb69f9f2193bc6b/subscriptions" + url: "/contacts/67f7d677cc99153fd675321e/subscriptions" total_count: 0 has_more: false opted_in_subscription_types: type: list data: [] - url: "/contacts/6762f3141bb69f9f2193bc6b/subscriptions" + url: "/contacts/67f7d677cc99153fd675321e/subscriptions" total_count: 0 has_more: false utm_campaign: @@ -12698,6 +10690,8 @@ paths: utm_source: utm_term: referrer: + sms_consent: false + unsubscribed_from_sms: false enabled_push_messaging: schema: "$ref": "#/components/schemas/contact" @@ -12709,7 +10703,7 @@ paths: Unauthorized: value: type: error.list - request_id: b3e71306-0600-41e4-9f44-83b52906d2b7 + request_id: 0ebf3251-5555-4e40-8b54-50759407b228 errors: - code: unauthorized message: Access Token Invalid @@ -12731,15 +10725,6 @@ paths: type: user components: schemas: - datetime: - oneOf: - - title: string - type: string - format: date-time - description: A date and time following the ISO8601 notation. - - title: integer - type: integer - description: A date and time as UNIX timestamp notation. activity_log: title: Activity Log type: object @@ -14443,6 +12428,31 @@ components: "$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 @@ -14469,13 +12479,9 @@ components: title: Contact companies type: object nullable: false - description: An object with metadata about companies attached to a contact . Up to 10 will be displayed here. Use the url to get more. + 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: - data: - type: array - description: An array of company data objects attached to the contact. - items: - "$ref": "#/components/schemas/company_data" url: type: string format: uri @@ -14483,7 +12489,7 @@ components: example: "/contacts/5ba682d23d7cf92bef87bfd4/companies" total_count: type: integer - description: Integer representing the total number of companies attached to + description: Int representing the total number of companyies attached to this contact example: 100 has_more: @@ -14491,32 +12497,27 @@ components: description: Whether there's more Addressable Objects to be viewed. If true, use the url to view all example: true - company_data: - title: Company Data + contact_deleted: + title: Contact Deleted type: object - description: An object containing data about the companies that a contact is associated with. + description: deleted contact object properties: - id: - type: string - description: The unique identifier for the company which is given by Intercom. - example: 5ba682d23d7cf92bef87bfd4 type: type: string - description: The type of the object. Always company. + description: always contact enum: - - company - example: company - url: + - contact + example: contact + id: type: string - format: uri - description: The relative URL of the company. - example: "/companies/5ba682d23d7cf92bef87bfd4" - contact_deleted: - title: Contact Deleted - description: deleted contact object - allOf: - - "$ref": "#/components/schemas/contact_reference" - properties: + 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. @@ -14616,7 +12617,7 @@ components: nullable: true description: The unique identifier for the contact which is provided by the Client. - example: "70" + example: f3b87a2e09d514c6c2e79b9a contact_reply_base_request: title: Contact Reply Base Object type: object @@ -14838,37 +12839,31 @@ components: description: Whether there's more Addressable Objects to be viewed. If true, use the url to view all example: true - contact_archived: - title: Contact Archived - description: archived contact object - allOf: - - "$ref": "#/components/schemas/contact_reference" - properties: - archived: - type: boolean - description: Whether the contact is archived or not. - example: true contact_unarchived: title: Contact Unarchived + type: object description: unarchived contact object - allOf: - - "$ref": "#/components/schemas/contact_reference" 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 - contact_blocked: - title: Contact Blocked - type: object - description: blocked contact object - allOf: - - "$ref": "#/components/schemas/contact_reference" - properties: - blocked: - type: boolean - description: Always true. - example: true content_import_source: title: Content Import Source type: object @@ -15284,28 +13279,6 @@ components: email_message_metadata: "$ref": "#/components/schemas/email_message_metadata" nullable: true - state: - type: string - enum: - - open - - closed - - snoozed - description: Indicates the current state of conversation when the conversation part was created. - example: open - tags: - type: array - description: A list of tags objects associated with the conversation part. - items: - "$ref": "#/components/schemas/tag_basic" - nullable: true - event_details: - "$ref": "#/components/schemas/event_details" - nullable: true - app_package_code: - type: string - nullable: true - example: "test-integration" - description: The app package code if this part was created via API. null if the part was not created via API. conversation_part_author: title: Conversation part author type: object @@ -15354,7 +13327,7 @@ components: total_count: type: integer description: '' - example: 1 + example: 2 conversation_rating: title: Conversation Rating type: object @@ -15402,24 +13375,14 @@ components: conversation_source: title: Conversation source type: object - description: The type of the conversation part that started this conversation. Can be Contact, Admin, Campaign, Automated or Operator initiated. + 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 - enum: - - conversation - - email - - facebook - - instagram - - phone_call - - phone_switch - - push - - sms - - twitter - - whatsapp id: type: string description: The id representing the message. @@ -15876,11 +13839,6 @@ components: type: string description: The content of the message. HTML is not supported. example: Hello - created_at: - type: integer - format: date-time - description: The time the conversation was created as a UTC Unix timestamp. If not provided, the current time will be used. This field is only recommneded for migrating past conversations from another source into Intercom. - example: 1671028894 required: - from - body @@ -16191,12 +14149,6 @@ components: - body - from - to - - title: 'message_type: `sms`.' - required: - - message_type - - body - - from - - to create_or_update_company_request: type: object title: Create Or Update Company Request Payload @@ -16276,8 +14228,6 @@ components: type: object nullable: true description: The custom attributes which are set for the Custom Object instance. - additionalProperties: - type: string create_or_update_tag_request: description: You can create or update an existing tag. type: object @@ -16357,15 +14307,6 @@ components: - email example: - id: '1234' - conversation_to_link_id: - type: string - description: "The ID of the conversation you want to link to the ticket. - Here are the valid ways of linking two tickets:\n - - conversation | back-office ticket\n - - customer tickets | non-shared back-office ticket\n - - conversation | tracker ticket\n - - customer ticket | tracker ticket" - example: '1234' company_id: type: string description: The ID of the company that the ticket is associated with. The @@ -16381,16 +14322,11 @@ components: assignment: type: object properties: - admin_assignee_id: + assignee_id: type: string - description: The ID of the admin to which the ticket is assigned. - If not provided, the ticket will be unassigned. + description: The ID of the admin to which the ticket is assigned. If + not provided, the ticket will be unassigned example: '123' - team_assignee_id: - type: string - description: The ID of the team to which the ticket is assigned. - If not provided, the ticket will be unassigned. - example: '8' required: - ticket_type_id - contacts @@ -16538,15 +14474,7 @@ components: additionalProperties: anyOf: - type: string - - type: integer - - $ref: "#/components/schemas/datetime" - "$ref": "#/components/schemas/custom_object_instance_list" - example: - paid_subscriber: true - monthly_spend: 155.5 - team_mates: 9 - start_date_iso8601: "2023-03-04T09:46:14Z" - end_date_timestamp: 1677923174 custom_object_instance: title: Custom Object Instance type: object @@ -16561,35 +14489,11 @@ components: id: type: string description: The Intercom defined id representing the custom object instance. - example: 16032025 + example: 5a7a19e9f59ae20001d1c1e6 external_id: type: string description: The id you have defined for the custom object instance. example: 0001d1c1e65a7a19e9f59ae2 - external_created_at: - type: integer - format: date-time - nullable: true - description: The time when the Custom Object instance was created in the - external system it originated from. - example: 1571672154 - external_updated_at: - type: integer - format: date-time - nullable: true - description: The time when the Custom Object instance was last updated in - the external system it originated from. - example: 1571672154 - 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 type: type: string description: The identifier of the custom object type that defines the structure @@ -17159,114 +15063,6 @@ components: description: A list of an email address headers. items: "$ref": "#/components/schemas/email_address_header" - conversation_attribute_updated_by_workflow: - title: Part type - conversation_attribute_updated_by_workflow - type: object - description: Contains details about the workflow that was triggered and any Custom Data Attributes (CDAs) that were modified during the workflow execution for conversation part type conversation_attribute_updated_by_workflow. - properties: - workflow: - type: object - properties: - name: - type: string - description: Name of the workflow - example: Workflow 1 - attribute: - type: object - properties: - name: - type: string - description: Name of the CDA updated - example: flight_category - value: - type: object - properties: - name: - type: string - description: Value of the CDA updated - example: vip_status - conversation_attribute_updated_by_admin: - title: Part type - conversation_attribute_updated_by_admin - type: object - description: Contains details about Custom Data Attributes (CDAs) that were modified by an admin (operator) for conversation part type conversation_attribute_updated_by_admin. - properties: - attribute: - type: object - properties: - name: - type: string - description: Name of the CDA updated - example: jira_issue_key - value: - type: object - properties: - name: - type: string - description: Value of the CDA updated - example: PROJ-007 - custom_action_started: - title: Part type - custom_action_started - type: object - description: Contains details about name of the action that was initiated for conversation part type custom_action_started. - properties: - action: - type: object - properties: - name: - type: string - description: Name of the action - example: Jira Create Issue - custom_action_finished: - title: Part type - custom_action_finished - type: object - description: Contains details about final status of the completed action for conversation part type custom_action_finished. - properties: - action: - type: object - properties: - name: - type: string - description: Name of the action - example: Jira Create Issue - result: - type: string - description: Status of the action - enum: - - success - - failed - example: success - operator_workflow_event: - title: Part type - operator_workflow_event - type: object - description: Contains details about name of the workflow for conversation part type operator_workflow_event. - properties: - workflow: - type: object - properties: - name: - type: string - description: The name of the workflow - example: Custom Bot 1 - event: - type: object - properties: - type: - type: string - description: Type of the workflow event initiated - example: wait_finished - result: - type: string - description: Result of the workflow event - example: Finsihed waiting - event_details: - title: Event details of Workflow & actions - type: object - anyOf: - - "$ref": "#/components/schemas/conversation_attribute_updated_by_workflow" - - "$ref": "#/components/schemas/conversation_attribute_updated_by_admin" - - "$ref": "#/components/schemas/custom_action_started" - - "$ref": "#/components/schemas/custom_action_finished" - - "$ref": "#/components/schemas/operator_workflow_event" error: type: object title: Error @@ -17670,49 +15466,6 @@ components: description: An array of Help Center objects items: "$ref": "#/components/schemas/help_center" - jobs: - title: Jobs - type: object - x-tags: - - Jobs - description: Jobs are tasks that are processed asynchronously by the Intercom system after being enqueued via the API. This allows for efficient handling of operations that may take time to complete, such as data imports or exports. You can check the status of your jobs to monitor their progress and ensure they are completed successfully. - properties: - type: - type: string - description: The type of the object - enum: - - job - id: - type: string - description: The id of the job that's currently being processed or has completed. - example: 20 - url: - type: string - description: API endpoint URL to check the job status. - example: https://api.intercom.io/jobs/status/20 - status: - type: string - description: The status of the job execution. - enum: - - pending - - success - - failed - resource_type: - type: string - description: The type of resource created during job execution. - example: ticket - resource_id: - type: string - description: The id of the resource created during job execution (e.g. ticket id) - example: 123 - nullable: true - resource_url: - type: string - description: The url of the resource created during job exeuction. Use this url to fetch the resource. - example: http://api.intercom.io/tickets/123 - nullable: true - required: - - id intercom_version: description: Intercom API version.
    By default, it's equal to the version set in the app package. @@ -17737,6 +15490,8 @@ components: - '2.9' - '2.10' - '2.11' + - '2.12' + - '2.13' - Unstable linked_object: title: Linked Object @@ -17841,9 +15596,8 @@ components: - inapp - facebook - twitter - - sms description: The type of message that was sent. Can be email, inapp, facebook - ,twitter or sms. + or twitter. example: inapp conversation_id: type: string @@ -18434,17 +16188,9 @@ components: search for the value. example: ">" value: - oneOf: - - type: string - - type: integer - - type: array - items: - oneOf: - - type: string - - type: integer + type: string description: The value that you want to search on. example: '73732934' - nullable: true sla_applied: title: Applied SLA type: object @@ -18625,26 +16371,6 @@ components: example: 1663597223 applied_by: "$ref": "#/components/schemas/reference" - tag_basic: - 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 tag_company_request: description: You can tag a single company or a list of companies. type: object @@ -18997,11 +16723,6 @@ components: type: boolean description: Whether or not the ticket part has been redacted. example: false - app_package_code: - type: string - nullable: false - example: text-integration - description: The app package code if this part was created via API. Note this field won't show if the part was not created via API. ticket_part_author: title: Ticket part author type: object @@ -19634,10 +17355,6 @@ components: type: boolean description: Mark a conversation as read within Intercom. example: true - title: - type: string - description: The title given to the conversation - example: Conversation Title custom_attributes: "$ref": "#/components/schemas/custom_attributes" update_data_attribute_request: @@ -19736,7 +17453,8 @@ components: company_id: type: string description: The ID of the company that the ticket is associated with. The - unique identifier for the company which is given by Intercom. Set to nil to remove company. + unique identifier for the company which is given by Intercom. Set to nil + to remove company. example: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 open: type: boolean @@ -19752,18 +17470,16 @@ components: 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' + admin_id: + type: integer + description: The ID of the admin performing ticket update. Needed for workflows + execution and attributing actions to specific admins. + 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 @@ -20164,49 +17880,6 @@ components: bearerAuth: type: http scheme: bearer - responses: - Unauthorized: - description: Unauthorized - content: - application/json: - examples: - Unauthorized: - value: - type: error.list - request_id: 12a938a3-314e-4939-b773-5cd45738bd21 - errors: - - code: unauthorized - message: Access Token Invalid - schema: - "$ref": "#/components/schemas/error" - TypeNotFound: - description: Not Found - content: - application/json: - examples: - TypeNotFound: - value: - type: error.list - request_id: 12a938a3-314e-4939-b773-5cd45738bd21 - errors: - - code: not_found - message: Custom object type `undefined` not found - schema: - "$ref": "#/components/schemas/error" - ObjectNotFound: - description: Not Found - content: - application/json: - examples: - ObjectNotFound: - value: - type: error.list - request_id: 12a938a3-314e-4939-b773-5cd45738bd21 - errors: - - code: not_found - message: Custom object instance not found - schema: - "$ref": "#/components/schemas/error" servers: - url: https://api.intercom.io description: The production API server @@ -20246,11 +17919,7 @@ tags: description: What is a conversation? url: https://www.intercom.com/help/en/articles/4323904-what-is-a-conversation - name: Custom Object Instances - description: | - Everything about your Custom Object instances. - {% admonition type="warning" name="Permission Requirements" %} - From now on, to access this endpoint, you need additional permissions. Please head over to the [Developer Hub](https://app.intercom.com/a/apps/_/developer-hub) app package authentication settings to configure the required permissions. - {% /admonition %} + description: Everything about your Custom Object instances. - name: Data Attributes description: Everything about your Data Attributes - name: Data Events @@ -20259,8 +17928,6 @@ tags: description: Everything about your Data Exports - name: Help Center description: Everything about your Help Center -- name: Jobs - description: Everything about jobs - name: Messages description: Everything about your messages - name: News